# GlobKurier ## Docs - Integration via the Globkurier API [Introduction (PL)](https://developer.globkurier.pl/introduction-pl-891928m0.md): - Integration via the Globkurier API [Introduction (EN)](https://developer.globkurier.pl/introduction-en-1268126m0.md): - Integration via the Globkurier API [Integration Strategy (PL)](https://developer.globkurier.pl/integration-strategy-pl-961307m0.md): - Integration via the Globkurier API [Integration Strategy (EN)](https://developer.globkurier.pl/integration-strategy-en-1281352m0.md): - Integration via the Globkurier API [Full Integration (PL)](https://developer.globkurier.pl/full-integration-pl-955543m0.md): - Integration via the Globkurier API [Full Integration (EN)](https://developer.globkurier.pl/full-integration-en-1281620m0.md): - Integration via the Globkurier API [Fast order Integration (PL)](https://developer.globkurier.pl/fast-order-integration-pl-955542m0.md): - Integration via the Globkurier API [Fast order Integration (EN)](https://developer.globkurier.pl/fast-order-integration-en-1281670m0.md): - Integration via the Globkurier API [Pricing Summary before ordering (PL)](https://developer.globkurier.pl/pricing-summary-before-ordering-pl-1268214m0.md): - Integration via the Globkurier API [Pricing Summary before ordering (EN)](https://developer.globkurier.pl/pricing-summary-before-ordering-en-1281688m0.md): - Integration via the Globkurier API [Shipment search (PL)](https://developer.globkurier.pl/shipment-search-pl-957204m0.md): - Integration via the Globkurier API [Shipment search (EN)](https://developer.globkurier.pl/shipment-search-en-1281693m0.md): - Integration via the Globkurier API [Crossborder / Points (PL)](https://developer.globkurier.pl/crossborder-points-pl-879272m0.md): - Integration via the Globkurier API [Crossborder / Points (EN)](https://developer.globkurier.pl/crossborder-points-en-1281725m0.md): - Integration via the Globkurier API [Labels (PL)](https://developer.globkurier.pl/labels-pl-1268219m0.md): - Integration via the Globkurier API [Labels (EN)](https://developer.globkurier.pl/labels-en-1287513m0.md): - Integration via the Globkurier API [Tracking (PL)](https://developer.globkurier.pl/tracking-pl-1268216m0.md): - Integration via the Globkurier API [Tracking (EN)](https://developer.globkurier.pl/tracking-en-1287526m0.md): - Integration via the Globkurier API [Get carrier data (PL)](https://developer.globkurier.pl/get-carrier-data-pl-1268226m0.md): - Integration via the Globkurier API [Get carrier data (EN)](https://developer.globkurier.pl/get-carrier-data-en-1287527m0.md): - Integration via the Globkurier API [Addon categories (PL)](https://developer.globkurier.pl/addon-categories-pl-1278051m0.md): - Integration via the Globkurier API [Addon categories (EN)](https://developer.globkurier.pl/addon-categories-en-1287532m0.md): - Integration via the Globkurier API [Order with customs (PL)](https://developer.globkurier.pl/order-with-customs-pl-1337773m0.md): - Integration via the Globkurier API [FAQ (PL)](https://developer.globkurier.pl/faq-pl-1278632m0.md): - Integration via the Globkurier API [FAQ (EN)](https://developer.globkurier.pl/faq-en-1287553m0.md): - Integration via the Globkurier API [Przykłady / Examples Crossborder](https://developer.globkurier.pl/przyk%C5%82ady-examples-crossborder-1703873m0.md): ## API Docs - Integration via the Globkurier API > Endpoints > Dictionary > Addresses [Get list of countries](https://developer.globkurier.pl/get-list-of-countries-15042404e0.md): - Integration via the Globkurier API > Endpoints > Dictionary > Addresses [Get states for country](https://developer.globkurier.pl/get-states-for-country-15042405e0.md): We use this functionality if the [/customRequiredFields](apidog://link/endpoint/17081609) call indicates that it is necessary to provide the sender or recipient status in the order [creating](apidog://link/endpoint/17083890)/[validation](apidog://link/endpoint/17125353) process. - Integration via the Globkurier API > Endpoints > Dictionary > Addresses [Get shipment/receiving points](https://developer.globkurier.pl/get-shipmentreceiving-points-17375879e0.md): - Integration via the Globkurier API > Endpoints > Dictionary > Addresses [Get Polish addresses](https://developer.globkurier.pl/get-polish-addresses-17375576e0.md): Returns Polish address ranges based on submitted parameters. This functionality supports automatic city completion based on postal code. You can search for an address by entering a postal code or a city and street. - Integration via the Globkurier API > Endpoints > Dictionary > Addresses [Get list of cities](https://developer.globkurier.pl/get-list-of-cities-15042406e0.md): The resource allows you to download a list of cities based on the given postal code and country. - Integration via the Globkurier API > Endpoints > Dictionary > Carriers [Get available carrier list](https://developer.globkurier.pl/get-available-carrier-list-15042399e0.md): The resource allows you to download a list of carriers along with a link to their logo. - Integration via the Globkurier API > Endpoints > Dictionary > Carriers [Get shipment/receiving points](https://developer.globkurier.pl/get-shipmentreceiving-points-19086448e0.md): - Integration via the Globkurier API > Endpoints > Dictionary > Finance [Get available currency list](https://developer.globkurier.pl/get-available-currency-list-15042412e0.md): - Integration via the Globkurier API > Endpoints > Dictionary > Orders [Get available order content](https://developer.globkurier.pl/get-available-order-content-15042414e0.md): - Integration via the Globkurier API > Endpoints > Dictionary > Agreements [Get agreements](https://developer.globkurier.pl/get-agreements-17381293e0.md): Endpoint provides pagination. The parameters related to it are described [here](apidog://link/pages/891928). - Integration via the Globkurier API > Endpoints > Authentication [Generate token](https://developer.globkurier.pl/generate-token-14885632e0.md): - Integration via the Globkurier API > Endpoints > Authentication [Refresh token](https://developer.globkurier.pl/refresh-token-14902244e0.md): We only send the `token` in the `x-auth-token` header of the request. - Integration via the Globkurier API > Endpoints > Authentication [Remove token](https://developer.globkurier.pl/remove-token-14902246e0.md): We only send the `token` in the `x-auth-token` header of the request. - Integration via the Globkurier API > Endpoints > Fast order [Simplified order placement (bestprice)](https://developer.globkurier.pl/simplified-order-placement-bestprice-17165486e0.md): A simplified order form allows you to place an order without knowing the product ID or country ID. - Integration via the Globkurier API > Endpoints > Full integration [Get products](https://developer.globkurier.pl/get-products-15859197e0.md): - Integration via the Globkurier API > Endpoints > Full integration [Get addons for product](https://developer.globkurier.pl/get-addons-for-product-17046611e0.md): Add-on logic to be implemented on the client side: - Integration via the Globkurier API > Endpoints > Full integration [Get discount code information](https://developer.globkurier.pl/get-discount-code-information-17052010e0.md): - Integration via the Globkurier API > Endpoints > Full integration [Get available courier arrival times to the sender for the shipment](https://developer.globkurier.pl/get-available-courier-arrival-times-to-the-sender-for-the-shipment-17068889e0.md): Fields marked as optional can be omitted, but providing as much data as possible allows for better matching of shipping dates for a given location. - Integration via the Globkurier API > Endpoints > Full integration [Get payments](https://developer.globkurier.pl/get-payments-17073389e0.md): When using the resource to check the list of available payments for a product associated with a voucher, only the `productId` parameter is required. Another way to check the possibility of paying for an order for a product associated with a voucher is to use the [/user/couponStats](apidog://link/endpoint/17226249) resource. - Integration via the Globkurier API > Endpoints > Full integration [Get bank account numbers](https://developer.globkurier.pl/get-bank-account-numbers-17073598e0.md): Endpoint allows you to retrieve bank account numbers for payments in different currencies. - Integration via the Globkurier API > Endpoints > Full integration [Get order price](https://developer.globkurier.pl/get-order-price-17078292e0.md): Querying the resource for a product associated with a voucher will return an error because for such products there is no order price, but the quantity of products available for ordering under the granted voucher. - Integration via the Globkurier API > Endpoints > Full integration [Get custom required fields](https://developer.globkurier.pl/get-custom-required-fields-17081609e0.md): Allows you to determine whether additional data fields should be sent using the [/order](apidog://link/endpoint/17083890) resource - Integration via the Globkurier API > Endpoints > Full integration [Create order](https://developer.globkurier.pl/create-order-17083890e0.md): In response, we receive the number, the hash of the placed order and information about the valuation of the placed order or a list of validation errors. - Integration via the Globkurier API > Endpoints > Full integration [Partial order validation](https://developer.globkurier.pl/partial-order-validation-17125353e0.md): The structure of the request body is the same as in [/order](apidog://link/endpoint/17083890). - Integration via the Globkurier API > Endpoints > Full integration [Create order for courier pick up](https://developer.globkurier.pl/create-order-for-courier-pick-up-17171293e0.md): Placing an order for a courier to pick up the order if the courier has not yet arrived. - Integration via the Globkurier API > Endpoints > Payments [Get list of available methods](https://developer.globkurier.pl/get-list-of-available-methods-17209577e0.md): Online payments may be subject to a flat 1% fee of the order value. This fee does not appear when viewing the payment list from the [payment](apidog://link/endpoint/17073389) collection method. - Integration via the Globkurier API > Endpoints > Payments [Generate form data for online order payment](https://developer.globkurier.pl/generate-form-data-for-online-order-payment-17209949e0.md): The resource requires a cookie to be saved on the user's browser. The `withCredentials` flag should be added to Ajax calls. - Integration via the Globkurier API > Endpoints > Payments [Prepaid top-up](https://developer.globkurier.pl/prepaid-top-up-17211961e0.md): The resource requires a cookie to be saved on the user's browser. The `withCredentials` flag should be added to Ajax calls. - Integration via the Globkurier API > Endpoints > Payments [Changing payment method for online order](https://developer.globkurier.pl/changing-payment-method-for-online-order-17213024e0.md): - Integration via the Globkurier API > Endpoints > Orders [Get order](https://developer.globkurier.pl/get-order-17377900e0.md): - Integration via the Globkurier API > Endpoints > Orders [Get list of orders for the protocol](https://developer.globkurier.pl/get-list-of-orders-for-the-protocol-17379333e0.md): Returns a list of grouped orders from which a protocol can be generated. By default, no filters need to be passed to generate them based on the list received the first time. - Integration via the Globkurier API > Endpoints > Orders [Get protocol](https://developer.globkurier.pl/get-protocol-17380309e0.md): The API returns information on whether it is possible to use this resource for a given product in the [/products](apidog://link/endpoint/15859197) resource. - Integration via the Globkurier API > Endpoints > Orders [Get labels](https://developer.globkurier.pl/get-labels-17381096e0.md): This resource is responsible for downloading labels (single and bulk). - Integration via the Globkurier API > Endpoints > Orders [Get shipment statuses](https://developer.globkurier.pl/get-shipment-statuses-17381253e0.md): - Integration via the Globkurier API > Endpoints > User [Get user data](https://developer.globkurier.pl/get-user-data-17226041e0.md): - Integration via the Globkurier API > Endpoints > User [Get user coupon data](https://developer.globkurier.pl/get-user-coupon-data-17226249e0.md): - Integration via the Globkurier API > Endpoints > User [Register user](https://developer.globkurier.pl/register-user-17226477e0.md): In response, we receive the number of the created customer account and an active authorization token. - Integration via the Globkurier API > Endpoints > User [Edit user](https://developer.globkurier.pl/edit-user-17281417e0.md): The resource returns status `204` after saving data. - Integration via the Globkurier API > Endpoints > User [Get company information](https://developer.globkurier.pl/get-company-information-17286012e0.md): The endpoint is used to retrieve company information for user verification before creating an account. - Integration via the Globkurier API > Endpoints > User [Get user invoice list](https://developer.globkurier.pl/get-user-invoice-list-17287602e0.md): The endpoint supports pagination. The parameters related to it are described [here](apidog://link/pages/891928). - Integration via the Globkurier API > Endpoints > User [Get invoice](https://developer.globkurier.pl/get-invoice-17289836e0.md): Link to the page where the selected invoice will be available for download. - Integration via the Globkurier API > Endpoints > User [Get compressed list of invoices](https://developer.globkurier.pl/get-compressed-list-of-invoices-17320336e0.md): Link to the page where the ZIP archive with the specified list of invoices will be downloaded. - Integration via the Globkurier API > Endpoints > User [Get invoice email](https://developer.globkurier.pl/get-invoice-email-17329582e0.md): The email message is an EML file, which can be opened in popular email clients such as MS Outlook 365 or Mozilla Thunderbird. - Integration via the Globkurier API > Endpoints > User [Get account and payment statistics](https://developer.globkurier.pl/get-account-and-payment-statistics-17330172e0.md): - Integration via the Globkurier API > Endpoints > User [Get list of payment methods](https://developer.globkurier.pl/get-list-of-payment-methods-17330620e0.md): This method behaves similarly to [/order/payments](apidog://link/endpoint/17073389). - Integration via the Globkurier API > Endpoints > User [Get selected payment method](https://developer.globkurier.pl/get-selected-payment-method-17330797e0.md): Returns information about the payment method saved by the user. - Integration via the Globkurier API > Endpoints > User [Create selected payment method](https://developer.globkurier.pl/create-selected-payment-method-17330907e0.md): The response returns code `201` or error information for each field. - Integration via the Globkurier API > Endpoints > User [Remove selected payment method](https://developer.globkurier.pl/remove-selected-payment-method-17331167e0.md): The response code is `204` if the query is valid. - Integration via the Globkurier API > Endpoints > User [Get order statistics](https://developer.globkurier.pl/get-order-statistics-17331605e0.md): - Integration via the Globkurier API > Endpoints > User [Get list of customs documents for the order](https://developer.globkurier.pl/get-list-of-customs-documents-for-the-order-17332011e0.md): - Integration via the Globkurier API > Endpoints > User [Get list of options for saving user preferences](https://developer.globkurier.pl/get-list-of-options-for-saving-user-preferences-17332320e0.md): - Integration via the Globkurier API > Endpoints > User [Save user preferences](https://developer.globkurier.pl/save-user-preferences-17333126e0.md): The resource returns status `204` after saving data. - Integration via the Globkurier API > Endpoints > User [Send SMS with a verification code](https://developer.globkurier.pl/send-sms-with-a-verification-code-19154854e0.md): The resource returns status `202` after successful SMS sending. - Integration via the Globkurier API > Endpoints > Users > AddressBook [Edit sender contact in address book](https://developer.globkurier.pl/edit-sender-contact-in-address-book-15042389e0.md): The resource returns status `204` after saving data. - Integration via the Globkurier API > Endpoints > Users > AddressBook [Add sender contact in address book](https://developer.globkurier.pl/add-sender-contact-in-address-book-15042390e0.md): - Integration via the Globkurier API > Endpoints > Users > AddressBook [Delete sender contact from address book](https://developer.globkurier.pl/delete-sender-contact-from-address-book-15042391e0.md): - Integration via the Globkurier API > Endpoints > Users > AddressBook [Edit receiver contact in address book](https://developer.globkurier.pl/edit-receiver-contact-in-address-book-15042392e0.md): The resource returns status `204` after saving data. - Integration via the Globkurier API > Endpoints > Users > AddressBook [Add receiver contact in address book](https://developer.globkurier.pl/add-receiver-contact-in-address-book-15042393e0.md): - Integration via the Globkurier API > Endpoints > Users > AddressBook [Delete receiver contact from address book](https://developer.globkurier.pl/delete-receiver-contact-from-address-book-15042394e0.md): - Integration via the Globkurier API > Endpoints > Users > AddressBook [Get senders contacts from address book](https://developer.globkurier.pl/get-senders-contacts-from-address-book-15042395e0.md): Endpoint provides pagination. The parameters related to it are described [here](apidog://link/pages/891928). - Integration via the Globkurier API > Endpoints > Users > AddressBook [Get receiver contacts from address book](https://developer.globkurier.pl/get-receiver-contacts-from-address-book-15042396e0.md): Endpoint provides pagination. The parameters related to it are described [here](https://app.apidog.com/link/project/844225/apis/doc-891928). - Integration via the Globkurier API > Endpoints > Users > AddressBook [Import sender contacts to address book](https://developer.globkurier.pl/import-sender-contacts-to-address-book-15042397e0.md): The endpoint accepts encoded file content in a specified data format. It allows you to add multiple contacts of the same type simultaneously. The file can have any name, as only its content matters. Currently, the only supported format `[type]` is `CSV`. The maximum file size is `5MB`. - Integration via the Globkurier API > Endpoints > Users > AddressBook [Import receiver contacts to address book](https://developer.globkurier.pl/import-receiver-contacts-to-address-book-15042398e0.md): The endpoint accepts encoded file content in a specified data format. It allows you to add multiple contacts of the same type simultaneously. The file can have any name, as only its content matters. Currently, the only supported format `[type]` is `CSV`. The maximum file size is `5MB`. - Integration via the Globkurier API > Endpoints > Users [get company for user](https://developer.globkurier.pl/get-company-for-user-15042400e0.md): - Integration via the Globkurier API > Endpoints > Users [Update user currency](https://developer.globkurier.pl/update-user-currency-15042401e0.md): This endpoint can be use for change default user currency set on profile. - Integration via the Globkurier API > Endpoints > Users [User return carrier list](https://developer.globkurier.pl/user-return-carrier-list-15042402e0.md): Get all carriers for return that user have assigned - Integration via the Globkurier API > Endpoints > Users [Manage user return carrier list](https://developer.globkurier.pl/manage-user-return-carrier-list-15042403e0.md): Allow user to assign given carrier list - Integration via the Globkurier API > Endpoints > AddressBook [Add sender contact to address book](https://developer.globkurier.pl/add-sender-contact-to-address-book-17217136e0.md): - Integration via the Globkurier API > Endpoints > AddressBook [Add receiver contact to address book](https://developer.globkurier.pl/add-receiver-contact-to-address-book-17218384e0.md): - Integration via the Globkurier API > Endpoints > AddressBook [Get senders address book](https://developer.globkurier.pl/get-senders-address-book-17218635e0.md): Endpoint provides pagination. The parameters related to it are described [here](apidog://link/pages/891928). - Integration via the Globkurier API > Endpoints > AddressBook [Get receivers address book](https://developer.globkurier.pl/get-receivers-address-book-17218659e0.md): Endpoint provides pagination. The parameters related to it are described [here](https://app.apidog.com/link/project/844225/apis/doc-891928). - Integration via the Globkurier API > Endpoints > AddressBook [Edit sender contact into address book](https://developer.globkurier.pl/edit-sender-contact-into-address-book-17219485e0.md): The resource returns status `204` after saving data. - Integration via the Globkurier API > Endpoints > AddressBook [Edit receiver contact into address book](https://developer.globkurier.pl/edit-receiver-contact-into-address-book-17219815e0.md): The resource returns status `204` after saving data. - Integration via the Globkurier API > Endpoints > AddressBook [Delete sender contact from address book](https://developer.globkurier.pl/delete-sender-contact-from-address-book-17219920e0.md): - Integration via the Globkurier API > Endpoints > AddressBook [Delete receiver contact from address book Copy](https://developer.globkurier.pl/delete-receiver-contact-from-address-book-copy-17221781e0.md): - Integration via the Globkurier API > Endpoints > Order templates [Add template](https://developer.globkurier.pl/add-template-17175505e0.md): - Integration via the Globkurier API > Endpoints > Order templates [Get tempalate list](https://developer.globkurier.pl/get-tempalate-list-17176372e0.md): Endpoint provides pagination. The parameters related to it are described [here](apidog://link/pages/891928). - Integration via the Globkurier API > Endpoints > Order templates [Edit template](https://developer.globkurier.pl/edit-template-17206598e0.md): The resource returns status `204` after saving data. - Integration via the Globkurier API > Endpoints > Order templates [Delete template](https://developer.globkurier.pl/delete-template-17208751e0.md): ## Schemas - Schemas [UpdatePlatformIntegrationDto](https://developer.globkurier.pl/updateplatformintegrationdto-5754676d0.md): - Schemas [UserReturnCarrierRequestDto](https://developer.globkurier.pl/userreturncarrierrequestdto-5775541d0.md): - Schemas [UpdatePlatformIntegrationResponseDto](https://developer.globkurier.pl/updateplatformintegrationresponsedto-5754677d0.md): - Schemas [CreateTokenRequestDto](https://developer.globkurier.pl/createtokenrequestdto-5775542d0.md): - Typy danych [Platformy](https://developer.globkurier.pl/platformy-5754675d0.md): - Typy danych [Shipment](https://developer.globkurier.pl/shipment-6181396d0.md): - Typy danych [Currency](https://developer.globkurier.pl/currency-5775540d0.md): - Typy danych [Pickup](https://developer.globkurier.pl/pickup-6194098d0.md): - Typy danych [UserAddress](https://developer.globkurier.pl/useraddress-6194102d0.md): - Typy danych [Address](https://developer.globkurier.pl/address-6852635d0.md): - Typy danych [Customs](https://developer.globkurier.pl/customs-6874954d0.md): - Typy danych [Shipment - BestPrice](https://developer.globkurier.pl/shipment-bestprice-6903075d0.md): - Typy danych [Address - BestPrice](https://developer.globkurier.pl/address-bestprice-6903091d0.md): - Typy danych [Contact](https://developer.globkurier.pl/contact-6926282d0.md): - Typy danych [CashOnDelivery](https://developer.globkurier.pl/cashondelivery-6957818d0.md):