dodajpaczke.eu API documentation version 1.11.0
https://api.dodajpaczke.eu/v1
Changelog
[1.11.0]
- Added a storehouse address in the shipper.
[1.10.0]
- Added a new method for precalculating Post NL providers' DDP shipment's tariff and tax pricing.
[1.9.0]
- Added new methods for generating retoure labels for existing shipments.
- Removed the B2C Free option from the retoure generation for DHL International shipments.
[1.8.0]
- Added a final carrier to the response of a shipment.
[1.7.0]
- The
persontype is now deprecated. If it is used, then thefirstNameandlastNameare copied into thecompanyNamefield.
[1.6.0]
- A custom declaration's standard and layout are now deprecated. The standard and layout are selected automatically based on a provider.
[1.5.0]
- Added a proof of export document.
[1.4.0]
- Removed the vatRegNumber from custom declarations. Tax identifications are loaded directly from shipper's data now.
[1.3.0]
- Added support for DHL Retoure labels as a separated provider (ID=36).
[1.2.1]
- Added support for DHL Retoure labels.
[1.2.0]
- Added the customs declarations support.
Postman
To test the service, you can a postman collection, that can be found here. In the collection, the token can be provided through the environment variable eh_access_token (see documentation).
Responses
All responses will be in the JSON format.
Response structure
The response structure for the API follows the below format:
{
"data": "Contains response data",
"error": "Contains an error description, if the error occurs"
}
If an error occurs then the error block will be sent. If both blocks are provided then the data block will consist the additional description of the error.
HTTP Methods
| Method | Description |
|---|---|
| GET | Used for retrieving resources. |
| POST | Used for creating resources and performing resource actions. |
| PUT | Used for updating resources. |
| DETELE | Used for deleting resources. |
/shipments
get
Gets a collection of shipments.
post
Creates a new shipment. Some providers (like ID=32, ID=33, and ID=36) generate retoure labels only. For these labels only some limited fields are required, see the examples below.
patch
Do operations over provided shipments. Shipment identifiers can be passed in three ways: shipmentsNumbers and shippingNumbers, both use shipping number, and shipment that use shipments IDs. You can use only one way of indicating identifiers in a request, but providing it is required.
delete
Removes shipments
get /shipments
Gets a collection of shipments.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
Headers
- X-Pagination-Total-Count: required (integer)
A total number of shipments.
- X-Pagination-Page-Count: required (integer)
A total number of pages.
- X-Pagination-Current-Page: required (integer)
The current page number.
- X-Pagination-Per-Page: required (integer)
A number of shipments per page.
Query Parameters
- search: (string)
Searches in addresses and the shipping number.
- status: (one of incomplete, new, prepared, collected, in_delivery, delivered, canceled, returned, undelivered, uncollected, exception)
Filters by the current status of a shipment.
- provider: (integer)
Provider ID (a provider means DHL, GLS and so on).
- since: (date)
Created since the date.
- until: (date)
Created before the date.
- perPage: (integer - default: 10)
The number of shipments per page.
- page: (integer - default: 1)
The current page.
- customerReference: (string)
An additional identification field.
- description: (string)
An additional identification field.
- deliveryRemarks: (string)
An additional identification field.
- shippingNumber: (string)
The shipping number
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"description": "A collection of shipments.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"shippingNumber": {
"type": "string"
},
"trackingNumber": {
"type": "string"
},
"retoureIdc": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"incomplete",
"new",
"prepared",
"collected",
"in_delivery",
"delivered",
"canceled",
"returned",
"undelivered",
"uncollected",
"exception",
"removed",
"archived"
]
},
"description": {
"type": "string"
},
"deliveryRemarks": {
"type": "string"
},
"customerReference": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"provider": {
"type": "object",
"properties": {
"id": {
"type": "integer"
}
},
"required": [
"id"
]
},
"shipper": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
},
"identityBank": {
"type": "object",
"properties": {
"accountOwner": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"bankCode": {
"type": "string"
},
"bankName": {
"type": "string"
},
"iban": {
"type": "string"
},
"bic": {
"type": "string"
}
},
"required": []
},
"storehouse": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
}
},
"required": [
"type"
]
},
"receiver": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
},
"item": {
"type": "object",
"properties": {
"weightInKg": {
"type": "number"
},
"lengthInCm": {
"type": "integer"
},
"widthInCm": {
"type": "integer"
},
"heightInCm": {
"type": "integer"
},
"packageType": {
"type": "string",
"enum": [
"PK",
"ENVELOPE",
"OTHER"
]
}
},
"required": [
"weightInKg",
"packageType"
]
},
"details": {
"type": "object",
"properties": {
"insuranceAmount": {
"type": "number"
},
"insuranceCurrency": {
"type": "string"
},
"codAmount": {
"type": "number"
},
"codCurrency": {
"type": "string"
},
"ageCheck": {
"type": "number",
"description": "It is only for the DHL service. Please, use 1 for the 16+ verification and 2 for the 18+ verification."
}
},
"required": []
},
"customs": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.dodajpaczke.eu/customsDeclaration.schema.json",
"title": "Customs declaration of a shipment",
"description": "",
"type": "object",
"properties": {
"standard": {
"type": "string",
"description": "Deprecated from 1.6.0.",
"enum": [
"cn22",
"cn23"
]
},
"layout": {
"type": "string",
"description": "Deprecated from 1.6.0. The layout of an output customs declaration PDF.",
"enum": [
"default",
"cn22_100x70",
"cn23_a4"
],
"default": "default"
},
"mergeWithShippingLabel": {
"type": "boolean",
"description": "If true, then a customs declaration will be attached below a shipping label. If false, then a customs declaration will be add as an additional label.",
"default": false
},
"designatedOperator": {
"type": "string",
"description": "A designated operator name. If left empty, then the value of this field will be filled with the shipment provider's name."
},
"sender": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"receiver": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"contentsCategory": {
"type": "array",
"items": {
"type": "string",
"enum": [
"gift",
"documents",
"sales-of-goods",
"samples",
"returned-goods",
"other"
]
},
"minItems": 1,
"uniqueItems": true
},
"currencyOfContentsValue": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"default": "EUR"
},
"unitOfContentsWeight": {
"type": "string",
"default": "KG"
},
"contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"weight": {
"type": "number"
},
"value": {
"type": "number"
},
"hsTariffNumber": {
"type": "string",
"pattern": "^[0-9\\. ]+$"
},
"origin": {
"type": "string",
"description": "The country of origin of goods. In the ISO 3166-2 standard (ISO 3166-1 alpha-2).",
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"description",
"quantity",
"weight",
"value",
"origin"
]
},
"minItems": 1,
"uniqueItems": true
},
"comments": {
"type": "string"
},
"numberOfLicences": {
"type": "integer"
},
"numberOfCertificates": {
"type": "integer"
},
"numberOfInvoices": {
"type": "integer"
},
"signatureDate": {
"type": "string",
"format": "date",
"description": "If left empty, then the current date will be used."
},
"postalCharges": {
"type": "number"
}
},
"required": [
"mergeWithShippingLabel",
"contentsCategory",
"contents",
"postalCharges"
]
},
"finalCarrier": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.dodajpaczke.eu/finalCarrier.schema.json",
"title": "Final carrier of a shipment",
"description": "",
"type": "object",
"properties": {
"carrierName": {
"type": "string"
},
"trackingUrl": {
"type": "string"
}
},
"required": []
}
},
"required": [
"shipper",
"provider",
"receiver",
"item",
"details",
"status",
"description",
"deliveryRemarks",
"description",
"customerReference",
"shippingNumber",
"trackingNumber",
"createdAt",
"modifiedAt"
]
}
}
},
"required": [
"shipments"
]
}
},
"required": [
"data"
]
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
post /shipments
Creates a new shipment. Some providers (like ID=32, ID=33, and ID=36) generate retoure labels only. For these labels only some limited fields are required, see the examples below.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
Query Parameters
- sync: (number)
Use
sync=1. If it is set then shipment(s) will be add synchronously, then as a response, shipment(s) objects will be returned.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"shipments": {
"type": "array",
"description": "A collection of shipments to add.",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"deliveryRemarks": {
"type": "string"
},
"customerReference": {
"type": "string"
},
"shipperId": {
"type": "integer",
"description": "Has to be valid a shipper address ID. The shipper ID is generated for each client's address. Please contact the support to get you own IDs."
},
"provider": {
"type": "object",
"properties": {
"id": {
"type": "integer"
}
},
"required": [
"id"
]
},
"receiver": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
},
"item": {
"type": "object",
"properties": {
"weightInKg": {
"type": "number"
},
"lengthInCm": {
"type": "integer"
},
"widthInCm": {
"type": "integer"
},
"heightInCm": {
"type": "integer"
},
"packageType": {
"type": "string",
"enum": [
"PK",
"ENVELOPE",
"OTHER"
]
}
},
"required": [
"weightInKg",
"packageType"
]
},
"details": {
"type": "object",
"properties": {
"insuranceAmount": {
"type": "number"
},
"insuranceCurrency": {
"type": "string"
},
"codAmount": {
"type": "number"
},
"codCurrency": {
"type": "string"
},
"ageCheck": {
"type": "number",
"description": "It is only for the DHL service. Please, use 1 for the 16+ verification and 2 for the 18+ verification."
}
},
"required": []
},
"customs": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.dodajpaczke.eu/customsDeclaration.schema.json",
"title": "Customs declaration of a shipment",
"description": "",
"type": "object",
"properties": {
"standard": {
"type": "string",
"description": "Deprecated from 1.6.0.",
"enum": [
"cn22",
"cn23"
]
},
"layout": {
"type": "string",
"description": "Deprecated from 1.6.0. The layout of an output customs declaration PDF.",
"enum": [
"default",
"cn22_100x70",
"cn23_a4"
],
"default": "default"
},
"mergeWithShippingLabel": {
"type": "boolean",
"description": "If true, then a customs declaration will be attached below a shipping label. If false, then a customs declaration will be add as an additional label.",
"default": false
},
"designatedOperator": {
"type": "string",
"description": "A designated operator name. If left empty, then the value of this field will be filled with the shipment provider's name."
},
"sender": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"receiver": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"contentsCategory": {
"type": "array",
"items": {
"type": "string",
"enum": [
"gift",
"documents",
"sales-of-goods",
"samples",
"returned-goods",
"other"
]
},
"minItems": 1,
"uniqueItems": true
},
"currencyOfContentsValue": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"default": "EUR"
},
"unitOfContentsWeight": {
"type": "string",
"default": "KG"
},
"contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"weight": {
"type": "number"
},
"value": {
"type": "number"
},
"hsTariffNumber": {
"type": "string",
"pattern": "^[0-9\\. ]+$"
},
"origin": {
"type": "string",
"description": "The country of origin of goods. In the ISO 3166-2 standard (ISO 3166-1 alpha-2).",
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"description",
"quantity",
"weight",
"value",
"origin"
]
},
"minItems": 1,
"uniqueItems": true
},
"comments": {
"type": "string"
},
"numberOfLicences": {
"type": "integer"
},
"numberOfCertificates": {
"type": "integer"
},
"numberOfInvoices": {
"type": "integer"
},
"signatureDate": {
"type": "string",
"format": "date",
"description": "If left empty, then the current date will be used."
},
"postalCharges": {
"type": "number"
}
},
"required": [
"mergeWithShippingLabel",
"contentsCategory",
"contents",
"postalCharges"
]
}
},
"required": [
"shipperId",
"provider",
"receiver",
"item"
]
}
}
},
"required": [
"shipments"
]
}
Type: application/json - Example - Simple request for a single shipment
Example:
{
"provider":{"id":1},
"item":{"weightInKg":1,"packageType":"PK"},
"shipperId":633544,
"receiver":{
"type":"company",
"companyName":"John DOE My Company",
"identityAddress":{"streetName":"Sample Street","streetNumber":"15","city":"Sample City","zipNumber":"11111","originCountryISOCode":"DE"},
"identityCommunication":{"contactPerson": "John Doe"}
}
}
Type: application/json - Example - Simple request for a retoure shipment (via B2C RYP)
Example:
{
"provider":{"id":33},
"shipperId":633544,
"item":{"weightInKg":1, "packageType": "PK"},
"receiver":{
"type":"company",
"companyName":"FIRMA",
"identityAddress":{"originCountryISOCode":"NL"}
}
}
Type: application/json - Example - Simple request for a retoure shipment (via DHL Retoure)
Example:
{
"provider":{"id":36},
"shipperId":633544,
"item":{"weightInKg":1, "packageType": "PK"},
"receiver":{
"type":"company",
"companyName":"FIRMA",
"identityAddress":{"originCountryISOCode":"DE", "zipNumber":"11111"}
}
}
Type: application/json - Example - Simple request for a shipment with a customs declaration
Example:
{
"provider": {"id": 1},
"shipperId": 633544,
"item":{"weightInKg":1,"packageType":"PK"},
"receiver":{
"type":"company",
"companyName":"John DOE My Company",
"identityAddress":{"streetName":"Sample Street","streetNumber":"15","city":"Sample City","zipNumber":"11111","originCountryISOCode":"TR"},
"identityCommunication":{"contactPerson": "John Doe"}
},
"customs": {
"mergeWithShippingLabel": false,
"contentsCategory": ["documents"],
"contents": [
{
"description": "Test",
"quantity": 1,
"weight": 1,
"value": 1,
"origin": "PL"
}
],
"postalCharges": 10
}
}
HTTP status code 201
If shipments are added synchronously, then shipment(s) objects will be returned as a response.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A consise description."
}
},
"required": [
"message"
]
}
},
"required": [
"data"
]
}
Example:
{
"data": {
"message": "The resource(s) will be created within a few minutes"
}
}
Type: application/json - Synchronous example
Example:
{
"data": {
"shipments": [
{
"shipment": {
"id": 1,
"shippingNumber": "1",
"trackingNumber": "1",
"retoureIdc": "1",
"status": "new",
"description": "",
"deliveryRemarks": "",
"customerReference": "",
"createdAt": "2022-03-04",
"modifiedAt": "2022-03-04",
"provider": {
"id": 1
},
"shipper": {
"companyName": "John DOE My Company",
"additionalCompanyName": "",
"type": "company",
"identityAddress": {
"streetName": "Sample Street",
"streetNumber": "15",
"careOfName": "",
"zipNumber": "11111",
"city": "Sample City",
"district": "",
"originCountryISOCode": "DE",
"originState": "",
"floorNumber": "",
"roomNumber": "",
"originCountryIsoCode": "DE"
},
"identityCommunication": {
"phone": "",
"email": "",
"fax": "",
"mobile": "",
"internet": "",
"contactPerson": "John Doe"
}
"identityBank": {
"accountOwner": "",
"accountNumber": "",
"bankCode": "",
"bankName": "",
"iban": "",
"bic": ""
}
},
"receiver": {
"salutation": "",
"title": "",
"firstname": "",
"middlename": "",
"lastname": "",
"companyName": "John DOE My Company",
"additionalCompanyName": "",
"type": "company",
"identityAddress": {
"streetName": "Sample Street",
"streetNumber": "15",
"careOfName": "",
"zipNumber": "11111",
"city": "Sample City",
"district": "",
"originCountryISOCode": "DE",
"originState": "",
"floorNumber": "",
"roomNumber": "",
"originCountryIsoCode": "DE"
},
"identityCommunication": {
"phone": "",
"email": "",
"fax": "",
"mobile": "",
"internet": "",
"contactPerson": "John Doe"
}
},
"item": {
"weightInKg": 1.0,
"lengthInCm": 0,
"widthInCm": 0,
"heightInCm": 0,
"packageType": "PK"
},
"details": {
"insuranceAmount": 0.0,
"codAmount": 0.0
},
"isIncorrectAddress": "1"
},
"statusCode": 0
}
]
}
}
HTTP status code 400
The provided schema is not valid.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "400",
"message": "One or more required parameters are not provided"
}
}
HTTP status code 422
The provided data are not valid.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"validationErrors": {
"type": "array",
"description": "A collection of validation errors",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "An identification of a field"
},
"message": {
"type": "string",
"description": "A consise description of an error"
}
},
"required": [
"field",
"message"
]
}
}
},
"required": [
"validationErrors"
]
},
"error": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
},
"required": [
"data",
"error"
]
}
Example:
{
"data": {
"validationErrors": [
{
"field": "The name of the field",
"message": "A consise description of a validation error"
}
]
},
"error": {
"code": "422",
"message": "The validation data error"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
patch /shipments
Do operations over provided shipments. Shipment identifiers can be passed in three ways: shipmentsNumbers and shippingNumbers, both use shipping number, and shipment that use shipments IDs. You can use only one way of indicating identifiers in a request, but providing it is required.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
Query Parameters
- shipmentsNumbers: (string)
A list of shipping numbers, comma-separated. It is an alias of the shippingNumbers field.
Example:
123456,123456,123456
- shippingNumbers: (string)
A list of shipping numbers, comma-separated.
Example:
123456,123456,123456
- shipments: (string)
A list of shipments IDs, comma-separated.
Example:
123456,123456,123456
- operation: required (one of cancel, generate-retoure, cancel-prepared)
An operation to execute on indicated shipments
- type: (one of post-nl-ryp, b2c-paid, dhl-domestic, postnl, dpd-de)
It is required for generating retoure labels. It indicates which service will be used. For DHL International, you can use
post-nl-rypandb2c-paid. For DHL DE, you can usedhl-domestic. For Post NL, you can usepostnl. For DPD DE, you can usedpd-de. Note, that some providers can automatically generate retoure labels depending on the client's settings.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A consise description."
}
},
"required": [
"message"
]
}
},
"required": [
"data"
]
}
Example:
{
"data": {
"message": "The resource(s) will be patched within a few minutes"
}
}
HTTP status code 400
The provided parameters are incorrect.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "400",
"message": "One or more required parameters are not provided"
}
}
HTTP status code 422
The provided parameters are not valid.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"validationErrors": {
"type": "array",
"description": "A collection of validation errors",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "An identification of a field"
},
"message": {
"type": "string",
"description": "A consise description of an error"
}
},
"required": [
"field",
"message"
]
}
}
},
"required": [
"validationErrors"
]
},
"error": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
},
"required": [
"data",
"error"
]
}
Example:
{
"data": {
"validationErrors": [
{
"field": "The name of the field",
"message": "A consise description of a validation error"
}
]
},
"error": {
"code": "422",
"message": "The validation data error"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
delete /shipments
Removes shipments
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
Query Parameters
- shipmentsNumbers: required (string)
A list of shipments numbers, comma-separated
Example:
123456,123456,123456
HTTP status code 204
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A consise description."
}
},
"required": [
"message"
]
}
},
"required": [
"data"
]
}
Example:
{
"data": {
"message": "The resource(s) is(are) removed"
}
}
HTTP status code 400
The required parameters are not correct.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "400",
"message": "One or more required parameters are not provided"
}
}
HTTP status code 422
The provided parameters are not valid.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"validationErrors": {
"type": "array",
"description": "A collection of validation errors",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "An identification of a field"
},
"message": {
"type": "string",
"description": "A consise description of an error"
}
},
"required": [
"field",
"message"
]
}
}
},
"required": [
"validationErrors"
]
},
"error": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
},
"required": [
"data",
"error"
]
}
Example:
{
"data": {
"validationErrors": [
{
"field": "The name of the field",
"message": "A consise description of a validation error"
}
]
},
"error": {
"code": "422",
"message": "The validation data error"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
get
Gets the shipment object.
put
Updates shipment's data.
patch
Do operation over the indicated shipment.
delete
Removes a shipment.
get /shipments/{shipmentId}
Gets the shipment object.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"shippingNumber": {
"type": "string"
},
"trackingNumber": {
"type": "string"
},
"retoureIdc": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"incomplete",
"new",
"prepared",
"collected",
"in_delivery",
"delivered",
"canceled",
"returned",
"undelivered",
"uncollected",
"exception",
"removed",
"archived"
]
},
"description": {
"type": "string"
},
"deliveryRemarks": {
"type": "string"
},
"customerReference": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"provider": {
"type": "object",
"properties": {
"id": {
"type": "integer"
}
},
"required": [
"id"
]
},
"shipper": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
},
"identityBank": {
"type": "object",
"properties": {
"accountOwner": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"bankCode": {
"type": "string"
},
"bankName": {
"type": "string"
},
"iban": {
"type": "string"
},
"bic": {
"type": "string"
}
},
"required": []
},
"storehouse": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
}
},
"required": [
"type"
]
},
"receiver": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
},
"item": {
"type": "object",
"properties": {
"weightInKg": {
"type": "number"
},
"lengthInCm": {
"type": "integer"
},
"widthInCm": {
"type": "integer"
},
"heightInCm": {
"type": "integer"
},
"packageType": {
"type": "string",
"enum": [
"PK",
"ENVELOPE",
"OTHER"
]
}
},
"required": [
"weightInKg",
"packageType"
]
},
"details": {
"type": "object",
"properties": {
"insuranceAmount": {
"type": "number"
},
"insuranceCurrency": {
"type": "string"
},
"codAmount": {
"type": "number"
},
"codCurrency": {
"type": "string"
},
"ageCheck": {
"type": "number",
"description": "It is only for the DHL service. Please, use 1 for the 16+ verification and 2 for the 18+ verification."
}
},
"required": []
},
"customs": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.dodajpaczke.eu/customsDeclaration.schema.json",
"title": "Customs declaration of a shipment",
"description": "",
"type": "object",
"properties": {
"standard": {
"type": "string",
"description": "Deprecated from 1.6.0.",
"enum": [
"cn22",
"cn23"
]
},
"layout": {
"type": "string",
"description": "Deprecated from 1.6.0. The layout of an output customs declaration PDF.",
"enum": [
"default",
"cn22_100x70",
"cn23_a4"
],
"default": "default"
},
"mergeWithShippingLabel": {
"type": "boolean",
"description": "If true, then a customs declaration will be attached below a shipping label. If false, then a customs declaration will be add as an additional label.",
"default": false
},
"designatedOperator": {
"type": "string",
"description": "A designated operator name. If left empty, then the value of this field will be filled with the shipment provider's name."
},
"sender": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"receiver": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"contentsCategory": {
"type": "array",
"items": {
"type": "string",
"enum": [
"gift",
"documents",
"sales-of-goods",
"samples",
"returned-goods",
"other"
]
},
"minItems": 1,
"uniqueItems": true
},
"currencyOfContentsValue": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"default": "EUR"
},
"unitOfContentsWeight": {
"type": "string",
"default": "KG"
},
"contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"weight": {
"type": "number"
},
"value": {
"type": "number"
},
"hsTariffNumber": {
"type": "string",
"pattern": "^[0-9\\. ]+$"
},
"origin": {
"type": "string",
"description": "The country of origin of goods. In the ISO 3166-2 standard (ISO 3166-1 alpha-2).",
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"description",
"quantity",
"weight",
"value",
"origin"
]
},
"minItems": 1,
"uniqueItems": true
},
"comments": {
"type": "string"
},
"numberOfLicences": {
"type": "integer"
},
"numberOfCertificates": {
"type": "integer"
},
"numberOfInvoices": {
"type": "integer"
},
"signatureDate": {
"type": "string",
"format": "date",
"description": "If left empty, then the current date will be used."
},
"postalCharges": {
"type": "number"
}
},
"required": [
"mergeWithShippingLabel",
"contentsCategory",
"contents",
"postalCharges"
]
},
"finalCarrier": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.dodajpaczke.eu/finalCarrier.schema.json",
"title": "Final carrier of a shipment",
"description": "",
"type": "object",
"properties": {
"carrierName": {
"type": "string"
},
"trackingUrl": {
"type": "string"
}
},
"required": []
}
},
"required": [
"shipper",
"provider",
"receiver",
"item",
"details",
"status",
"description",
"deliveryRemarks",
"description",
"customerReference",
"shippingNumber",
"trackingNumber",
"createdAt",
"modifiedAt"
]
}
},
"required": [
"data"
]
}
HTTP status code 403
Access denied.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The shipment is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
put /shipments/{shipmentId}
Updates shipment's data.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"description": {
"type": "string"
},
"deliveryRemarks": {
"type": "string"
},
"customerReference": {
"type": "string"
},
"shipperId": {
"type": "integer",
"description": "Has to be valid a shipper address ID. The shipper ID is generated for each client's address. Please contact the support to get you own IDs."
},
"provider": {
"type": "object",
"properties": {
"id": {
"type": "integer"
}
},
"required": [
"id"
]
},
"receiver": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
},
"item": {
"type": "object",
"properties": {
"weightInKg": {
"type": "number"
},
"lengthInCm": {
"type": "integer"
},
"widthInCm": {
"type": "integer"
},
"heightInCm": {
"type": "integer"
},
"packageType": {
"type": "string",
"enum": [
"PK",
"ENVELOPE",
"OTHER"
]
}
},
"required": [
"weightInKg",
"packageType"
]
},
"details": {
"type": "object",
"properties": {
"insuranceAmount": {
"type": "number"
},
"insuranceCurrency": {
"type": "string"
},
"codAmount": {
"type": "number"
},
"codCurrency": {
"type": "string"
},
"ageCheck": {
"type": "number",
"description": "It is only for the DHL service. Please, use 1 for the 16+ verification and 2 for the 18+ verification."
}
},
"required": []
},
"customs": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.dodajpaczke.eu/customsDeclaration.schema.json",
"title": "Customs declaration of a shipment",
"description": "",
"type": "object",
"properties": {
"standard": {
"type": "string",
"description": "Deprecated from 1.6.0.",
"enum": [
"cn22",
"cn23"
]
},
"layout": {
"type": "string",
"description": "Deprecated from 1.6.0. The layout of an output customs declaration PDF.",
"enum": [
"default",
"cn22_100x70",
"cn23_a4"
],
"default": "default"
},
"mergeWithShippingLabel": {
"type": "boolean",
"description": "If true, then a customs declaration will be attached below a shipping label. If false, then a customs declaration will be add as an additional label.",
"default": false
},
"designatedOperator": {
"type": "string",
"description": "A designated operator name. If left empty, then the value of this field will be filled with the shipment provider's name."
},
"sender": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"receiver": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"contentsCategory": {
"type": "array",
"items": {
"type": "string",
"enum": [
"gift",
"documents",
"sales-of-goods",
"samples",
"returned-goods",
"other"
]
},
"minItems": 1,
"uniqueItems": true
},
"currencyOfContentsValue": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"default": "EUR"
},
"unitOfContentsWeight": {
"type": "string",
"default": "KG"
},
"contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"weight": {
"type": "number"
},
"value": {
"type": "number"
},
"hsTariffNumber": {
"type": "string",
"pattern": "^[0-9\\. ]+$"
},
"origin": {
"type": "string",
"description": "The country of origin of goods. In the ISO 3166-2 standard (ISO 3166-1 alpha-2).",
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"description",
"quantity",
"weight",
"value",
"origin"
]
},
"minItems": 1,
"uniqueItems": true
},
"comments": {
"type": "string"
},
"numberOfLicences": {
"type": "integer"
},
"numberOfCertificates": {
"type": "integer"
},
"numberOfInvoices": {
"type": "integer"
},
"signatureDate": {
"type": "string",
"format": "date",
"description": "If left empty, then the current date will be used."
},
"postalCharges": {
"type": "number"
}
},
"required": [
"mergeWithShippingLabel",
"contentsCategory",
"contents",
"postalCharges"
]
}
},
"required": [
"shipperId",
"provider",
"receiver",
"item"
]
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A consise description."
}
},
"required": [
"message"
]
}
},
"required": [
"data"
]
}
Example:
{
"data": {
"message": "The resource(s) will be updated within a few minutes"
}
}
HTTP status code 400
The provided data schema is incorrect.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "400",
"message": "One or more required parameters are not provided"
}
}
HTTP status code 403
Access denied.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The shipment is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
HTTP status code 422
The provided data are not valid.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"validationErrors": {
"type": "array",
"description": "A collection of validation errors",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "An identification of a field"
},
"message": {
"type": "string",
"description": "A consise description of an error"
}
},
"required": [
"field",
"message"
]
}
}
},
"required": [
"validationErrors"
]
},
"error": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
},
"required": [
"data",
"error"
]
}
Example:
{
"data": {
"validationErrors": [
{
"field": "The name of the field",
"message": "A consise description of a validation error"
}
]
},
"error": {
"code": "422",
"message": "The validation data error"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
patch /shipments/{shipmentId}
Do operation over the indicated shipment.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
Query Parameters
- operation: required (one of cancel, generate-retoure, cancel-prepared)
An operation to execute on the indicated shipment.
- type: (one of post-nl-ryp, b2c-paid, dhl-domestic)
It is required for generating retoure labels. It indicates which service will be used.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A consise description."
}
},
"required": [
"message"
]
}
},
"required": [
"data"
]
}
Example:
{
"data": {
"message": "The resource(s) will be patched within a few minutes"
}
}
HTTP status code 400
The required parameters are not correct.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "400",
"message": "One or more required parameters are not provided"
}
}
HTTP status code 404
The shipment is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
HTTP status code 422
The provided parameters are empty or cannot be validated.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"data": {
"validationErrors": [
{
"field": "The name of the field",
"message": "A consise description of a validation error"
}
]
},
"error": {
"code": "422",
"message": "The validation data error"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
delete /shipments/{shipmentId}
Removes a shipment.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
HTTP status code 204
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A consise description."
}
},
"required": [
"message"
]
}
},
"required": [
"data"
]
}
Example:
{
"data": {
"message": "The resource(s) is(are) removed"
}
}
HTTP status code 403
Access denied.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The shipment is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
get
Gets history entries of a shipment.
get /shipments/{shipmentId}/history
Gets history entries of a shipment.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
Headers
- X-Pagination-Total-Count: required (integer)
A total number of history entries.
- X-Pagination-Page-Count: required (integer)
A total number of pages.
- X-Pagination-Current-Page: required (integer)
The current page number.
- X-Pagination-Per-Page: required (integer)
A number of entries per page.
Query Parameters
- since: (date)
Created since the date.
- until: (date)
Created before the date.
- perPage: (integer - default: 10)
The number of history entries per page.
- page: (integer - default: 1)
The current page.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"description": "A collection of history entries",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"addictionalStatus": {
"type": "string"
},
"message": {
"type": "string"
},
"createdAt": {
"type": "string"
}
},
"required": [
"field",
"message"
]
}
}
},
"required": [
"entries"
]
}
},
"required": [
"data"
]
}
HTTP status code 403
Access denied.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
get
Gets a shipping label.
get /shipments/{shipmentId}/shippingLabel
Gets a shipping label.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Base64 file data"
},
"name": {
"type": "string",
"description": "A name of a file."
},
"extension": {
"type": "string",
"description": "An extension of a file."
},
"mimeType": {
"type": "string",
"description": "File's mime type"
}
},
"required": [
"file",
"name",
"extension",
"mimeType"
]
}
},
"required": [
"data"
]
}
HTTP status code 403
Access denied.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The shipping label file is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
get
Gets a retoure label.
get /shipments/{shipmentId}/retoureLabel
Gets a retoure label.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Base64 file data"
},
"name": {
"type": "string",
"description": "A name of a file."
},
"extension": {
"type": "string",
"description": "An extension of a file."
},
"mimeType": {
"type": "string",
"description": "File's mime type"
}
},
"required": [
"file",
"name",
"extension",
"mimeType"
]
}
},
"required": [
"data"
]
}
HTTP status code 403
Access denied.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The retoure label file is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
get
Gets a customs declaration.
get /shipments/{shipmentId}/customsDeclaration
Gets a customs declaration.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Base64 file data"
},
"name": {
"type": "string",
"description": "A name of a file."
},
"extension": {
"type": "string",
"description": "An extension of a file."
},
"mimeType": {
"type": "string",
"description": "File's mime type"
}
},
"required": [
"file",
"name",
"extension",
"mimeType"
]
}
},
"required": [
"data"
]
}
HTTP status code 403
Access denied.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The retoure label file is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
get
Gets a proof of delivery.
get /shipments/{shipmentId}/proofOfDelivery
Gets a proof of delivery.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Base64 file data"
},
"name": {
"type": "string",
"description": "A name of a file."
},
"extension": {
"type": "string",
"description": "An extension of a file."
},
"mimeType": {
"type": "string",
"description": "File's mime type"
}
},
"required": [
"file",
"name",
"extension",
"mimeType"
]
}
},
"required": [
"data"
]
}
HTTP status code 403
Access denied.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The proof-of-delivery file is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
get
Gets a proof of export.
get /shipments/{shipmentId}/proofOfExportLabel
Gets a proof of export.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Base64 file data"
},
"name": {
"type": "string",
"description": "A name of a file."
},
"extension": {
"type": "string",
"description": "An extension of a file."
},
"mimeType": {
"type": "string",
"description": "File's mime type"
}
},
"required": [
"file",
"name",
"extension",
"mimeType"
]
}
},
"required": [
"data"
]
}
HTTP status code 403
Access denied.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The proof of export file is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
/providers
get
Gets a collection of available providers.
get /providers
Gets a collection of available providers.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"providers": {
"type": "array",
"description": "A collection of providers.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The provider ID."
},
"name": {
"type": "string",
"description": "A specific name, it could be more descriptive than the type."
},
"type": {
"type": "string",
"description": "A general provider name."
}
},
"required": [
"id",
"name",
"type"
]
}
}
},
"required": [
"providers"
]
}
},
"required": [
"data"
]
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
/addresses
get
Gets a collection of user's addresses.
get /addresses
Gets a collection of user's addresses.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"addresses": {
"type": "array",
"description": "A collection of an user's addresses",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of an user address."
},
"name": {
"type": "string",
"description": "The short name of an user address."
},
"identity": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
},
"identityBank": {
"type": "object",
"properties": {
"accountOwner": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"bankCode": {
"type": "string"
},
"bankName": {
"type": "string"
},
"iban": {
"type": "string"
},
"bic": {
"type": "string"
}
},
"required": []
},
"storehouse": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
}
},
"required": [
"type"
]
},
"isDefault": {
"type": "boolean",
"description": "Indicates that the address is default."
},
"canBeMerged": {
"type": "boolean",
"description": "Indicates that the address can be merge with the so-called base address."
}
},
"required": [
"id",
"name",
"identity",
"isDefault",
"canBeMerged"
]
}
}
},
"required": [
"addresses"
]
}
},
"required": [
"data"
]
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
get
Gets shipper's address.
get /addresses/{addressId}
Gets shipper's address.
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipper's address ID: required (integer)
The ID of shipper's address.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of an user address."
},
"name": {
"type": "string",
"description": "The short name of an user address."
},
"identity": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
},
"identityBank": {
"type": "object",
"properties": {
"accountOwner": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"bankCode": {
"type": "string"
},
"bankName": {
"type": "string"
},
"iban": {
"type": "string"
},
"bic": {
"type": "string"
}
},
"required": []
},
"storehouse": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
}
},
"required": [
"type"
]
},
"isDefault": {
"type": "boolean",
"description": "Indicates that the address is default."
},
"canBeMerged": {
"type": "boolean",
"description": "Indicates that the address can be merge with the so-called base address."
}
},
"required": [
"id",
"name",
"identity",
"isDefault",
"canBeMerged"
]
}
HTTP status code 403
The address is forbidden.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The address is not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
Gets default shipper's address.
get
get /addresses/default
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of an user address."
},
"name": {
"type": "string",
"description": "The short name of an user address."
},
"identity": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
},
"identityBank": {
"type": "object",
"properties": {
"accountOwner": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"bankCode": {
"type": "string"
},
"bankName": {
"type": "string"
},
"iban": {
"type": "string"
},
"bic": {
"type": "string"
}
},
"required": []
},
"storehouse": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
}
},
"required": [
"type"
]
},
"isDefault": {
"type": "boolean",
"description": "Indicates that the address is default."
},
"canBeMerged": {
"type": "boolean",
"description": "Indicates that the address can be merge with the so-called base address."
}
},
"required": [
"id",
"name",
"identity",
"isDefault",
"canBeMerged"
]
}
HTTP status code 404
The default shipper address does not exist. Please contact with our customer service.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
/requests
Ask the provider for a proof-of-delivery document.
post
post /requests/proofofdelivery/{shipmentId}
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
URI Parameters
- Shipment ID: required (integer)
The ID of a shipment.
HTTP status code 201
The proof-of-delivery request is sent.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A consise description."
}
},
"required": [
"message"
]
}
},
"required": [
"data"
]
}
Example:
{
"data": {
"message": "The resource(s) will be created within a few minutes"
}
}
HTTP status code 403
The shipment is forbidden.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "403",
"message": "Forbidden"
}
}
HTTP status code 404
The shipment do not exist.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "404",
"message": "The resource is not found"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
/get-customs-pricing
Precalculating of shipment price with customs for Post NL providers
post
post /get-customs-pricing
Secured by Authorization Token
All API resources need to authorized using an access token. The access token can be obtained programmatically by submitting an HTTP POST request to the URL /users/authentication. See details in a proper resource. The authorization requires either the Authorization request header or the access_token query parameter.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"shipments": {
"type": "array",
"description": "A collection of shipments to add.",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"deliveryRemarks": {
"type": "string"
},
"customerReference": {
"type": "string"
},
"shipperId": {
"type": "integer",
"description": "Has to be valid a shipper address ID. The shipper ID is generated for each client's address. Please contact the support to get you own IDs."
},
"provider": {
"type": "object",
"properties": {
"id": {
"type": "integer"
}
},
"required": [
"id"
]
},
"receiver": {
"type": "object",
"properties": {
"salutation": {
"type": "string"
},
"title": {
"type": "string"
},
"firstname": {
"type": "string"
},
"middlename": {
"type": "string"
},
"lastname": {
"type": "string"
},
"companyName": {
"type": "string"
},
"additionalCompanyName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"identityAddress": {
"type": "object",
"properties": {
"streetName": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"careOfName": {
"type": "string"
},
"zipNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"district": {
"type": "string"
},
"originCountryISOCode": {
"type": "string",
"enum": [
"AF",
"DE",
"ZA",
"AL",
"DZ",
"AD",
"AO",
"AI",
"AG",
"AN",
"SA",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BY",
"BO",
"BA",
"BW",
"BR",
"IO",
"BN",
"VG",
"BG",
"BF",
"BI",
"TD",
"CL",
"CN",
"HR",
"CY",
"ME",
"CZ",
"DK",
"FO",
"DO",
"DM",
"DJ",
"EG",
"EC",
"ER",
"EE",
"ET",
"FK",
"FJ",
"PH",
"FI",
"FR",
"GA",
"GM",
"GH",
"GR",
"GD",
"GL",
"GE",
"GY",
"GF",
"GP",
"GT",
"GN",
"GW",
"HT",
"ES",
"NL",
"BQ",
"HN",
"IN",
"ID",
"IQ",
"IR",
"IE",
"IS",
"IL",
"JM",
"JP",
"YE",
"JO",
"KH",
"CM",
"CA",
"QA",
"KZ",
"KE",
"KG",
"KI",
"CO",
"KM",
"CG",
"KR",
"KP",
"CR",
"CU",
"KW",
"LA",
"LS",
"LB",
"LR",
"LY",
"LI",
"LT",
"LU",
"LV",
"MK",
"MG",
"MW",
"MV",
"MY",
"ML",
"MT",
"MA",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"MS",
"MZ",
"MM",
"KY",
"NA",
"NR",
"NP",
"NE",
"NG",
"NI",
"NO",
"NC",
"NZ",
"OM",
"PK",
"PW",
"PA",
"PG",
"PY",
"PE",
"PN",
"PF",
"PL",
"SS",
"PT",
"CD",
"CF",
"RE",
"RU",
"GQ",
"RO",
"RW",
"ST",
"SV",
"WS",
"SM",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SO",
"LK",
"SH",
"LC",
"PM",
"VC",
"KN",
"US",
"SD",
"SR",
"SZ",
"SY",
"CH",
"SE",
"TJ",
"TH",
"TW",
"TZ",
"TF",
"TG",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"UY",
"UZ",
"VU",
"WF",
"VA",
"VE",
"HU",
"GB",
"VN",
"IT",
"TL",
"CI",
"MH",
"SB",
"CV",
"ZM",
"ZW",
"AE"
]
},
"originState": {
"type": "string"
},
"floorNumber": {
"type": "string"
},
"roomNumber": {
"type": "string"
}
},
"required": [
"streetName",
"streetNumber",
"zipNumber",
"city",
"originCountryISOCode"
]
},
"identityCommunication": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"internet": {
"type": "string"
},
"contactPerson": {
"type": "string"
}
},
"required": []
}
},
"required": [
"type"
]
},
"item": {
"type": "object",
"properties": {
"weightInKg": {
"type": "number"
},
"lengthInCm": {
"type": "integer"
},
"widthInCm": {
"type": "integer"
},
"heightInCm": {
"type": "integer"
},
"packageType": {
"type": "string",
"enum": [
"PK",
"ENVELOPE",
"OTHER"
]
}
},
"required": [
"weightInKg",
"packageType"
]
},
"details": {
"type": "object",
"properties": {
"insuranceAmount": {
"type": "number"
},
"insuranceCurrency": {
"type": "string"
},
"codAmount": {
"type": "number"
},
"codCurrency": {
"type": "string"
},
"ageCheck": {
"type": "number",
"description": "It is only for the DHL service. Please, use 1 for the 16+ verification and 2 for the 18+ verification."
}
},
"required": []
},
"customs": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.dodajpaczke.eu/customsDeclaration.schema.json",
"title": "Customs declaration of a shipment",
"description": "",
"type": "object",
"properties": {
"standard": {
"type": "string",
"description": "Deprecated from 1.6.0.",
"enum": [
"cn22",
"cn23"
]
},
"layout": {
"type": "string",
"description": "Deprecated from 1.6.0. The layout of an output customs declaration PDF.",
"enum": [
"default",
"cn22_100x70",
"cn23_a4"
],
"default": "default"
},
"mergeWithShippingLabel": {
"type": "boolean",
"description": "If true, then a customs declaration will be attached below a shipping label. If false, then a customs declaration will be add as an additional label.",
"default": false
},
"designatedOperator": {
"type": "string",
"description": "A designated operator name. If left empty, then the value of this field will be filled with the shipment provider's name."
},
"sender": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"receiver": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"businessName": {
"type": "string"
},
"street": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"reference": {
"type": "string"
}
},
"required": []
},
"contentsCategory": {
"type": "array",
"items": {
"type": "string",
"enum": [
"gift",
"documents",
"sales-of-goods",
"samples",
"returned-goods",
"other"
]
},
"minItems": 1,
"uniqueItems": true
},
"currencyOfContentsValue": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"default": "EUR"
},
"unitOfContentsWeight": {
"type": "string",
"default": "KG"
},
"contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"weight": {
"type": "number"
},
"value": {
"type": "number"
},
"hsTariffNumber": {
"type": "string",
"pattern": "^[0-9\\. ]+$"
},
"origin": {
"type": "string",
"description": "The country of origin of goods. In the ISO 3166-2 standard (ISO 3166-1 alpha-2).",
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"description",
"quantity",
"weight",
"value",
"origin"
]
},
"minItems": 1,
"uniqueItems": true
},
"comments": {
"type": "string"
},
"numberOfLicences": {
"type": "integer"
},
"numberOfCertificates": {
"type": "integer"
},
"numberOfInvoices": {
"type": "integer"
},
"signatureDate": {
"type": "string",
"format": "date",
"description": "If left empty, then the current date will be used."
},
"postalCharges": {
"type": "number"
}
},
"required": [
"mergeWithShippingLabel",
"contentsCategory",
"contents",
"postalCharges"
]
}
},
"required": [
"shipperId",
"provider",
"receiver",
"item"
]
}
}
},
"required": [
"shipments"
]
}
Type: application/json - Example - Simple request
Example:
{
"provider":{"id":42},
"description": "Testowa przesyłka",
"item": {
"weightInKg": 1,
"lengthInCm": 2,
"widthInCm": 2,
"heightInCm": 2,
"packageType": "PK"
},
"shipperId":633544,
"receiver": {
"type": "company",
"companyName": "Przykładowy sklep w Dättwil",
"additionalCompanyName": "Dodatkowa nazwa",
"identityAddress": {
"streetName": "Informatica Täfernstrasse",
"streetNumber": "4",
"city": "Dättwil",
"zipNumber": "BD23 6QZ",
"originCountryISOCode": "GB"
},
"identityCommunication": {
"phone": "999999999",
"contactPerson": "Osoba kontaktowa",
"email": "etst@test.pl"
}
},
"customs": {
"mergeWithShippingLabel": 0,
"designatedOperator": "DHL",
"sender": {
"name": "Firma testowego klienta",
"businessName": "",
"country": "DE",
"city": "G\u00f6rlitz",
"postcode": "02826",
"street": "Rauschwalderstra\u00dfe 41",
"reference": ""
},
"receiver": {
"name": "Sample shop in Tirana",
"businessName": "",
"country": "FR",
"city": "Sheshi Zogu i Zi Tirana",
"postcode": "98712",
"street": "Rruga Dritan Hoxha Nd.04",
"reference": ""
},
"contentsCategory": [
"documents"
],
"currencyOfContentsValue": "EUR",
"unitOfContentsWeight": "KG",
"contents": [
{
"description": "Food supplements",
"quantity": "1",
"weight": "1",
"value": "10",
"hsTariffNumber": 2106909285,
"origin": "ZA"
}
],
"comments": "",
"numberOfLicences": 0,
"numberOfCertificates": 0,
"numberOfInvoices": 0,
"signatureDate": "2024-12-19",
"postalCharges": "1.00"
}
}
Secured by Authorization Token
Headers
- Authorization: (string)
Use the standard authorization header considering that instead the normal username and password base64 code, the access token should be used. Do not use with the
access_tokenquery string parameter.Example:
Authorization: {your access token}
HTTP status code 401
Bad or expired token. To fix, you should reauthenticate.
/users/authentication
An authentication of an user.
post
post /users/authentication
Secured by
Body
Type: application/x-www-form-urlencoded
Form Parameters- login: required (string)
The login that is used in the web application.
- password: required (string)
The password that is used in the web application.
HTTP status code 200
The access token is created.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"title": "AccessToken",
"properties": {
"accessToken": {
"type": "string",
"description": "A generated access token."
},
"expirationDate": {
"type": "string",
"description": "A expiration date in RFC2616 format."
},
"expirationTimestamp": {
"type": "integer",
"description": "A expiration date in Unix Timestamp format."
},
"expiresIn": {
"type": "integer",
"description": "The number of seconds before expiration."
}
},
"required": [
"accessToken",
"expirationDate",
"expirationTimestamp",
"expiresIn"
]
}
},
"required": [
"data"
]
}
Example:
{
"data": {
"accessToken": "c46f4ca3-78b9-40a5-8ee8-cfe4a0f7f864",
"expirationDate": "Tue, 15 Nov 1994 12:45:26 GMT",
"expirationTimestamp": 4654564654,
"expiresIn": 4546
}
}
HTTP status code 400
Either the login or the password is not provided.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code in format 4xx, 5xx."
},
"message": {
"type": "string",
"description": "A consise description of an error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "400",
"message": "One or more required parameters are not provided"
}
}
Secured by