Introduction (EN)

Previous version of documentation: https://api.globkurier.pl/v1/documentation

1. Getting Started

The GlobKurier API is based on REST architecture. Responses are returned in JSON format. Communication with the production endpoint is SSL-encrypted.

Environments are separated. To use the test API, you are required to have a production user account, provided at least one day has passed since registration or profile update (propagation time to the test environment). Test data is deleted at the end of the day.

You can send requests in JSON format with the Content-Type header set to application/json. In other cases, for POST requests, this header should be set to application/x-www-form-urlencoded.

To facilitate the integration and testing process, the documentation includes interactive requests.

Base URL:

https://api.globkurier.pl/v1

Test URL:

https://test.api.globkurier.pl/v1

2. Language Versions

The API language is selected by sending the accept-language header with an ISO 639-1 language code in the request.

Currently supported languages:

• pl
• en (default)

3. Resource Types

There are 3 resource types by authorization:

• no authorization required (e.g. fetching the country list)
• optional authorization (e.g. product search, which returns different products for guests and logged-in users) – marked in the documentation with a filter icon

4. Resource Discovery

You can retrieve available methods by querying any resource with the HTTP OPTIONS method. The response will include the following headers:

Access-Control-Allow-Methods – allowed HTTP methods for the resource, e.g., OPTIONS, GET
Access-Control-Allow-Headers – allowed headers for the resource, e.g., x-auth-token, accept-language, x-currency

This allows pre-verification whether a resource requires no token, or if your token provides sufficient access.

Attempting a not allowed method on a resource will result in the 405 Method Not Allowed error status.

5. API Constants

The list contains constant values that must be provided in specific cases and cannot be retrieved from API resources.

Name	Possible Values
Dispatch Type	PICKUP, POINT, CROSSBORDER
Pickup Type	PICKUP, POINT, CROSSBORDER
Informational Labels	transport type: GROUND, AIR additional carrier information: PACZKOMAT, PACZKA_W_RUCHU
Client Type	PERSON, COMPANY
Shipment Purpose	SOLD, GIFT, SAMPLE, NOT_SOLD, PERSONAL_EFFECTS, REPAIR_AND_RETURN
Order Status	NEW_SHIPMENT – new IN_PROGRESS – being processed by the system IN_TRANSIT – in transit with the carrier DELIVERED – delivered CANCELED – canceled RETURNED_TO_SENDER – returned to sender
Financial Document Type	PROFORMA_INVOICE – proforma invoice INVOICE – VAT invoice CORRECTION_INVOICE – corrective invoice SUPPLEMENTARY_INVOICE – supplementary invoice RECEIPT – receipt INVOICE_FOR_RECEIPT – invoice for receipt INVOICE_WITHOUT_VAT – invoice without VAT PROFORMA_INVOICE_WITHOUT_VAT – proforma invoice without VAT
Transport Document Type	WAYBILL – waybill PROTOCOL – protocol PROFORMA_INVOICE – proforma invoice AUTHORIZATION – authorization INSTRUCTION_FOR_CUSTOMS_DOCUMENTATION – instruction for customs documentation CUSTOMS_CLEARANCE_CARD – customs clearance card EXPORTER_STATEMENT – exporter statement

6. API Pagination

All resources supporting pagination follow the scheme below.

Request

Field	Description	Required
limit	Maximum number of results for given filters, default 25, maximum 100.	No
offset	Index of the result from which results are returned, numbered from 0, default 0.	No
filters []	Array of filters. Filters differ depending on the endpoint.	No

Response

Field	Description
offset	The index provided in the request parameters or the default, if not specified.
limit	The maximum number of results provided in the request parameters or the default if not specified.
total	Total number of results for the given filters.
results []	Array of results.

Pagination Example

If you want to display a maximum of 10 records per page, to get the first page, query the API with offset = 0 and limit = 10. In response, you receive information that the total number of results is 126. You know that with ten results per page, there are 13 result pages (the last one has 6 results). To display the second page, query the API with offset = 10 and limit = 10.

7. API Responses

The API uses the following response statuses (RFC 2616):

HTTP Status	Description
200 OK	Successful response with collection or object content.
201 Created	Successful response – indicates changes on the server in the form of a new object being created.
202 Accepted	Successful response – the request has been accepted but is still being processed. The response structure contains a description indicating which endpoint to call for information about the processed item.
204 No Content	Successful response with no content – indicates the server successfully processed the request but does not need to return any content.
400 Bad Request	Bad request – the client's request contains incorrect data. The returned response contains an error message structure with general information and details about incorrectly filled fields. Based on this, you should correct the request and resend.
401 Unauthorized	Authorization error – the request does not contain the appropriate token for the protected resource. You must obtain one and retry the request.
403 Forbidden	Access denied to the resource – the provided token does not have the required permissions for the protected resource.
404 Not Found	Resource not found – the client’s request refers to a non-existent path or resource identifier.
405 Method Not Allowed	Method not allowed – the HTTP method used in the request is not allowed for the specified resource. The response also includes a list of allowed methods in the Allow header. Allowed methods can be discovered before use.
500 Internal Server Error	Internal API error – a permanent error was encountered that prevents fulfilling the request. Please contact technical support for information about repair status.
503 Service Unavailable	API temporarily unavailable – the request could not be completed, please try again.