The following headers can be specified when executing a request
Header
Description
Authorization
Authorization header, where all authorization data should be sent. Details can be found in the Authorization chapter.
X-User-Agent
This header allows you to specify the client/platform name and/or other information related to it.
X-User-Agent-Version
This header allows you to specify the client/platform number of the request. Its content does not affect the functioning of the API.
X-Request-ID
This header allows you to specify the name of the request. It is useful for debugging bugs and problems that may occur during API integration. Its application does not impact the functioning of the API.
Accept-Language
This header allows you to change the editing of errors. Available values:
keys (some_error_message)
en_GB (Some error message)
pl_PL (Przykładowy komunikat o błędzie)
Response header
In response, the server returns the following header:
Header
Description
X-Request-ID
Request ID. It is useful for debugging bugs and problems that may occur during API integration. If it is specified during the request, the API will not generate its own IID, and the one provided during the request will be returned to the response.
Authorization
All requests which are sent to the server requires passing a valid access token, which belongs to the owner of the organization.
The access token should be provided in the header Authorization.
Request Example:
GET /v1/users HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
Authorization: Bearer TOKEN-MUST-BE-PLACED-HERE
Collections
Collection attributes
Attribute
Type
Description
href
String
Absolute URL address to the collection.
count
Integer
A total number of items in the collection.
page
Integer
The current collection results page.
per_page
Integer
A number of results (per page) returned to the response.
Collections support paging (unless stated otherwise in the resource-specific documentation).
Scrolling through the pages of the collection is done by passing query parameters (page) and/or (page_page) in the request. Request example:
GET /v1/points?page=10 HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
Errors
Errors example
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"status": 400,
"error": "invalid_parameter",
"description": "Passed unsupported value (value of the parameter here) to parameter (parameter name)",
"details": null
}
List of error keys that may occur:
Key
Description
resource_not_found
The resource you are looking for was not found.
access_forbidden
Access to the specified resource is denied.
invalid_parameter
An invalid value was passed for a parameter in the URI. Details are available under the description key of the error response.
validation_failed
Validation error. The data sent in the payload of the POST request is incorrect. Details of the error are in the response under the details key.
offer_expired
The offer cannot be purchased, because its validity has expired.
Error example
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"status": 400,
"error": "validation_failed",
"description": "Some of data sent in payload are invalid. Check details for more information.",
"details": {
"email": ["invalid"]
}
}
The details object contains a collection in which the keys correspond to the names of parameters sent in the payload of the request, while the values are an array with keys specifying which validation errors occurred for a given parameter.
Possible validation errors:
Validation error
Description
required
The value for the specified parameter is required.
too_short
The number of characters is too small. Check the resource documentation for details.
too_long
The number of characters is too large. Check the resource documentation for details.
not_a_number
The entered value should be a number.
not_an_integer
The entered value should be an integer number.
invalid
The entered value is invalid. Check the resource documentation for details.