The purpose of this API is to register a parcel shipment. Given the data in the request, this API will perform the booking and return the corresponding transport information
...
Name | Type | Example | Mandatory | Description |
|---|---|---|---|---|
shipmentId | string | (401)70712190172720651 |
| See description with the same name in the request. |
freightProductId | whole number | 2 |
| The selected freight product for this shipment. See example freight products ablow |
list of party objects |
| Note that the API could make minor changes to the returned consignee address. | ||
list of item objects |
| See description with the same name in the request. | ||
map of properties | Map with additional properties. Various information (properties) are specified only for certain transport products. | |||
list of additionalService objects | See description with the same name in the request. | |||
proofOfDelivery | string | NO_CONFIRMATION | See description with the same name in the request. |
Freight Products
The freight product describes a way of delivery, and is defined by a delivery method and the coverage of the given method. Contact you carrier provider to determine which freight product ID(s) you'll have access to and can expect in the response.Â
...
HTTP Status code | Text | Description |
|---|---|---|
400 | Client or Validation Error | The request body/query string is not in the correct format. |
401 | Authentication Failure | Indicates that the Authorization header is either missing or incorrect. You can learn more about the Authorization header here. |
403 | Access denied | This indicates that the agent whose credentials were used in making this request was not authorized to perform this API call. It could be that you do not have access to the shop or transportsolution you provided in your request. If you believe this is a mistake, please reach out to your contact so it can be rectified. |
405 | Method not allowed | This API request used the wrong HTTP verb/method. For example a PUT request will result in this error. |
4xx | Client error | Generally receiving an error code that starts with 4 indicates that the client needs to change something. |
500 | Unexpected Server Error | Oops! This may indicates an error on our side. Please try again, if the error continues notify your contact person |
...
Field | Description |
|---|---|
statusCode | The HTTP code associated with this error. |
errorKey | A machine parseable error code. |
errorMap | Additional details pertaining to the error. |
...