Transsmart Developer Documentation

0. Introduction

Being a developer documentation, the content of this document should primarily serve as the main guidance for those integrating Transsmart into their systems. This document is not meant to describe how Transsmart operates in the logistics process-chain, but rather assumes the reader to be familiar with the business operations of Transsmart, as an organization.

The purpose of this document is to be a sufficient guideline for integrating the Transsmart platform in the operations of another system.

Target Audience

Though the title of this document may imply that its target audience is developers, it actually is meant to be used by all system integrators that for one reason or the other may have an interest in the Transsmart integration capabilities.

So system integrators, platform/solution architects and system developers, are all perceived as being the target audience of this document.

What is on offer?

For any reader of this document, it should be possible to easily identify what the Transsmart integration platform has to offer, in terms of versioning and their respective supported resources.

The document references all publicly available environments, i.e. user acceptance and production.

Transsmart integration endpoints

Transsmart offers two integration endpoints:

SOAP webservice
RESTful API

The SOAP webservice is the longest-living integration endpoint of Transsmart. The RESTful API has recently received a major upgrade in terms of features and capabilities.

We advice you to integrate with our RESTful API because of the advantages of having more functionalities available

SOAP webservice documentation

The documentation of the SOAP webservice can be downloaded below.

Download here the SOAP webservice documentation

RESTful API

The API is offered as a RESTful web service

API description

The descriptions provide the following API properties;

Supported data formats
Supported verbs
Request/response status codes and error messages.
Data type.
Data Constrains (if applicable).
Data default (if applicable).

Environments

Environment Base URL Description

Environment	Base URL	Description
`Beta developments`	https://beta-api.transsmart.com	Available for (pilot) customers. Changes are deployed at least 1 week before being deployed to Accept.
`User acceptance`	https://accept-api.transsmart.com	Technically equal to Production except on deployment day (1 day difference); mainly used for implementations and training.
`Production`	https://api.transsmart.com	Production environment

Beta developments

https://beta-api.transsmart.com

Available for (pilot) customers. Changes are deployed at least 1 week before being deployed to Accept.

User acceptance

https://accept-api.transsmart.com

Technically equal to Production except on deployment day (1 day difference); mainly used for implementations and training.

Production

https://api.transsmart.com

Production environment

Prerequisites

A valid and active Transsmart account.
A valid user attached to the Transsmart client account to be used.
Basic knowledge of web-services (in particular RESTful services) and the HTTP protocol.
Working knowledge of JSON or XML
Familiarity with the logistics domain.

It is import to note that this document assumes certain technical knowledge on the part of the respective user, so it should not be mistaken for a user manual.

HTTP verbs

The API tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.

Verb Usage

Verb	Usage
`GET`	Mainly used to retrieve a resource though in some cases also trigger an action, for instance, in the case of document print.
`POST`	Used to create a new resource
`PATCH`	Used to update an existing resource, including partial updates
`PUT`	Used to update an existing resource, full updates only
`DELETE`	Used to delete an existing resource

GET

Mainly used to retrieve a resource though in some cases also trigger an action, for instance, in the case of document print.

POST

Used to create a new resource

PATCH

Used to update an existing resource, including partial updates

PUT

Used to update an existing resource, full updates only

DELETE

Used to delete an existing resource

HTTP status codes

The API tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.

Status code Usage

Status code	Usage
`200 OK`	Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.
`201 Created`	The request has been fulfilled and resulted in a new resource being created.
`204 No Content`	The server successfully processed the request, but is not returning any content.
`400 Bad Request`	The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
`401 Unauthorized`	The server cannot or will not process the request due a missing token or due to an invalid token.
`404 Not Found`	The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.
`409 Conflict`	Indicates that the request could not be processed because of conflict in the request, such as an 'add conflict' where a duplicated record is posted, the service returns then this code with a more detailed message.
`415 Unsupported Media Type`	The request entity has a media type which the server or resource does not support. For example, the client posts a request as text/plain, but the server requires that the post use a different format as to be aapplication/xml or application/json.
`429 Too Many Requests`	The user has sent too many requests in a given amount of time. Intended for use with rate-limiting schemes.
`500 Internal Server Error`	A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

200 OK

Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

201 Created

The request has been fulfilled and resulted in a new resource being created.

204 No Content

The server successfully processed the request, but is not returning any content.

400 Bad Request

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401 Unauthorized

The server cannot or will not process the request due a missing token or due to an invalid token.

404 Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

409 Conflict

Indicates that the request could not be processed because of conflict in the request, such as an 'add conflict' where a duplicated record is posted, the service returns then this code with a more detailed message.

415 Unsupported Media Type

The request entity has a media type which the server or resource does not support. For example, the client posts a request as text/plain, but the server requires that the post use a different format as to be aapplication/xml or application/json.

429 Too Many Requests

The user has sent too many requests in a given amount of time. Intended for use with rate-limiting schemes.

500 Internal Server Error

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

Supported Data formats

Both JSON and XML are supported as input and output data formats.

In the examples given in the resources' description only the json format is demonstrated.

Direct links

MyTranssmart supports direct links. These can be used to direct link from an ERP system to a specific page in the MyTranssmart dashboard: Path /v2/direct/details?key=cQBauM7gcQBauM7gcQBauM7gcQBauM7g gcQBauM7gcQBauM7gcQBauM7g&reference=7111117854 (key and reference are not valid, you need a valid customer key and reference. Don’t forget to URL encode it as required for all query parameters). See chapter 1.1 ‘Requesting for a token’ on how to obtain the required key.

Options:

/v2/direct/details?key=….&reference=..&account=…
/v2/direct/overview?key=….
/v2/direct/manifest?key=….

Key = the login key
Reference = the reference of a shipment
account= Account = Optional the account where the shipment is booked on. If not specified the account belonging to the key is used. This can be used if the shipment is booked on a child account and if you want to access this shipment via Act on Behalf function with the key of the parent account.

Language, Country and Currency codes

For these three fields we comply with below applicable ISO codes:

Parameter Description

Parameter	Description
`language`	ISO 639-1 two letter code; lower case.
`country`	ISO 3166-1 two letter code; upper case.
`currency`	ISO 4217 three letter code; upper case.

language

ISO 639-1 two letter code; lower case.

country

ISO 3166-1 two letter code; upper case.

currency

ISO 4217 three letter code; upper case.

Table/field changes

Developments are sometimes accompanied by the addition of new fields or changes to existing fields. When changing existing fields, we will make sure that they are backwards compatible and we will announce them well in advance through release notes. The addition of new fields has a shorter lead time; these changes will also be communicated via the release notes, but you should make the connection to us in such a way that no problems arise on your side when new, and therefore unknown to you, fields are added. These fields should be ignored or of course if desired, mapped to a corresponding field on your side.

API Rate Limiter

To prevent our API from being overwhelmed, per API service type (shipment service, status service, report service etc…) we have configured rate limits per account per time frame.

When high loads of calls are being done in a very short time frame, you will receive an 429 error.

If that is the case, to avoid reaching our rate limiter, your configuration/integration needs to be verified by you or your (ERP/WMS) partner.

Most probably the amount of calls can be reduced by lowering the configuration of sending API calls for (all) shipments.

The best way to implement a correct process for handling 429 errors, is to act on the information we send back in Response Header:

X-RateLimit-Remaining: the number of remaining calls (if still allowed)
X-RateLimit-Reset: the number of milliseconds before next call may be done (in case of a blocked call)

Two other ways are either simply wait longer before sending a retry or implement an exponential backoff which means you don’t retry sending a request for instance every 0.1 second but retry 1 second later, then 10 seconds later, then 1 minute later… etc. until you get the correct response call information.

We comply with a Fair Use Policy and will adjust the values -and in exceptional cases even block requesters- if we notice there is abuse in submitting or requesting too much data.

This section (introduction) has mainly introduced the Transsmart API, described how this documentation may be used and established some conventions adopted by the Transsmart API.

The next section describes the API, by defining the resources it offers, how they may be used and their respective behaviour (normal and in error).

From this point on-words, where used in this documentation, the "API" refers to and implies the Transsmart API. Also where used within this documentation, the "platform" is in reference to the Transsmart platform.

API V2 Documentation

This section describes the API; information regarding authenticating to API is provided first,
followed by the description of the respective API resources, in relation to their related functionality.

API Resources

Accounts are hierarchical, meaning; when logged in on an account there is also access possible to the child accounts. This is reflected on the interface by specifying the account on which the action should take place. Trying to access another accounts will be denied with a http status 'FORBIDDEN'. This accounts hierarchy also applies to the accounts settings, so any setting specified on an account is also applicable for the child accounts.

The API assumes a plural-based resources naming convention.

API QuickGuides

These QuickGuides help you integrate with Transsmart.

QuickGuide for API integration - Using Postman for API Integration

QuickGuide for API integration - Basic Actions

QuickGuide for API integration - Location Select

QuickGuide for API integration - Shipment Status Tracking

QuickGuide for API integration - Using Account Settings

QuickGuide for API integration - Using Addresses

QuickGuide for API integration - Using Tariffs

1.0 Authenticating

For version two, the API employs token based authentication. An issued token has a 24-hour validity period.

1.1 Requesting for a token

To request for a token, make a GET request to environment_base_url/login using basic authentication with valid user credentials. As response a JWT token is returned and is valid for 24 hours.

Having received the token, subsequent calls to the API have to be made with token placed in the Authorization header of the request with prefix Bearer.

When the token is expired you will receive a response Token expired and you’ll have to make sure to request for a new token. Or, just make sure to request for a token every 24 hours. Do NOT request for a token before every other API call you do; this is causing a lot of unneccesary API traffic on both our as your servers.

Example header key Authorization with value Bearer eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ…

You can also request for a key by specifying the parameter response=key. This key can be used in the direct links. This key is 24 hours valid.

To get the account where the user belongs to, specify the parameter response=account.

To get the token, the key and the account, specify the parameter response=token,key,account.

In case of a failed request, an appropriate response with be given, indicating a likely cause.

2.0 Shipment management

This involves booking/creation, manifesting, deletion and retrieval of shipments.

Main resource: v2/shipments

2.1 Shipment Booking

Action parameter

The action parameter can be either CREATE , BOOK or PRINT. With CREATE the shipment is only saved, no validation is performed, this can be used as a draft booking. With BOOK the shipment is booked. With PRINT the shipment is also booked and the parameter rawJob determines if the printing should be handled by the system or the, to be printed, documents should be returned in the response. So in case of a rawJob the actual base64 encoded shipment level and package level documents (PDF and / or ZPL) are included in the response. The origin/sourcesystem of the booking can be specified in the http header 'TranssmartOrigin' if this header is not specified then the value 'API2' is used. This is not the same as the REST origin header that one is used to track the IP address of the sender. For all actions the same input is used but all response are differend and described below. Consult your project manager / consultant for more information on implementation. The example shows a shipment with all possible values.

Using units

There are only a limited number of units allowed for both the weight and the size unit of measure. In every case it so that the units must be consistently used within the complete shipment. It is not allowed to use one unit on the shipment level and another unit on the package level. If this is the case, the system will return an error. Additionally, the system reads the unit of measure of the shipment first. If empty, it will look for the first occurrence on the package level.

Shipment Booking only

Path parameters

Table 1. /v2/shipments/{account}/{action}
Parameter	Description
`account`	The account to which the shipment belongs.
`action`	Action to be performed; possible values are CREATE, BOOK or PRINT. With PRINT, the shipment is booked first and then printed .

Request structure book

Path	Type	Description	Constraints	Default
[] .reference	String	Shipment reference.	Not Null and not empty. The size must be between 1 and 32.
[] .carrier	String	The carrier.	Fixed length of 3. Not Null and not empty.
[] .costCenter	String	The cost center.	Maximum size of 32.
[] .mailType	Integer	The mail type.	Maximum value is 127.
[] .language	String	The language.	Maximum size of 2.
[] .description	String	The description.	Maximum size of 128.
[] .instruction	String	The instruction.	Maximum size of 256.
[] .value	Decimal	The shipment monetary value. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .valueCurrency	String	The shipment monetary value currency.	Maximum size of 3.
[] .spotPrice	Decimal	The spot price. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .spotPriceCurrency	String	The spot price currency.	Maximum size of 3.	EUR
[] .pickupDate	String	The pickup date.	Format yyyy-MM-dd.	Depends on routing rules.
[] .pickupTime	String	The earliest pickup time.	Format HH:mm.	Depends on routing rules.
[] .pickupTimeTo	String	The latest shipment pickup time.	Format HH:mm.	Depends on routing rules.
[] .requestedDeliveryDate	String	The requested delivery date.	Format yyyy-MM-dd.	Depends on routing rules.
[] .requestedDeliveryTime	String	The requested earliest delivery time	Format HH:mm.	Depends on routing rules.
[] .requestedDeliveryTimeTo	String	The requested lates delivery time.	Format HH:mm.	Depends on routing rules.
[] .service	String	The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU	Maximum size of 16.
[] .insurance	Boolean	Should this shipment be insured or is it insured		false
[] .serviceLevelTime	String	The requested service level time.	Maximum size of 32. Not Null and not empty.
[] .serviceLevelOther	String	The service level other.	Maximum size of 256.
[] .incoterms	String	The inco terms.	Maximum size of 16.
[] .inbound	Integer	Is this an outbound or inbound shipment (outbound= 0, inbound= 1).	Maximum value is 1. Minimum value is 0.	0
[] .loadmeters	Decimal	The load meters of the shipment. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .numberOfPackages	Integer		Maximum value is 32767.	0
[] .paymentTerms	String	The payment terms.	Maximum size of 32.
[] .deliveryNoteInformation	Delivery note	The number of packages/collin in the shipment.
[] .deliveryNoteInformation .deliveryNoteId	String	The identification for the delivery note.	Maximum size of 64.
[] .deliveryNoteInformation .currency	String	The currency of the price.	Maximum size of 3.
[] .deliveryNoteInformation .price	Decimal	Total price of the all deliverynote lines. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .deliveryNoteInformation .deliveryNoteLines	List	The deliverynote lines.
[] .deliveryNoteInformation .deliveryNoteLines.[] .deliveryNoteId	String	The deliverynote id.	Maximum size of 64.
[] .deliveryNoteInformation .deliveryNoteLines.[] .lineNumber	Integer	The sequential line number.	Maximum value is 200000.
[] .deliveryNoteInformation .deliveryNoteLines.[] .quantity	Integer	The quantity of products in the shipment.	Maximum value is 200000.
[] .deliveryNoteInformation .deliveryNoteLines.[] .quantityUom	String	The quantity unit of measure (e.g. PCS,BOX etc).	Maximum size of 32.
[] .deliveryNoteInformation .deliveryNoteLines.[] .quantityOrder	Integer	The quantity that is ordered.	Maximum value is 200000.
[] .deliveryNoteInformation .deliveryNoteLines.[] .quantityBackorder	Integer	The quantity that is in back order.	Maximum value is 200000.
[] .deliveryNoteInformation .deliveryNoteLines.[] .articleId	String	The article id.	Maximum size of 64.
[] .deliveryNoteInformation .deliveryNoteLines.[] .articleName	String	The article name.	Maximum size of 128.
[] .deliveryNoteInformation .deliveryNoteLines.[] .description	String	The description of the article.	Maximum size of 256.
[] .deliveryNoteInformation .deliveryNoteLines.[] .hsCode	String	The HS Code.	Maximum size of 25.
[] .deliveryNoteInformation .deliveryNoteLines.[] .countryOrigin	String	The country of origin.	Maximum size of 3.
[] .deliveryNoteInformation .deliveryNoteLines.[] .price	Decimal	The price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .deliveryNoteInformation .deliveryNoteLines.[] .goodsValue	Decimal	The value per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .deliveryNoteInformation .deliveryNoteLines.[] .currency	String	The currency of the price.	Maximum size of 3.	EUR
[] .deliveryNoteInformation .deliveryNoteLines.[] .serialNumber	String	The serialnumber of the article.	Maximum size of 64.
[] .deliveryNoteInformation .deliveryNoteLines.[] .reasonOfExport	String	The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.	Maximum size of 64.
[] .deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceDate	String	The date for on the proforma invoice.	Format yyyyMMdd.
[] .deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceNumber	String	The number for on the proforma invoice.	Maximum size of 64.
[] .deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceLineNumber	String	The line number for on the proforma invoice.	Maximum size of 15.
[] .deliveryNoteInformation .deliveryNoteLines.[] .quantityM2	Decimal	The quantity in cubic meters. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .deliveryNoteInformation .deliveryNoteLines.[] .customerOrder	String	The customer order.	Maximum size of 64.
[] .deliveryNoteInformation .deliveryNoteLines.[] .articleEanCode	String	The article’s ean code.	Maximum size of 64.
[] .deliveryNoteInformation .deliveryNoteLines.[] .quality	String	The quality of the article.	Maximum size of 64.
[] .deliveryNoteInformation .deliveryNoteLines.[] .composition	String	The composition.	Maximum size of 128.
[] .deliveryNoteInformation .deliveryNoteLines.[] .assemblyInstructions	String	The assembly instructions.	Maximum size of 65535.
[] .deliveryNoteInformation .deliveryNoteLines.[] .grossWeight	Decimal	The gross weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .deliveryNoteInformation .deliveryNoteLines.[] .nettWeight	Decimal	The net weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .deliveryNoteInformation .deliveryNoteLines.[] .weightUom	String	The weight unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
[] .deliveryNoteInformation .deliveryNoteLines.[] .hsCodeDescription	String	The HS Code description.	Maximum size of 128.
[] .deliveryNoteInformation .deliveryNoteLines.[] .nettPrice	Decimal	The net price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceFreightCharges	Decimal	The freight charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceInsuranceCharges	Decimal	The insurance charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceDiscounts	Decimal	Thediscount for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceOtherCharges	Decimal	The other charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .measurements .length	Decimal	The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .measurements .width	Decimal	The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .measurements .height	Decimal	The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .measurements .weight	Decimal	The weight of the object (shipment, package, dangerous good). Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .measurements .linearUom	String	The linear unit of measure (e.g. CM, FT, IN, YD).	Maximum size of 3.
[] .measurements .massUom	String	The mass unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
[] .additionalReferences	List	The additional references.
[] .additionalReferences.[] .type	String	The type of the additional reference.	Mandatory. Maximum size of 64.
[] .additionalReferences.[] .value	String	The additional reference.	Maximum size of 1024.
[] .monetaryDetails	List	The monetary details.
[] .monetaryDetails.[] .type	String	The type of the value.	Has to match pattern: (GOODS\| CUSTOMS\| INSURANCE\| COD\| FREIGHT\| TAXES\| DUTIES\| SPOTPRICE)
[] .monetaryDetails.[] .value	Decimal	The value.
[] .monetaryDetails.[] .currency	String	The currency of the value.	Maximum size of 3.
[] .addresses	List	The addresses, the address indicates the type.
[] .addresses.[] .type	String	The type of the address.	Has to match pattern: (SEND\| RECV\| INVC\| 3PTY\| SNDO\| RCVO) Maximum size of 4. Not Null and not empty.
[] .addresses.[] .name	String	The name.	Maximum size of 64. Not Null and not empty.
[] .addresses.[] .addressLine1	String	The first address line.	Maximum size of 64. Not Null and not empty.
[] .addresses.[] .addressLine2	String	The second address line.	Maximum size of 64.
[] .addresses.[] .addressLine3	String	The third address line.	Maximum size of 64.
[] .addresses.[] .houseNo	String	The house number.	Maximum size of 16.
[] .addresses.[] .city	String	The city.	Maximum size of 64. Not Null and not empty.
[] .addresses.[] .zipCode	String	The zip code.	Maximum size of 16. Not Null and not empty.
[] .addresses.[] .state	String	The state.	Maximum size of 16.
[] .addresses.[] .country	String	The country code.	Maximum size of 3. Not Null and not empty.
[] .addresses.[] .building	String	The building name.	Maximum size of 64.
[] .addresses.[] .floor	String	The floor level.	Maximum size of 16.
[] .addresses.[] .department	String	The department.	Maximum size of 64.
[] .addresses.[] .doorcode	String	The doorcode.	Maximum size of 10.
[] .addresses.[] .contact	String	The contact information.	Maximum size of 64.
[] .addresses.[] .telNo	String	The phone number.	Maximum size of 32.
[] .addresses.[] .faxNo	String	The fax number.	Maximum size of 32.
[] .addresses.[] .email	String	The email address.	Maximum size of 256.
[] .addresses.[] .accountNumber	String	The account number.	Maximum size of 32.
[] .addresses.[] .customerNumber	String	The customer number.	Maximum size of 32.
[] .addresses.[] .vatNumber	String	The vat number.	Maximum size of 32.
[] .addresses.[] .residential	Boolean wrapped in Integer	Indicator for residential addresses.	Maximum value is 1. Minimum value is 0.
[] .addresses.[] .contactDateOfBirth	String	Date of birth.	Has to match pattern: \d{4}-\d{2}-\d{2}\| ^$
[] .addresses.[] .contactIdType	String	The document type whereby the contact will be identified.	Maximum size of 64.
[] .addresses.[] .contactIdNumber	String	The unique number of the identification document.	Maximum size of 64.
[] .addresses.[] .contactIdExpirationDate	String	The expiration date of the identification document.	Has to match pattern: \d{4}-\d{2}-\d{2}\| ^$\| BpI.*
[] .addresses.[] .eoriNumber	String	The Economic Operators Registration and Identification number.	Has to match pattern: [A-Z]{2}[\w]{1,15}\| ^$
[] .customerDocuments	List	The customer documents.
[] .customerDocuments.[] .templateName	String	Attached document template.	Maximum size of 64.
[] .customerDocuments.[] .format	String	Attached document format, e.g. PDF, PNG, GIF, CSV, etc.	Maximum size of 8.
[] .customerDocuments.[] .content	String	Attached document base64 string.	Maximum size of 524288.
[] .packages	List	The packages/collo.
[] .packages.[] .lineNo	Integer	The line number for this package.	Maximum value is 2147483647.
[] .packages.[] .shipmentLineId	String	The shipment line number for this package. In this field the SSCC code can be mapped.	Maximum size of 32.
[] .packages.[] .packageType	String	The package type.	Maximum size of 16.
[] .packages.[] .description	String	The description of the goods.	Maximum size of 128.
[] .packages.[] .quantity	Integer	The quantity.	Mandatory. Maximum value is 127. Minimum value is 0.
[] .packages.[] .stackable	Boolean	Is the package is stackable?
[] .packages.[] .stackHeight	Integer	The stack height.	Maximum value is 32767.	1
[] .packages.[] .additionalReferences	List	The additional reference.
[] .packages.[] .additionalReferences.[] .type	String	The type of the additional reference.	Mandatory. Maximum size of 64.
[] .packages.[] .additionalReferences.[] .value	String	The additional reference.	Maximum size of 1024.
[] .packages.[] .monetaryDetails	List	The monetary details.
[] .packages.[] .monetaryDetails.[] .type	String	The type of the value.	Has to match pattern: (GOODS\| CUSTOMS\| INSURANCE\| COD\| FREIGHT\| TAXES\| DUTIES\| SPOTPRICE)
[] .packages.[] .monetaryDetails.[] .value	Decimal	The value.
[] .packages.[] .monetaryDetails.[] .currency	String	The currency of the value.	Maximum size of 3.
[] .packages.[] .deliveryNoteInfo	Delivery note	Delivery note information on collo level, please note to use either shipment level or package level (preferably package level), mixing both could end up in unwanted results to the carrier.
[] .packages.[] .deliveryNoteInfo .deliveryNoteId	String	The identification for the delivery note.	Maximum size of 64.
[] .packages.[] .deliveryNoteInfo .currency	String	The currency of the price.	Maximum size of 3.
[] .packages.[] .deliveryNoteInfo .price	Decimal	Total price of the all deliverynote lines. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines	List	The deliverynote lines.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .deliveryNoteId	String	The deliverynote id.	Maximum size of 64.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .lineNumber	Integer	The sequential line number.	Maximum value is 200000.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantity	Integer	The quantity of products in the shipment.	Maximum value is 200000.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityUom	String	The quantity unit of measure (e.g. PCS,BOX etc).	Maximum size of 32.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityOrder	Integer	The quantity that is ordered.	Maximum value is 200000.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityBackorder	Integer	The quantity that is in back order.	Maximum value is 200000.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .articleId	String	The article id.	Maximum size of 64.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .articleName	String	The article name.	Maximum size of 128.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .description	String	The description of the article.	Maximum size of 256.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .hsCode	String	The HS Code.	Maximum size of 25.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .countryOrigin	String	The country of origin.	Maximum size of 3.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .price	Decimal	The price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .goodsValue	Decimal	The value per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .currency	String	The currency of the price.	Maximum size of 3.	EUR
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .serialNumber	String	The serialnumber of the article.	Maximum size of 64.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .reasonOfExport	String	The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.	Maximum size of 64.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceDate	String	The date for on the proforma invoice.	Format yyyyMMdd.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceNumber	String	The number for on the proforma invoice.	Maximum size of 64.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceLineNumber	String	The line number for on the proforma invoice.	Maximum size of 15.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityM2	Decimal	The quantity in cubic meters. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .customerOrder	String	The customer order.	Maximum size of 64.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .articleEanCode	String	The article’s ean code.	Maximum size of 64.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quality	String	The quality of the article.	Maximum size of 64.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .composition	String	The composition.	Maximum size of 128.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .assemblyInstructions	String	The assembly instructions.	Maximum size of 65535.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .grossWeight	Decimal	The gross weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .nettWeight	Decimal	The net weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .weightUom	String	The weight unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .hsCodeDescription	String	The HS Code description.	Maximum size of 128.
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .nettPrice	Decimal	The net price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceFreightCharges	Decimal	The freight charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceInsuranceCharges	Decimal	The insurance charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceDiscounts	Decimal	Thediscount for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceOtherCharges	Decimal	The other charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation	Dangerous goods	The dangerousgoods information.
[] .packages.[] .dangerousGoodsInformation .dangerousGoodsGds	List	Dangerous goods gds, this object is currently obsolete.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods	List	The dangerous goods lines
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .idCode	String	The Id code.	Maximum size of 64.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .unCode	String	The Un code.	Maximum size of 64.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .unSubCode	String	The Un subcode.	Maximum size of 64.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingGroup	String	The packing group.	Maximum size of 64.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingType	String	The package type.	Maximum size of 64.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingClassification	String	The packing classification.	Maximum size of 64.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingInstruction	String	The packing instruction.	Maximum size of 64.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .quantity	Integer	The quantity.	Maximum value is 32767.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .description	String	The description.	Maximum size of 128.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .markingIdentifier	String	The marking identifier.	Maximum size of 64.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .limitedQuantity	Integer	The limited quantity.	Maximum value is 127.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .instruction	String	Instruction.	Maximum size of 128.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .limitedQuantityPoints	Integer	The limited quantity point.	Maximum value is 9999.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .tunnelCode	String	The tunnelcode.	Maximum size of 16.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .overpackID	String	The overpackID	Maximum size of 24.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .isHazardousSubstance	Boolean	Hazardous substance indicator.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .internationalTechnicalName	String	The international technical name.	Maximum size of 256.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .localTechnicalName	String	The local technical name	Maximum size of 256.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .properInternationalShippingName	String	The proper international shipping name	Maximum size of 256.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .properLocalShippingName	String	The proper local shipping name	Maximum size of 256.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .classificationCode	String	The classification code.	Maximum size of 12.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .regulation .level	String	The regulation level.	Maximum size of 2.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .regulation .type	String	The regulation type.	Maximum size of 5.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass .primary	String	The primary hazard class.	Maximum size of 3.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass .secondary	String	The secondary hazard class.	Maximum size of 3.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass .tertiary	String	The tertiary hazard class.	Maximum size of 3.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .flashPoint	Decimal	The flash point.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .controlTemperature	Decimal	The control temperature.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .emergencyTemperature	Decimal	The emergency temperature.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .temperatureUom	String	The temperature units-of-measure.	Maximum size of 1.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements	DangerousGoodsMeasurements	The measurements.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .length	Decimal	The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .width	Decimal	The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .height	Decimal	The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .linearUom	String	The linear unit of measure (e.g. CM, FT, IN, YD).	Maximum size of 3.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .massUom	String	The mass unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .netExplosiveMassUom	String	The net explosive mass units-of-measure.	Maximum size of 2.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .netExplosiveMass	Decimal	The net explosive mass.	Maximum value is 1,000,000,000 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .netWeight	Decimal	The nett weight. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .grossWeight	Decimal	The gross weight.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .volume	Decimal	The volume. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .volumeUom	String	The volume units-of-measure.	Maximum size of 8.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .authorizationCode	String	The authorization code.	Maximum size of 24.
[] .packages.[] .measurements .length	Decimal	The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .measurements .width	Decimal	The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .measurements .height	Decimal	The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .measurements .weight	Decimal	The weight of the object (shipment, package, dangerous good). Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .measurements .calculatedWeight	Decimal		Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .customerDocuments	List	The customer documents.
[] .packages.[] .customerDocuments.[] .templateName	String	Attached document template.	Maximum size of 64.
[] .packages.[] .customerDocuments.[] .format	String	Attached document format, e.g. PDF, PNG, GIF, CSV, etc.	Maximum size of 8.
[] .packages.[] .customerDocuments.[] .content	String	Attached document base64 string.	Maximum size of 524288.
[] .measurements .linearUom	String	The linear unit of measure (e.g. CM, FT, IN, YD).	Maximum size of 3.
[] .measurements .massUom	String	The mass unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.

Path

Type

Description

Constraints

Default

[]
.reference

String

Shipment reference.

Not Null and not empty.
The size must be between 1 and 32.

[]
.carrier

String

The carrier.

Fixed length of 3.
Not Null and not empty.

[]
.costCenter

String

The cost center.

Maximum size of 32.

[]
.mailType

Integer

The mail type.

Maximum value is 127.

[]
.language

String

The language.

Maximum size of 2.

[]
.description

String

The description.

Maximum size of 128.

[]
.instruction

String

The instruction.

Maximum size of 256.

[]
.value

Decimal

The shipment monetary value. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.valueCurrency

String

The shipment monetary value currency.

Maximum size of 3.

[]
.spotPrice

Decimal

The spot price. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.spotPriceCurrency

String

The spot price currency.

Maximum size of 3.

EUR

[]
.pickupDate

String

The pickup date.

Format yyyy-MM-dd.

Depends on routing rules.

[]
.pickupTime

String

The earliest pickup time.

Format HH:mm.

Depends on routing rules.

[]
.pickupTimeTo

String

The latest shipment pickup time.

Format HH:mm.

Depends on routing rules.

[]
.requestedDeliveryDate

String

The requested delivery date.

Format yyyy-MM-dd.

Depends on routing rules.

[]
.requestedDeliveryTime

String

The requested earliest delivery time

Format HH:mm.

Depends on routing rules.

[]
.requestedDeliveryTimeTo

String

The requested lates delivery time.

Format HH:mm.

Depends on routing rules.

[]
.service

String

The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU

Maximum size of 16.

[]
.insurance

Boolean

Should this shipment be insured or is it insured

false

[]
.serviceLevelTime

String

The requested service level time.

Maximum size of 32.
Not Null and not empty.

[]
.serviceLevelOther

String

The service level other.

Maximum size of 256.

[]
.incoterms

String

The inco terms.

Maximum size of 16.

[]
.inbound

Integer

Is this an outbound or inbound shipment (outbound= 0, inbound= 1).

Maximum value is 1.
Minimum value is 0.

[]
.loadmeters

Decimal

The load meters of the shipment. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.numberOfPackages

Integer

Maximum value is 32767.

[]
.paymentTerms

String

The payment terms.

Maximum size of 32.

[]
.deliveryNoteInformation

Delivery note

The number of packages/collin in the shipment.

[]
.deliveryNoteInformation
.deliveryNoteId

String

The identification for the delivery note.

Maximum size of 64.

[]
.deliveryNoteInformation
.currency

String

The currency of the price.

Maximum size of 3.

[]
.deliveryNoteInformation
.price

Decimal

Total price of the all deliverynote lines. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.deliveryNoteInformation
.deliveryNoteLines

List

The deliverynote lines.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.deliveryNoteId

String

The deliverynote id.

Maximum size of 64.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.lineNumber

Integer

The sequential line number.

Maximum value is 200000.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.quantity

Integer

The quantity of products in the shipment.

Maximum value is 200000.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.quantityUom

String

The quantity unit of measure (e.g. PCS,BOX etc).

Maximum size of 32.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.quantityOrder

Integer

The quantity that is ordered.

Maximum value is 200000.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.quantityBackorder

Integer

The quantity that is in back order.

Maximum value is 200000.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.articleId

String

The article id.

Maximum size of 64.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.articleName

String

The article name.

Maximum size of 128.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.description

String

The description of the article.

Maximum size of 256.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.hsCode

String

The HS Code.

Maximum size of 25.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.countryOrigin

String

The country of origin.

Maximum size of 3.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.price

Decimal

The price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.goodsValue

Decimal

The value per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.currency

String

The currency of the price.

Maximum size of 3.

EUR

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.serialNumber

String

The serialnumber of the article.

Maximum size of 64.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.reasonOfExport

String

The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.

Maximum size of 64.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceDate

String

The date for on the proforma invoice.

Format yyyyMMdd.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceNumber

String

The number for on the proforma invoice.

Maximum size of 64.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceLineNumber

String

The line number for on the proforma invoice.

Maximum size of 15.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.quantityM2

Decimal

The quantity in cubic meters. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.customerOrder

String

The customer order.

Maximum size of 64.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.articleEanCode

String

The article’s ean code.

Maximum size of 64.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.quality

String

The quality of the article.

Maximum size of 64.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.composition

String

The composition.

Maximum size of 128.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.assemblyInstructions

String

The assembly instructions.

Maximum size of 65535.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.grossWeight

Decimal

The gross weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.nettWeight

Decimal

The net weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.hsCodeDescription

String

The HS Code description.

Maximum size of 128.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.nettPrice

Decimal

The net price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceFreightCharges

Decimal

The freight charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceInsuranceCharges

Decimal

The insurance charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceDiscounts

Decimal

Thediscount for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceOtherCharges

Decimal

The other charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.measurements
.length

Decimal

The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.measurements
.width

Decimal

The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.measurements
.height

Decimal

The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.measurements
.weight

Decimal

The weight of the object (shipment, package, dangerous good). Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.measurements
.linearUom

String

The linear unit of measure (e.g. CM, FT, IN, YD).

Maximum size of 3.

[]
.measurements
.massUom

String

The mass unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

[]
.additionalReferences

List

The additional references.

[]
.additionalReferences.[]
.type

String

The type of the additional reference.

Mandatory.
Maximum size of 64.

[]
.additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

[]
.monetaryDetails

List

The monetary details.

[]
.monetaryDetails.[]
.type

String

The type of the value.

[]
.monetaryDetails.[]
.value

Decimal

The value.

[]
.monetaryDetails.[]
.currency

String

The currency of the value.

Maximum size of 3.

[]
.addresses

List

The addresses, the address indicates the type.

[]
.addresses.[]
.type

String

The type of the address.

[]
.addresses.[]
.name

String

The name.

Maximum size of 64.
Not Null and not empty.

[]
.addresses.[]
.addressLine1

String

The first address line.

Maximum size of 64.
Not Null and not empty.

[]
.addresses.[]
.addressLine2

String

The second address line.

Maximum size of 64.

[]
.addresses.[]
.addressLine3

String

The third address line.

Maximum size of 64.

[]
.addresses.[]
.houseNo

String

The house number.

Maximum size of 16.

[]
.addresses.[]
.city

String

The city.

Maximum size of 64.
Not Null and not empty.

[]
.addresses.[]
.zipCode

String

The zip code.

Maximum size of 16.
Not Null and not empty.

[]
.addresses.[]
.state

String

The state.

Maximum size of 16.

[]
.addresses.[]
.country

String

The country code.

Maximum size of 3.
Not Null and not empty.

[]
.addresses.[]
.building

String

The building name.

Maximum size of 64.

[]
.addresses.[]
.floor

String

The floor level.

Maximum size of 16.

[]
.addresses.[]
.department

String

The department.

Maximum size of 64.

[]
.addresses.[]
.doorcode

String

The doorcode.

Maximum size of 10.

[]
.addresses.[]
.contact

String

The contact information.

Maximum size of 64.

[]
.addresses.[]
.telNo

String

The phone number.

Maximum size of 32.

[]
.addresses.[]
.faxNo

String

The fax number.

Maximum size of 32.

[]
.addresses.[]
.email

String

The email address.

Maximum size of 256.

[]
.addresses.[]
.accountNumber

String

The account number.

Maximum size of 32.

[]
.addresses.[]
.customerNumber

String

The customer number.

Maximum size of 32.

[]
.addresses.[]
.vatNumber

String

The vat number.

Maximum size of 32.

[]
.addresses.[]
.residential

Boolean wrapped in Integer

Indicator for residential addresses.

Maximum value is 1.
Minimum value is 0.

[]
.addresses.[]
.contactDateOfBirth

String

Date of birth.

Has to match pattern: \d{4}-\d{2}-\d{2}|
^$

[]
.addresses.[]
.contactIdType

String

The document type whereby the contact will be identified.

Maximum size of 64.

[]
.addresses.[]
.contactIdNumber

String

The unique number of the identification document.

Maximum size of 64.

[]
.addresses.[]
.contactIdExpirationDate

String

The expiration date of the identification document.

Has to match pattern: \d{4}-\d{2}-\d{2}|
^$|
BpI.*

[]
.addresses.[]
.eoriNumber

String

The Economic Operators Registration and Identification number.

Has to match pattern: [A-Z]{2}[\w]{1,15}|
^$

[]
.customerDocuments

List

The customer documents.

[]
.customerDocuments.[]
.templateName

String

Attached document template.

Maximum size of 64.

[]
.customerDocuments.[]
.format

String

Attached document format, e.g. PDF, PNG, GIF, CSV, etc.

Maximum size of 8.

[]
.customerDocuments.[]
.content

String

Attached document base64 string.

Maximum size of 524288.

[]
.packages

List

The packages/collo.

[]
.packages.[]
.lineNo

Integer

The line number for this package.

Maximum value is 2147483647.

[]
.packages.[]
.shipmentLineId

String

The shipment line number for this package. In this field the SSCC code can be mapped.

Maximum size of 32.

[]
.packages.[]
.packageType

String

The package type.

Maximum size of 16.

[]
.packages.[]
.description

String

The description of the goods.

Maximum size of 128.

[]
.packages.[]
.quantity

Integer

The quantity.

Mandatory.
Maximum value is 127.
Minimum value is 0.

[]
.packages.[]
.stackable

Boolean

Is the package is stackable?

[]
.packages.[]
.stackHeight

Integer

The stack height.

Maximum value is 32767.

[]
.packages.[]
.additionalReferences

List

The additional reference.

[]
.packages.[]
.additionalReferences.[]
.type

String

The type of the additional reference.

Mandatory.
Maximum size of 64.

[]
.packages.[]
.additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

[]
.packages.[]
.monetaryDetails

List

The monetary details.

[]
.packages.[]
.monetaryDetails.[]
.type

String

The type of the value.

[]
.packages.[]
.monetaryDetails.[]
.value

Decimal

The value.

[]
.packages.[]
.monetaryDetails.[]
.currency

String

The currency of the value.

Maximum size of 3.

[]
.packages.[]
.deliveryNoteInfo

Delivery note

Delivery note information on collo level, please note to use either shipment level or package level (preferably package level), mixing both could end up in unwanted results to the carrier.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteId

String

The identification for the delivery note.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.currency

String

The currency of the price.

Maximum size of 3.

[]
.packages.[]
.deliveryNoteInfo
.price

Decimal

Total price of the all deliverynote lines. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines

List

The deliverynote lines.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.deliveryNoteId

String

The deliverynote id.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.lineNumber

Integer

The sequential line number.

Maximum value is 200000.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantity

Integer

The quantity of products in the shipment.

Maximum value is 200000.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityUom

String

The quantity unit of measure (e.g. PCS,BOX etc).

Maximum size of 32.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityOrder

Integer

The quantity that is ordered.

Maximum value is 200000.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityBackorder

Integer

The quantity that is in back order.

Maximum value is 200000.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleId

String

The article id.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleName

String

The article name.

Maximum size of 128.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.description

String

The description of the article.

Maximum size of 256.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.hsCode

String

The HS Code.

Maximum size of 25.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.countryOrigin

String

The country of origin.

Maximum size of 3.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.price

Decimal

The price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.goodsValue

Decimal

The value per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.currency

String

The currency of the price.

Maximum size of 3.

EUR

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.serialNumber

String

The serialnumber of the article.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.reasonOfExport

String

The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceDate

String

The date for on the proforma invoice.

Format yyyyMMdd.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceNumber

String

The number for on the proforma invoice.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceLineNumber

String

The line number for on the proforma invoice.

Maximum size of 15.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityM2

Decimal

The quantity in cubic meters. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.customerOrder

String

The customer order.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleEanCode

String

The article’s ean code.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quality

String

The quality of the article.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.composition

String

The composition.

Maximum size of 128.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.assemblyInstructions

String

The assembly instructions.

Maximum size of 65535.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.grossWeight

Decimal

The gross weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.nettWeight

Decimal

The net weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.hsCodeDescription

String

The HS Code description.

Maximum size of 128.

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.nettPrice

Decimal

The net price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceFreightCharges

Decimal

The freight charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceInsuranceCharges

Decimal

The insurance charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceDiscounts

Decimal

Thediscount for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceOtherCharges

Decimal

The other charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation

Dangerous goods

The dangerousgoods information.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoodsGds

List

Dangerous goods gds, this object is currently obsolete.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods

List

The dangerous goods lines

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.idCode

String

The Id code.

Maximum size of 64.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.unCode

String

The Un code.

Maximum size of 64.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.unSubCode

String

The Un subcode.

Maximum size of 64.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingGroup

String

The packing group.

Maximum size of 64.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingType

String

The package type.

Maximum size of 64.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingClassification

String

The packing classification.

Maximum size of 64.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingInstruction

String

The packing instruction.

Maximum size of 64.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.quantity

Integer

The quantity.

Maximum value is 32767.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.description

String

The description.

Maximum size of 128.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.markingIdentifier

String

The marking identifier.

Maximum size of 64.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.limitedQuantity

Integer

The limited quantity.

Maximum value is 127.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.instruction

String

Instruction.

Maximum size of 128.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.limitedQuantityPoints

Integer

The limited quantity point.

Maximum value is 9999.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.tunnelCode

String

The tunnelcode.

Maximum size of 16.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.overpackID

String

The overpackID

Maximum size of 24.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.isHazardousSubstance

Boolean

Hazardous substance indicator.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.internationalTechnicalName

String

The international technical name.

Maximum size of 256.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.localTechnicalName

String

The local technical name

Maximum size of 256.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.properInternationalShippingName

String

The proper international shipping name

Maximum size of 256.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.properLocalShippingName

String

The proper local shipping name

Maximum size of 256.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.classificationCode

String

The classification code.

Maximum size of 12.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.regulation
.level

String

The regulation level.

Maximum size of 2.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.regulation
.type

String

The regulation type.

Maximum size of 5.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass
.primary

String

The primary hazard class.

Maximum size of 3.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass
.secondary

String

The secondary hazard class.

Maximum size of 3.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass
.tertiary

String

The tertiary hazard class.

Maximum size of 3.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.flashPoint

Decimal

The flash point.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.controlTemperature

Decimal

The control temperature.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.emergencyTemperature

Decimal

The emergency temperature.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.temperatureUom

String

The temperature units-of-measure.

Maximum size of 1.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements

DangerousGoodsMeasurements

The measurements.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.length

Decimal

The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.width

Decimal

The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.height

Decimal

The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.linearUom

String

The linear unit of measure (e.g. CM, FT, IN, YD).

Maximum size of 3.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.massUom

String

The mass unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.netExplosiveMassUom

String

The net explosive mass units-of-measure.

Maximum size of 2.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.netExplosiveMass

Decimal

The net explosive mass.

Maximum value is 1,000,000,000
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.netWeight

Decimal

The nett weight. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.grossWeight

Decimal

The gross weight.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.volume

Decimal

The volume. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.volumeUom

String

The volume units-of-measure.

Maximum size of 8.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.authorizationCode

String

The authorization code.

Maximum size of 24.

[]
.packages.[]
.measurements
.length

Decimal

The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.measurements
.width

Decimal

The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.measurements
.height

Decimal

The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.measurements
.weight

Decimal

The weight of the object (shipment, package, dangerous good). Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.measurements
.calculatedWeight

Decimal

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.customerDocuments

List

The customer documents.

[]
.packages.[]
.customerDocuments.[]
.templateName

String

Attached document template.

Maximum size of 64.

[]
.packages.[]
.customerDocuments.[]
.format

String

Attached document format, e.g. PDF, PNG, GIF, CSV, etc.

Maximum size of 8.

[]
.packages.[]
.customerDocuments.[]
.content

String

Attached document base64 string.

Maximum size of 524288.

[]
.measurements
.linearUom

String

The linear unit of measure (e.g. CM, FT, IN, YD).

Maximum size of 3.

[]
.measurements
.massUom

String

The mass unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

Response structure `BOOK`

Path	Type	Description	Constraints
[] .reference	String	Shipment reference.
[] .awb	String	The airway bill number.
[] .carrier	String	The carrier.
[] .executingCarrier	String	The executing carrier.
[] .pieces	Decimal	Number of packages
[] .weight	Decimal	Shipment weight
[] .service	String	The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU
[] .serviceLevelTime	String	The used service level time.
[] .serviceLevelOther	String	The used service level other.
[] .incoterms	String	The incoterms
[] .price	Decimal	The price.
[] .currency	String	The price currency.
[] .salesPrice	Decimal	The sales price.
[] .salesPriceCurrency	String	The sales price currency.
[] .pickupDate	String	The booked pickup date
[] .trackingUrl	String	The tracking URL.
[] .shipmentStatus	BookingStatus	The shipment status
[] .shipmentStatus .statusCode	String	The status code.
[] .shipmentStatus .plannedDeliveryDate	String	The planned delivery date.	Format yyyy-MM-dd.
[] .shipmentStatus .plannedDeliveryTime	String	The planned delivery time.	Format HH:mm.
[] .packages	List	The list of packages
[] .packages[] .sequence	String	Shipment line sequence
[] .packages[] .lineNo	Integer	The lineno of the package.
[] .packages[] .shipmentLineId	String	The shipment line number for this package.
[] .packages[] .awb	String	Shipment line airwaybill
[] .packages[] .genericStatusCode	String	Shipment line status code
[] .packages[] .carrierStatusCode	String	Carrier shipment line status
[] .packages[] .carrierStatusDescription	String	Carrier shipment line status description
tariffLogs	List	List of tariff information of the shipment
tariffLogs.[] .tariffType	String	Tariff type.
tariffLogs.[] .tariffValue	String	Tariff value.
tariffLogs.[] .currency	String	Currency of the value.
tariffLogs.[] .chargeGroup	String	The charge group.
tariffLogs.[] .chargeType	String	The charge type.
tariffLogs.[] .calcType	String	The calculation type.

Path

Type

Description

Constraints

[]
.reference

String

Shipment reference.

[]
.awb

String

The airway bill number.

[]
.carrier

String

The carrier.

[]
.executingCarrier

String

The executing carrier.

[]
.pieces

Decimal

Number of packages

[]
.weight

Decimal

Shipment weight

[]
.service

String

The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU

[]
.serviceLevelTime

String

The used service level time.

[]
.serviceLevelOther

String

The used service level other.

[]
.incoterms

String

The incoterms

[]
.price

Decimal

The price.

[]
.currency

String

The price currency.

[]
.salesPrice

Decimal

The sales price.

[]
.salesPriceCurrency

String

The sales price currency.

[]
.pickupDate

String

The booked pickup date

[]
.trackingUrl

String

The tracking URL.

[]
.shipmentStatus

BookingStatus

The shipment status

[]
.shipmentStatus
.statusCode

String

The status code.

[]
.shipmentStatus
.plannedDeliveryDate

String

The planned delivery date.

Format yyyy-MM-dd.

[]
.shipmentStatus
.plannedDeliveryTime

String

The planned delivery time.

Format HH:mm.

[]
.packages

List

The list of packages

[]
.packages[]
.sequence

String

Shipment line sequence

[]
.packages[]
.lineNo

Integer

The lineno of the package.

[]
.packages[]
.shipmentLineId

String

The shipment line number for this package.

[]
.packages[]
.awb

String

Shipment line airwaybill

[]
.packages[]
.genericStatusCode

String

Shipment line status code

[]
.packages[]
.carrierStatusCode

String

Carrier shipment line status

[]
.packages[]
.carrierStatusDescription

String

Carrier shipment line status description

tariffLogs

List

List of tariff information of the shipment

tariffLogs.[]
.tariffType

String

Tariff type.

tariffLogs.[]
.tariffValue

String

Tariff value.

tariffLogs.[]
.currency

String

Currency of the value.

tariffLogs.[]
.chargeGroup

String

The charge group.

tariffLogs.[]
.chargeType

String

The charge type.

tariffLogs.[]
.calcType

String

The calculation type.

Curl Example requests

Click here to show/hide example

$ curl 'https://test-api.transsmart.com/v2/shipments/DEVDOCS/BOOK' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -d '[ {
  "reference" : "Transsmart_1690195367303",
  "carrier" : "DPD",
  "costCenter" : "",
  "mailType" : 1,
  "language" : "NL",
  "description" : "example-description",
  "instruction" : "example-instruction1",
  "value" : 10,
  "valueCurrency" : "EUR",
  "spotPrice" : 15,
  "spotPriceCurrency" : "EUR",
  "pickupDate" : "2023-07-24",
  "pickupTime" : "08:00",
  "pickupTimeTo" : "10:00",
  "requestedDeliveryDate" : "2023-07-27",
  "requestedDeliveryTime" : "15:00",
  "requestedDeliveryTimeTo" : "17:00",
  "paymentTerms" : "paymentTerms",
  "service" : "NON-DOCS",
  "serviceLevelTime" : "CLASSIC",
  "serviceLevelOther" : "",
  "incoterms" : "DAP",
  "inbound" : 0,
  "loadmeters" : 0.41,
  "numberOfPackages" : 1,
  "measurements" : {
    "length" : 0,
    "width" : 0,
    "height" : 0,
    "weight" : 0,
    "linearUom" : "CM",
    "massUom" : "KG"
  },
  "additionalReferences" : [ {
    "type" : "ENGINEER",
    "value" : "example-engineer-additional-value-shipment-level"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  } ],
  "addresses" : [ {
    "type" : "RECV",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0,
    "contactDateOfBirth" : "1999-01-01",
    "contactIdType" : "type",
    "contactIdNumber" : "1234",
    "contactIdExpirationDate" : "2020-10-10",
    "eoriNumber" : "NL4321"
  }, {
    "type" : "SEND",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0
  }, {
    "type" : "INVC",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0
  } ],
  "packages" : [ {
    "lineNo" : 1,
    "shipmentLineId" : "example-shippmentLineId",
    "packageType" : "BOX",
    "description" : "example-description",
    "quantity" : 2,
    "stackable" : false,
    "stackHeight" : 1,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "monetaryDetails" : [ ],
    "deliveryNoteInfo" : {
      "deliveryNoteId" : "0987654321",
      "currency" : "EUR",
      "price" : 16,
      "deliveryNoteLines" : [ {
        "deliveryNoteId" : "09876543210987654321",
        "lineNumber" : 1,
        "quantity" : 1,
        "quantityUom" : "PCS",
        "quantityOrder" : 1,
        "quantityBackorder" : 0,
        "articleId" : "example-articleId",
        "articleName" : "example-articleName",
        "description" : "example-articleDescription",
        "hsCode" : "example-hsCode",
        "countryOrigin" : "NL",
        "price" : 16,
        "goodsValue" : 1.0,
        "currency" : "EUR",
        "serialNumber" : "example-serialNumber",
        "reasonOfExport" : "example-reasonOfExport",
        "proformaInvoiceDate" : "20171121",
        "proformaInvoiceNumber" : "TS0987654321",
        "proformaInvoiceLineNumber" : "L2",
        "quantityM2" : 1,
        "customerOrder" : "example-customerOrder",
        "articleEanCode" : "example-articleEanCode",
        "quality" : "example-quality",
        "composition" : "example-composition",
        "assemblyInstructions" : "example-assemblyInstructions",
        "grossWeight" : 20,
        "nettWeight" : 18,
        "weightUom" : "KG",
        "hsCodeDescription" : "example-hsCodeDescription",
        "nettPrice" : 15,
        "proformaInvoiceFreightCharges" : 20,
        "proformaInvoiceInsuranceCharges" : 2,
        "proformaInvoiceDiscounts" : 2,
        "proformaInvoiceOtherCharges" : 2
      } ]
    },
    "dangerousGoodsInformation" : {
      "dangerousGoods" : [ {
        "idCode" : "idCode",
        "unCode" : "1234",
        "unSubCode" : "1",
        "packingGroup" : "I",
        "packingType" : "CAN",
        "packingClassification" : "1.2",
        "packingInstruction" : "packingInstruction",
        "isHazardousSubstance" : false,
        "quantity" : 1,
        "description" : "description",
        "markingIdentifier" : "3",
        "limitedQuantity" : 0,
        "instruction" : "instruction",
        "limitedQuantityPoints" : 850,
        "tunnelCode" : "C/D",
        "overpackID" : "1of1",
        "measurements" : {
          "length" : 8,
          "width" : 8,
          "height" : 8,
          "linearUom" : "CM",
          "massUom" : "KG"
        },
        "netWeight" : 7.5,
        "volume" : 0.51,
        "volumeUom" : "L"
      } ],
      "dangerousGoodsGds" : [ ]
    },
    "measurements" : {
      "length" : 20,
      "width" : 20,
      "height" : 20,
      "weight" : 20
    }
  } ],
  "monetaryDetails" : [ {
    "type" : "GOODS",
    "value" : 2.0,
    "currency" : "EUR"
  } ]
} ]'

Http example:

Click here to show/hide example

POST /v2/shipments/DEVDOCS/BOOK HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 6008
Host: test-api.transsmart.com

[ {
  "reference" : "Transsmart_1690195367303",
  "carrier" : "DPD",
  "costCenter" : "",
  "mailType" : 1,
  "language" : "NL",
  "description" : "example-description",
  "instruction" : "example-instruction1",
  "value" : 10,
  "valueCurrency" : "EUR",
  "spotPrice" : 15,
  "spotPriceCurrency" : "EUR",
  "pickupDate" : "2023-07-24",
  "pickupTime" : "08:00",
  "pickupTimeTo" : "10:00",
  "requestedDeliveryDate" : "2023-07-27",
  "requestedDeliveryTime" : "15:00",
  "requestedDeliveryTimeTo" : "17:00",
  "paymentTerms" : "paymentTerms",
  "service" : "NON-DOCS",
  "serviceLevelTime" : "CLASSIC",
  "serviceLevelOther" : "",
  "incoterms" : "DAP",
  "inbound" : 0,
  "loadmeters" : 0.41,
  "numberOfPackages" : 1,
  "measurements" : {
    "length" : 0,
    "width" : 0,
    "height" : 0,
    "weight" : 0,
    "linearUom" : "CM",
    "massUom" : "KG"
  },
  "additionalReferences" : [ {
    "type" : "ENGINEER",
    "value" : "example-engineer-additional-value-shipment-level"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  } ],
  "addresses" : [ {
    "type" : "RECV",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0,
    "contactDateOfBirth" : "1999-01-01",
    "contactIdType" : "type",
    "contactIdNumber" : "1234",
    "contactIdExpirationDate" : "2020-10-10",
    "eoriNumber" : "NL4321"
  }, {
    "type" : "SEND",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0
  }, {
    "type" : "INVC",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0
  } ],
  "packages" : [ {
    "lineNo" : 1,
    "shipmentLineId" : "example-shippmentLineId",
    "packageType" : "BOX",
    "description" : "example-description",
    "quantity" : 2,
    "stackable" : false,
    "stackHeight" : 1,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "monetaryDetails" : [ ],
    "deliveryNoteInfo" : {
      "deliveryNoteId" : "0987654321",
      "currency" : "EUR",
      "price" : 16,
      "deliveryNoteLines" : [ {
        "deliveryNoteId" : "09876543210987654321",
        "lineNumber" : 1,
        "quantity" : 1,
        "quantityUom" : "PCS",
        "quantityOrder" : 1,
        "quantityBackorder" : 0,
        "articleId" : "example-articleId",
        "articleName" : "example-articleName",
        "description" : "example-articleDescription",
        "hsCode" : "example-hsCode",
        "countryOrigin" : "NL",
        "price" : 16,
        "goodsValue" : 1.0,
        "currency" : "EUR",
        "serialNumber" : "example-serialNumber",
        "reasonOfExport" : "example-reasonOfExport",
        "proformaInvoiceDate" : "20171121",
        "proformaInvoiceNumber" : "TS0987654321",
        "proformaInvoiceLineNumber" : "L2",
        "quantityM2" : 1,
        "customerOrder" : "example-customerOrder",
        "articleEanCode" : "example-articleEanCode",
        "quality" : "example-quality",
        "composition" : "example-composition",
        "assemblyInstructions" : "example-assemblyInstructions",
        "grossWeight" : 20,
        "nettWeight" : 18,
        "weightUom" : "KG",
        "hsCodeDescription" : "example-hsCodeDescription",
        "nettPrice" : 15,
        "proformaInvoiceFreightCharges" : 20,
        "proformaInvoiceInsuranceCharges" : 2,
        "proformaInvoiceDiscounts" : 2,
        "proformaInvoiceOtherCharges" : 2
      } ]
    },
    "dangerousGoodsInformation" : {
      "dangerousGoods" : [ {
        "idCode" : "idCode",
        "unCode" : "1234",
        "unSubCode" : "1",
        "packingGroup" : "I",
        "packingType" : "CAN",
        "packingClassification" : "1.2",
        "packingInstruction" : "packingInstruction",
        "isHazardousSubstance" : false,
        "quantity" : 1,
        "description" : "description",
        "markingIdentifier" : "3",
        "limitedQuantity" : 0,
        "instruction" : "instruction",
        "limitedQuantityPoints" : 850,
        "tunnelCode" : "C/D",
        "overpackID" : "1of1",
        "measurements" : {
          "length" : 8,
          "width" : 8,
          "height" : 8,
          "linearUom" : "CM",
          "massUom" : "KG"
        },
        "netWeight" : 7.5,
        "volume" : 0.51,
        "volumeUom" : "L"
      } ],
      "dangerousGoodsGds" : [ ]
    },
    "measurements" : {
      "length" : 20,
      "width" : 20,
      "height" : 20,
      "weight" : 20
    }
  } ],
  "monetaryDetails" : [ {
    "type" : "GOODS",
    "value" : 2.0,
    "currency" : "EUR"
  } ]
} ]

Example response `BOOK`

Click here to show/hide example

Shipment Booking and printing

The same request input as book only is applicable

Path parameters `PRINT`

Table 2. /v2/shipments/{account}/{action}
Parameter	Description
`account`	The account to which the shipment belongs.
`action`	With PRINT, the shipment is booked first and then printed.

Request parameters `PRINT`

Parameter	Description	Constraints
user	The user name (not the email that is used to loggin) from whom the print setting should be used.	This is ignored when spc is also specified.
spc	The SmartPrint connection that needs to handle the print job. The value is a concatenation of user and device in the format "user@device" or "device$@device" if SmartPrint is running as service.	If specified, then either a ZPL, PDF or a document printer need to be specified as well.
printer_zpl	ZPL printer name	May be empty if a PDF or DOC printer is specified.
printer_pdf	PDF printer name	May be empty if a ZPL or DOC printer is specified.
printer_doc	Document printer name	May be empty if a ZPL or PDF printer is specified.

Parameter

Description

Constraints

user

The user name (not the email that is used to loggin) from whom the print setting should be used.

This is ignored when spc is also specified.

spc

The SmartPrint connection that needs to handle the print job. The value is a concatenation of user and device in the format "user@device" or "device$@device" if SmartPrint is running as service.

If specified, then either a ZPL, PDF or a document printer need to be specified as well.

printer_zpl

ZPL printer name

May be empty if a PDF or DOC printer is specified.

printer_pdf

PDF printer name

May be empty if a ZPL or DOC printer is specified.

printer_doc

Document printer name

May be empty if a ZPL or PDF printer is specified.

Response structure `PRINT`

See to Print Response structure.

Example response `PRINT`

See to Print example response.

Shipment Booking and printing as rawjob

The same request input as book only is applicable

Path parameters `PRINT` as rawJob

Table 3. /v2/shipments/{account}/{action}
Parameter	Description
`account`	The account to which the shipment belongs.
`action`	With PRINT, the shipment is booked first and then printed .

Request parameters `PRINT` as rawJob

Parameter	Description	Constraints
rawJob	Include the shipment and package level pdf’s and or zpl documents in the response, the documents are not printing by the service. Note this option works only with action PRINT.	Default is false.

Parameter

Description

Constraints

rawJob

Include the shipment and package level pdf’s and or zpl documents in the response, the documents are not printing by the service. Note this option works only with action PRINT.

Default is false.

Response structure `PRINT` as rawJob

See to Print Response structure rawjob.

Example response `PRINT` as rawJob

See to Print Example rawjob.

Shipment Booking validation error

The same parameters and request input as book only is applicable

Response structure Booking validation error

Path	Type	Description
status	HttpStatus	The status of the error, e.g. BAD_REQUEST or INTERNAL_SERVER_ERROR.
timestamp	String	The actual timestamp when the error was raised.
code	String	The Transsmart internal error code, e.g. TS50001
message	String	The message given either by the carrier or by Transsmart
details	List	The details given either by the carrier or by Transsmart
details.[] .reference	String	The reference of the booking.
details.[] .validationErrors	List	List of validation errors.
details.[] .validationErrors.[] .object	String	The object that contains the field that has an error.
details.[] .validationErrors.[] .field	String	The field that has an error.
details.[] .validationErrors.[] .rejectedValue	Object	The value that is rejected.
details.[] .validationErrors.[] .message	String	The reasone why the value is rejected.

Path

Type

Description

Constraints

status

HttpStatus

The status of the error, e.g. BAD_REQUEST or INTERNAL_SERVER_ERROR.

timestamp

String

The actual timestamp when the error was raised.

code

String

The Transsmart internal error code, e.g. TS50001

message

String

The message given either by the carrier or by Transsmart

details

List

The details given either by the carrier or by Transsmart

details.[]
.reference

String

The reference of the booking.

details.[]
.validationErrors

List

List of validation errors.

details.[]
.validationErrors.[]
.object

String

The object that contains the field that has an error.

details.[]
.validationErrors.[]
.field

String

The field that has an error.

details.[]
.validationErrors.[]
.rejectedValue

Object

The value that is rejected.

details.[]
.validationErrors.[]
.message

String

The reasone why the value is rejected.

Curl Example requests

Click here to show/hide example

$ curl 'https://test-api.transsmart.com/v2/shipments/DEVDOCS/BOOK' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -d '[ {
  "reference" : "this_reference_is_tolong_so_a_error_will_be_reported",
  "carrier" : "to_long_carrier",
  "costCenter" : "",
  "mailType" : 1,
  "language" : "NL",
  "description" : "example-description",
  "instruction" : "example-instruction1",
  "value" : 10,
  "valueCurrency" : "EUR",
  "spotPrice" : 15,
  "spotPriceCurrency" : "EUR",
  "pickupDate" : "2023-07-24",
  "pickupTime" : "08:00",
  "pickupTimeTo" : "10:00",
  "requestedDeliveryDate" : "2023-07-27",
  "requestedDeliveryTime" : "15:00",
  "requestedDeliveryTimeTo" : "17:00",
  "paymentTerms" : "paymentTerms",
  "service" : "NON-DOCS",
  "serviceLevelTime" : "CLASSIC",
  "serviceLevelOther" : "",
  "incoterms" : "DAP",
  "inbound" : 0,
  "loadmeters" : 0.41,
  "numberOfPackages" : 1,
  "measurements" : {
    "length" : 0,
    "width" : 0,
    "height" : 0,
    "weight" : 0,
    "linearUom" : "CM",
    "massUom" : "KG"
  },
  "additionalReferences" : [ {
    "type" : "ENGINEER",
    "value" : "example-engineer-additional-value-shipment-level"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  } ],
  "addresses" : [ {
    "type" : "RECV",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0,
    "contactDateOfBirth" : "1999-01-01",
    "contactIdType" : "type",
    "contactIdNumber" : "1234",
    "contactIdExpirationDate" : "2020-10-10",
    "eoriNumber" : "NL4321"
  }, {
    "type" : "SEND",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0
  }, {
    "type" : "INVC",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0
  } ],
  "packages" : [ {
    "lineNo" : 1,
    "shipmentLineId" : "example-shippmentLineId",
    "packageType" : "BOX",
    "description" : "example-description",
    "quantity" : 2,
    "stackable" : false,
    "stackHeight" : 1,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "monetaryDetails" : [ ],
    "deliveryNoteInfo" : {
      "deliveryNoteId" : "0987654321",
      "currency" : "EUR",
      "price" : 16,
      "deliveryNoteLines" : [ {
        "deliveryNoteId" : "09876543210987654321",
        "lineNumber" : 1,
        "quantity" : 1,
        "quantityUom" : "PCS",
        "quantityOrder" : 1,
        "quantityBackorder" : 0,
        "articleId" : "example-articleId",
        "articleName" : "example-articleName",
        "description" : "example-articleDescription",
        "hsCode" : "example-hsCode",
        "countryOrigin" : "NL",
        "price" : 16,
        "goodsValue" : 1.0,
        "currency" : "EUR",
        "serialNumber" : "example-serialNumber",
        "reasonOfExport" : "example-reasonOfExport",
        "proformaInvoiceDate" : "20171121",
        "proformaInvoiceNumber" : "TS0987654321",
        "proformaInvoiceLineNumber" : "L2",
        "quantityM2" : 1,
        "customerOrder" : "example-customerOrder",
        "articleEanCode" : "example-articleEanCode",
        "quality" : "example-quality",
        "composition" : "example-composition",
        "assemblyInstructions" : "example-assemblyInstructions",
        "grossWeight" : 20,
        "nettWeight" : 18,
        "weightUom" : "KG",
        "hsCodeDescription" : "example-hsCodeDescription",
        "nettPrice" : 15,
        "proformaInvoiceFreightCharges" : 20,
        "proformaInvoiceInsuranceCharges" : 2,
        "proformaInvoiceDiscounts" : 2,
        "proformaInvoiceOtherCharges" : 2
      } ]
    },
    "dangerousGoodsInformation" : {
      "dangerousGoods" : [ {
        "idCode" : "idCode",
        "unCode" : "1234",
        "unSubCode" : "1",
        "packingGroup" : "I",
        "packingType" : "CAN",
        "packingClassification" : "1.2",
        "packingInstruction" : "packingInstruction",
        "isHazardousSubstance" : false,
        "quantity" : 1,
        "description" : "description",
        "markingIdentifier" : "3",
        "limitedQuantity" : 0,
        "instruction" : "instruction",
        "limitedQuantityPoints" : 850,
        "tunnelCode" : "C/D",
        "overpackID" : "1of1",
        "measurements" : {
          "length" : 8,
          "width" : 8,
          "height" : 8,
          "linearUom" : "CM",
          "massUom" : "KG"
        },
        "netWeight" : 7.5,
        "volume" : 0.51,
        "volumeUom" : "L"
      } ],
      "dangerousGoodsGds" : [ ]
    },
    "measurements" : {
      "length" : 20,
      "width" : 20,
      "height" : 20,
      "weight" : 20
    }
  } ],
  "monetaryDetails" : [ {
    "type" : "GOODS",
    "value" : 2.0,
    "currency" : "EUR"
  } ]
} ]'

Http example:

Click here to show/hide example

POST /v2/shipments/DEVDOCS/BOOK HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 6048
Host: test-api.transsmart.com

[ {
  "reference" : "this_reference_is_tolong_so_a_error_will_be_reported",
  "carrier" : "to_long_carrier",
  "costCenter" : "",
  "mailType" : 1,
  "language" : "NL",
  "description" : "example-description",
  "instruction" : "example-instruction1",
  "value" : 10,
  "valueCurrency" : "EUR",
  "spotPrice" : 15,
  "spotPriceCurrency" : "EUR",
  "pickupDate" : "2023-07-24",
  "pickupTime" : "08:00",
  "pickupTimeTo" : "10:00",
  "requestedDeliveryDate" : "2023-07-27",
  "requestedDeliveryTime" : "15:00",
  "requestedDeliveryTimeTo" : "17:00",
  "paymentTerms" : "paymentTerms",
  "service" : "NON-DOCS",
  "serviceLevelTime" : "CLASSIC",
  "serviceLevelOther" : "",
  "incoterms" : "DAP",
  "inbound" : 0,
  "loadmeters" : 0.41,
  "numberOfPackages" : 1,
  "measurements" : {
    "length" : 0,
    "width" : 0,
    "height" : 0,
    "weight" : 0,
    "linearUom" : "CM",
    "massUom" : "KG"
  },
  "additionalReferences" : [ {
    "type" : "ENGINEER",
    "value" : "example-engineer-additional-value-shipment-level"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  } ],
  "addresses" : [ {
    "type" : "RECV",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0,
    "contactDateOfBirth" : "1999-01-01",
    "contactIdType" : "type",
    "contactIdNumber" : "1234",
    "contactIdExpirationDate" : "2020-10-10",
    "eoriNumber" : "NL4321"
  }, {
    "type" : "SEND",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0
  }, {
    "type" : "INVC",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0
  } ],
  "packages" : [ {
    "lineNo" : 1,
    "shipmentLineId" : "example-shippmentLineId",
    "packageType" : "BOX",
    "description" : "example-description",
    "quantity" : 2,
    "stackable" : false,
    "stackHeight" : 1,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "monetaryDetails" : [ ],
    "deliveryNoteInfo" : {
      "deliveryNoteId" : "0987654321",
      "currency" : "EUR",
      "price" : 16,
      "deliveryNoteLines" : [ {
        "deliveryNoteId" : "09876543210987654321",
        "lineNumber" : 1,
        "quantity" : 1,
        "quantityUom" : "PCS",
        "quantityOrder" : 1,
        "quantityBackorder" : 0,
        "articleId" : "example-articleId",
        "articleName" : "example-articleName",
        "description" : "example-articleDescription",
        "hsCode" : "example-hsCode",
        "countryOrigin" : "NL",
        "price" : 16,
        "goodsValue" : 1.0,
        "currency" : "EUR",
        "serialNumber" : "example-serialNumber",
        "reasonOfExport" : "example-reasonOfExport",
        "proformaInvoiceDate" : "20171121",
        "proformaInvoiceNumber" : "TS0987654321",
        "proformaInvoiceLineNumber" : "L2",
        "quantityM2" : 1,
        "customerOrder" : "example-customerOrder",
        "articleEanCode" : "example-articleEanCode",
        "quality" : "example-quality",
        "composition" : "example-composition",
        "assemblyInstructions" : "example-assemblyInstructions",
        "grossWeight" : 20,
        "nettWeight" : 18,
        "weightUom" : "KG",
        "hsCodeDescription" : "example-hsCodeDescription",
        "nettPrice" : 15,
        "proformaInvoiceFreightCharges" : 20,
        "proformaInvoiceInsuranceCharges" : 2,
        "proformaInvoiceDiscounts" : 2,
        "proformaInvoiceOtherCharges" : 2
      } ]
    },
    "dangerousGoodsInformation" : {
      "dangerousGoods" : [ {
        "idCode" : "idCode",
        "unCode" : "1234",
        "unSubCode" : "1",
        "packingGroup" : "I",
        "packingType" : "CAN",
        "packingClassification" : "1.2",
        "packingInstruction" : "packingInstruction",
        "isHazardousSubstance" : false,
        "quantity" : 1,
        "description" : "description",
        "markingIdentifier" : "3",
        "limitedQuantity" : 0,
        "instruction" : "instruction",
        "limitedQuantityPoints" : 850,
        "tunnelCode" : "C/D",
        "overpackID" : "1of1",
        "measurements" : {
          "length" : 8,
          "width" : 8,
          "height" : 8,
          "linearUom" : "CM",
          "massUom" : "KG"
        },
        "netWeight" : 7.5,
        "volume" : 0.51,
        "volumeUom" : "L"
      } ],
      "dangerousGoodsGds" : [ ]
    },
    "measurements" : {
      "length" : 20,
      "width" : 20,
      "height" : 20,
      "weight" : 20
    }
  } ],
  "monetaryDetails" : [ {
    "type" : "GOODS",
    "value" : 2.0,
    "currency" : "EUR"
  } ]
} ]

Example response `BOOK`

Click here to show/hide example

Shipment Booking by booking profile

Path parameters

Table 4. /v2/shipments/{account}/{action}/{bookingProfileCode}
Parameter	Description
`account`	The account to which the shipment belongs.
`action`	Action to be performed; possible values are CREATE, BOOK or PRINT. With PRINT, the shipment is booked first and then printed .
`bookingProfileCode`	The booking profile to use.

Request structure book

Path	Type	Description	Constraints	Default
reference	String	Shipment reference.	Not Null and not empty. The size must be between 1 and 32.
carrier	String	The carrier.	Fixed length of 3. Not Null and not empty.
costCenter	String	The cost center.	Maximum size of 32.
mailType	Integer	The mail type.	Maximum value is 127.
language	String	The language.	Maximum size of 2.
description	String	The description.	Maximum size of 128.
instruction	String	The instruction.	Maximum size of 256.
value	Decimal	The shipment monetary value. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
valueCurrency	String	The shipment monetary value currency.	Maximum size of 3.
spotPrice	Decimal	The spot price. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
spotPriceCurrency	String	The spot price currency.	Maximum size of 3.	EUR
pickupDate	String	The pickup date.	Format yyyy-MM-dd.	Depends on routing rules.
pickupTime	String	The earliest pickup time.	Format HH:mm.	Depends on routing rules.
pickupTimeTo	String	The latest shipment pickup time.	Format HH:mm.	Depends on routing rules.
requestedDeliveryDate	String	The requested delivery date.	Format yyyy-MM-dd.	Depends on routing rules.
requestedDeliveryTime	String	The requested earliest delivery time	Format HH:mm.	Depends on routing rules.
requestedDeliveryTimeTo	String	The requested lates delivery time.	Format HH:mm.	Depends on routing rules.
service	String	The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU	Maximum size of 16.
insurance	Boolean	Should this shipment be insured or is it insured		false
serviceLevelTime	String	The requested service level time.	Maximum size of 32. Not Null and not empty.
serviceLevelOther	String	The service level other.	Maximum size of 256.
incoterms	String	The inco terms.	Maximum size of 16.
inbound	Integer	Is this an outbound or inbound shipment (outbound= 0, inbound= 1).	Maximum value is 1. Minimum value is 0.	0
loadmeters	Decimal	The load meters of the shipment. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
numberOfPackages	Integer		Maximum value is 32767.	0
deliveryNoteInformation	Delivery note	The number of packages/collin in the shipment.
paymentTerms	String	The payment terms.	Maximum size of 32.
deliveryNoteInformation .deliveryNoteId	String	The identification for the delivery note.	Maximum size of 64.
deliveryNoteInformation .currency	String	The currency of the price.	Maximum size of 3.
deliveryNoteInformation .price	Decimal	Total price of the all deliverynote lines. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
deliveryNoteInformation .deliveryNoteLines	List	The deliverynote lines.
deliveryNoteInformation .deliveryNoteLines.[] .deliveryNoteId	String	The deliverynote id.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .lineNumber	Integer	The sequential line number.	Maximum value is 200000.
deliveryNoteInformation .deliveryNoteLines.[] .quantity	Integer	The quantity of products in the shipment.	Maximum value is 200000.
deliveryNoteInformation .deliveryNoteLines.[] .quantityUom	String	The quantity unit of measure (e.g. PCS,BOX etc).	Maximum size of 32.
deliveryNoteInformation .deliveryNoteLines.[] .quantityOrder	Integer	The quantity that is ordered.	Maximum value is 200000.
deliveryNoteInformation .deliveryNoteLines.[] .quantityBackorder	Integer	The quantity that is in back order.	Maximum value is 200000.
deliveryNoteInformation .deliveryNoteLines.[] .articleId	String	The article id.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .articleName	String	The article name.	Maximum size of 128.
deliveryNoteInformation .deliveryNoteLines.[] .description	String	The description of the article.	Maximum size of 256.
deliveryNoteInformation .deliveryNoteLines.[] .hsCode	String	The HS Code.	Maximum size of 25.
deliveryNoteInformation .deliveryNoteLines.[] .countryOrigin	String	The country of origin.	Maximum size of 3.
deliveryNoteInformation .deliveryNoteLines.[] .price	Decimal	The price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
deliveryNoteInformation .deliveryNoteLines.[] .currency	String	The currency of the price.	Maximum size of 3.	EUR
deliveryNoteInformation .deliveryNoteLines.[] .serialNumber	String	The serialnumber of the article.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .reasonOfExport	String	The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceDate	String	The date for on the proforma invoice.	Format yyyyMMdd.
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceNumber	String	The number for on the proforma invoice.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceLineNumber	String	The line number for on the proforma invoice.	Maximum size of 15.
deliveryNoteInformation .deliveryNoteLines.[] .quantityM2	Decimal	The quantity in cubic meters. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .customerOrder	String	The customer order.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .articleEanCode	String	The article’s ean code.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .quality	String	The quality of the article.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .composition	String	The composition.	Maximum size of 128.
deliveryNoteInformation .deliveryNoteLines.[] .assemblyInstructions	String	The assembly instructions.	Maximum size of 65535.
deliveryNoteInformation .deliveryNoteLines.[] .grossWeight	Decimal	The gross weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .nettWeight	Decimal	The net weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .weightUom	String	The weight unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
deliveryNoteInformation .deliveryNoteLines.[] .hsCodeDescription	String	The HS Code description.	Maximum size of 128.
deliveryNoteInformation .deliveryNoteLines.[] .nettPrice	Decimal	The net price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceFreightCharges	Decimal	The freight charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceInsuranceCharges	Decimal	The insurance charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceDiscounts	Decimal	Thediscount for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceOtherCharges	Decimal	The other charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
measurements .length	Decimal	The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
measurements .width	Decimal	The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
measurements .height	Decimal	The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
measurements .weight	Decimal	The weight of the object (shipment, package, dangerous good). Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
measurements .linearUom	String	The linear unit of measure (e.g. CM, FT, IN, YD).	Maximum size of 3.
measurements .massUom	String	The mass unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
additionalReferences	List	The additional references.
additionalReferences.[] .type	String	The type of the additional reference.	Mandatory. Maximum size of 64.
additionalReferences.[] .value	String	The additional reference.	Maximum size of 1024.
monetaryDetails	List	The monetary details.
[] .packages.[] .monetaryDetails.[] .type	String	The type of the value.	Has to match pattern: (GOODS\| CUSTOMS\| INSURANCE\| COD\| FREIGHT\| TAXES\| DUTIES\| SPOTPRICE)
[] .packages.[] .monetaryDetails.[] .value	Decimal	The value.
[] .packages.[] .monetaryDetails.[] .currency	String	The currency of the value.	Maximum size of 3.
addresses	List	The addresses, the address indicates the type.
addresses.[] .type	String	The type of the address.	Has to match pattern: (SEND\| RECV\| INVC\| 3PTY\| SNDO\| RCVO) Maximum size of 4. Not Null and not empty.
addresses.[] .name	String	The name.	Maximum size of 64. Not Null and not empty.
addresses.[] .addressLine1	String	The first address line.	Maximum size of 64. Not Null and not empty.
addresses.[] .addressLine2	String	The second address line.	Maximum size of 64.
addresses.[] .addressLine3	String	The third address line.	Maximum size of 64.
addresses.[] .houseNo	String	The house number.	Maximum size of 16.
addresses.[] .city	String	The city.	Maximum size of 64. Not Null and not empty.
addresses.[] .zipCode	String	The zip code.	Maximum size of 16. Not Null and not empty.
addresses.[] .state	String	The state.	Maximum size of 16.
addresses.[] .country	String	The country code.	Maximum size of 3. Not Null and not empty.
addresses.[] .building	String	The building name.	Maximum size of 64.
addresses.[] .floor	String	The floor level.	Maximum size of 16.
addresses.[] .department	String	The department.	Maximum size of 64.
addresses.[] .doorcode	String	The doorcode.	Maximum size of 10.
addresses.[] .contact	String	The contact information.	Maximum size of 64.
addresses.[] .telNo	String	The phone number.	Maximum size of 32.
addresses.[] .faxNo	String	The fax number.	Maximum size of 32.
addresses.[] .email	String	The email address.	Maximum size of 256.
addresses.[] .accountNumber	String	The account number.	Maximum size of 32.
addresses.[] .customerNumber	String	The customer number.	Maximum size of 32.
addresses.[] .vatNumber	String	The vat number.	Maximum size of 32.
addresses.[] .residential	Boolean wrapped in Integer	Indicator for residential addresses.	Maximum value is 1. Minimum value is 0.
addresses.[] .contactDateOfBirth	String	Date of birth.	Has to match pattern: \d{4}-\d{2}-\d{2}\| ^$
addresses.[] .contactIdType	String	The document type whereby the contact will be identified.	Maximum size of 64.
addresses.[] .contactIdNumber	String	The unique number of the identification document.	Maximum size of 64.
addresses.[] .contactIdExpirationDate	String	The expiration date of the identification document.	Has to match pattern: \d{4}-\d{2}-\d{2}\| ^$\| BpI.*
addresses.[] .eoriNumber	String	The Economic Operators Registration and Identification number.	Has to match pattern: [A-Z]{2}[\w]{1,15}\| ^$
[] .customerDocuments	List	The customer documents.
[] .customerDocuments.[] .templateName	String	Attached document template.	Maximum size of 64.
[] .customerDocuments.[] .format	String	Attached document format, e.g. PDF, PNG, GIF, CSV, etc.	Maximum size of 8.
[] .customerDocuments.[] .content	String	Attached document base64 string.	Maximum size of 524288.
packages	List	The packages/collo.
packages.[] .lineNo	Integer	The line number for this package.	Maximum value is 2147483647.
packages.[] .shipmentLineId	String	The shipment line number for this package. In this field the SSCC code can be mapped.	Maximum size of 32.
packages.[] .packageType	String	The package type.	Maximum size of 16.
packages.[] .description	String	The description of the goods.	Maximum size of 128.
packages.[] .quantity	Integer	The quantity.	Mandatory. Maximum value is 127. Minimum value is 0.
packages.[] .stackable	Boolean	Is the package is stackable?
packages.[] .stackHeight	Integer	The stack height.	Maximum value is 32767.	1
packages.[] .additionalReferences	List	The additional reference.
packages.[] .additionalReferences.[] .type	String	The type of the additional reference.	Mandatory. Maximum size of 64.
packages.[] .additionalReferences.[] .value	String	The additional reference.	Maximum size of 1024.
packages.[] .monetaryDetails	List	The monetary details.
[] .packages.[] .monetaryDetails.[] .type	String	The type of the value.	Has to match pattern: (GOODS\| CUSTOMS\| INSURANCE\| COD\| FREIGHT\| TAXES\| DUTIES\| SPOTPRICE)
[] .packages.[] .monetaryDetails.[] .value	Decimal	The value.
[] .packages.[] .monetaryDetails.[] .currency	String	The currency of the value.	Maximum size of 3.
packages.[] .deliveryNoteInfo	Delivery note	Delivery note information on collo level, please note to use either shipment level or package level (preferably package level), mixing both could end up in unwanted results to the carrier.
packages.[] .deliveryNoteInfo .deliveryNoteId	String	The identification for the delivery note.	Maximum size of 64.
packages.[] .deliveryNoteInfo .currency	String	The currency of the price.	Maximum size of 3.
packages.[] .deliveryNoteInfo .price	Decimal	Total price of the all deliverynote lines. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
packages.[] .deliveryNoteInfo .deliveryNoteLines	List	The deliverynote lines.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .deliveryNoteId	String	The deliverynote id.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .lineNumber	Integer	The sequential line number.	Maximum value is 200000.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantity	Integer	The quantity of products in the shipment.	Maximum value is 200000.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityUom	String	The quantity unit of measure (e.g. PCS,BOX etc).	Maximum size of 32.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityOrder	Integer	The quantity that is ordered.	Maximum value is 200000.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityBackorder	Integer	The quantity that is in back order.	Maximum value is 200000.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .articleId	String	The article id.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .articleName	String	The article name.	Maximum size of 128.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .description	String	The description of the article.	Maximum size of 256.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .hsCode	String	The HS Code.	Maximum size of 25.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .countryOrigin	String	The country of origin.	Maximum size of 3.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .price	Decimal	The price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .currency	String	The currency of the price.	Maximum size of 3.	EUR
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .serialNumber	String	The serialnumber of the article.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .reasonOfExport	String	The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceDate	String	The date for on the proforma invoice.	Format yyyyMMdd.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceNumber	String	The number for on the proforma invoice.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceLineNumber	String	The line number for on the proforma invoice.	Maximum size of 15.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityM2	Decimal	The quantity in cubic meters. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .customerOrder	String	The customer order.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .articleEanCode	String	The article’s ean code.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quality	String	The quality of the article.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .composition	String	The composition.	Maximum size of 128.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .assemblyInstructions	String	The assembly instructions.	Maximum size of 65535.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .grossWeight	Decimal	The gross weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .nettWeight	Decimal	The net weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .weightUom	String	The weight unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .hsCodeDescription	String	The HS Code description.	Maximum size of 128.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .nettPrice	Decimal	The net price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceFreightCharges	Decimal	The freight charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceInsuranceCharges	Decimal	The insurance charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceDiscounts	Decimal	Thediscount for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceOtherCharges	Decimal	The other charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation	Dangerous goods	The dangerousgoods information.
packages.[] .dangerousGoodsInformation .dangerousGoodsGds	List	Dangerous goods gds, this object is currently obsolete.
packages.[] .dangerousGoodsInformation .dangerousGoods	List	The dangerous goods lines
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .idCode	String	The Id code.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .unCode	String	The Un code.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .unSubCode	String	The Un subcode.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingGroup	String	The packing group.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingType	String	The package type.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingClassification	String	The packing classification.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingInstruction	String	The packing instruction.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .quantity	Integer	The quantity.	Maximum value is 32767.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .description	String	The description.	Maximum size of 128.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .markingIdentifier	String	The marking identifier.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .limitedQuantity	Integer	The limited quantity.	Maximum value is 127.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .instruction	String	Instruction.	Maximum size of 128.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .limitedQuantityPoints	Integer	The limited quantity point.	Maximum value is 9999.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .tunnelCode	String	The tunnelcode.	Maximum size of 16.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .overpackID	String	The overpackID	Maximum size of 24.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .isHazardousSubstance	Boolean	Hazardous substance indicator.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .internationalTechnicalName	String	The international technical name.	Maximum size of 256.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .localTechnicalName	String	The local technical name	Maximum size of 256.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .properInternationalShippingName	String	The proper international shipping name	Maximum size of 256.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .properLocalShippingName	String	The proper local shipping name	Maximum size of 256.
[] .packages.[] .dangerousGoodsInformation .dangerousGoods.[] .classificationCode	String	The classification code.	Maximum size of 12.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .regulation .level	String	The regulation level.	Maximum size of 2.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .regulation .type	String	The regulation type.	Maximum size of 5.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass .primary	String	The primary hazard class.	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass .secondary	String	The secondary hazard class.	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass .tertiary	String	The tertiary hazard class.	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .flashPoint	Decimal	The flash point.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .controlTemperature	Decimal	The control temperature.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .emergencyTemperature	Decimal	The emergency temperature.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .temperatureUom	String	The temperature units-of-measure.	Maximum size of 1.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements	DangerousGoodsMeasurements	The measurements.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .length	Decimal	The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .width	Decimal	The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .height	Decimal	The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .weight	Decimal	The weight of the object (shipment, package, dangerous good). Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .linearUom	String	The linear unit of measure (e.g. CM, FT, IN, YD).	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .massUom	String	The mass unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .netExplosiveMassUom	String	The net explosive mass units-of-measure.	Maximum size of 2.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .netExplosiveMass	Decimal	The net explosive mass.	Maximum value is 1,000,000,000 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .netWeight	Decimal	The nett weight. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .grossWeight	Decimal	The gross weight.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .volume	Decimal	The volume. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .volumeUom	String	The volume units-of-measure.	Maximum size of 8.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .authorizationCode	String	The authorization code.	Maximum size of 24.
packages.[] .measurements .length	Decimal	The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .measurements .width	Decimal	The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .measurements .height	Decimal	The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .measurements .weight	Decimal	The weight of the object (shipment, package, dangerous good). Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .measurements .calculatedWeight	Decimal		Maximum value is 999,999,999.99 Minimum value is 0
[] .packages.[] .customerDocuments	List	The customer documents.
[] .packages.[] .customerDocuments.[] .templateName	String	Attached document template.	Maximum size of 64.
[] .packages.[] .customerDocuments.[] .format	String	Attached document format, e.g. PDF, PNG, GIF, CSV, etc.	Maximum size of 8.
[] .packages.[] .customerDocuments.[] .content	String	Attached document base64 string.	Maximum size of 524288.
measurements .linearUom	String	The linear unit of measure (e.g. CM, FT, IN, YD).	Maximum size of 3.
measurements .massUom	String	The mass unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.

Path

Type

Description

Constraints

Default

reference

String

Shipment reference.

Not Null and not empty.
The size must be between 1 and 32.

carrier

String

The carrier.

Fixed length of 3.
Not Null and not empty.

costCenter

String

The cost center.

Maximum size of 32.

mailType

Integer

The mail type.

Maximum value is 127.

language

String

The language.

Maximum size of 2.

description

String

The description.

Maximum size of 128.

instruction

String

The instruction.

Maximum size of 256.

value

Decimal

The shipment monetary value. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

valueCurrency

String

The shipment monetary value currency.

Maximum size of 3.

spotPrice

Decimal

The spot price. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

spotPriceCurrency

String

The spot price currency.

Maximum size of 3.

EUR

pickupDate

String

The pickup date.

Format yyyy-MM-dd.

Depends on routing rules.

pickupTime

String

The earliest pickup time.

Format HH:mm.

Depends on routing rules.

pickupTimeTo

String

The latest shipment pickup time.

Format HH:mm.

Depends on routing rules.

requestedDeliveryDate

String

The requested delivery date.

Format yyyy-MM-dd.

Depends on routing rules.

requestedDeliveryTime

String

The requested earliest delivery time

Format HH:mm.

Depends on routing rules.

requestedDeliveryTimeTo

String

The requested lates delivery time.

Format HH:mm.

Depends on routing rules.

service

String

The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU

Maximum size of 16.

insurance

Boolean

Should this shipment be insured or is it insured

false

serviceLevelTime

String

The requested service level time.

Maximum size of 32.
Not Null and not empty.

serviceLevelOther

String

The service level other.

Maximum size of 256.

incoterms

String

The inco terms.

Maximum size of 16.

inbound

Integer

Is this an outbound or inbound shipment (outbound= 0, inbound= 1).

Maximum value is 1.
Minimum value is 0.

loadmeters

Decimal

The load meters of the shipment. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

numberOfPackages

Integer

Maximum value is 32767.

deliveryNoteInformation

Delivery note

The number of packages/collin in the shipment.

paymentTerms

String

The payment terms.

Maximum size of 32.

deliveryNoteInformation
.deliveryNoteId

String

The identification for the delivery note.

Maximum size of 64.

deliveryNoteInformation
.currency

String

The currency of the price.

Maximum size of 3.

deliveryNoteInformation
.price

Decimal

Total price of the all deliverynote lines. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

deliveryNoteInformation
.deliveryNoteLines

List

The deliverynote lines.

deliveryNoteInformation
.deliveryNoteLines.[]
.deliveryNoteId

String

The deliverynote id.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.lineNumber

Integer

The sequential line number.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantity

Integer

The quantity of products in the shipment.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityUom

String

The quantity unit of measure (e.g. PCS,BOX etc).

Maximum size of 32.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityOrder

Integer

The quantity that is ordered.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityBackorder

Integer

The quantity that is in back order.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleId

String

The article id.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleName

String

The article name.

Maximum size of 128.

deliveryNoteInformation
.deliveryNoteLines.[]
.description

String

The description of the article.

Maximum size of 256.

deliveryNoteInformation
.deliveryNoteLines.[]
.hsCode

String

The HS Code.

Maximum size of 25.

deliveryNoteInformation
.deliveryNoteLines.[]
.countryOrigin

String

The country of origin.

Maximum size of 3.

deliveryNoteInformation
.deliveryNoteLines.[]
.price

Decimal

The price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

deliveryNoteInformation
.deliveryNoteLines.[]
.currency

String

The currency of the price.

Maximum size of 3.

EUR

deliveryNoteInformation
.deliveryNoteLines.[]
.serialNumber

String

The serialnumber of the article.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.reasonOfExport

String

The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceDate

String

The date for on the proforma invoice.

Format yyyyMMdd.

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceNumber

String

The number for on the proforma invoice.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceLineNumber

String

The line number for on the proforma invoice.

Maximum size of 15.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityM2

Decimal

The quantity in cubic meters. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.customerOrder

String

The customer order.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleEanCode

String

The article’s ean code.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.quality

String

The quality of the article.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.composition

String

The composition.

Maximum size of 128.

deliveryNoteInformation
.deliveryNoteLines.[]
.assemblyInstructions

String

The assembly instructions.

Maximum size of 65535.

deliveryNoteInformation
.deliveryNoteLines.[]
.grossWeight

Decimal

The gross weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.nettWeight

Decimal

The net weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

deliveryNoteInformation
.deliveryNoteLines.[]
.hsCodeDescription

String

The HS Code description.

Maximum size of 128.

deliveryNoteInformation
.deliveryNoteLines.[]
.nettPrice

Decimal

The net price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceFreightCharges

Decimal

The freight charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceInsuranceCharges

Decimal

The insurance charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceDiscounts

Decimal

Thediscount for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceOtherCharges

Decimal

The other charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.length

Decimal

The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.width

Decimal

The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.height

Decimal

The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.weight

Decimal

The weight of the object (shipment, package, dangerous good). Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.linearUom

String

The linear unit of measure (e.g. CM, FT, IN, YD).

Maximum size of 3.

measurements
.massUom

String

The mass unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

additionalReferences

List

The additional references.

additionalReferences.[]
.type

String

The type of the additional reference.

Mandatory.
Maximum size of 64.

additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

monetaryDetails

List

The monetary details.

[]
.packages.[]
.monetaryDetails.[]
.type

String

The type of the value.

[]
.packages.[]
.monetaryDetails.[]
.value

Decimal

The value.

[]
.packages.[]
.monetaryDetails.[]
.currency

String

The currency of the value.

Maximum size of 3.

addresses

List

The addresses, the address indicates the type.

addresses.[]
.type

String

The type of the address.

addresses.[]
.name

String

The name.

Maximum size of 64.
Not Null and not empty.

addresses.[]
.addressLine1

String

The first address line.

Maximum size of 64.
Not Null and not empty.

addresses.[]
.addressLine2

String

The second address line.

Maximum size of 64.

addresses.[]
.addressLine3

String

The third address line.

Maximum size of 64.

addresses.[]
.houseNo

String

The house number.

Maximum size of 16.

addresses.[]
.city

String

The city.

Maximum size of 64.
Not Null and not empty.

addresses.[]
.zipCode

String

The zip code.

Maximum size of 16.
Not Null and not empty.

addresses.[]
.state

String

The state.

Maximum size of 16.

addresses.[]
.country

String

The country code.

Maximum size of 3.
Not Null and not empty.

addresses.[]
.building

String

The building name.

Maximum size of 64.

addresses.[]
.floor

String

The floor level.

Maximum size of 16.

addresses.[]
.department

String

The department.

Maximum size of 64.

addresses.[]
.doorcode

String

The doorcode.

Maximum size of 10.

addresses.[]
.contact

String

The contact information.

Maximum size of 64.

addresses.[]
.telNo

String

The phone number.

Maximum size of 32.

addresses.[]
.faxNo

String

The fax number.

Maximum size of 32.

addresses.[]
.email

String

The email address.

Maximum size of 256.

addresses.[]
.accountNumber

String

The account number.

Maximum size of 32.

addresses.[]
.customerNumber

String

The customer number.

Maximum size of 32.

addresses.[]
.vatNumber

String

The vat number.

Maximum size of 32.

addresses.[]
.residential

Boolean wrapped in Integer

Indicator for residential addresses.

Maximum value is 1.
Minimum value is 0.

addresses.[]
.contactDateOfBirth

String

Date of birth.

Has to match pattern: \d{4}-\d{2}-\d{2}|
^$

addresses.[]
.contactIdType

String

The document type whereby the contact will be identified.

Maximum size of 64.

addresses.[]
.contactIdNumber

String

The unique number of the identification document.

Maximum size of 64.

addresses.[]
.contactIdExpirationDate

String

The expiration date of the identification document.

Has to match pattern: \d{4}-\d{2}-\d{2}|
^$|
BpI.*

addresses.[]
.eoriNumber

String

The Economic Operators Registration and Identification number.

Has to match pattern: [A-Z]{2}[\w]{1,15}|
^$

[]
.customerDocuments

List

The customer documents.

[]
.customerDocuments.[]
.templateName

String

Attached document template.

Maximum size of 64.

[]
.customerDocuments.[]
.format

String

Attached document format, e.g. PDF, PNG, GIF, CSV, etc.

Maximum size of 8.

[]
.customerDocuments.[]
.content

String

Attached document base64 string.

Maximum size of 524288.

packages

List

The packages/collo.

packages.[]
.lineNo

Integer

The line number for this package.

Maximum value is 2147483647.

packages.[]
.shipmentLineId

String

The shipment line number for this package. In this field the SSCC code can be mapped.

Maximum size of 32.

packages.[]
.packageType

String

The package type.

Maximum size of 16.

packages.[]
.description

String

The description of the goods.

Maximum size of 128.

packages.[]
.quantity

Integer

The quantity.

Mandatory.
Maximum value is 127.
Minimum value is 0.

packages.[]
.stackable

Boolean

Is the package is stackable?

packages.[]
.stackHeight

Integer

The stack height.

Maximum value is 32767.

packages.[]
.additionalReferences

List

The additional reference.

packages.[]
.additionalReferences.[]
.type

String

The type of the additional reference.

Mandatory.
Maximum size of 64.

packages.[]
.additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

packages.[]
.monetaryDetails

List

The monetary details.

[]
.packages.[]
.monetaryDetails.[]
.type

String

The type of the value.

[]
.packages.[]
.monetaryDetails.[]
.value

Decimal

The value.

[]
.packages.[]
.monetaryDetails.[]
.currency

String

The currency of the value.

Maximum size of 3.

packages.[]
.deliveryNoteInfo

Delivery note

Delivery note information on collo level, please note to use either shipment level or package level (preferably package level), mixing both could end up in unwanted results to the carrier.

packages.[]
.deliveryNoteInfo
.deliveryNoteId

String

The identification for the delivery note.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.currency

String

The currency of the price.

Maximum size of 3.

packages.[]
.deliveryNoteInfo
.price

Decimal

Total price of the all deliverynote lines. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

packages.[]
.deliveryNoteInfo
.deliveryNoteLines

List

The deliverynote lines.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.deliveryNoteId

String

The deliverynote id.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.lineNumber

Integer

The sequential line number.

Maximum value is 200000.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantity

Integer

The quantity of products in the shipment.

Maximum value is 200000.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityUom

String

The quantity unit of measure (e.g. PCS,BOX etc).

Maximum size of 32.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityOrder

Integer

The quantity that is ordered.

Maximum value is 200000.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityBackorder

Integer

The quantity that is in back order.

Maximum value is 200000.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleId

String

The article id.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleName

String

The article name.

Maximum size of 128.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.description

String

The description of the article.

Maximum size of 256.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.hsCode

String

The HS Code.

Maximum size of 25.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.countryOrigin

String

The country of origin.

Maximum size of 3.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.price

Decimal

The price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.currency

String

The currency of the price.

Maximum size of 3.

EUR

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.serialNumber

String

The serialnumber of the article.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.reasonOfExport

String

The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceDate

String

The date for on the proforma invoice.

Format yyyyMMdd.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceNumber

String

The number for on the proforma invoice.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceLineNumber

String

The line number for on the proforma invoice.

Maximum size of 15.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityM2

Decimal

The quantity in cubic meters. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.customerOrder

String

The customer order.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleEanCode

String

The article’s ean code.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quality

String

The quality of the article.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.composition

String

The composition.

Maximum size of 128.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.assemblyInstructions

String

The assembly instructions.

Maximum size of 65535.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.grossWeight

Decimal

The gross weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.nettWeight

Decimal

The net weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.hsCodeDescription

String

The HS Code description.

Maximum size of 128.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.nettPrice

Decimal

The net price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceFreightCharges

Decimal

The freight charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceInsuranceCharges

Decimal

The insurance charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceDiscounts

Decimal

Thediscount for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceOtherCharges

Decimal

The other charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation

Dangerous goods

The dangerousgoods information.

packages.[]
.dangerousGoodsInformation
.dangerousGoodsGds

List

Dangerous goods gds, this object is currently obsolete.

packages.[]
.dangerousGoodsInformation
.dangerousGoods

List

The dangerous goods lines

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.idCode

String

The Id code.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.unCode

String

The Un code.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.unSubCode

String

The Un subcode.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingGroup

String

The packing group.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingType

String

The package type.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingClassification

String

The packing classification.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingInstruction

String

The packing instruction.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.quantity

Integer

The quantity.

Maximum value is 32767.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.description

String

The description.

Maximum size of 128.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.markingIdentifier

String

The marking identifier.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.limitedQuantity

Integer

The limited quantity.

Maximum value is 127.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.instruction

String

Instruction.

Maximum size of 128.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.limitedQuantityPoints

Integer

The limited quantity point.

Maximum value is 9999.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.tunnelCode

String

The tunnelcode.

Maximum size of 16.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.overpackID

String

The overpackID

Maximum size of 24.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.isHazardousSubstance

Boolean

Hazardous substance indicator.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.internationalTechnicalName

String

The international technical name.

Maximum size of 256.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.localTechnicalName

String

The local technical name

Maximum size of 256.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.properInternationalShippingName

String

The proper international shipping name

Maximum size of 256.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.properLocalShippingName

String

The proper local shipping name

Maximum size of 256.

[]
.packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.classificationCode

String

The classification code.

Maximum size of 12.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.regulation
.level

String

The regulation level.

Maximum size of 2.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.regulation
.type

String

The regulation type.

Maximum size of 5.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass
.primary

String

The primary hazard class.

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass
.secondary

String

The secondary hazard class.

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass
.tertiary

String

The tertiary hazard class.

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.flashPoint

Decimal

The flash point.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.controlTemperature

Decimal

The control temperature.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.emergencyTemperature

Decimal

The emergency temperature.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.temperatureUom

String

The temperature units-of-measure.

Maximum size of 1.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements

DangerousGoodsMeasurements

The measurements.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.length

Decimal

The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.width

Decimal

The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.height

Decimal

The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.weight

Decimal

The weight of the object (shipment, package, dangerous good). Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.linearUom

String

The linear unit of measure (e.g. CM, FT, IN, YD).

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.massUom

String

The mass unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.netExplosiveMassUom

String

The net explosive mass units-of-measure.

Maximum size of 2.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.netExplosiveMass

Decimal

The net explosive mass.

Maximum value is 1,000,000,000
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.netWeight

Decimal

The nett weight. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.grossWeight

Decimal

The gross weight.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.volume

Decimal

The volume. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.volumeUom

String

The volume units-of-measure.

Maximum size of 8.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.authorizationCode

String

The authorization code.

Maximum size of 24.

packages.[]
.measurements
.length

Decimal

The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.measurements
.width

Decimal

The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.measurements
.height

Decimal

The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.measurements
.weight

Decimal

The weight of the object (shipment, package, dangerous good). Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.measurements
.calculatedWeight

Decimal

Maximum value is 999,999,999.99
Minimum value is 0

[]
.packages.[]
.customerDocuments

List

The customer documents.

[]
.packages.[]
.customerDocuments.[]
.templateName

String

Attached document template.

Maximum size of 64.

[]
.packages.[]
.customerDocuments.[]
.format

String

Attached document format, e.g. PDF, PNG, GIF, CSV, etc.

Maximum size of 8.

[]
.packages.[]
.customerDocuments.[]
.content

String

Attached document base64 string.

Maximum size of 524288.

measurements
.linearUom

String

The linear unit of measure (e.g. CM, FT, IN, YD).

Maximum size of 3.

measurements
.massUom

String

The mass unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

Response structure `BOOK`

Path	Type	Description	Constraints
[] .reference	String	Shipment reference.
[] .awb	String	The airway bill number.
[] .carrier	String	The carrier.
[] .executingCarrier	String	The executing carrier.
[] .pieces	Decimal	Number of packages
[] .weight	Decimal	Shipment weight
[] .service	String	The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU
[] .serviceLevelTime	String	The used service level time.
[] .serviceLevelOther	String	The used service level other.
[] .incoterms	String	The incoterms
[] .price	Decimal	The price.
[] .currency	String	The price currency.
[] .salesPrice	Decimal	The sales price.
[] .salesPriceCurrency	String	The sales price currency.
[] .pickupDate	String	The booked pickup date
[] .trackingUrl	String	The tracking URL.
[] .shipmentStatus	BookingStatus	The shipment status
[] .shipmentStatus .statusCode	String	The status code.
[] .shipmentStatus .plannedDeliveryDate	String	The planned delivery date.	Format yyyy-MM-dd.
[] .shipmentStatus .plannedDeliveryTime	String	The planned delivery time.	Format HH:mm.
[] .packages	List	The list of packages
[] .packages[] .sequence	String	Shipment line sequence
[] .packages[] .lineNo	Integer	The lineno of the package.
[] .packages[] .shipmentLineId	String	The shipment line number for this package.
[] .packages[] .awb	String	Shipment line airwaybill
[] .packages[] .genericStatusCode	String	Shipment line status code
[] .packages[] .carrierStatusCode	String	Carrier shipment line status
[] .packages[] .carrierStatusDescription	String	Carrier shipment line status description
tariffLogs	List	List of tariff information of the shipment
tariffLogs.[] .tariffType	String	Tariff type.
tariffLogs.[] .tariffValue	String	Tariff value.
tariffLogs.[] .currency	String	Currency of the value.
tariffLogs.[] .chargeGroup	String	The charge group.
tariffLogs.[] .chargeType	String	The charge type.
tariffLogs.[] .calcType	String	The calculation type.

Path

Type

Description

Constraints

[]
.reference

String

Shipment reference.

[]
.awb

String

The airway bill number.

[]
.carrier

String

The carrier.

[]
.executingCarrier

String

The executing carrier.

[]
.pieces

Decimal

Number of packages

[]
.weight

Decimal

Shipment weight

[]
.service

String

The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU

[]
.serviceLevelTime

String

The used service level time.

[]
.serviceLevelOther

String

The used service level other.

[]
.incoterms

String

The incoterms

[]
.price

Decimal

The price.

[]
.currency

String

The price currency.

[]
.salesPrice

Decimal

The sales price.

[]
.salesPriceCurrency

String

The sales price currency.

[]
.pickupDate

String

The booked pickup date

[]
.trackingUrl

String

The tracking URL.

[]
.shipmentStatus

BookingStatus

The shipment status

[]
.shipmentStatus
.statusCode

String

The status code.

[]
.shipmentStatus
.plannedDeliveryDate

String

The planned delivery date.

Format yyyy-MM-dd.

[]
.shipmentStatus
.plannedDeliveryTime

String

The planned delivery time.

Format HH:mm.

[]
.packages

List

The list of packages

[]
.packages[]
.sequence

String

Shipment line sequence

[]
.packages[]
.lineNo

Integer

The lineno of the package.

[]
.packages[]
.shipmentLineId

String

The shipment line number for this package.

[]
.packages[]
.awb

String

Shipment line airwaybill

[]
.packages[]
.genericStatusCode

String

Shipment line status code

[]
.packages[]
.carrierStatusCode

String

Carrier shipment line status

[]
.packages[]
.carrierStatusDescription

String

Carrier shipment line status description

tariffLogs

List

List of tariff information of the shipment

tariffLogs.[]
.tariffType

String

Tariff type.

tariffLogs.[]
.tariffValue

String

Tariff value.

tariffLogs.[]
.currency

String

Currency of the value.

tariffLogs.[]
.chargeGroup

String

The charge group.

tariffLogs.[]
.chargeType

String

The charge type.

tariffLogs.[]
.calcType

String

The calculation type.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response `BOOK`

Click here to show/hide example

Update Shipment

Shipments can only be updated when there not in a final status.

Path parameters

Table 5. /v2/shipments/{account}
Parameter	Description
`account`	The account to which the shipment belongs.

Request structure book

Path	Type	Description	Constraints	Default
[] .reference	String	Shipment reference.	Not Null and not empty. The size must be between 1 and 32.
[] .description	String	The description.	Maximum size of 128.
[] .instruction	String	The instruction.	Maximum size of 256.
[] .loadmeters	Decimal	The load meters of the shipment. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
[] .pickupDate	String	The pickup date.	Format yyyy-MM-dd.	Depends on routing rules.
[] .pickupTime	String	The earliest pickup time.	Format HH:mm.	Depends on routing rules.
[] .pickupTimeTo	String	The latest shipment pickup time.	Format HH:mm.	Depends on routing rules.
[] .reference	String	Shipment reference.	Not Null and not empty. The size must be between 1 and 32.
[] .requestedDeliveryDate	String	The requested delivery date.	Format yyyy-MM-dd.	Depends on routing rules.
[] .requestedDeliveryTime	String	The requested earliest delivery time	Format HH:mm.	Depends on routing rules.
[] .requestedDeliveryTimeTo	String	The requested lates delivery time.	Format HH:mm.	Depends on routing rules.
[] .value	Decimal	The shipment monetary value. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99	0.00
[] .valueCurrency	String	The shipment monetary value currency.	Maximum size of 3.
[] .insurance	Boolean	Should this shipment be insured or is it insured		false
[] .additionalReferences	List	The additional references.
[] .additionalReferences.[] .type	String	The type of the additional reference.	Mandatory. Maximum size of 64.
[] .additionalReferences.[] .value	String	The additional reference.	Maximum size of 1024.

Path

Type

Description

Constraints

Default

[]
.reference

String

Shipment reference.

Not Null and not empty.
The size must be between 1 and 32.

[]
.description

String

The description.

Maximum size of 128.

[]
.instruction

String

The instruction.

Maximum size of 256.

[]
.loadmeters

Decimal

The load meters of the shipment. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

[]
.pickupDate

String

The pickup date.

Format yyyy-MM-dd.

Depends on routing rules.

[]
.pickupTime

String

The earliest pickup time.

Format HH:mm.

Depends on routing rules.

[]
.pickupTimeTo

String

The latest shipment pickup time.

Format HH:mm.

Depends on routing rules.

[]
.reference

String

Shipment reference.

Not Null and not empty.
The size must be between 1 and 32.

[]
.requestedDeliveryDate

String

The requested delivery date.

Format yyyy-MM-dd.

Depends on routing rules.

[]
.requestedDeliveryTime

String

The requested earliest delivery time

Format HH:mm.

Depends on routing rules.

[]
.requestedDeliveryTimeTo

String

The requested lates delivery time.

Format HH:mm.

Depends on routing rules.

[]
.value

Decimal

The shipment monetary value. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

0.00

[]
.valueCurrency

String

The shipment monetary value currency.

Maximum size of 3.

[]
.insurance

Boolean

Should this shipment be insured or is it insured

false

[]
.additionalReferences

List

The additional references.

[]
.additionalReferences.[]
.type

String

The type of the additional reference.

Mandatory.
Maximum size of 64.

[]
.additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

Response structure `BOOK`

Path	Type	Description	Constraints
[] .reference	String	Shipment reference.
[] .awb	String	The airway bill number.
[] .carrier	String	The carrier.
[] .executingCarrier	String	The executing carrier.
[] .pieces	Decimal	Number of packages
[] .weight	Decimal	Shipment weight
[] .service	String	The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU
[] .serviceLevelTime	String	The used service level time.
[] .serviceLevelOther	String	The used service level other.
[] .incoterms	String	The incoterms
[] .price	Decimal	The price.
[] .currency	String	The price currency.
[] .salesPrice	Decimal	The sales price.
[] .salesPriceCurrency	String	The sales price currency.
[] .pickupDate	String	The booked pickup date
[] .trackingUrl	String	The tracking URL.
[] .shipmentStatus	BookingStatus	The shipment status
[] .insurance	Boolean	Is this shipment insured.
[] .shipmentStatus .statusCode	String	The status code.
[] .shipmentStatus .plannedDeliveryDate	String	The planned delivery date.	Format yyyy-MM-dd.
[] .shipmentStatus .plannedDeliveryTime	String	The planned delivery time.	Format HH:mm.
[] .packages	List	The list of packages
[] .packages[] .sequence	String	Shipment line sequence
[] .packages[] .lineNo	Integer	The lineno of the package.
[] .packages[] .shipmentLineId	String	The shipment line number for this package.
[] .packages[] .awb	String	Shipment line airwaybill
[] .packages[] .genericStatusCode	String	Shipment line status code
[] .packages[] .carrierStatusCode	String	Carrier shipment line status
[] .packages[] .carrierStatusDescription	String	Carrier shipment line status description

Path

Type

Description

Constraints

[]
.reference

String

Shipment reference.

[]
.awb

String

The airway bill number.

[]
.carrier

String

The carrier.

[]
.executingCarrier

String

The executing carrier.

[]
.pieces

Decimal

Number of packages

[]
.weight

Decimal

Shipment weight

[]
.service

String

The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU

[]
.serviceLevelTime

String

The used service level time.

[]
.serviceLevelOther

String

The used service level other.

[]
.incoterms

String

The incoterms

[]
.price

Decimal

The price.

[]
.currency

String

The price currency.

[]
.salesPrice

Decimal

The sales price.

[]
.salesPriceCurrency

String

The sales price currency.

[]
.pickupDate

String

The booked pickup date

[]
.trackingUrl

String

The tracking URL.

[]
.shipmentStatus

BookingStatus

The shipment status

[]
.insurance

Boolean

Is this shipment insured.

[]
.shipmentStatus
.statusCode

String

The status code.

[]
.shipmentStatus
.plannedDeliveryDate

String

The planned delivery date.

Format yyyy-MM-dd.

[]
.shipmentStatus
.plannedDeliveryTime

String

The planned delivery time.

Format HH:mm.

[]
.packages

List

The list of packages

[]
.packages[]
.sequence

String

Shipment line sequence

[]
.packages[]
.lineNo

Integer

The lineno of the package.

[]
.packages[]
.shipmentLineId

String

The shipment line number for this package.

[]
.packages[]
.awb

String

Shipment line airwaybill

[]
.packages[]
.genericStatusCode

String

Shipment line status code

[]
.packages[]
.carrierStatusCode

String

Carrier shipment line status

[]
.packages[]
.carrierStatusDescription

String

Carrier shipment line status description

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

2.2 Shipment Retrieval

Shipments may be retrieved one-by-one (using the reference) or in paged batches.

Single shipment retrieval

A shipment is retrieved by its' reference which uniquely identifies it. By specified the client also the shipments of a child account can be retrieved.

Path parameters

Table 6. /v2/shipments/{account}/{reference}
Parameter	Description
`account`	Is the account to which the shipment belongs.
`reference`	Reference of shipment to be retrieved.

Response structure

Path	Type	Description	Constraints
reference	String	Shipment reference.	Not Null and not empty. The size must be between 1 and 32.
carrier	String	The carrier.	Fixed length of 3. Not Null and not empty.
carrierAccountNumber	String	The account number to be used for the carrier.	Maximum size of 32.
costCenter	String	The cost center.	Maximum size of 32.
mailType	Integer	The mail type.	Maximum value is 127.
language	String	The language.	Maximum size of 2.
selectedCarrier	String	The selected carrier.	Maximum size of 3.
executingCarrier	String	The carrier that executed the shipment.	Maximum size of 3.
airwayBillNumber	String	The airway bill number.	Maximum size of 32.
trackingAndTraceUrl	String	The track&trace url.	Maximum size of 2048.
description	String	The description.	Maximum size of 128.
instruction	String	The instruction.	Maximum size of 256.
value	Decimal	The shipment monetary value. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
valueCurrency	String	The shipment monetary value currency.	Maximum size of 3.
currency	String	General currency for shipment monetary fields.	Maximum size of 3.
spotPrice	Decimal	The spot price. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
spotPriceCurrency	String	The spot price currency.	Maximum size of 3.
price	Decimal	The cost price of the shipment. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
priceCurrency	String	The price currency.	Maximum size of 3.
salesPrice	Decimal	The shipment sales price. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
salesPriceCurrency	String	The sales price currency.	Maximum size of 3.
shipmentStatusCode	String	The status code. (NONE\|NEW\|LABL\|MANI\|ERR\|DEL\|REFU\|BOOK\|ONHOLD\|DONE\|TRNS)	Maximum size of 8.
pickupDate	String	The pickup date.	Format yyyy-MM-dd.
pickupTime	String	The earliest pickup time.	Format HH:mm.
pickupTimeTo	String	The latest shipment pickup time.	Format HH:mm.
requestedDeliveryDate	String	The requested delivery date.	Format yyyy-MM-dd.
requestedDeliveryTime	String	The requested earliest delivery time	Format HH:mm.
requestedDeliveryTimeTo	String	The requested lates delivery time.	Format HH:mm.
creationDate	String	The shipment’s creation date.
service	String	The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU	Maximum size of 16.
insurance	Boolean	Should this shipment be insured or is it insured
serviceLevelTime	String	The requested service level time.	Maximum size of 32. Not Null and not empty.
executedServiceLevelTime	String	The executed service level time, me by differend then the requested service level time because of routing rules.	Maximum size of 32.
serviceLevelOther	String	The service level other.	Maximum size of 256.
executedServiceLevelOther	String	The executed service level time, me by differend then the requested service level other because of routing rules.	Maximum size of 256.
incoterms	String	The inco terms.	Maximum size of 16.
inbound	Integer	Is this an outbound or inbound shipment (outbound= 0, inbound= 1).	Maximum value is 1. Minimum value is 0.
numberOfPackages	Integer		Maximum value is 32767.
loadmeters	Decimal	The load meters of the shipment. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
calculatedLoadmeters	Decimal	The calculated load meters of the shipment. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
calculatedWeight	Decimal	The calculated weight of the shipment. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
paymentTerms	String	The payment terms.	Maximum size of 32.
deliveryNoteInformation	Delivery note	The number of packages/collin in the shipment.
deliveryNoteInformation .deliveryNoteId	String	The identification for the delivery note.	Maximum size of 64.
deliveryNoteInformation .currency	String	The currency of the price.	Maximum size of 3.
deliveryNoteInformation .price	Decimal	Total price of the all deliverynote lines. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
deliveryNoteInformation .deliveryNoteLines	List	The deliverynote lines.
deliveryNoteInformation .deliveryNoteLines.[] .deliveryNoteId	String	The deliverynote id.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .lineNumber	Integer	The sequential line number.	Maximum value is 200000.
deliveryNoteInformation .deliveryNoteLines.[] .quantity	Integer	The quantity of products in the shipment.	Maximum value is 200000.
deliveryNoteInformation .deliveryNoteLines.[] .quantityUom	String	The quantity unit of measure (e.g. PCS,BOX etc).	Maximum size of 32.
deliveryNoteInformation .deliveryNoteLines.[] .quantityOrder	Integer	The quantity that is ordered.	Maximum value is 200000.
deliveryNoteInformation .deliveryNoteLines.[] .quantityBackorder	Integer	The quantity that is in back order.	Maximum value is 200000.
deliveryNoteInformation .deliveryNoteLines.[] .articleId	String	The article id.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .articleName	String	The article name.	Maximum size of 128.
deliveryNoteInformation .deliveryNoteLines.[] .description	String	The description of the article.	Maximum size of 256.
deliveryNoteInformation .deliveryNoteLines.[] .hsCode	String	The HS Code.	Maximum size of 25.
deliveryNoteInformation .deliveryNoteLines.[] .countryOrigin	String	The country of origin.	Maximum size of 3.
deliveryNoteInformation .deliveryNoteLines.[] .price	Decimal	The price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
deliveryNoteInformation .deliveryNoteLines.[] .goodsValue	Decimal	The value per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
deliveryNoteInformation .deliveryNoteLines.[] .currency	String	The currency of the price.	Maximum size of 3.
deliveryNoteInformation .deliveryNoteLines.[] .serialNumber	String	The serialnumber of the article.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .reasonOfExport	String	The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceDate	String	The date for on the proforma invoice.	Format yyyyMMdd.
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceNumber	String	The number for on the proforma invoice.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceLineNumber	String	The line number for on the proforma invoice.	Maximum size of 15.
deliveryNoteInformation .deliveryNoteLines.[] .quantityM2	Decimal	The quantity in cubic meters. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .customerOrder	String	The customer order.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .articleEanCode	String	The article’s ean code.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .quality	String	The quality of the article.	Maximum size of 64.
deliveryNoteInformation .deliveryNoteLines.[] .composition	String	The composition.	Maximum size of 128.
deliveryNoteInformation .deliveryNoteLines.[] .assemblyInstructions	String	The assembly instructions.	Maximum size of 65535.
deliveryNoteInformation .deliveryNoteLines.[] .grossWeight	Decimal	The gross weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .nettWeight	Decimal	The net weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .weightUom	String	The weight unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
deliveryNoteInformation .deliveryNoteLines.[] .hsCodeDescription	String	The HS Code description.	Maximum size of 128.
deliveryNoteInformation .deliveryNoteLines.[] .nettPrice	Decimal	The net price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceFreightCharges	Decimal	The freight charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceInsuranceCharges	Decimal	The insurance charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceDiscounts	Decimal	Thediscount for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
deliveryNoteInformation .deliveryNoteLines.[] .proformaInvoiceOtherCharges	Decimal	The other charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
measurements .length	Decimal	The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
measurements .width	Decimal	The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
measurements .height	Decimal	The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
measurements .weight	Decimal	The weight of the object (shipment, package, dangerous good). Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
measurements .linearUom	String	The linear unit of measure (e.g. CM, FT, IN, YD).	Maximum size of 3.
measurements .massUom	String	The mass unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
measurements .calculatedWeight	Decimal		Maximum value is 999,999,999.99 Minimum value is 0
measurements .calculatedWeightUom	String	The unit of measure for the calculated shipment weight.	Maximum size of 16.
additionalReferences	List	The additional references.
additionalReferences.[] .type	String	The type of the additional reference.	Mandatory. Maximum size of 64.
additionalReferences.[] .value	String	The additional reference.	Maximum size of 1024.
monetaryDetails	List	The monetary details.
monetaryDetails.[] .type	String	The type of the value.	Has to match pattern: (GOODS\| CUSTOMS\| INSURANCE\| COD\| FREIGHT\| TAXES\| DUTIES\| SPOTPRICE)
monetaryDetails.[] .value	Decimal	The value.
monetaryDetails.[] .currency	String	The currency of the value.	Maximum size of 3.
addresses	List	The addresses, the address indicates the type.
addresses.[] .type	String	The type of the address.	Has to match pattern: (SEND\| RECV\| INVC\| 3PTY\| SNDO\| RCVO) Maximum size of 4. Not Null and not empty.
addresses.[] .name	String	The name.	Maximum size of 64. Not Null and not empty.
addresses.[] .addressLine1	String	The first address line.	Maximum size of 64. Not Null and not empty.
addresses.[] .addressLine2	String	The second address line.	Maximum size of 64.
addresses.[] .addressLine3	String	The third address line.	Maximum size of 64.
addresses.[] .houseNo	String	The house number.	Maximum size of 16.
addresses.[] .city	String	The city.	Maximum size of 64. Not Null and not empty.
addresses.[] .zipCode	String	The zip code.	Maximum size of 16. Not Null and not empty.
addresses.[] .state	String	The state.	Maximum size of 16.
addresses.[] .country	String	The country code.	Maximum size of 3. Not Null and not empty.
addresses.[] .building	String	The building name.	Maximum size of 64.
addresses.[] .floor	String	The floor level.	Maximum size of 16.
addresses.[] .department	String	The department.	Maximum size of 64.
addresses.[] .doorcode	String	The doorcode.	Maximum size of 10.
addresses.[] .contact	String	The contact information.	Maximum size of 64.
addresses.[] .telNo	String	The phone number.	Maximum size of 32.
addresses.[] .faxNo	String	The fax number.	Maximum size of 32.
addresses.[] .email	String	The email address.	Maximum size of 256.
addresses.[] .accountNumber	String	The account number.	Maximum size of 32.
addresses.[] .customerNumber	String	The customer number.	Maximum size of 32.
addresses.[] .vatNumber	String	The vat number.	Maximum size of 32.
addresses.[] .residential	Boolean wrapped in Integer	Indicator for residential addresses.	Maximum value is 1. Minimum value is 0.
addresses.[] .contactDateOfBirth	String	Date of birth.	Has to match pattern: \d{4}-\d{2}-\d{2}\| ^$
addresses.[] .contactIdType	String	The document type whereby the contact will be identified.	Maximum size of 64.
addresses.[] .contactIdNumber	String	The unique number of the identification document.	Maximum size of 64.
addresses.[] .contactIdExpirationDate	String	The expiration date of the identification document.	Has to match pattern: \d{4}-\d{2}-\d{2}\| ^$\| BpI.*
addresses.[] .eoriNumber	String	The Economic Operators Registration and Identification number.	Has to match pattern: [A-Z]{2}[\w]{1,15}\| ^$
packages	List	The packages/collo.
packages.[] .lineNo	Integer	The line number for this package.	Maximum value is 2147483647.
packages.[] .shipmentLineId	String	The shipment line number for this package. In this field the SSCC code can be mapped.	Maximum size of 32.
packages.[] .airwaybillNumber	String	The package airway bill number.	Maximum size of 256.
packages.[] .packageType	String	The package type.	Maximum size of 16.
packages.[] .description	String	The description of the goods.	Maximum size of 128.
packages.[] .quantity	Integer	The quantity.	Mandatory. Maximum value is 127. Minimum value is 0.
packages.[] .stackable	Boolean	Is the package is stackable?
packages.[] .stackHeight	Integer	The stack height.	Maximum value is 32767.
packages.[] .additionalReferences	List	The additional reference.
packages.[] .additionalReferences.[] .type	String	The type of the additional reference.	Mandatory. Maximum size of 64.
packages.[] .additionalReferences.[] .value	String	The additional reference.	Maximum size of 1024.
packages.[] .monetaryDetails	List	The monetary details.
packages.[] .monetaryDetails.[] .type	String	The type of the value.	Has to match pattern: (GOODS\| CUSTOMS\| INSURANCE\| COD\| FREIGHT\| TAXES\| DUTIES\| SPOTPRICE)
packages.[] .monetaryDetails.[] .value	Decimal	The value.
packages.[] .monetaryDetails.[] .currency	String	The currency of the value.	Maximum size of 3.
packages.[] .deliveryNoteInfo	Delivery note	Delivery note information on collo level, please note to use either shipment level or package level (preferably package level), mixing both could end up in unwanted results to the carrier.
packages.[] .deliveryNoteInfo .deliveryNoteId	String	The identification for the delivery note.	Maximum size of 64.
packages.[] .deliveryNoteInfo .currency	String	The currency of the price.	Maximum size of 3.
packages.[] .deliveryNoteInfo .price	Decimal	Total price of the all deliverynote lines. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
packages.[] .deliveryNoteInfo .deliveryNoteLines	List	The deliverynote lines.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .deliveryNoteId	String	The deliverynote id.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .lineNumber	Integer	The sequential line number.	Maximum value is 200000.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantity	Integer	The quantity of products in the shipment.	Maximum value is 200000.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityUom	String	The quantity unit of measure (e.g. PCS,BOX etc).	Maximum size of 32.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityOrder	Integer	The quantity that is ordered.	Maximum value is 200000.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityBackorder	Integer	The quantity that is in back order.	Maximum value is 200000.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .articleId	String	The article id.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .articleName	String	The article name.	Maximum size of 128.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .description	String	The description of the article.	Maximum size of 256.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .hsCode	String	The HS Code.	Maximum size of 25.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .countryOrigin	String	The country of origin.	Maximum size of 3.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .price	Decimal	The price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .goodsValue	Decimal	The value per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .currency	String	The currency of the price.	Maximum size of 3.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .serialNumber	String	The serialnumber of the article.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .reasonOfExport	String	The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceDate	String	The date for on the proforma invoice.	Format yyyyMMdd.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceNumber	String	The number for on the proforma invoice.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceLineNumber	String	The line number for on the proforma invoice.	Maximum size of 15.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quantityM2	Decimal	The quantity in cubic meters. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .customerOrder	String	The customer order.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .articleEanCode	String	The article’s ean code.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .quality	String	The quality of the article.	Maximum size of 64.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .composition	String	The composition.	Maximum size of 128.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .assemblyInstructions	String	The assembly instructions.	Maximum size of 65535.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .grossWeight	Decimal	The gross weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .nettWeight	Decimal	The net weight per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .weightUom	String	The weight unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .hsCodeDescription	String	The HS Code description.	Maximum size of 128.
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .nettPrice	Decimal	The net price per article. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceFreightCharges	Decimal	The freight charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceInsuranceCharges	Decimal	The insurance charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceDiscounts	Decimal	Thediscount for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .deliveryNoteInfo .deliveryNoteLines.[] .proformaInvoiceOtherCharges	Decimal	The other charges for on the proforma invoice. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation	Dangerous goods	The dangerousgoods information.
packages.[] .dangerousGoodsInformation .dangerousGoodsGds	List	Dangerous goods gds, this object is currently obsolete.
packages.[] .dangerousGoodsInformation .dangerousGoods	List	The dangerous goods lines
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .idCode	String	The Id code.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .unCode	String	The Un code.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .unSubCode	String	The Un subcode.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingGroup	String	The packing group.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingType	String	The package type.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingClassification	String	The packing classification.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .packingInstruction	String	The packing instruction.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .quantity	Integer	The quantity.	Maximum value is 32767.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .description	String	The description.	Maximum size of 128.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .markingIdentifier	String	The marking identifier.	Maximum size of 64.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .limitedQuantity	Integer	The limited quantity.	Maximum value is 127.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .instruction	String	Instruction.	Maximum size of 128.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .limitedQuantityPoints	Integer	The limited quantity point.	Maximum value is 9999.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .tunnelCode	String	The tunnelcode.	Maximum size of 16.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .overpackID	String	The overpackID	Maximum size of 24.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .isHazardousSubstance	Boolean	Hazardous substance indicator.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .transportCategory	Integer	The transport category.	Maximum value is 2147483647.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .regulation	Regulation	The regulation details.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .regulation .level	String	The regulation level.	Maximum size of 2.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .regulation .type	String	The regulation type.	Maximum size of 5.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass	HazardClass	the hazard classification.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass .primary	String	The primary hazard class.	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass .secondary	String	The secondary hazard class.	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .hazardClass .tertiary	String	The tertiary hazard class.	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature	Temperature	The temperature.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .flashPoint	Decimal	The flash point.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .controlTemperature	Decimal	The control temperature.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .emergencyTemperature	Decimal	The emergency temperature.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .temperature .temperatureUom	String	The temperature units-of-measure.	Maximum size of 1.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .limitedQuantityPointsMultiplier	Integer	The limited quantity points multiplier.	Maximum value is 2147483647.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements	DangerousGoodsMeasurements	The measurements.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .length	Decimal	The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .width	Decimal	The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .height	Decimal	The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .linearUom	String	The linear unit of measure (e.g. CM, FT, IN, YD).	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .massUom	String	The mass unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .netExplosiveMassUom	String	The net explosive mass units-of-measure.	Maximum size of 2.
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .measurements .netExplosiveMass	Decimal	The net explosive mass.	Maximum value is 1,000,000,000 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .netWeight	Decimal	The nett weight. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .volume	Decimal	The volume. (Precision of 2)	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .dangerousGoodsInformation .dangerousGoods.[] .volumeUom	String	The volume units-of-measure.	Maximum size of 8.
packages.[] .measurements .length	Decimal	The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .measurements .width	Decimal	The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .measurements .height	Decimal	The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .measurements .weight	Decimal	The weight of the object (shipment, package, dangerous good). Max 2 decimals.	Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .measurements .calculatedWeight	Decimal		Maximum value is 999,999,999.99 Minimum value is 0
packages.[] .measurements .linearUom	String	The linear unit of measure (e.g. CM, FT, IN, YD).	Maximum size of 3.
packages.[] .measurements .massUom	String	The mass unit of measure (e.g. KG, LB, OZ).	Maximum size of 3.
packages.[] .measurements .calculatedWeightUom	String	The unit of measure for the calculated shipment weight.	Maximum size of 16.
tariffLog	List	The tariff log.
errorCode	Integer	The Error code in case a error occurred.
errorDescription	String	A description of the error, this can be a technical error in the request or a message while validating the shipment for the carrier’s requirements, or a message directly from the carrier while booking.

Path

Type

Description

Constraints

reference

String

Shipment reference.

Not Null and not empty.
The size must be between 1 and 32.

carrier

String

The carrier.

Fixed length of 3.
Not Null and not empty.

carrierAccountNumber

String

The account number to be used for the carrier.

Maximum size of 32.

costCenter

String

The cost center.

Maximum size of 32.

mailType

Integer

The mail type.

Maximum value is 127.

language

String

The language.

Maximum size of 2.

selectedCarrier

String

The selected carrier.

Maximum size of 3.

executingCarrier

String

The carrier that executed the shipment.

Maximum size of 3.

airwayBillNumber

String

The airway bill number.

Maximum size of 32.

trackingAndTraceUrl

String

The track&trace url.

Maximum size of 2048.

description

String

The description.

Maximum size of 128.

instruction

String

The instruction.

Maximum size of 256.

value

Decimal

The shipment monetary value. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

valueCurrency

String

The shipment monetary value currency.

Maximum size of 3.

currency

String

General currency for shipment monetary fields.

Maximum size of 3.

spotPrice

Decimal

The spot price. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

spotPriceCurrency

String

The spot price currency.

Maximum size of 3.

price

Decimal

The cost price of the shipment. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

priceCurrency

String

The price currency.

Maximum size of 3.

salesPrice

Decimal

The shipment sales price. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

salesPriceCurrency

String

The sales price currency.

Maximum size of 3.

shipmentStatusCode

String

Maximum size of 8.

pickupDate

String

The pickup date.

Format yyyy-MM-dd.

pickupTime

String

The earliest pickup time.

Format HH:mm.

pickupTimeTo

String

The latest shipment pickup time.

Format HH:mm.

requestedDeliveryDate

String

The requested delivery date.

Format yyyy-MM-dd.

requestedDeliveryTime

String

The requested earliest delivery time

Format HH:mm.

requestedDeliveryTimeTo

String

The requested lates delivery time.

Format HH:mm.

creationDate

String

The shipment’s creation date.

service

String

The service: example NON-DOCS/DOCS >> may indicate if a shipment goes out of the EU

Maximum size of 16.

insurance

Boolean

Should this shipment be insured or is it insured

serviceLevelTime

String

The requested service level time.

Maximum size of 32.
Not Null and not empty.

executedServiceLevelTime

String

The executed service level time, me by differend then the requested service level time because of routing rules.

Maximum size of 32.

serviceLevelOther

String

The service level other.

Maximum size of 256.

executedServiceLevelOther

String

The executed service level time, me by differend then the requested service level other because of routing rules.

Maximum size of 256.

incoterms

String

The inco terms.

Maximum size of 16.

inbound

Integer

Is this an outbound or inbound shipment (outbound= 0, inbound= 1).

Maximum value is 1.
Minimum value is 0.

numberOfPackages

Integer

Maximum value is 32767.

loadmeters

Decimal

The load meters of the shipment. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

calculatedLoadmeters

Decimal

The calculated load meters of the shipment. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

calculatedWeight

Decimal

The calculated weight of the shipment. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

paymentTerms

String

The payment terms.

Maximum size of 32.

deliveryNoteInformation

Delivery note

The number of packages/collin in the shipment.

deliveryNoteInformation
.deliveryNoteId

String

The identification for the delivery note.

Maximum size of 64.

deliveryNoteInformation
.currency

String

The currency of the price.

Maximum size of 3.

deliveryNoteInformation
.price

Decimal

Total price of the all deliverynote lines. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

deliveryNoteInformation
.deliveryNoteLines

List

The deliverynote lines.

deliveryNoteInformation
.deliveryNoteLines.[]
.deliveryNoteId

String

The deliverynote id.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.lineNumber

Integer

The sequential line number.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantity

Integer

The quantity of products in the shipment.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityUom

String

The quantity unit of measure (e.g. PCS,BOX etc).

Maximum size of 32.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityOrder

Integer

The quantity that is ordered.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityBackorder

Integer

The quantity that is in back order.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleId

String

The article id.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleName

String

The article name.

Maximum size of 128.

deliveryNoteInformation
.deliveryNoteLines.[]
.description

String

The description of the article.

Maximum size of 256.

deliveryNoteInformation
.deliveryNoteLines.[]
.hsCode

String

The HS Code.

Maximum size of 25.

deliveryNoteInformation
.deliveryNoteLines.[]
.countryOrigin

String

The country of origin.

Maximum size of 3.

deliveryNoteInformation
.deliveryNoteLines.[]
.price

Decimal

The price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

deliveryNoteInformation
.deliveryNoteLines.[]
.goodsValue

Decimal

The value per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

deliveryNoteInformation
.deliveryNoteLines.[]
.currency

String

The currency of the price.

Maximum size of 3.

deliveryNoteInformation
.deliveryNoteLines.[]
.serialNumber

String

The serialnumber of the article.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.reasonOfExport

String

The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceDate

String

The date for on the proforma invoice.

Format yyyyMMdd.

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceNumber

String

The number for on the proforma invoice.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceLineNumber

String

The line number for on the proforma invoice.

Maximum size of 15.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityM2

Decimal

The quantity in cubic meters. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.customerOrder

String

The customer order.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleEanCode

String

The article’s ean code.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.quality

String

The quality of the article.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.composition

String

The composition.

Maximum size of 128.

deliveryNoteInformation
.deliveryNoteLines.[]
.assemblyInstructions

String

The assembly instructions.

Maximum size of 65535.

deliveryNoteInformation
.deliveryNoteLines.[]
.grossWeight

Decimal

The gross weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.nettWeight

Decimal

The net weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

deliveryNoteInformation
.deliveryNoteLines.[]
.hsCodeDescription

String

The HS Code description.

Maximum size of 128.

deliveryNoteInformation
.deliveryNoteLines.[]
.nettPrice

Decimal

The net price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceFreightCharges

Decimal

The freight charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceInsuranceCharges

Decimal

The insurance charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceDiscounts

Decimal

Thediscount for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceOtherCharges

Decimal

The other charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.length

Decimal

The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.width

Decimal

The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.height

Decimal

The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.weight

Decimal

The weight of the object (shipment, package, dangerous good). Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.linearUom

String

The linear unit of measure (e.g. CM, FT, IN, YD).

Maximum size of 3.

measurements
.massUom

String

The mass unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

measurements
.calculatedWeight

Decimal

Maximum value is 999,999,999.99
Minimum value is 0

measurements
.calculatedWeightUom

String

The unit of measure for the calculated shipment weight.

Maximum size of 16.

additionalReferences

List

The additional references.

additionalReferences.[]
.type

String

The type of the additional reference.

Mandatory.
Maximum size of 64.

additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

monetaryDetails

List

The monetary details.

monetaryDetails.[]
.type

String

The type of the value.

monetaryDetails.[]
.value

Decimal

The value.

monetaryDetails.[]
.currency

String

The currency of the value.

Maximum size of 3.

addresses

List

The addresses, the address indicates the type.

addresses.[]
.type

String

The type of the address.

addresses.[]
.name

String

The name.

Maximum size of 64.
Not Null and not empty.

addresses.[]
.addressLine1

String

The first address line.

Maximum size of 64.
Not Null and not empty.

addresses.[]
.addressLine2

String

The second address line.

Maximum size of 64.

addresses.[]
.addressLine3

String

The third address line.

Maximum size of 64.

addresses.[]
.houseNo

String

The house number.

Maximum size of 16.

addresses.[]
.city

String

The city.

Maximum size of 64.
Not Null and not empty.

addresses.[]
.zipCode

String

The zip code.

Maximum size of 16.
Not Null and not empty.

addresses.[]
.state

String

The state.

Maximum size of 16.

addresses.[]
.country

String

The country code.

Maximum size of 3.
Not Null and not empty.

addresses.[]
.building

String

The building name.

Maximum size of 64.

addresses.[]
.floor

String

The floor level.

Maximum size of 16.

addresses.[]
.department

String

The department.

Maximum size of 64.

addresses.[]
.doorcode

String

The doorcode.

Maximum size of 10.

addresses.[]
.contact

String

The contact information.

Maximum size of 64.

addresses.[]
.telNo

String

The phone number.

Maximum size of 32.

addresses.[]
.faxNo

String

The fax number.

Maximum size of 32.

addresses.[]
.email

String

The email address.

Maximum size of 256.

addresses.[]
.accountNumber

String

The account number.

Maximum size of 32.

addresses.[]
.customerNumber

String

The customer number.

Maximum size of 32.

addresses.[]
.vatNumber

String

The vat number.

Maximum size of 32.

addresses.[]
.residential

Boolean wrapped in Integer

Indicator for residential addresses.

Maximum value is 1.
Minimum value is 0.

addresses.[]
.contactDateOfBirth

String

Date of birth.

Has to match pattern: \d{4}-\d{2}-\d{2}|
^$

addresses.[]
.contactIdType

String

The document type whereby the contact will be identified.

Maximum size of 64.

addresses.[]
.contactIdNumber

String

The unique number of the identification document.

Maximum size of 64.

addresses.[]
.contactIdExpirationDate

String

The expiration date of the identification document.

Has to match pattern: \d{4}-\d{2}-\d{2}|
^$|
BpI.*

addresses.[]
.eoriNumber

String

The Economic Operators Registration and Identification number.

Has to match pattern: [A-Z]{2}[\w]{1,15}|
^$

packages

List

The packages/collo.

packages.[]
.lineNo

Integer

The line number for this package.

Maximum value is 2147483647.

packages.[]
.shipmentLineId

String

The shipment line number for this package. In this field the SSCC code can be mapped.

Maximum size of 32.

packages.[]
.airwaybillNumber

String

The package airway bill number.

Maximum size of 256.

packages.[]
.packageType

String

The package type.

Maximum size of 16.

packages.[]
.description

String

The description of the goods.

Maximum size of 128.

packages.[]
.quantity

Integer

The quantity.

Mandatory.
Maximum value is 127.
Minimum value is 0.

packages.[]
.stackable

Boolean

Is the package is stackable?

packages.[]
.stackHeight

Integer

The stack height.

Maximum value is 32767.

packages.[]
.additionalReferences

List

The additional reference.

packages.[]
.additionalReferences.[]
.type

String

The type of the additional reference.

Mandatory.
Maximum size of 64.

packages.[]
.additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

packages.[]
.monetaryDetails

List

The monetary details.

packages.[]
.monetaryDetails.[]
.type

String

The type of the value.

packages.[]
.monetaryDetails.[]
.value

Decimal

The value.

packages.[]
.monetaryDetails.[]
.currency

String

The currency of the value.

Maximum size of 3.

packages.[]
.deliveryNoteInfo

Delivery note

Delivery note information on collo level, please note to use either shipment level or package level (preferably package level), mixing both could end up in unwanted results to the carrier.

packages.[]
.deliveryNoteInfo
.deliveryNoteId

String

The identification for the delivery note.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.currency

String

The currency of the price.

Maximum size of 3.

packages.[]
.deliveryNoteInfo
.price

Decimal

Total price of the all deliverynote lines. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

packages.[]
.deliveryNoteInfo
.deliveryNoteLines

List

The deliverynote lines.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.deliveryNoteId

String

The deliverynote id.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.lineNumber

Integer

The sequential line number.

Maximum value is 200000.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantity

Integer

The quantity of products in the shipment.

Maximum value is 200000.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityUom

String

The quantity unit of measure (e.g. PCS,BOX etc).

Maximum size of 32.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityOrder

Integer

The quantity that is ordered.

Maximum value is 200000.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityBackorder

Integer

The quantity that is in back order.

Maximum value is 200000.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleId

String

The article id.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleName

String

The article name.

Maximum size of 128.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.description

String

The description of the article.

Maximum size of 256.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.hsCode

String

The HS Code.

Maximum size of 25.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.countryOrigin

String

The country of origin.

Maximum size of 3.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.price

Decimal

The price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.goodsValue

Decimal

The value per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.currency

String

The currency of the price.

Maximum size of 3.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.serialNumber

String

The serialnumber of the article.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.reasonOfExport

String

The reason of export. The following values are advised to use: Gift, Intercompany data, Sale, Sample, Repair, Return, Other.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceDate

String

The date for on the proforma invoice.

Format yyyyMMdd.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceNumber

String

The number for on the proforma invoice.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceLineNumber

String

The line number for on the proforma invoice.

Maximum size of 15.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quantityM2

Decimal

The quantity in cubic meters. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.customerOrder

String

The customer order.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleEanCode

String

The article’s ean code.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.quality

String

The quality of the article.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.composition

String

The composition.

Maximum size of 128.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.assemblyInstructions

String

The assembly instructions.

Maximum size of 65535.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.grossWeight

Decimal

The gross weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.nettWeight

Decimal

The net weight per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.hsCodeDescription

String

The HS Code description.

Maximum size of 128.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.nettPrice

Decimal

The net price per article. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceFreightCharges

Decimal

The freight charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceInsuranceCharges

Decimal

The insurance charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceDiscounts

Decimal

Thediscount for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.proformaInvoiceOtherCharges

Decimal

The other charges for on the proforma invoice. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation

Dangerous goods

The dangerousgoods information.

packages.[]
.dangerousGoodsInformation
.dangerousGoodsGds

List

Dangerous goods gds, this object is currently obsolete.

packages.[]
.dangerousGoodsInformation
.dangerousGoods

List

The dangerous goods lines

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.idCode

String

The Id code.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.unCode

String

The Un code.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.unSubCode

String

The Un subcode.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingGroup

String

The packing group.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingType

String

The package type.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingClassification

String

The packing classification.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.packingInstruction

String

The packing instruction.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.quantity

Integer

The quantity.

Maximum value is 32767.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.description

String

The description.

Maximum size of 128.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.markingIdentifier

String

The marking identifier.

Maximum size of 64.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.limitedQuantity

Integer

The limited quantity.

Maximum value is 127.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.instruction

String

Instruction.

Maximum size of 128.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.limitedQuantityPoints

Integer

The limited quantity point.

Maximum value is 9999.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.tunnelCode

String

The tunnelcode.

Maximum size of 16.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.overpackID

String

The overpackID

Maximum size of 24.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.isHazardousSubstance

Boolean

Hazardous substance indicator.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.transportCategory

Integer

The transport category.

Maximum value is 2147483647.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.regulation

Regulation

The regulation details.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.regulation
.level

String

The regulation level.

Maximum size of 2.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.regulation
.type

String

The regulation type.

Maximum size of 5.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass

HazardClass

the hazard classification.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass
.primary

String

The primary hazard class.

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass
.secondary

String

The secondary hazard class.

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.hazardClass
.tertiary

String

The tertiary hazard class.

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature

Temperature

The temperature.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.flashPoint

Decimal

The flash point.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.controlTemperature

Decimal

The control temperature.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.emergencyTemperature

Decimal

The emergency temperature.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.temperature
.temperatureUom

String

The temperature units-of-measure.

Maximum size of 1.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.limitedQuantityPointsMultiplier

Integer

The limited quantity points multiplier.

Maximum value is 2147483647.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements

DangerousGoodsMeasurements

The measurements.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.length

Decimal

The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.width

Decimal

The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.height

Decimal

The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.linearUom

String

The linear unit of measure (e.g. CM, FT, IN, YD).

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.massUom

String

The mass unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.netExplosiveMassUom

String

The net explosive mass units-of-measure.

Maximum size of 2.

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.measurements
.netExplosiveMass

Decimal

The net explosive mass.

Maximum value is 1,000,000,000
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.netWeight

Decimal

The nett weight. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.volume

Decimal

The volume. (Precision of 2)

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.dangerousGoodsInformation
.dangerousGoods.[]
.volumeUom

String

The volume units-of-measure.

Maximum size of 8.

packages.[]
.measurements
.length

Decimal

The length of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.measurements
.width

Decimal

The width of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.measurements
.height

Decimal

The height of the object (package, dangerous good). Is ignored when used on shipment level. Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.measurements
.weight

Decimal

The weight of the object (shipment, package, dangerous good). Max 2 decimals.

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.measurements
.calculatedWeight

Decimal

Maximum value is 999,999,999.99
Minimum value is 0

packages.[]
.measurements
.linearUom

String

The linear unit of measure (e.g. CM, FT, IN, YD).

Maximum size of 3.

packages.[]
.measurements
.massUom

String

The mass unit of measure (e.g. KG, LB, OZ).

Maximum size of 3.

packages.[]
.measurements
.calculatedWeightUom

String

The unit of measure for the calculated shipment weight.

Maximum size of 16.

tariffLog

List

The tariff log.

errorCode

Integer

The Error code in case a error occurred.

errorDescription

String

A description of the error, this can be a technical error in the request or a message while validating the shipment for the carrier’s requirements, or a message directly from the carrier while booking.

Response structure not existing shipment

Path	Type	Description
status	HttpStatus	The status of the error, e.g. BAD_REQUEST or INTERNAL_SERVER_ERROR.
timestamp	String	The actual timestamp when the error was raised.
description	String	The description given either by the carrier or by Transsmart
code	String	The Transsmart internal error code, e.g. TS50001
message	String	The message given either by the carrier or by Transsmart

Path

Type

Description

Constraints

status

HttpStatus

The status of the error, e.g. BAD_REQUEST or INTERNAL_SERVER_ERROR.

timestamp

String

The actual timestamp when the error was raised.

description

String

The description given either by the carrier or by Transsmart

code

String

The Transsmart internal error code, e.g. TS50001

message

String

The message given either by the carrier or by Transsmart

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 10888

{
  "reference" : "Transsmart_1690195353897",
  "carrier" : "DPD",
  "carrierAccountNumber" : "48389",
  "costCenter" : "",
  "mailType" : 1,
  "language" : "NL",
  "selectedCarrier" : "DPD",
  "executingCarrier" : "DPD",
  "airwayBillNumber" : "05228021367613",
  "trackingAndTraceUrl" : "https://tracking.dpd.de/parcelstatus?query=MPS0522802136761320230724&locale=nl_NL&Tracking=Track",
  "description" : "example-description",
  "instruction" : "example-instruction1",
  "value" : 10.0,
  "valueCurrency" : "EUR",
  "currency" : "EUR",
  "spotPrice" : 15.0,
  "spotPriceCurrency" : "EUR",
  "price" : 15.0,
  "priceCurrency" : "EUR",
  "salesPrice" : 0.0,
  "salesPriceCurrency" : "",
  "shipmentStatusCode" : "NEW",
  "pickupDate" : "2023-07-24",
  "pickupTime" : "08:00",
  "pickupTimeTo" : "10:00",
  "requestedDeliveryDate" : "2023-07-27",
  "requestedDeliveryTime" : "15:00",
  "requestedDeliveryTimeTo" : "17:00",
  "paymentTerms" : "paymentTerms",
  "creationDate" : "2023-07-24 12:42:34",
  "service" : "NON-DOCS",
  "serviceLevelTime" : "CLASSIC",
  "executedServiceLevelTime" : "CLASSIC",
  "serviceLevelOther" : "",
  "executedServiceLevelOther" : "",
  "incoterms" : "DAP",
  "inbound" : 0,
  "loadmeters" : 0.41,
  "calculatedLoadmeters" : 0.41,
  "calculatedWeight" : 40.0,
  "numberOfPackages" : 2,
  "insurance" : false,
  "measurements" : {
    "length" : 0.0,
    "width" : 0.0,
    "height" : 0.0,
    "weight" : 40.0,
    "linearUom" : "CM",
    "massUom" : "KG"
  },
  "tariffLog" : [ ],
  "additionalReferences" : [ {
    "type" : "ENGINEER",
    "value" : "example-engineer-additional-value-shipment-level"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  } ],
  "addresses" : [ {
    "type" : "INVC",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0,
    "contactDateOfBirth" : "",
    "contactIdType" : "",
    "contactIdNumber" : "",
    "contactIdExpirationDate" : "",
    "building" : "",
    "floor" : "",
    "department" : "",
    "doorcode" : ""
  }, {
    "type" : "RECV",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0,
    "contactDateOfBirth" : "1999-01-01",
    "contactIdType" : "type",
    "contactIdNumber" : "BpI0tLBNz31IP5wWS3mNgHS5ascw+/WuzCnK02L4kqW9NFdPU0OxLed4EUjF7WRKBBg0MUJ627U0i+xXmCHXqg==",
    "contactIdExpirationDate" : "BpI0tLBNz31IP5wWS3mNgHS5ascw+/WuzCnK02L4kqVOFWf0SJAsjF5fJ95pIUVP2tePhkzHz/xuwqkZzYoWT6h4jtw3YW9k+L0Fhar0jbM=",
    "eoriNumber" : "NL4321",
    "building" : "",
    "floor" : "",
    "department" : "",
    "doorcode" : ""
  }, {
    "type" : "SEND",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNo" : "1c",
    "addressLine2" : "2nd floor",
    "addressLine3" : "att. Support",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "state" : "",
    "country" : "NL",
    "contact" : "Support",
    "telNo" : "0031881260300",
    "faxNo" : "0031881260301",
    "email" : "example@domain.com",
    "accountNumber" : "example-accountNumber",
    "customerNumber" : "example-customerNumber",
    "vatNumber" : "example-vatNumber",
    "residential" : 0,
    "contactDateOfBirth" : "",
    "contactIdType" : "",
    "contactIdNumber" : "",
    "contactIdExpirationDate" : "",
    "building" : "",
    "floor" : "",
    "department" : "",
    "doorcode" : ""
  } ],
  "packages" : [ {
    "lineNo" : 1,
    "shipmentLineId" : "example-shippmentLineId",
    "airwaybillNumber" : "05228021367613",
    "packageType" : "BOX",
    "description" : "example-description",
    "quantity" : 1,
    "stackable" : true,
    "stackHeight" : 1,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "monetaryDetails" : [ ],
    "deliveryNoteInfo" : {
      "deliveryNoteId" : "0987654321",
      "currency" : "EUR",
      "price" : 16.0,
      "deliveryNoteLines" : [ {
        "deliveryNoteId" : "09876543210987654321",
        "lineNumber" : 1,
        "quantity" : 1,
        "quantityUom" : "PCS",
        "quantityOrder" : 1,
        "quantityBackorder" : 0,
        "articleId" : "example-articleId",
        "articleName" : "example-articleName",
        "description" : "example-articleDescription",
        "hsCode" : "example-hsCode",
        "countryOrigin" : "NL",
        "price" : 16.0,
        "goodsValue" : 1.0,
        "currency" : "EUR",
        "serialNumber" : "example-serialNumber",
        "reasonOfExport" : "example-reasonOfExport",
        "proformaInvoiceDate" : "20171121",
        "proformaInvoiceNumber" : "TS0987654321",
        "proformaInvoiceLineNumber" : "L2",
        "quantityM2" : 1.0,
        "customerOrder" : "example-customerOrder",
        "articleEanCode" : "example-articleEanCode",
        "quality" : "example-quality",
        "composition" : "example-composition",
        "assemblyInstructions" : "example-assemblyInstructions",
        "grossWeight" : 20.0,
        "nettWeight" : 18.0,
        "weightUom" : "KG",
        "hsCodeDescription" : "example-hsCodeDescription",
        "nettPrice" : 15.0,
        "proformaInvoiceFreightCharges" : 20.0,
        "proformaInvoiceInsuranceCharges" : 2.0,
        "proformaInvoiceDiscounts" : 2.0,
        "proformaInvoiceOtherCharges" : 2.0
      } ]
    },
    "dangerousGoodsInformation" : {
      "dangerousGoods" : [ {
        "idCode" : "idCode",
        "unCode" : "1234",
        "unSubCode" : "1",
        "packingGroup" : "I",
        "regulation" : { },
        "hazardClass" : { },
        "packingType" : "CAN",
        "packingClassification" : "1.2",
        "packingInstruction" : "packingInstruction",
        "isHazardousSubstance" : false,
        "quantity" : 1,
        "description" : "description",
        "markingIdentifier" : "3",
        "transportCategory" : 0,
        "limitedQuantity" : 0,
        "instruction" : "instruction",
        "temperature" : { },
        "limitedQuantityPoints" : 850,
        "limitedQuantityPointsMultiplier" : 0,
        "tunnelCode" : "C/D",
        "overpackID" : "1of1",
        "measurements" : {
          "length" : 8.0,
          "width" : 8.0,
          "height" : 8.0,
          "linearUom" : "CM",
          "massUom" : "KG"
        },
        "netWeight" : 7.5,
        "volume" : 0.51,
        "volumeUom" : "L"
      } ],
      "dangerousGoodsGds" : [ ]
    },
    "measurements" : {
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "weight" : 20.0,
      "linearUom" : "CM",
      "massUom" : "KG",
      "calculatedWeight" : 0
    }
  }, {
    "lineNo" : 2,
    "shipmentLineId" : "example-shippmentLineId",
    "airwaybillNumber" : "05228021367614",
    "packageType" : "BOX",
    "description" : "example-description",
    "quantity" : 1,
    "stackable" : true,
    "stackHeight" : 1,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "monetaryDetails" : [ ],
    "deliveryNoteInfo" : {
      "deliveryNoteId" : "0987654321",
      "currency" : "EUR",
      "price" : 16.0,
      "deliveryNoteLines" : [ {
        "deliveryNoteId" : "09876543210987654321",
        "lineNumber" : 1,
        "quantity" : 1,
        "quantityUom" : "PCS",
        "quantityOrder" : 1,
        "quantityBackorder" : 0,
        "articleId" : "example-articleId",
        "articleName" : "example-articleName",
        "description" : "example-articleDescription",
        "hsCode" : "example-hsCode",
        "countryOrigin" : "NL",
        "price" : 16.0,
        "goodsValue" : 1.0,
        "currency" : "EUR",
        "serialNumber" : "example-serialNumber",
        "reasonOfExport" : "example-reasonOfExport",
        "proformaInvoiceDate" : "20171121",
        "proformaInvoiceNumber" : "TS0987654321",
        "proformaInvoiceLineNumber" : "L2",
        "quantityM2" : 1.0,
        "customerOrder" : "example-customerOrder",
        "articleEanCode" : "example-articleEanCode",
        "quality" : "example-quality",
        "composition" : "example-composition",
        "assemblyInstructions" : "example-assemblyInstructions",
        "grossWeight" : 20.0,
        "nettWeight" : 18.0,
        "weightUom" : "KG",
        "hsCodeDescription" : "example-hsCodeDescription",
        "nettPrice" : 15.0,
        "proformaInvoiceFreightCharges" : 20.0,
        "proformaInvoiceInsuranceCharges" : 2.0,
        "proformaInvoiceDiscounts" : 2.0,
        "proformaInvoiceOtherCharges" : 2.0
      } ]
    },
    "dangerousGoodsInformation" : {
      "dangerousGoods" : [ {
        "idCode" : "idCode",
        "unCode" : "1234",
        "unSubCode" : "1",
        "packingGroup" : "I",
        "regulation" : { },
        "hazardClass" : { },
        "packingType" : "CAN",
        "packingClassification" : "1.2",
        "packingInstruction" : "packingInstruction",
        "isHazardousSubstance" : false,
        "quantity" : 1,
        "description" : "description",
        "markingIdentifier" : "3",
        "transportCategory" : 0,
        "limitedQuantity" : 0,
        "instruction" : "instruction",
        "temperature" : { },
        "limitedQuantityPoints" : 850,
        "limitedQuantityPointsMultiplier" : 0,
        "tunnelCode" : "C/D",
        "overpackID" : "1of1",
        "measurements" : {
          "length" : 8.0,
          "width" : 8.0,
          "height" : 8.0,
          "linearUom" : "CM",
          "massUom" : "KG"
        },
        "netWeight" : 7.5,
        "volume" : 0.51,
        "volumeUom" : "L"
      } ],
      "dangerousGoodsGds" : [ ]
    },
    "measurements" : {
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "weight" : 20.0,
      "linearUom" : "CM",
      "massUom" : "KG",
      "calculatedWeight" : 0
    }
  } ],
  "monetaryDetails" : [ {
    "type" : "GOODS",
    "value" : 2.0,
    "currency" : "EUR"
  } ],
  "errorCode" : 0
}

Example response not existing shipment

Click here to show/hide example

Multiple shipments retrieval.

If no reference is specified all shipments for the specified client are retrieved. If a referenceType is specifed a list of shipments is returned that have a additional reference with the value as specified in reference. Pagination is used to restrict the amount of data per page. In the example below a page size of 2 is used.

Path parameters

Table 7. /v2/shipments/{account}
Parameter	Description
`account`	The account to which the shipment belongs.

Request parameters

Parameter	Description	Constraints
reference	The reference wildcard. Optional	Default is all reference
referenceType	If the reference type is specified the additional reference of the shipment is searched. Optional	Default is shipment reference
carrierCode	Effective when extended is set to true, filters response by specified carriers . Optional	Default is all applicable carriers
accountCode	Effective when extended is set to true, filters response by specified sub-account codes. Optional	Default is currect account and all its sub-accounts
costCenter	Effective when extended is set to true, filters response by specified costceters. Optional	Default is all cost centers
createdFrom	Effective when extended is set to true, lower range of the date and time of creation for the shipments to be retrieved. Optional	Default is current time
createdTo	Effective when extended is set to true, upper range of the date and time of creation for the shipments to be retrieved. Optional	Default is current time minus 1 hour
extended	Flag to turn on the extended shipment retrieval. Optional	Default is false
pickUpDateFrom	The pickup date from. Optional	Default is all dates
pickUpDateTo	The pickup date to. Optional	Default is all dates
page	The desired page.	Default is 1.
size	The amount of items per page.	Default is 20.

Parameter

Description

Constraints

reference

The reference wildcard. Optional

Default is all reference

referenceType

If the reference type is specified the additional reference of the shipment is searched. Optional

Default is shipment reference

carrierCode

Effective when extended is set to true, filters response by specified carriers . Optional

Default is all applicable carriers

accountCode

Effective when extended is set to true, filters response by specified sub-account codes. Optional

Default is currect account and all its sub-accounts

costCenter

Effective when extended is set to true, filters response by specified costceters. Optional

Default is all cost centers

createdFrom

Effective when extended is set to true, lower range of the date and time of creation for the shipments to be retrieved. Optional

Default is current time

createdTo

Effective when extended is set to true, upper range of the date and time of creation for the shipments to be retrieved. Optional

Default is current time minus 1 hour

extended

Flag to turn on the extended shipment retrieval. Optional

Default is false

pickUpDateFrom

The pickup date from. Optional

Default is all dates

pickUpDateTo

The pickup date to. Optional

Default is all dates

page

The desired page.

Default is 1.

size

The amount of items per page.

Default is 20.

Response structure

Path	Type	Description	Constraints
content	Object	The content of this page.
content.[] .reference	String	Shipment reference, the remaining shipment structure is the same as retrieving one shipment, for description see that section.	Not Null and not empty. The size must be between 1 and 32.
contentType	String
pageSize	Integer	The amount of items per page.
currentPage	Integer	The current page.
totalPages	Integer	Total amount of pages.
totalItems	Integer	Total amount of items.
numberOfItems	Integer	Number of items in this page.
isLastPage	Boolean	Indicates if this is the last page.
isFirstPage	Boolean	Indicates if this is the first page.

Path

Type

Description

Constraints

content

Object

The content of this page.

content.[]
.reference

String

Shipment reference, the remaining shipment structure is the same as retrieving one shipment, for description see that section.

Not Null and not empty.
The size must be between 1 and 32.

contentType

String

pageSize

Integer

The amount of items per page.

currentPage

Integer

The current page.

totalPages

Integer

Total amount of pages.

totalItems

Integer

Total amount of items.

numberOfItems

Integer

Number of items in this page.

isLastPage

Boolean

Indicates if this is the last page.

isFirstPage

Boolean

Indicates if this is the first page.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 23427

{
  "content" : [ {
    "reference" : "Transsmart_1672743257555",
    "carrier" : "DPD",
    "carrierAccountNumber" : "48389",
    "costCenter" : "",
    "mailType" : 1,
    "language" : "NL",
    "selectedCarrier" : "DPD",
    "executingCarrier" : "DPD",
    "airwayBillNumber" : "05228021357098",
    "trackingAndTraceUrl" : "https://tracking.dpd.de/parcelstatus?query=MPS0522802135709820230103&locale=nl_NL&Tracking=Track",
    "description" : "example-description",
    "instruction" : "example-instruction1",
    "value" : 10.0,
    "valueCurrency" : "EUR",
    "currency" : "EUR",
    "spotPrice" : 15.0,
    "spotPriceCurrency" : "EUR",
    "price" : 15.0,
    "priceCurrency" : "EUR",
    "salesPrice" : 0.0,
    "salesPriceCurrency" : "",
    "shipmentStatusCode" : "DEL",
    "pickupDate" : "2023-01-03",
    "pickupTime" : "08:00",
    "pickupTimeTo" : "10:00",
    "requestedDeliveryDate" : "2023-01-06",
    "requestedDeliveryTime" : "15:00",
    "requestedDeliveryTimeTo" : "17:00",
    "paymentTerms" : "paymentTerms",
    "creationDate" : "2023-01-03 11:54:22",
    "service" : "NON-DOCS",
    "serviceLevelTime" : "CLASSIC",
    "executedServiceLevelTime" : "CLASSIC",
    "serviceLevelOther" : "",
    "executedServiceLevelOther" : "",
    "incoterms" : "DAP",
    "inbound" : 0,
    "loadmeters" : 0.41,
    "calculatedLoadmeters" : 0.41,
    "calculatedWeight" : 0,
    "numberOfPackages" : 2,
    "insurance" : false,
    "measurements" : {
      "length" : 0.0,
      "width" : 0.0,
      "height" : 0.0,
      "weight" : 40.0,
      "linearUom" : "CM",
      "massUom" : "KG"
    },
    "tariffLog" : [ ],
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    }, {
      "type" : "ENGINEER",
      "value" : "example-engineer-additional-value-shipment-level"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "addresses" : [ {
      "type" : "INVC",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNo" : "1c",
      "addressLine2" : "2nd floor",
      "addressLine3" : "att. Support",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "state" : "",
      "country" : "NL",
      "contact" : "Support",
      "telNo" : "0031881260300",
      "faxNo" : "0031881260301",
      "email" : "example@domain.com",
      "accountNumber" : "example-accountNumber",
      "customerNumber" : "example-customerNumber",
      "vatNumber" : "example-vatNumber",
      "residential" : 0,
      "contactDateOfBirth" : "",
      "contactIdType" : "",
      "contactIdNumber" : "",
      "contactIdExpirationDate" : "",
      "building" : "",
      "floor" : "",
      "department" : "",
      "doorcode" : ""
    }, {
      "type" : "RECV",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNo" : "1c",
      "addressLine2" : "2nd floor",
      "addressLine3" : "att. Support",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "state" : "",
      "country" : "NL",
      "contact" : "Support",
      "telNo" : "0031881260300",
      "faxNo" : "0031881260301",
      "email" : "example@domain.com",
      "accountNumber" : "example-accountNumber",
      "customerNumber" : "example-customerNumber",
      "vatNumber" : "example-vatNumber",
      "residential" : 0,
      "contactDateOfBirth" : "1999-01-01",
      "contactIdType" : "type",
      "contactIdNumber" : "BpI0tLBNz31IP5wWS3mNgHS5ascw+/WuzCnK02L4kqXlfJBkvWl4TW5uLCpfnVs6BBg0MUJ627U0i+xXmCHXqg==",
      "contactIdExpirationDate" : "BpI0tLBNz31IP5wWS3mNgHS5ascw+/WuzCnK02L4kqXPQbVD5WkzYAEs/1n5SM3qfpGLBoSxi40Fb9rco8zak3sTCkif+I00eBeWdVs8ppM=",
      "eoriNumber" : "NL4321",
      "building" : "",
      "floor" : "",
      "department" : "",
      "doorcode" : ""
    }, {
      "type" : "SEND",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNo" : "1c",
      "addressLine2" : "2nd floor",
      "addressLine3" : "att. Support",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "state" : "",
      "country" : "NL",
      "contact" : "Support",
      "telNo" : "0031881260300",
      "faxNo" : "0031881260301",
      "email" : "example@domain.com",
      "accountNumber" : "example-accountNumber",
      "customerNumber" : "example-customerNumber",
      "vatNumber" : "example-vatNumber",
      "residential" : 0,
      "contactDateOfBirth" : "",
      "contactIdType" : "",
      "contactIdNumber" : "",
      "contactIdExpirationDate" : "",
      "building" : "",
      "floor" : "",
      "department" : "",
      "doorcode" : ""
    } ],
    "packages" : [ {
      "lineNo" : 1,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybillNumber" : "05228021357098",
      "packageType" : "BOX",
      "description" : "example-description",
      "quantity" : 1,
      "stackable" : true,
      "stackHeight" : 1,
      "additionalReferences" : [ ],
      "monetaryDetails" : [ ],
      "deliveryNoteInfo" : {
        "deliveryNoteId" : "0987654321",
        "currency" : "EUR",
        "price" : 16.0,
        "deliveryNoteLines" : [ {
          "deliveryNoteId" : "09876543210987654321",
          "lineNumber" : 1,
          "quantity" : 1,
          "quantityUom" : "PCS",
          "quantityOrder" : 1,
          "quantityBackorder" : 0,
          "articleId" : "example-articleId",
          "articleName" : "example-articleName",
          "description" : "example-articleDescription",
          "hsCode" : "example-hsCode",
          "countryOrigin" : "NL",
          "price" : 16.0,
          "goodsValue" : 1.0,
          "currency" : "EUR",
          "serialNumber" : "example-serialNumber",
          "reasonOfExport" : "example-reasonOfExport",
          "proformaInvoiceDate" : "20171121",
          "proformaInvoiceNumber" : "TS0987654321",
          "proformaInvoiceLineNumber" : "L2",
          "quantityM2" : 1.0,
          "customerOrder" : "example-customerOrder",
          "articleEanCode" : "example-articleEanCode",
          "quality" : "example-quality",
          "composition" : "example-composition",
          "assemblyInstructions" : "example-assemblyInstructions",
          "grossWeight" : 20.0,
          "nettWeight" : 18.0,
          "weightUom" : "KG",
          "hsCodeDescription" : "example-hsCodeDescription",
          "nettPrice" : 15.0,
          "proformaInvoiceFreightCharges" : 20.0,
          "proformaInvoiceInsuranceCharges" : 2.0,
          "proformaInvoiceDiscounts" : 2.0,
          "proformaInvoiceOtherCharges" : 2.0
        } ]
      },
      "dangerousGoodsInformation" : {
        "dangerousGoods" : [ {
          "idCode" : "idCode",
          "unCode" : "1234",
          "unSubCode" : "1",
          "packingGroup" : "I",
          "regulation" : { },
          "hazardClass" : { },
          "packingType" : "CAN",
          "packingClassification" : "1.2",
          "packingInstruction" : "packingInstruction",
          "isHazardousSubstance" : false,
          "quantity" : 1,
          "description" : "description",
          "markingIdentifier" : "3",
          "transportCategory" : 0,
          "limitedQuantity" : 0,
          "instruction" : "instruction",
          "temperature" : { },
          "limitedQuantityPoints" : 850,
          "limitedQuantityPointsMultiplier" : 0,
          "tunnelCode" : "C/D",
          "overpackID" : "1of1",
          "measurements" : {
            "length" : 8.0,
            "width" : 8.0,
            "height" : 8.0,
            "linearUom" : "CM",
            "massUom" : "KG"
          },
          "netWeight" : 7.5,
          "volume" : 0.51,
          "volumeUom" : "L"
        } ],
        "dangerousGoodsGds" : [ ]
      },
      "measurements" : {
        "length" : 20.0,
        "width" : 20.0,
        "height" : 20.0,
        "weight" : 20.0,
        "linearUom" : "CM",
        "massUom" : "KG",
        "calculatedWeight" : 0
      }
    }, {
      "lineNo" : 2,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybillNumber" : "05228021357099",
      "packageType" : "BOX",
      "description" : "example-description",
      "quantity" : 1,
      "stackable" : true,
      "stackHeight" : 1,
      "additionalReferences" : [ ],
      "monetaryDetails" : [ ],
      "deliveryNoteInfo" : {
        "deliveryNoteId" : "0987654321",
        "currency" : "EUR",
        "price" : 16.0,
        "deliveryNoteLines" : [ {
          "deliveryNoteId" : "09876543210987654321",
          "lineNumber" : 1,
          "quantity" : 1,
          "quantityUom" : "PCS",
          "quantityOrder" : 1,
          "quantityBackorder" : 0,
          "articleId" : "example-articleId",
          "articleName" : "example-articleName",
          "description" : "example-articleDescription",
          "hsCode" : "example-hsCode",
          "countryOrigin" : "NL",
          "price" : 16.0,
          "goodsValue" : 1.0,
          "currency" : "EUR",
          "serialNumber" : "example-serialNumber",
          "reasonOfExport" : "example-reasonOfExport",
          "proformaInvoiceDate" : "20171121",
          "proformaInvoiceNumber" : "TS0987654321",
          "proformaInvoiceLineNumber" : "L2",
          "quantityM2" : 1.0,
          "customerOrder" : "example-customerOrder",
          "articleEanCode" : "example-articleEanCode",
          "quality" : "example-quality",
          "composition" : "example-composition",
          "assemblyInstructions" : "example-assemblyInstructions",
          "grossWeight" : 20.0,
          "nettWeight" : 18.0,
          "weightUom" : "KG",
          "hsCodeDescription" : "example-hsCodeDescription",
          "nettPrice" : 15.0,
          "proformaInvoiceFreightCharges" : 20.0,
          "proformaInvoiceInsuranceCharges" : 2.0,
          "proformaInvoiceDiscounts" : 2.0,
          "proformaInvoiceOtherCharges" : 2.0
        } ]
      },
      "dangerousGoodsInformation" : {
        "dangerousGoods" : [ {
          "idCode" : "idCode",
          "unCode" : "1234",
          "unSubCode" : "1",
          "packingGroup" : "I",
          "regulation" : { },
          "hazardClass" : { },
          "packingType" : "CAN",
          "packingClassification" : "1.2",
          "packingInstruction" : "packingInstruction",
          "isHazardousSubstance" : false,
          "quantity" : 1,
          "description" : "description",
          "markingIdentifier" : "3",
          "transportCategory" : 0,
          "limitedQuantity" : 0,
          "instruction" : "instruction",
          "temperature" : { },
          "limitedQuantityPoints" : 850,
          "limitedQuantityPointsMultiplier" : 0,
          "tunnelCode" : "C/D",
          "overpackID" : "1of1",
          "measurements" : {
            "length" : 8.0,
            "width" : 8.0,
            "height" : 8.0,
            "linearUom" : "CM",
            "massUom" : "KG"
          },
          "netWeight" : 7.5,
          "volume" : 0.51,
          "volumeUom" : "L"
        } ],
        "dangerousGoodsGds" : [ ]
      },
      "measurements" : {
        "length" : 20.0,
        "width" : 20.0,
        "height" : 20.0,
        "weight" : 20.0,
        "linearUom" : "CM",
        "massUom" : "KG",
        "calculatedWeight" : 0
      }
    } ],
    "monetaryDetails" : [ {
      "type" : "GOODS",
      "value" : 2.0,
      "currency" : "EUR"
    } ],
    "errorDescription" : "",
    "errorCode" : 0
  }, {
    "reference" : "Transsmart_1672743269162",
    "carrier" : "DPD",
    "carrierAccountNumber" : "48389",
    "costCenter" : "",
    "mailType" : 1,
    "language" : "NL",
    "selectedCarrier" : "DPD",
    "executingCarrier" : "DPD",
    "airwayBillNumber" : "05228021357100",
    "trackingAndTraceUrl" : "https://tracking.dpd.de/parcelstatus?query=MPS0522802135710020230103&locale=nl_NL&Tracking=Track",
    "description" : "example-description",
    "instruction" : "example-instruction1",
    "value" : 10.0,
    "valueCurrency" : "EUR",
    "currency" : "EUR",
    "spotPrice" : 15.0,
    "spotPriceCurrency" : "EUR",
    "price" : 15.0,
    "priceCurrency" : "EUR",
    "salesPrice" : 0.0,
    "salesPriceCurrency" : "",
    "shipmentStatusCode" : "DEL",
    "pickupDate" : "2023-01-03",
    "pickupTime" : "08:00",
    "pickupTimeTo" : "10:00",
    "requestedDeliveryDate" : "2023-01-06",
    "requestedDeliveryTime" : "15:00",
    "requestedDeliveryTimeTo" : "17:00",
    "paymentTerms" : "paymentTerms",
    "creationDate" : "2023-01-03 11:54:29",
    "service" : "NON-DOCS",
    "serviceLevelTime" : "CLASSIC",
    "executedServiceLevelTime" : "CLASSIC",
    "serviceLevelOther" : "",
    "executedServiceLevelOther" : "",
    "incoterms" : "DAP",
    "inbound" : 0,
    "loadmeters" : 0.41,
    "calculatedLoadmeters" : 0.41,
    "calculatedWeight" : 0,
    "numberOfPackages" : 2,
    "insurance" : false,
    "measurements" : {
      "length" : 0.0,
      "width" : 0.0,
      "height" : 0.0,
      "weight" : 40.0,
      "linearUom" : "CM",
      "massUom" : "KG"
    },
    "tariffLog" : [ ],
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    }, {
      "type" : "ENGINEER",
      "value" : "example-engineer-additional-value-shipment-level"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "addresses" : [ {
      "type" : "INVC",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNo" : "1c",
      "addressLine2" : "2nd floor",
      "addressLine3" : "att. Support",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "state" : "",
      "country" : "NL",
      "contact" : "Support",
      "telNo" : "0031881260300",
      "faxNo" : "0031881260301",
      "email" : "example@domain.com",
      "accountNumber" : "example-accountNumber",
      "customerNumber" : "example-customerNumber",
      "vatNumber" : "example-vatNumber",
      "residential" : 0,
      "contactDateOfBirth" : "",
      "contactIdType" : "",
      "contactIdNumber" : "",
      "contactIdExpirationDate" : "",
      "building" : "",
      "floor" : "",
      "department" : "",
      "doorcode" : ""
    }, {
      "type" : "RECV",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNo" : "1c",
      "addressLine2" : "2nd floor",
      "addressLine3" : "att. Support",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "state" : "",
      "country" : "NL",
      "contact" : "Support",
      "telNo" : "0031881260300",
      "faxNo" : "0031881260301",
      "email" : "example@domain.com",
      "accountNumber" : "example-accountNumber",
      "customerNumber" : "example-customerNumber",
      "vatNumber" : "example-vatNumber",
      "residential" : 0,
      "contactDateOfBirth" : "1999-01-01",
      "contactIdType" : "type",
      "contactIdNumber" : "BpI0tLBNz31IP5wWS3mNgHS5ascw+/WuzCnK02L4kqWBvNDk77FdFM0cfXBYRARfBBg0MUJ627U0i+xXmCHXqg==",
      "contactIdExpirationDate" : "BpI0tLBNz31IP5wWS3mNgHS5ascw+/WuzCnK02L4kqVLDK/40r4zyULPp3ziwJZg2tePhkzHz/xuwqkZzYoWT6h4jtw3YW9k+L0Fhar0jbM=",
      "eoriNumber" : "NL4321",
      "building" : "",
      "floor" : "",
      "department" : "",
      "doorcode" : ""
    }, {
      "type" : "SEND",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNo" : "1c",
      "addressLine2" : "2nd floor",
      "addressLine3" : "att. Support",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "state" : "",
      "country" : "NL",
      "contact" : "Support",
      "telNo" : "0031881260300",
      "faxNo" : "0031881260301",
      "email" : "example@domain.com",
      "accountNumber" : "example-accountNumber",
      "customerNumber" : "example-customerNumber",
      "vatNumber" : "example-vatNumber",
      "residential" : 0,
      "contactDateOfBirth" : "",
      "contactIdType" : "",
      "contactIdNumber" : "",
      "contactIdExpirationDate" : "",
      "building" : "",
      "floor" : "",
      "department" : "",
      "doorcode" : ""
    } ],
    "packages" : [ {
      "lineNo" : 1,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybillNumber" : "05228021357100",
      "packageType" : "BOX",
      "description" : "example-description",
      "quantity" : 1,
      "stackable" : true,
      "stackHeight" : 1,
      "additionalReferences" : [ ],
      "monetaryDetails" : [ ],
      "deliveryNoteInfo" : {
        "deliveryNoteId" : "0987654321",
        "currency" : "EUR",
        "price" : 16.0,
        "deliveryNoteLines" : [ {
          "deliveryNoteId" : "09876543210987654321",
          "lineNumber" : 1,
          "quantity" : 1,
          "quantityUom" : "PCS",
          "quantityOrder" : 1,
          "quantityBackorder" : 0,
          "articleId" : "example-articleId",
          "articleName" : "example-articleName",
          "description" : "example-articleDescription",
          "hsCode" : "example-hsCode",
          "countryOrigin" : "NL",
          "price" : 16.0,
          "goodsValue" : 1.0,
          "currency" : "EUR",
          "serialNumber" : "example-serialNumber",
          "reasonOfExport" : "example-reasonOfExport",
          "proformaInvoiceDate" : "20171121",
          "proformaInvoiceNumber" : "TS0987654321",
          "proformaInvoiceLineNumber" : "L2",
          "quantityM2" : 1.0,
          "customerOrder" : "example-customerOrder",
          "articleEanCode" : "example-articleEanCode",
          "quality" : "example-quality",
          "composition" : "example-composition",
          "assemblyInstructions" : "example-assemblyInstructions",
          "grossWeight" : 20.0,
          "nettWeight" : 18.0,
          "weightUom" : "KG",
          "hsCodeDescription" : "example-hsCodeDescription",
          "nettPrice" : 15.0,
          "proformaInvoiceFreightCharges" : 20.0,
          "proformaInvoiceInsuranceCharges" : 2.0,
          "proformaInvoiceDiscounts" : 2.0,
          "proformaInvoiceOtherCharges" : 2.0
        } ]
      },
      "dangerousGoodsInformation" : {
        "dangerousGoods" : [ {
          "idCode" : "idCode",
          "unCode" : "1234",
          "unSubCode" : "1",
          "packingGroup" : "I",
          "regulation" : { },
          "hazardClass" : { },
          "packingType" : "CAN",
          "packingClassification" : "1.2",
          "packingInstruction" : "packingInstruction",
          "isHazardousSubstance" : false,
          "quantity" : 1,
          "description" : "description",
          "markingIdentifier" : "3",
          "transportCategory" : 0,
          "limitedQuantity" : 0,
          "instruction" : "instruction",
          "temperature" : { },
          "limitedQuantityPoints" : 850,
          "limitedQuantityPointsMultiplier" : 0,
          "tunnelCode" : "C/D",
          "overpackID" : "1of1",
          "measurements" : {
            "length" : 8.0,
            "width" : 8.0,
            "height" : 8.0,
            "linearUom" : "CM",
            "massUom" : "KG"
          },
          "netWeight" : 7.5,
          "volume" : 0.51,
          "volumeUom" : "L"
        } ],
        "dangerousGoodsGds" : [ ]
      },
      "measurements" : {
        "length" : 20.0,
        "width" : 20.0,
        "height" : 20.0,
        "weight" : 20.0,
        "linearUom" : "CM",
        "massUom" : "KG",
        "calculatedWeight" : 0
      }
    }, {
      "lineNo" : 2,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybillNumber" : "05228021357101",
      "packageType" : "BOX",
      "description" : "example-description",
      "quantity" : 1,
      "stackable" : true,
      "stackHeight" : 1,
      "additionalReferences" : [ ],
      "monetaryDetails" : [ ],
      "deliveryNoteInfo" : {
        "deliveryNoteId" : "0987654321",
        "currency" : "EUR",
        "price" : 16.0,
        "deliveryNoteLines" : [ {
          "deliveryNoteId" : "09876543210987654321",
          "lineNumber" : 1,
          "quantity" : 1,
          "quantityUom" : "PCS",
          "quantityOrder" : 1,
          "quantityBackorder" : 0,
          "articleId" : "example-articleId",
          "articleName" : "example-articleName",
          "description" : "example-articleDescription",
          "hsCode" : "example-hsCode",
          "countryOrigin" : "NL",
          "price" : 16.0,
          "goodsValue" : 1.0,
          "currency" : "EUR",
          "serialNumber" : "example-serialNumber",
          "reasonOfExport" : "example-reasonOfExport",
          "proformaInvoiceDate" : "20171121",
          "proformaInvoiceNumber" : "TS0987654321",
          "proformaInvoiceLineNumber" : "L2",
          "quantityM2" : 1.0,
          "customerOrder" : "example-customerOrder",
          "articleEanCode" : "example-articleEanCode",
          "quality" : "example-quality",
          "composition" : "example-composition",
          "assemblyInstructions" : "example-assemblyInstructions",
          "grossWeight" : 20.0,
          "nettWeight" : 18.0,
          "weightUom" : "KG",
          "hsCodeDescription" : "example-hsCodeDescription",
          "nettPrice" : 15.0,
          "proformaInvoiceFreightCharges" : 20.0,
          "proformaInvoiceInsuranceCharges" : 2.0,
          "proformaInvoiceDiscounts" : 2.0,
          "proformaInvoiceOtherCharges" : 2.0
        } ]
      },
      "dangerousGoodsInformation" : {
        "dangerousGoods" : [ {
          "idCode" : "idCode",
          "unCode" : "1234",
          "unSubCode" : "1",
          "packingGroup" : "I",
          "regulation" : { },
          "hazardClass" : { },
          "packingType" : "CAN",
          "packingClassification" : "1.2",
          "packingInstruction" : "packingInstruction",
          "isHazardousSubstance" : false,
          "quantity" : 1,
          "description" : "description",
          "markingIdentifier" : "3",
          "transportCategory" : 0,
          "limitedQuantity" : 0,
          "instruction" : "instruction",
          "temperature" : { },
          "limitedQuantityPoints" : 850,
          "limitedQuantityPointsMultiplier" : 0,
          "tunnelCode" : "C/D",
          "overpackID" : "1of1",
          "measurements" : {
            "length" : 8.0,
            "width" : 8.0,
            "height" : 8.0,
            "linearUom" : "CM",
            "massUom" : "KG"
          },
          "netWeight" : 7.5,
          "volume" : 0.51,
          "volumeUom" : "L"
        } ],
        "dangerousGoodsGds" : [ ]
      },
      "measurements" : {
        "length" : 20.0,
        "width" : 20.0,
        "height" : 20.0,
        "weight" : 20.0,
        "linearUom" : "CM",
        "massUom" : "KG",
        "calculatedWeight" : 0
      }
    } ],
    "monetaryDetails" : [ {
      "type" : "GOODS",
      "value" : 2.0,
      "currency" : "EUR"
    } ],
    "errorDescription" : "",
    "errorCode" : 0
  } ],
  "contentType" : "Shipments",
  "isLastPage" : false,
  "totalItems" : 4445,
  "totalPages" : 2223,
  "pageSize" : 2,
  "currentPage" : 1,
  "isFirstPage" : true,
  "numberOfItems" : 2
}

2.3 Shipment Deletion

There are two interface to delete shipments. The first is to delete one shipment the other is to delete a list of shipments. In both cases the client and the shipment reference needs to be provided. The response in both cases is true of the shipment could be deleted or false in case this was not possible.

Single shipment deletion

Path variables

Table 8. /v2/shipments/{account}/{reference}
Parameter	Description
`account`	The account to which the shipment belongs
`reference`	Reference of shipment to be deleted

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

If the response is true the shipment has been deleted else not.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 4

true

Multiple shipments deletion

Path variables

Table 9. /v2/shipments/{account}
Parameter	Description
`account`	The account to which the shipment belongs.

Request parameters

Parameter	Description	Constraints
reference	The references of the shipments to be deleted.	Mutiple entries are supported.

Parameter

Description

Constraints

reference

The references of the shipments to be deleted.

Mutiple entries are supported.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

If the response is true atleast one of the shipments has been deleted else none of the shipments are deleted.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 5

false

2.4 Shipment Manifesting

Manifesting of shipments. In the past, there was also a chapter 10.1 'LoadingList' but that chapter has become redundant and has been merged into this chapter 2.4 by, among others, the addition of the parameter documentType in which a carrier specific loading list code can be set.

Retrieve list

Retrieve a list of shipments ready to be manifested.

Path parameters

Table 10. /v2/shipments/{account}/manifest/list
Parameter	Description
`account`	The account to which the shipment(s) belong(s).

Request parameters

Parameter	Description	Constraints
date	The pickup date.	Format yyyy-MM-dd HH:mm:ss.
dateTo	The pickup date until.	Format yyyy-MM-dd HH:mm:ss.
pagedResult	Return the results in transsmart pages.	true or false
carrier	The carrier.	Fixed length of 3.
costCenter	The costCenter (optional).	Maximum size of 32.
slt	The service level time (optional).	Maximum size of 32.
slo	The service level other (optional).	Maximum size of 32.
receiverCountry	The country of the receiver (optional).	Maximum size of 3.

Parameter

Description

Constraints

date

The pickup date.

Format yyyy-MM-dd HH:mm:ss.

dateTo

The pickup date until.

Format yyyy-MM-dd HH:mm:ss.

pagedResult

Return the results in transsmart pages.

true or false

carrier

The carrier.

Fixed length of 3.

costCenter

The costCenter (optional).

Maximum size of 32.

slt

The service level time (optional).

Maximum size of 32.

slo

The service level other (optional).

Maximum size of 32.

receiverCountry

The country of the receiver (optional).

Maximum size of 3.

Response structure

Path	Type	Description	Constraints
contentType	String
isLastPage	Boolean	Indicates if this is the last page.
isFirstPage	Boolean	Indicates if this is the first page.
totalItems	Integer	Total amount of items.
totalPages	Integer	Total amount of pages.
pageSize	Integer	The amount of items per page.
currentPage	Integer	The current page.
numberOfItems	Integer	Number of items in this page.
content	Object	The content of this page.
content .manifests.[] .costCenter	String	The costCenter of the shipment.	Maximum size of 32.
content .manifests.[] .instruction	String	The instruction of the shipment.	Maximum size of 32. Not Null and not empty.
content .manifests.[] .packageTypes	String	The package types of the shipment.	Maximum size of 32. Not Null and not empty.
content .manifests.[] .reference	String	The reference of the shipment.	Not Null and not empty. The size must be between 1 and 32.
content .manifests.[] .status	String	The status of the shipment.	Has to match pattern: (NONE\| ERR\| REFU\| NEW\| BOOK\| ONHOLD\| LABL\| MANI\| ACCEP\| TRNS\| DELAY\| DONE\| APOD\| DEL) Maximum size of 8.
content .manifests.[] .airwaybill	String	The airwaybill of the shipment.	Maximum size of 256.
content .manifests.[] .name	String	The name of the address where the shipment is send to.	Maximum size of 64. Not Null and not empty.
content .manifests.[] .zipCode	String	The zipCode of the address where the shipment is send to.	Maximum size of 16. Not Null and not empty.
content .manifests.[] .city	String	The city where the shipment is send to.	Maximum size of 64. Not Null and not empty.
content .manifests.[] .serviceLevels	String	The serviceLevels of the shipment, this is a _ concatenation of the service level time and service level other (example: EUROPLUS_COD )	Maximum size of 32. Not Null and not empty.
content .manifests.[] .packages	Integer	The amount of packages.	Maximum value is 32767.
content .manifests.[] .weight	Decimal	The weight of the shipment.	Maximum value is 999,999,999.99 Minimum value is 0
content .manifests.[] .value	Decimal	The value of the shipment.	Maximum value is 999,999,999.99 Minimum value is -999,999,999.99
content .costCenters .[]	Field [] not found	Field [] not found

Path

Type

Description

Constraints

contentType

String

isLastPage

Boolean

Indicates if this is the last page.

isFirstPage

Boolean

Indicates if this is the first page.

totalItems

Integer

Total amount of items.

totalPages

Integer

Total amount of pages.

pageSize

Integer

The amount of items per page.

currentPage

Integer

The current page.

numberOfItems

Integer

Number of items in this page.

content

Object

The content of this page.

content
.manifests.[]
.costCenter

String

The costCenter of the shipment.

Maximum size of 32.

content
.manifests.[]
.instruction

String

The instruction of the shipment.

Maximum size of 32.
Not Null and not empty.

content
.manifests.[]
.packageTypes

String

The package types of the shipment.

Maximum size of 32.
Not Null and not empty.

content
.manifests.[]
.reference

String

The reference of the shipment.

Not Null and not empty.
The size must be between 1 and 32.

content
.manifests.[]
.status

String

The status of the shipment.

content
.manifests.[]
.airwaybill

String

The airwaybill of the shipment.

Maximum size of 256.

content
.manifests.[]
.name

String

The name of the address where the shipment is send to.

Maximum size of 64.
Not Null and not empty.

content
.manifests.[]
.zipCode

String

The zipCode of the address where the shipment is send to.

Maximum size of 16.
Not Null and not empty.

content
.manifests.[]
.city

String

The city where the shipment is send to.

Maximum size of 64.
Not Null and not empty.

content
.manifests.[]
.serviceLevels

String

The serviceLevels of the shipment, this is a _ concatenation of the service level time and service level other (example: EUROPLUS_COD )

Maximum size of 32.
Not Null and not empty.

content
.manifests.[]
.packages

Integer

The amount of packages.

Maximum value is 32767.

content
.manifests.[]
.weight

Decimal

The weight of the shipment.

Maximum value is 999,999,999.99
Minimum value is 0

content
.manifests.[]
.value

Decimal

The value of the shipment.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content
.costCenters
.[]

Field [] not found

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 8456

{
  "content" : {
    "manifests" : [ {
      "reference" : "Transsmart_1690185954256",
      "status" : "MANI",
      "airwaybill" : "05228021367568",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690185940710",
      "status" : "MANI",
      "airwaybill" : "05228021367565",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690185911698",
      "status" : "MANI",
      "airwaybill" : "05228021367545",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690185908106",
      "status" : "MANI",
      "airwaybill" : "05228021367543",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690185905878",
      "status" : "MANI",
      "airwaybill" : "05228021367541",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690185875428",
      "status" : "MANI",
      "airwaybill" : "05228021367539",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690185841742",
      "status" : "MANI",
      "airwaybill" : "05228021367537",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690185838270",
      "status" : "MANI",
      "airwaybill" : "05228021367534",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195284085",
      "status" : "MANI",
      "airwaybill" : "05228021367599",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195364793",
      "status" : "LABL",
      "airwaybill" : "05228021367623",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195362488",
      "status" : "LABL",
      "airwaybill" : "05228021367621",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195360675",
      "status" : "LABL",
      "airwaybill" : "05228021367619",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195358561",
      "status" : "MANI",
      "airwaybill" : "05228021367617",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195270739",
      "status" : "MANI",
      "airwaybill" : "05228021367596",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195266455",
      "status" : "MANI",
      "airwaybill" : "05228021367592",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195264232",
      "status" : "MANI",
      "airwaybill" : "05228021367590",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195260633",
      "status" : "MANI",
      "airwaybill" : "05228021367588",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1690195255035",
      "status" : "MANI",
      "airwaybill" : "05228021367586",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1689949656613",
      "status" : "MANI",
      "airwaybill" : "05228021367475",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    }, {
      "reference" : "Transsmart_1689949643405",
      "status" : "MANI",
      "airwaybill" : "05228021367472",
      "costCenter" : "",
      "name" : "Transsmart",
      "zipCode" : "5032MD",
      "city" : "Tilburg",
      "serviceLevels" : "CLASSIC",
      "instruction" : "example-instruction1",
      "packages" : 2,
      "weight" : 40.0,
      "value" : 10.0,
      "packageTypes" : "BOX,BOX"
    } ],
    "costCenters" : [ "" ]
  },
  "contentType" : "Manifests",
  "isLastPage" : false,
  "totalItems" : 39,
  "totalPages" : 2,
  "pageSize" : 20,
  "currentPage" : 1,
  "isFirstPage" : true,
  "numberOfItems" : 20
}

Download PDF list

Download a PDF list of shipments ready to be manifested.

Path parameters

Table 11. /v2/shipments/{account}/manifest/list/download
Parameter	Description
`account`	The account to which the shipment(s) belong(s).

Request parameters

Parameter	Description	Constraints
date	The pickup date.	Format yyyy-MM-dd HH:mm:ss.
dateTo	The pickup date until.	Format yyyy-MM-dd HH:mm:ss.
carrier	The carrier.	Fixed length of 3.
costCenter	The costCenter (optional).	Maximum size of 32.
slt	The service level time (optional).	Maximum size of 32.
slo	The service level other (optional).	Maximum size of 32.
receiverCountry	The country of the receiver (optional).	Maximum size of 3.
documentType	The document type to download (optional). Ask support for any carrier specific document.

Parameter

Description

Constraints

date

The pickup date.

Format yyyy-MM-dd HH:mm:ss.

dateTo

The pickup date until.

Format yyyy-MM-dd HH:mm:ss.

carrier

The carrier.

Fixed length of 3.

costCenter

The costCenter (optional).

Maximum size of 32.

slt

The service level time (optional).

Maximum size of 32.

slo

The service level other (optional).

Maximum size of 32.

receiverCountry

The country of the receiver (optional).

Maximum size of 3.

documentType

The document type to download (optional). Ask support for any carrier specific document.

Response structure

HTTP/1.1 200 OK Content-Disposition: form-data; name="attachment"; filename="ManifestList.pdf" Cache-Control: must-revalidate, post-check=0, pre-check=0 Content-Type: application/pdf

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

HTTP/1.1 200 OK
cache-control: must-revalidate, post-check=0, pre-check=0
connection: keep-alive
content-disposition: form-data; name="attachment"; filename="manifest.pdf"
Content-Length: 7996
Content-Type: application/pdf
date: Mon, 24 Jul 2023 10:42:42 GMT
keep-alive: timeout=60

%PDF-1.4
%����
3 0 obj
<</Filter/FlateDecode/Length 5068>>stream
x���Ms$�q����|0�U�]�}�H�A�ɐ�
+���]��
���3=��4���5�C�TfvU��xUͿ����M�vSJ�Ӽ{���?�����_o����7��}ڥ�{����n���n�2�vg�o~��ݧ�w�/��/�ڽ�����������p��ǿ���V������������v���M�oǺ��X3��iܥ�{���`}��{��4?��m*���!=Hi��O%�z;��#���Q��4<��%�v�i�y�곐2L��DE�<��OS�m}��~8_L�o��<�0�:<M����]�gj��w4l��sI�
I�$݆$��ݖ$�\�nK�z��nK����ے$.��sI�-I�$ݖ$�\�nK��!�$�I2A�)(9%���A��<����Kr� Jl�@�M(��H�$}��EP�EI_%}Q��ERqI��(鋢�/���!�$�IrX#Sr
JND�)�(9E%6O�$.⒜"�[-PbJ�,���&I%i��QQ�FEI%i���E\�4*JҨ(I��$n�"I<l�tIPr
JND�)�(9E%6O�$.⒜"�[-PbJ�,���'Iꜘ�)���"��J|�@	1I,(��Ɣ�DbJ�!GI`�$��bJ,(���"��'PE\�SP⫍)�Ĕ@CI�a����:J�(������:HJ�".I%uP��AQ7d�$6Iz��-(�{���W���I��E\�^�w_-P�+�
Y$��M�"ܻ%E�w� J�r�>O�$.���}�@IQ��H�$Y�wJ�r�A�d��}�DI\�%�ʽ�j����;4d�$6I�p��$��-�(Iʽ�<����K��{��%I�wh�"I<|�d��{���J,(����	�@��"�_mL�O$�r��M�I�w�)���"��J|�@	qI&��}�1%>��h�"I<l��½[P2*�nDɨܻϓ(���$�r�Z�dT��H�$U�wJ�r�A�T��}�DI\�%�ʽ�j����;4d�$6Iz��-(�{���W���I��E\�^�w_-P�+�
Y$��M�"ܻ%E�w� J�r�>O�$.���}�@IQ��H�$I�wJ�r�A�$��}�DI\�%Iʽ�j����;4d�$6I:��-(�{���S���I��E\�N�w_-P�)�
Y$��O���p�Sb@�E%��<�(b�XP⫍)�Ĕ@C����I2	�n1%�XPb@��(�".ɤܻ�6��'S
Y$��M�*ܻ%U�w� J�r�>O�$.�T��}�@IU��H�$�p��ʽ[Q2(���$J�".ɠܻ�(�{��,���&I/ܻ%�r�A��ʽ�<����K�+��Jz�ޡ!�$�IR�{���(�nDIQ���I��E\��ܻ�()ʽCCI�a�$	�n@IR��"���ܻϓ(���$I�w_-P��{��,���&I'ܻ%�r�A�tʽ�<����K�)��J:�ޡ!�$��I�2	�n1%�XPb@��(�"&�E%�ژ�HL	4�(	�$�����e�
J��Q�du�a��2���%Y_fآ��$��[���e�-J��2�%АE�x�$�½[PR�{���*���$J�".IU��W�T�ޡ!�$�I2�^��ˠ�{�{/�r�e����$�r�eP�ʽCCI�a���n@IQ��"���ܻϓ(���$E�w_-PR�{��,���&I�d��KV�d��KV���I��E\��ܻ�(�ʽCCI�a�$	�n@IR��"���ܻϓ(���$I�w_-P��{��,���&I'�{�{/�r�S�tʽ�N�w(�tʽ�N���)�
Y$��O��I�w�)���"��J|�@	1I,(��Ɣ�DbJ�!GI`�$�{ϣp�yT�=�ʽ�Q��<J�E\�Q��<*��G�ޡ!�$�I2�n@ɠܻE%�r�>O�$.�ʽ�j��A�wh�"I<l��.3lQ��̰EI�Q�du�a��>4�.��2�&%q�du�a���e�MJV�6)��H�$E�wJ�r�A���}�DI\�%)ʽ�j����;4d�$6I�p�9���r�9+���r�9K�E\���{�ʽ��;4d�$6I:��-(�{���S���I��E\�N�w_-P�)�
Y$��O��Y��4��f��Ӭ�{��{O�t�P�$I�r�iV�=�ʽCC����I2	�n1%�XPb@��(�".ɤܻ�6��'S
Y$��M�Q��4
��F��Ө�{�{O�t�P�%�{O�r�iT��H�$�p��ʽ[Q2(���$J�".ɠܻ�(�{��,���&I/�{�{O�r�W�=�ʽ�^�w(��ʽ�^���+�
Y$��M�,ܻ%Y�w� J�r�>O�$.�d��}�@IV��H�$��[��.3lQ�B7꒬.3lR�B�풬/3lRqIV�6)Y]fؤdu�a���!�$�I�	�n@I�ܻE%�r�>O�$.�tʽ�j��N�wh�"I<|�d�}�}V�}V�}V�}��=.aZ�ʵ�ʴ�ʳǍ8���WO�Q}�N~�N~�N~�N�N~�N~�N~�N~��?O'\z&�
�^�E�ʡWeЫ��q���;	�2�Uy��/;1
��Үn����>��ήo�����.���.o��Evu^�W���1xy
^��g��xy^�������p�s
��2��5x>���������?��
|�t��I��O��Og\�������?��<x:�5�t���������Q���՛�7��������F�\�o�����n�����̃{<脙����z�߮pԡp�����~�ͼ�|����s=�����/�o����5�E:�'X�������w�ο���U*�;�OX���z��Ǡ�e��/���#)��?�r�v����e�!(s����2�{�_��,o<�m��~�~�?�z|��a�߿��� ����݇��n/Ќ�g'�3�<�}�������S�^��
������%Mi ����}����fwC�S�S�c�GD�������Y�9�����,���|���~��`���=���m��o=��q��zc��������総��?�{DE��s�����[��&�B�����l����þL9x�qH��R��Ù9lksH5Z8�9�pH�8�/�sH��C����8�"sX�X��Pf��}��vrH��R�9�%�s���j�p�sh�
4qH���8�\�a���!�������l����g�nN���9����/��a[�C���!Ρ�C*��!�'8�\�a��˵r�E.�NP,xm-���a_Z������!>Zr��+�I��
@���C�C�X��C,�b��s5��e3�T�b(Vq-���ᰵOs����l���h�!e�sX���9lksH5Z8�9�pH�8��CJUR�氿�>
����l-���a�ڧ9ț���6�њC�^q�^��5�9�-�Z8�MR�!�*)Ws���O�E.氃b��e��l�p���i�:���9������a[�C���!Ρ�C*��!R��r%��t�},r)��ł}{[e6q8n��9�6�8�GK1{�!��� �X��C�C�X��C,�b��s5��
�4X�b���Jm��ڨ9�ۗ��?��5��}����"�h��"h�
)U��/��\a��\b&Ë'j0�	����&��H�� R�
D��EcD��"ΡD*�" R�_\	b��N
�Ď/����y{�f,�wf ң5��}b�������j���sh�
4�H���@�W��OWت�"��؏dy�L
�6�X��j���#�D�GK1{"�Dll��5@�94��Z@�"�
�ŕ Wث�"�ؓ��C5��b��Y3���A
Dz���W �a��0�T�D�C�T�	D* @�T"���r��,r1��</����&��f�X�!ڰ4��D�^�ȧ�� R�q- R�&���R���J�+l�`�KA,3y^<V��- �y{�f��F�GK1��bcD��"ϡD,�"`1U��/��LWج�"�Hw�����&k�Y3�~ğ��h
"e�@��76�A�- �Z@�M R"�*�ŕ Wج�"�H������sby�Yӥi�\z��h
"e�@�?�76�A�- �Z@�M R"�*�ŕ �+l�`��A��T	O�`j���f�ĩ��'M��D�>1:�� �5�A�- �Z@�M R"�*�ŕ ��,�A�"����:U��`j�yz�Ysq�����h	"f�@�5�
@�F�<��@��!��*@�\	b��Y�E.��Se<Y��M ֗�5�)w�wD|���W �݋�0�T�D�C�T�	D|�DJU R�q��f
�D�P}1�C�M ���5�e�#zD|����A,Ķ0�T�D�C�T�	D|�DJU R�1_a��\"ݨ�x�S�@�7k�>�=~%�A������0�T�D�C�T�	D|�DJU R�1�Wج�"����JUƓ5��b��͚��i��h	"f�@�?�76A�
 �@�- �� b�s5��6k��� ҝ��'k0�	�a{�f�,2��h
"e������� R�q- R�&�
b)U�H���
�5X�b�NUƓ5��b�ެ��)EK7��D�^��'k� R�q- R�&�
b)U�H��|��,r1�t�*�µ-�R�@�7k�tHៈ�h
"e�@���
`�F�8��@��1���@�\	�|���q)�t�*ri��x�F͸�O3�������٦��s+ضx�J4��3h���[���L��6|����Q��/���OԼrkf�ޙ�-��OӸ/�>Os��Ӽ��4��6�k?M��L�Ӽ���ѣb�Z��]���Uѧ��U&q<���*T��(�+�T(�� گ�Q�Lu����K��
endstream
endobj
5 0 obj
<</Contents 3 0 R/Type/Page/Resources<</ProcSet [/PDF /Text /ImageB /ImageC /ImageI]/Font<</F1 1 0 R/F2 2 0 R>>>>/Parent 4 0 R/MediaBox[0 0 595.28 841.89]>>
endobj
6 0 obj
<</Filter/FlateDecode/Length 1677>>stream
x���Oo�6���)tlQ9"9�N�.���l������m�}������7�v0̙��<�,��z�^y��Dm���וk^uԗ���׫��o㿮�e���+���U���M��\
-��\�ۮ�$ �6����, w-���6�,�(��,���a�Ǎ%�s��YD�u�s�]j#�B|���#�c�K����,!�<L����#�R9>��~~�8t1dԐZ�,IٰDtK$X"����:�%@D,�`I9�nI)D�4�`	XKR|a	/X2�%�`� [�%S�X�K�L�M^�D�Kx�]�X2E�%�d��v���,�B&Kx��!�%��X�Ѡ��A	G��%-J8���"��%-J8Z��
-їŒ�
J�@��(�"%S�D�D��"Œ)Q"��H!��!�%��X�A��%>[��lQ�E��&%�H��g��-J|�(�2Z�/�%�7(�%S�d�@�L��Q��K�D��P"�J􆌖��b	y��%�-J�[���(!oR��K�[���(!oQ�7d�D_�,�0%�S"���H���	("b�DJ�iuJJ!:%�!K��X�'L��H�D"%()uJ�H��O%�:%��А�}Y,IdP�Ƞ$�EI"��D%�LJt�bI"��D%�,J􆌖��b	ӻJؚ�%Q���^�D��"����rZ@	[�;h�h��,�cz�@I��w�@�kz/u"Jt�bI���rZ@I��wА�}Y,���.�oM��(���^�D��"�oM�崀oM�!�%��XB��.���w�@��5��:%�H���齜PB��2Z�/�%Θ�%P��]"%Κ�K��]�X�齜P��4d�D_�,�٘�%@�D%(�@I�PD�����ꔔBtJ@C�,.<|�E��R3�l��Ƹ��ꇟ�G�Y��rc��z������߯�}�\�_)�����������~Y��3�!��ss������?b��6�x��聘WR�0(u���?>�mv�OĹ��R�Yٱ��[O��~��7e��u���s�}���y?ޖ�5@i?��:i�S����?L����������Z3�n�wWW�o���U
�S#�x��R�k�S҃�|�s���t��� F �>�aPj��C�m- ��mQ�K�bf��D�Q"��D$P"0@D��(�1�@D"'�聘�Z�à�*���8��o"��e��<Gĺ`�F
����@�H��Z �\D�g���b>�à�9�e�K>C��6�(�D� �5��4j@�5Ԁ��@D�(�� r��?�P�T91<���*�_���oD��	"�>Q�i  V6�5*@�5T�j@�D�j�sm��5P�d#��Q�r�ZbX��񱏬T- ��mQ����D�Q"��D$P"0@D��(�џ���b�.k�Q�R�@�/k�gtxA���.^��
D�G oĺ`�F
����@�H��Z �\D:�e
���д����bPzRf��ʥ�ݜ,�1/\���F>�\;��XG�c
R�/l��>��n��_��)6�X�"���gC�
��v��*f���x[	�~��)%I�P��R������vF��P�����
endstream
endobj
7 0 obj
<</Contents 6 0 R/Type/Page/Resources<</ProcSet [/PDF /Text /ImageB /ImageC /ImageI]/Font<</F2 2 0 R>>>>/Parent 4 0 R/MediaBox[0 0 595.28 841.89]>>
endobj
1 0 obj
<</Subtype/Type1/Type/Font/BaseFont/Helvetica-Bold/Encoding/WinAnsiEncoding>>
endobj
2 0 obj
<</Subtype/Type1/Type/Font/BaseFont/Helvetica/Encoding/WinAnsiEncoding>>
endobj
4 0 obj
<</Kids[5 0 R 7 0 R]/Type/Pages/Count 2/ITXT(2.1.7)>>
endobj
8 0 obj
<</Type/Catalog/Pages 4 0 R>>
endobj
9 0 obj
<</ModDate(D:20230724124242+02'00')/CreationDate(D:20230724124242+02'00')/Producer(iText 2.1.7 by 1T3XT)>>
endobj
xref
0 10
0000000000 65535 f
0000007231 00000 n
0000007324 00000 n
0000000015 00000 n
0000007412 00000 n
0000005151 00000 n
0000005323 00000 n
0000007068 00000 n
0000007481 00000 n
0000007526 00000 n
trailer
<</Info 9 0 R/ID [<552b1e727381581372fd24b0e9b5edfa><c76991eef99bbb8d78818d09284471e8>]/Root 8 0 R/Size 10>>
startxref
7648
%%EOF

Retrieve list filter on aditional reference

Retrieve a list of shipments ready to be manifested and are filtered on aditional reference.

Path parameters

Table 12. /v2/shipments/{account}/manifest/list
Parameter	Description
`account`	The account to which the shipment(s) belong(s).

Request parameters

Parameter	Description	Constraints
date	The pickup date.	Format yyyy-MM-dd HH:mm:ss.
dateTo	The pickup date until.	Format yyyy-MM-dd HH:mm:ss.
carrier	The carrier.	Fixed length of 3.
costCenter	The costCenter (optional).	Maximum size of 32.
slt	The service level time (optional).	Maximum size of 32.
slo	The service level other (optional).	Maximum size of 32.
receiverCountry	The country of the receiver (optional).	Maximum size of 3.
reference	The value of the aditional reference (optional).
referenceType	The aditional reference type (optional).

Parameter

Description

Constraints

date

The pickup date.

Format yyyy-MM-dd HH:mm:ss.

dateTo

The pickup date until.

Format yyyy-MM-dd HH:mm:ss.

carrier

The carrier.

Fixed length of 3.

costCenter

The costCenter (optional).

Maximum size of 32.

slt

The service level time (optional).

Maximum size of 32.

slo

The service level other (optional).

Maximum size of 32.

receiverCountry

The country of the receiver (optional).

Maximum size of 3.

reference

The value of the aditional reference (optional).

referenceType

The aditional reference type (optional).

Response structure

same as manifestlist

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

same as manifestlist

Manifest shipments

Manifest shipments that are ready to be manifested.

Path parameters

Table 13. /v2/shipments/{account}/manifest
Parameter	Description
`account`	The account to which the shipment(s) belong(s).

Request parameters

Parameter	Description	Constraints
from	The from pickup date.	Format yyyy-MM-dd HH:mm:ss.
to	The to pickup date.	Format yyyy-MM-dd HH:mm:ss.
carrier	The carrier.	Fixed length of 3.
costCenter	The costCenter (optional).	Maximum size of 32.
receiverCountry	The country of the receiver (optional).	Maximum size of 3.

Parameter

Description

Constraints

from

The from pickup date.

Format yyyy-MM-dd HH:mm:ss.

The to pickup date.

Format yyyy-MM-dd HH:mm:ss.

carrier

The carrier.

Fixed length of 3.

costCenter

The costCenter (optional).

Maximum size of 32.

receiverCountry

The country of the receiver (optional).

Maximum size of 3.

Response structure

Returns true if shipments where manifested, else false.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

Manifest shipments filtered on aditional reference

Manifest shipments that are ready to be manifested and are filtered on aditional reference.

Path parameters

Unresolved directive in v2/services/shipments/service_doc.adoc - include::snippets/manifestOnReferenceShipments/path-parameters.adoc[]

Request parameters

Unresolved directive in v2/services/shipments/service_doc.adoc - include::snippets/manifestOnReferenceShipments/request-parameters.adoc[]

Response structure

same as Manifest shipments

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

3.0 Rates calculation

This involves a pre-booking calculation of the shipment charges before the shipment is actually booked.

Main resource: v2/rates

3.1 Calculating rates

Call this resource to get a list of calculated buying and selling rates for your configured carriers and their servicelevels based on shipment details.

The following calculation are supported:

calculate, this calculates rates for all carriers and service levels.
preBooking, this completes the booking based on routing rules and then calculates the rate for that booking.
filtered, this calculates rates for the (optional) specified carrier, service levels time and service level other.

Path parameters

Unresolved directive in v2/services/rates/service_doc.adoc - include::snippets/retrieveRates/path-parameters.adoc[]

Request parameters

Unresolved directive in v2/services/rates/service_doc.adoc - include::snippets/retrieveRates/request-parameters.adoc[]

Request fields

Unresolved directive in v2/services/rates/service_doc.adoc - include::snippets/retrieveRates/request-fields.adoc[]

Response structure

Unresolved directive in v2/services/rates/service_doc.adoc - include::snippets/retrieveRates/response-fields.adoc[]

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

3.2 Calculating insurance

Get a list of ensurance premiums for your configured insurance company.

Path parameters

Table 14. /v2/rates/{account}/insurance
Parameter	Description
`account`	The account.

Request parameters

Parameter	Description	Constraints
currency	The currency to calculate with.
countryFrom	The country where the shipment is originated.
countryTo	The country where the shipment is shipped to.
value	The value of the goods to be shipped.

Parameter

Description

Constraints

currency

The currency to calculate with.

countryFrom

The country where the shipment is originated.

countryTo

The country where the shipment is shipped to.

value

The value of the goods to be shipped.

Response structure

Path	Type	Description	Constraints
[] .company	String	The insurance company.	Maximum size of 128.
[] .description	String	The description for this rate.	Maximum size of 128.
[] .currency	String	The currency.	Maximum size of 3.
[] .premium	Decimal	The price.	Maximum value is 999,999,999.99 Minimum value is 0

Path

Type

Description

Constraints

[]
.company

String

The insurance company.

Maximum size of 128.

[]
.description

String

The description for this rate.

Maximum size of 128.

[]
.currency

String

The currency.

Maximum size of 3.

[]
.premium

Decimal

The price.

Maximum value is 999,999,999.99
Minimum value is 0

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

3.3 Get insurance information

Get the ensurance information for the shipment.

Path parameters

Table 15. /v2/rates/{account}/insurance/{reference}
Parameter	Description
`account`	The account.
`reference`	The booking reference.

Response structure

Path	Type	Description	Constraints
company	String	The insurance company.	Maximum size of 128.
currency	String	The currency.	Maximum size of 3.
claimLink	String	The link to claim a insurance.	Maximum size of 256.
policyLink	String	The link to the policy applicable for the insurance.	Maximum size of 256.
description	String	The description for this rate.	Maximum size of 128.
insuredValue	Decimal	The insured value.	Maximum value is 999,999,999.99 Minimum value is 0
premium	Decimal	The price.	Maximum value is 999,999,999.99 Minimum value is 0

Path

Type

Description

Constraints

company

String

The insurance company.

Maximum size of 128.

currency

String

The currency.

Maximum size of 3.

claimLink

String

The link to claim a insurance.

Maximum size of 256.

policyLink

String

The link to the policy applicable for the insurance.

Maximum size of 256.

description

String

The description for this rate.

Maximum size of 128.

insuredValue

Decimal

The insured value.

Maximum value is 999,999,999.99
Minimum value is 0

premium

Decimal

The price.

Maximum value is 999,999,999.99
Minimum value is 0

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

4.0 Document printing

This involves the printing of documents that may have been generated for a shipment.

Main resource: v2/prints

4.1 Print document

Print a shipment by reference

The parameter rawJob determines if the printing should be handled by the system or the to be printed documents should be returned in the response. So in case of a rawJob the actual base64 encoded shipment level and package level documents (PDF and / or ZPL) are included in the response.+ In the example below the same input is used and only the parameter rawJob is false or true.

Path variables

Table 16. /v2/prints/{account}/{reference}
Parameter	Description
`account`	Account on which the shipment has been booked.
`reference`	Reference of shipment to be printed

Request variables

Parameter	Description	Constraints
rawJob	Include all shipment level and package level documents, either pdf and/or zpl, in base64 encoded format. When set to false Transsmart will automatically print the documents via SmartPrint. Speak with your Transsmart contact for more information on the implementation considerations	Default is false.

Parameter

Description

Constraints

rawJob

Include all shipment level and package level documents, either pdf and/or zpl, in base64 encoded format. When set to false Transsmart will automatically print the documents via SmartPrint. Speak with your Transsmart contact for more information on the implementation considerations

Default is false.

Response structure print

HTTP/1.1 200 OK
Content-Type: text/plain;charset=UTF-8
Content-Length: 18

Sent to smartprint

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Response structure rawJob

Click here to show/hide example

Path	Type	Description	Constraints
[].reference	String	Shipment reference	The size must be between 1 and 32.
[].airwaybillNumber	String	Shipment airwaybill number	Maximum size of 32.
[].shipmentDocs	List	Shipment level documents
[].shipmentDocs[].docType	String	Document type	Maximum size of 12.
[].shipmentDocs[].fileFormat	String	Document format	Maximum size of 8.
[].shipmentDocs[].encodingFormat	String	Data encoding format	Maximum size of 8.
[].shipmentDocs[].data	String	Document data	Maximum size of 16777215.
[].shipmentDocs[].printerType	String	Type of printer	Maximum size of 64.
[].shipmentDocs[].printerName	String	Printer name	Maximum size of 256.
[].shipmentDocs[].sequence	String	Package sequence	Maximum size of 200000.
[].shipmentDocs[].height	Integer wrapped in String	Height in milimeters, not used	Maximum value is 999,999,999 Minimum value is 0
[].shipmentDocs[].width	Integer wrapped in String	Width in milimeters, not used	Maximum value is 999,999,999 Minimum value is 0
[].shipmentDocs[].templateID	String	Document Template ID	Maximum size of 12.
[].errors	List	Errors that may have happend during the printjob.
[].errors[].errorCode	String	Error code
[].errors[].errorTitle	String	Error title
[].errors[].errorDescription	String	More detailed description of the actual error.
[].packageDocs	List	Shipment package level documents
[].packageDocs[].docType	String	Document type	Maximum size of 12.
[].packageDocs[].fileFormat	String	Document format	Maximum size of 8.
[].packageDocs[].encodingFormat	String	Data encoding format	Maximum size of 8.
[].packageDocs[].data	String	Document data	Maximum size of 16777215.
[].packageDocs[].printerType	String	Type of printer	Maximum size of 64.
[].packageDocs[].printerName	String	Printer name	Maximum size of 256.
[].packageDocs[].sequence	String	Package sequence	Maximum size of 200000.
[].packageDocs[].airwaybillNumber	String	Package airwaybill	Maximum size of 32.
[].packageDocs[].lineNo	Integer	Package line number	Maximum value is 200000.
[].packageDocs[].shipmentLineId	String	Shipment line identifier	Maximum size of 32.
[].packageDocs[].height	Integer wrapped in String	Height in milimeters, not used	Maximum value is 999,999,999 Minimum value is 0
[].packageDocs[].width	Integer wrapped in String	Width in milimeters, not used	Maximum value is 999,999,999 Minimum value is 0
[].packageDocs[].templateID	String	Document Template ID	Maximum size of 12.

Path

Type

Description

Constraints

[].reference

String

Shipment reference

The size must be between 1 and 32.

[].airwaybillNumber

String

Shipment airwaybill number

Maximum size of 32.

[].shipmentDocs

List

Shipment level documents

[].shipmentDocs[].docType

String

Document type

Maximum size of 12.

[].shipmentDocs[].fileFormat

String

Document format

Maximum size of 8.

[].shipmentDocs[].encodingFormat

String

Data encoding format

Maximum size of 8.

[].shipmentDocs[].data

String

Document data

Maximum size of 16777215.

[].shipmentDocs[].printerType

String

Type of printer

Maximum size of 64.

[].shipmentDocs[].printerName

String

Printer name

Maximum size of 256.

[].shipmentDocs[].sequence

String

Package sequence

Maximum size of 200000.

[].shipmentDocs[].height

Integer wrapped in String

Height in milimeters, not used

Maximum value is 999,999,999
Minimum value is 0

[].shipmentDocs[].width

Integer wrapped in String

Width in milimeters, not used

Maximum value is 999,999,999
Minimum value is 0

[].shipmentDocs[].templateID

String

Document Template ID

Maximum size of 12.

[].errors

List

Errors that may have happend during the printjob.

[].errors[].errorCode

String

Error code

[].errors[].errorTitle

String

Error title

[].errors[].errorDescription

String

More detailed description of the actual error.

[].packageDocs

List

Shipment package level documents

[].packageDocs[].docType

String

Document type

Maximum size of 12.

[].packageDocs[].fileFormat

String

Document format

Maximum size of 8.

[].packageDocs[].encodingFormat

String

Data encoding format

Maximum size of 8.

[].packageDocs[].data

String

Document data

Maximum size of 16777215.

[].packageDocs[].printerType

String

Type of printer

Maximum size of 64.

[].packageDocs[].printerName

String

Printer name

Maximum size of 256.

[].packageDocs[].sequence

String

Package sequence

Maximum size of 200000.

[].packageDocs[].airwaybillNumber

String

Package airwaybill

Maximum size of 32.

[].packageDocs[].lineNo

Integer

Package line number

Maximum value is 200000.

[].packageDocs[].shipmentLineId

String

Shipment line identifier

Maximum size of 32.

[].packageDocs[].height

Integer wrapped in String

Height in milimeters, not used

Maximum value is 999,999,999
Minimum value is 0

[].packageDocs[].width

Integer wrapped in String

Width in milimeters, not used

Maximum value is 999,999,999
Minimum value is 0

[].packageDocs[].templateID

String

Document Template ID

Maximum size of 12.

Example response rawJob

Click here to show/hide example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 10688

[ {
  "reference" : "Transsmart_1687866674312",
  "airwaybillNumber" : "05228021365536",
  "shipmentDocs" : [ ],
  "packageDocs" : [ {
    "docType" : "Label",
    "templateID" : "DPD_ZPL_SCR",
    "fileFormat" : "ZPL",
    "encodingFormat" : "base64",
    "data" : "XlhBCl5GWCBERUZBVUxUIFRSQU5TU01BUlQgSEVBREVSIF5GUwpeTU5ZXlBNTl5MSDAsMF5KTUFeTFJOXkNJMjgKXlhaCl5YQQ0KDQojRFBEIExPR08jDQpeRk83MjksMzgwXkdGQSw3NTAsNzUwLDEwLCxNMDdJRixNMElGRTIsTTBJRkM3LEwwMUlGQzcsTDAzSUY4RjgsTDAzSUY4RkMsTDA3SUYxRkMsTDA3RkZFMUZFLEwwSUZFM0ZFLEswMUlGQzdGRiw6SzAzSUY4SUY4LEswMzhJMElGOCxLMDc4MDAxSUZDLEswM0MwMDNJRjgsSzAxTUY4LEswMU1GLEwwSkY3RkYsTDBJRkUzRkUsTDA3SUYxRkMsOkwwM0lGOEY4LEwwMUlGOEY4LEwwMUlGQzcsTTBJRkUzLE0wSUZFMixNMDdJRiwsOjo6Ojo6OjpOMEZDLE0wMUZGLE0wMUZGOCxNMDNDMzgsTTAzODM4LE0wNzAxOCw6Ok0wNzAzODIsTTA3SUZFLE0wM0lGRSw6LEwwN0lGOCw6Ok8wMzgsTzAxOCxNMDcwMTgsOk0wNzgzOCxNMDNDNzgsTTAzRkY4LE0wMUZGLE4wM0MsLE4wN0MsTTAxRkYsTTAzRkY4LE0wM0M3OCxNMDMwMzgsTTA3MDE4LDo6TTA3SUZFLDpNMDNJRkUsUTAyLF5GUw0KDQojTElKTkVOIE9QIEhFVCBMQUJFTCMNCl5GTzAsODdeRlJeR0I3OTksMiwyXkZTDQpeRk8wLDMyNl5GUl5HQjU5NywyLDJeRlMNCl5GTzAsNDc0XkZSXkdCNzk5LDIsMl5GUw0KXkZPMCw2MzheRlJeR0I3OTksMiwyXkZTDQpeRk82MDEsODdeRlJeR0IyLDM4NywyXkZTDQpeRk82ODEsODdeRlJeR0IyLDM4NywyXkZTDQpeRk80MzksMzI4XkZSXkdCMiwxNDYsMl5GUw0KDQojU0NIQURFIE5PVElGSUNBVElFIFZFTEQjDQpeRk81OSwzMF5BME4sMTQsMTReRlJeRkRTY2hhZGUgbmlldCBoZXJrZW5iYWFyIGFhbiBkZSBidWl0ZW5rYW50IG1vZXQgYmlubmVuIDcgZGFnZW4gbmEgYWZsZXZlcmluZyBzY2hyaWZ0ZWxpamsgZ2VtZWxkIHdvcmRlbi5eRlMNCl5GTzU5LDQ3XkEwTiwxNCwxNF5GUl5GRERhbWFnZSBub3QgcmVjb2duaXphYmxlIG9uIHRoZSBvdXRzaWRlIGhhcyB0byBiZSByZXBvcnRlZCBpbiB3cml0aW5nIHRvIERQRCB3aXRoaW4gNyBkYXlzIGFmdGVyIGRlbGl2ZXJ5Ll5GUw0KDQojRFBEIElOR0FOR1MgREVQT1QgR0VHRVZFTlMjDQpeRk83NDQsOTZeQTBOLDE0LDE2XkZSXkZERGVwb3ReRlMNCl5GTzc2MiwxMTReQTBSLDE5LDE2XkZSXkZERFBEIChOZWRlcmxhbmQpIEIuVi4gZGVwb3QgMDUyMl5GUw0KXkZPNzQ0LDExNF5BMFIsMTksMTVeRlJeRkRXZXN0ZmllbGRzIDE0MTBeRlMNCl5GTzcyNiwxMTReQTBSLDE5LDE2XkZSXkZENTY4OEhBIE9pcnNjaG90XkZTDQpeRk83MDgsMTE0XkEwUiwxOSwxNV5GUl5GRFBob25lOiArMzEtKDApNCA5OS0zIDM5LTkgMDBeRlMNCl5GTzY5MCwxMTReQTBSLDE5LDE1XkZSXkZERmF4OiArMzEtKDApNCA5OS0zIDM5LTkgMDFeRlMNCg0KI1ZFUlpFTkRFUiBHRUdFVkVOUyBWRUxEIw0KXkZPNjMwLDk2XkEwTiwxNCwxNl5GUl5GRFNlbmRlcl5GUw0KXkZPNjU2LDExNF5BMFIsMTksMTVeRlJeRkRUcmFuc3NtYXJ0XkZTDQpeRk82MzgsMTE0XkEwUiwxOSwxNV5GUl5GREVsbGVuIFBhbmtodXJzdHN0cmFhdCAxY15GUw0KXkZPNjIwLDExNF5BMFIsMTksMTZeRlJeRkROTC01MDMyTUQgVGlsYnVyZ15GUw0KXkZPNjAyLDExNF5BMFIsMTksMTZeRlJeRkReRlMNCg0KI09OVFZBTkdFUiBHRUdFVkVOUyBWRUxEIw0KXkZPNTQyLDk2XkEwTiwxNCwxNV5GUl5GRFJlY2VpdmVyXkZTDQpeRk8xNiwxMDJeQTBOLDIyLDMyXkZSXkZEVHJhbnNzbWFydF5GUw0KXkZPMTYsMTMwXkEwTiwyMiwzMl5GUl5GRF5GUw0KXkZPMTYsMTU4XkEwTiwyMiwzMl5GUl5GRFN1cHBvcnReRlMNCl5GTzE2LDE4Nl5BME4sMjIsMzJeRlJeRkRFbGxlbiBQYW5raHVyc3RzdHJhYXQgIDFjXkZTDQpeRk8xNiwyMTReQTBOLDIyLDMyXkZSXkZEMm5kIGZsb29yXkZTDQpeRk8xNiwyNDJeQTBOLDIyLDMyXkZSXkZEMDAzMTg4MTI2MDMwMF5GUw0KXkZPMTYsMjc4XkEwTiwzMCw0OF5GUl5GRE5MLTUwMzJNRF5GUw0KXkZPMzEwLDI3OF5BME4sMjUsMzBeRlJeRkRUaWxidXJnXkZTDQoNCiNBQU5UQUwgUEFLRVRURU4gKyBHRVdJQ0hUUyBWRUxEIw0KXkZPNDkwLDM2MF5BME4sMzAsMzdeRlJeRkQxLzJeRlMNCl5GTzQ1Myw0MjleQTBOLDMwLDM4XkZSXkZEMjAuMDAga2deRlMNCl5GTzUzNywzMzReQTBOLDE0LDE1XkZSXkZEUGFja2FnZV5GUw0KXkZPNTUyLDQwNV5BME4sMTQsMTVeRlJeRkRXZWlnaHReRlMNCg0KI1JFRkVSRU5USUVOVU1NRVIgVkVMRCMNCl5GTzI0LDMzNF5BME4sMzAsMzleRlJeRkRSZWY6IFRyYW5zc21hcnRfMTY4Nzg2NjY3NDMxMl5GUw0KXkZPMjQsMzcwXkEwTiwzMCwzOV5GUl5GRCAxXkZTDQpeRk8yNCw0MDZeQTBOLDMwLDM5XkZSXkZEMiBeRlMNCl5GTzI0LDQ0Ml5BME4sMzAsMzleRlJeRkQgM15GUw0KDQojU2VydmljZSBibG9jayMNCl5GTzE4LDQ4M15BME4sMjIsMzJeRlJeRkQgXkZTDQpeRk8xOCw1MzNeQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk8xOCw1NTZeQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk8xOCw1NzleQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk8xOCw2MDJeQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk80NTAsNDgzXkEwTiwyMiwzMl5GUl5GRF5GUw0KXkZPNDUwLDUwOF5BME4sMjIsMzJeRlJeRkReRlMNCl5GTzQ1MCw1MzNeQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk8zNzAsNTcwXkEwTiwzMCwzN15GUl5GRF5GUw0KDQojUEFLRVROVU1NRVIgKyBDSEVDSyBESUdJVCArIFNFUlZJQ0UgQ09ERShJTiBURVhUKSMNCl5GTzE4LDcwN15BME4sMTQsMTReRlJeRkRUcmFja15GUw0KXkZPMTYsNjU2XkEwTiw1Nyw3OF5GUl5GRDA1MjJeRlMNCl5GTzE4NSw2NjZeQTBOLDQwLDU2XkZSXkZEODAyMSAzNjU1IDM2XkZTDQpeRk81MDgsNjc1XkEwTiwyNCwyM15GUl5GREJeRlMNCl5GTzQ2NSw2NTleQTBOLDM1LDMwXkZSXkZCMzIwLDEsLFIsLF5GREReRlMNCl5GTzU4MCw3MDdeQTBOLDE0LDE1XkZSXkZCMjAwLDEsLFIsLF5GRFNlcnZpY2VeRlMNCg0KI1JPVVRFIFZFTEQjDQpeRk8xNiw4MjBeQTBOLDEwMCw3Ml5GUl5GRDA1MjVeRlMNCl5GTzYxNiw4MjBeQTBOLDEwMCw3Ml5GUl5GRDFfQl5GUw0KXkZPMTYsNzIyXkEwTiwxMjUsOTFeRlJeRkI4NDAsMSwsQywsXkZETkwtMDUyNV5GUw0KDQojREFUVU0gKyBUSUpEICYgU0VSVklDRSBDT0RFICsgTEFORENPREUgKyBQT1NUQ09ERSAmIFZFUlNJRSBOUi4jDQpeRk8yOTEsODI3XkEwTiw0MCwzNV5GUl5GRDEwMS1OTC01MDMyTUReRlMNCl5GTzI3Miw4NjJeQTBOLDE0LDE2XkZSXkZEMjcvMDYvMjNeRlMNCl5GTzMzNSw4NjJeQTBOLDE0LDE2XkZSXkZEMTM6NTFeRlMNCl5GTzM3Niw4NjJeQTBOLDE0LDE2XkZSXkZEVmVyc2lvbjogMDEvMjAyMyBUQk9YXkZTDQoNCiNTTUFMTCBQQVJDRUwgWCBJUyBUTyBCRSBESVNQTEFZRUQgLyBJTlRFUk5BVElPTkFMIEVYUFJFU1MgRSBJUyBUTyBCRSBESVNQTEFZRUQjDQpeRk8yMCw3MzBeRlMNCl5GTzI5LDc0NV5BME4sNjAsNTVeRlJeRkReRlMNCg0KI0JBUkNPREUgVkVMRCMNCl5GTzM1LDkwNF5GUl5HQjc0MCwxMCwxMF5GUw0KXkZPNDAsOTE0XkJZMywyLjAsMTk5XkJDTiwxOTksTixOLE4sQV5GUl5GRCUwNTAzMk1EMDUyMjgwMjEzNjU1MzYxMDE1MjheRlNeRkQNCl5GTzE2MCwxMTYwXkEwTiwzMCwzMV5GUl5GRDA1MDMyTUQgMDUyMiA4MDIxIDM2NTUgMzYgMTAxIDUyOCBPXkZTDQoNCl5QUTENCl5YWg0K",
    "printerType" : "LABEL",
    "printerName" : "ZDesigner GK420d",
    "sequence" : "1",
    "height" : "0",
    "width" : "0",
    "airwaybillNumber" : "05228021365536",
    "lineNo" : 1,
    "shipmentLineId" : "example-shippmentLineId"
  }, {
    "docType" : "Label",
    "templateID" : "DPD_ZPL_SCR",
    "fileFormat" : "ZPL",
    "encodingFormat" : "base64",
    "data" : "XlhBCl5GWCBERUZBVUxUIFRSQU5TU01BUlQgSEVBREVSIF5GUwpeTU5ZXlBNTl5MSDAsMF5KTUFeTFJOXkNJMjgKXlhaCl5YQQ0KDQojRFBEIExPR08jDQpeRk83MjksMzgwXkdGQSw3NTAsNzUwLDEwLCxNMDdJRixNMElGRTIsTTBJRkM3LEwwMUlGQzcsTDAzSUY4RjgsTDAzSUY4RkMsTDA3SUYxRkMsTDA3RkZFMUZFLEwwSUZFM0ZFLEswMUlGQzdGRiw6SzAzSUY4SUY4LEswMzhJMElGOCxLMDc4MDAxSUZDLEswM0MwMDNJRjgsSzAxTUY4LEswMU1GLEwwSkY3RkYsTDBJRkUzRkUsTDA3SUYxRkMsOkwwM0lGOEY4LEwwMUlGOEY4LEwwMUlGQzcsTTBJRkUzLE0wSUZFMixNMDdJRiwsOjo6Ojo6OjpOMEZDLE0wMUZGLE0wMUZGOCxNMDNDMzgsTTAzODM4LE0wNzAxOCw6Ok0wNzAzODIsTTA3SUZFLE0wM0lGRSw6LEwwN0lGOCw6Ok8wMzgsTzAxOCxNMDcwMTgsOk0wNzgzOCxNMDNDNzgsTTAzRkY4LE0wMUZGLE4wM0MsLE4wN0MsTTAxRkYsTTAzRkY4LE0wM0M3OCxNMDMwMzgsTTA3MDE4LDo6TTA3SUZFLDpNMDNJRkUsUTAyLF5GUw0KDQojTElKTkVOIE9QIEhFVCBMQUJFTCMNCl5GTzAsODdeRlJeR0I3OTksMiwyXkZTDQpeRk8wLDMyNl5GUl5HQjU5NywyLDJeRlMNCl5GTzAsNDc0XkZSXkdCNzk5LDIsMl5GUw0KXkZPMCw2MzheRlJeR0I3OTksMiwyXkZTDQpeRk82MDEsODdeRlJeR0IyLDM4NywyXkZTDQpeRk82ODEsODdeRlJeR0IyLDM4NywyXkZTDQpeRk80MzksMzI4XkZSXkdCMiwxNDYsMl5GUw0KDQojU0NIQURFIE5PVElGSUNBVElFIFZFTEQjDQpeRk81OSwzMF5BME4sMTQsMTReRlJeRkRTY2hhZGUgbmlldCBoZXJrZW5iYWFyIGFhbiBkZSBidWl0ZW5rYW50IG1vZXQgYmlubmVuIDcgZGFnZW4gbmEgYWZsZXZlcmluZyBzY2hyaWZ0ZWxpamsgZ2VtZWxkIHdvcmRlbi5eRlMNCl5GTzU5LDQ3XkEwTiwxNCwxNF5GUl5GRERhbWFnZSBub3QgcmVjb2duaXphYmxlIG9uIHRoZSBvdXRzaWRlIGhhcyB0byBiZSByZXBvcnRlZCBpbiB3cml0aW5nIHRvIERQRCB3aXRoaW4gNyBkYXlzIGFmdGVyIGRlbGl2ZXJ5Ll5GUw0KDQojRFBEIElOR0FOR1MgREVQT1QgR0VHRVZFTlMjDQpeRk83NDQsOTZeQTBOLDE0LDE2XkZSXkZERGVwb3ReRlMNCl5GTzc2MiwxMTReQTBSLDE5LDE2XkZSXkZERFBEIChOZWRlcmxhbmQpIEIuVi4gZGVwb3QgMDUyMl5GUw0KXkZPNzQ0LDExNF5BMFIsMTksMTVeRlJeRkRXZXN0ZmllbGRzIDE0MTBeRlMNCl5GTzcyNiwxMTReQTBSLDE5LDE2XkZSXkZENTY4OEhBIE9pcnNjaG90XkZTDQpeRk83MDgsMTE0XkEwUiwxOSwxNV5GUl5GRFBob25lOiArMzEtKDApNCA5OS0zIDM5LTkgMDBeRlMNCl5GTzY5MCwxMTReQTBSLDE5LDE1XkZSXkZERmF4OiArMzEtKDApNCA5OS0zIDM5LTkgMDFeRlMNCg0KI1ZFUlpFTkRFUiBHRUdFVkVOUyBWRUxEIw0KXkZPNjMwLDk2XkEwTiwxNCwxNl5GUl5GRFNlbmRlcl5GUw0KXkZPNjU2LDExNF5BMFIsMTksMTVeRlJeRkRUcmFuc3NtYXJ0XkZTDQpeRk82MzgsMTE0XkEwUiwxOSwxNV5GUl5GREVsbGVuIFBhbmtodXJzdHN0cmFhdCAxY15GUw0KXkZPNjIwLDExNF5BMFIsMTksMTZeRlJeRkROTC01MDMyTUQgVGlsYnVyZ15GUw0KXkZPNjAyLDExNF5BMFIsMTksMTZeRlJeRkReRlMNCg0KI09OVFZBTkdFUiBHRUdFVkVOUyBWRUxEIw0KXkZPNTQyLDk2XkEwTiwxNCwxNV5GUl5GRFJlY2VpdmVyXkZTDQpeRk8xNiwxMDJeQTBOLDIyLDMyXkZSXkZEVHJhbnNzbWFydF5GUw0KXkZPMTYsMTMwXkEwTiwyMiwzMl5GUl5GRF5GUw0KXkZPMTYsMTU4XkEwTiwyMiwzMl5GUl5GRFN1cHBvcnReRlMNCl5GTzE2LDE4Nl5BME4sMjIsMzJeRlJeRkRFbGxlbiBQYW5raHVyc3RzdHJhYXQgIDFjXkZTDQpeRk8xNiwyMTReQTBOLDIyLDMyXkZSXkZEMm5kIGZsb29yXkZTDQpeRk8xNiwyNDJeQTBOLDIyLDMyXkZSXkZEMDAzMTg4MTI2MDMwMF5GUw0KXkZPMTYsMjc4XkEwTiwzMCw0OF5GUl5GRE5MLTUwMzJNRF5GUw0KXkZPMzEwLDI3OF5BME4sMjUsMzBeRlJeRkRUaWxidXJnXkZTDQoNCiNBQU5UQUwgUEFLRVRURU4gKyBHRVdJQ0hUUyBWRUxEIw0KXkZPNDkwLDM2MF5BME4sMzAsMzdeRlJeRkQyLzJeRlMNCl5GTzQ1Myw0MjleQTBOLDMwLDM4XkZSXkZEMjAuMDAga2deRlMNCl5GTzUzNywzMzReQTBOLDE0LDE1XkZSXkZEUGFja2FnZV5GUw0KXkZPNTUyLDQwNV5BME4sMTQsMTVeRlJeRkRXZWlnaHReRlMNCg0KI1JFRkVSRU5USUVOVU1NRVIgVkVMRCMNCl5GTzI0LDMzNF5BME4sMzAsMzleRlJeRkRSZWY6IFRyYW5zc21hcnRfMTY4Nzg2NjY3NDMxMl5GUw0KXkZPMjQsMzcwXkEwTiwzMCwzOV5GUl5GRCAxXkZTDQpeRk8yNCw0MDZeQTBOLDMwLDM5XkZSXkZEMiBeRlMNCl5GTzI0LDQ0Ml5BME4sMzAsMzleRlJeRkQgM15GUw0KDQojU2VydmljZSBibG9jayMNCl5GTzE4LDQ4M15BME4sMjIsMzJeRlJeRkQgXkZTDQpeRk8xOCw1MzNeQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk8xOCw1NTZeQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk8xOCw1NzleQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk8xOCw2MDJeQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk80NTAsNDgzXkEwTiwyMiwzMl5GUl5GRF5GUw0KXkZPNDUwLDUwOF5BME4sMjIsMzJeRlJeRkReRlMNCl5GTzQ1MCw1MzNeQTBOLDIyLDMyXkZSXkZEXkZTDQpeRk8zNzAsNTcwXkEwTiwzMCwzN15GUl5GRF5GUw0KDQojUEFLRVROVU1NRVIgKyBDSEVDSyBESUdJVCArIFNFUlZJQ0UgQ09ERShJTiBURVhUKSMNCl5GTzE4LDcwN15BME4sMTQsMTReRlJeRkRUcmFja15GUw0KXkZPMTYsNjU2XkEwTiw1Nyw3OF5GUl5GRDA1MjJeRlMNCl5GTzE4NSw2NjZeQTBOLDQwLDU2XkZSXkZEODAyMSAzNjU1IDM3XkZTDQpeRk81MDgsNjc1XkEwTiwyNCwyM15GUl5GRDleRlMNCl5GTzQ2NSw2NTleQTBOLDM1LDMwXkZSXkZCMzIwLDEsLFIsLF5GREReRlMNCl5GTzU4MCw3MDdeQTBOLDE0LDE1XkZSXkZCMjAwLDEsLFIsLF5GRFNlcnZpY2VeRlMNCg0KI1JPVVRFIFZFTEQjDQpeRk8xNiw4MjBeQTBOLDEwMCw3Ml5GUl5GRDA1MjVeRlMNCl5GTzYxNiw4MjBeQTBOLDEwMCw3Ml5GUl5GRDFfQl5GUw0KXkZPMTYsNzIyXkEwTiwxMjUsOTFeRlJeRkI4NDAsMSwsQywsXkZETkwtMDUyNV5GUw0KDQojREFUVU0gKyBUSUpEICYgU0VSVklDRSBDT0RFICsgTEFORENPREUgKyBQT1NUQ09ERSAmIFZFUlNJRSBOUi4jDQpeRk8yOTEsODI3XkEwTiw0MCwzNV5GUl5GRDEwMS1OTC01MDMyTUReRlMNCl5GTzI3Miw4NjJeQTBOLDE0LDE2XkZSXkZEMjcvMDYvMjNeRlMNCl5GTzMzNSw4NjJeQTBOLDE0LDE2XkZSXkZEMTM6NTFeRlMNCl5GTzM3Niw4NjJeQTBOLDE0LDE2XkZSXkZEVmVyc2lvbjogMDEvMjAyMyBUQk9YXkZTDQoNCiNTTUFMTCBQQVJDRUwgWCBJUyBUTyBCRSBESVNQTEFZRUQgLyBJTlRFUk5BVElPTkFMIEVYUFJFU1MgRSBJUyBUTyBCRSBESVNQTEFZRUQjDQpeRk8yMCw3MzBeRlMNCl5GTzI5LDc0NV5BME4sNjAsNTVeRlJeRkReRlMNCg0KI0JBUkNPREUgVkVMRCMNCl5GTzM1LDkwNF5GUl5HQjc0MCwxMCwxMF5GUw0KXkZPNDAsOTE0XkJZMywyLjAsMTk5XkJDTiwxOTksTixOLE4sQV5GUl5GRCUwNTAzMk1EMDUyMjgwMjEzNjU1MzcxMDE1MjheRlNeRkQNCl5GTzE2MCwxMTYwXkEwTiwzMCwzMV5GUl5GRDA1MDMyTUQgMDUyMiA4MDIxIDM2NTUgMzcgMTAxIDUyOCA3XkZTDQoNCl5QUTENCl5YWg0K",
    "printerType" : "LABEL",
    "printerName" : "ZDesigner GK420d",
    "sequence" : "2",
    "height" : "0",
    "width" : "0",
    "airwaybillNumber" : "05228021365537",
    "lineNo" : 1,
    "shipmentLineId" : "example-shippmentLineId"
  } ],
  "errors" : null
} ]

5.0 Shipment status tracking

This involves status tracking after a shipment is successfully booked.

Main resource: v2/statuses

5.1 Status retrieval

For the status retrieval we have 2 types of retrievals:

Per shipment with a query per reference
A list of shipments based on query parameters.

5.1.1 For a single shipment

Retrieve status for a shipment per reference without detailed information

Path parameters

Table 17. /v2/statuses/{account}/shipments/{reference}
Parameter	Description
`account`	Account code
`reference`	Shipment reference

Request parameters

Parameter

Description

Constraints

isDetailed

Include the status history in chronological order.

Default is true.

currentStatusOnly

Only include the last status per shipment and collo, not the complete history, this parameter only works when the parameter 'isDetailed' set to true.

Default is false.

withPod

Include the POD in the response if set to true. This parameter only works when the parameter 'isDetailed' is set to true.

Default is false.

Response structure

Path

Type

Description

Constraints

reference

String

Shipment reference

Not Null and not empty.
The size must be between 1 and 32.

carrier

String

Carrier

Fixed length of 3.
Not Null and not empty.

costcenter

String

Costcenter. Only returned when the backend parameter extended is set to true, contact your consultant for more details

Maximum size of 32.

shipmentStatus

String

Latest shipment status code

trackAndTraceUrl

String

Track and trace url

Maximum size of 2048.

airwaybill

String

Airwaybill

Maximum size of 32.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

Retrieve status for a shipment per reference with detailed information

Path parameters

Table 18. /v2/statuses/{account}/shipments/{reference}
Parameter	Description
`account`	Account code
`reference`	Shipment reference

Request parameters

Parameter

Description

Constraints

isDetailed

Include the status history in chronological order.

Default is true.

currentStatusOnly

Only include the last status per shipment and collo, not the complete history, this parameter only works when the parameter 'isDetailed' set to true.

Default is false.

withPod

Include the POD in the response if set to true. This parameter only works when the parameter 'isDetailed' is set to true.

Default is false.

Response structure

Path

Type

Description

Constraints

reference

String

Shipment reference

Not Null and not empty.
The size must be between 1 and 32.

carrier

String

Carrier

Fixed length of 3.
Not Null and not empty.

costcenter

String

Costcenter. Only returned when the backend parameter extended is set to true, contact your consultant for more details

Maximum size of 32.

shipmentStatus

String

Latest shipment status code

trackAndTraceUrl

String

Track and trace url

Maximum size of 2048.

airwaybill

String

Airwaybill

Maximum size of 32.

accountId

String

Account of the shipment

Maximum size of 32.

incoterms

String

Incoterms of the shipment

Maximum size of 16.

acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

actualDeliveryDate

Date wrapped in String

Actual deliverydate

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

requestedDeliveryDateFrom

Date wrapped in String

Requested delivery date from, as sent during booking

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

requestedDeliveryDateTo

Date wrapped in String

Requested delivery date to, as sent during booking

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

plannedDeliveryDateFrom

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

plannedDeliveryDateTo

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

price

Decimal

Price of the shipment, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

priceCurrency

String

Currency of the price of the shipment

Maximum size of 3.

pickupDateFrom

Date wrapped in String

Pickup date from, of the shipment

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

pickupDateTo

Date wrapped in String

Pickup date to, of the shipment

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

description

String

Shipments description

Maximum size of 128.

instruction

String

Shipments instruction

Maximum size of 128.

weight

String

The weight of the shipment. May be different from the shipments original weight in case the carrier has acknowledged another value as part of the delivery status feedback.

Maximum value is 999,999,999.99
Minimum value is 0

weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Has to match pattern: (KG|
LB|
OZ|
)
Maximum size of 3.

currency

String

Currency of the price of the shipment

Maximum size of 3.

executingCarrier

String

The actual executing carrier in the 3 letter char code

Fixed length of 3.

inbound

Integer

Indicates if it is an inbound shipment (inbound =1 else 0)

Maximum value is 1.
Minimum value is 0.

pieces

Integer

Number of packages/colli in the shipment

Maximum value is 32767.
Minimum value is 0.

service

String

Service indicating DOCS or NON-DOCS

Maximum size of 16.

serviceLevelTime

String

Service level time like STANDARD, SAVER

Maximum size of 32.
Not Null and not empty.

serviceLevelOther

String

Service level other like COD, EVENING etc.

Maximum size of 32.

value

Decimal

Value of the goods, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

valueCurrency

String

Currency of the value of the goods

Maximum size of 3.

addresses

List

List of addresses of the shipment

addresses.[]
.type

String

Address type

Maximum size of 4.
Not Null and not empty.

addresses.[]
.name

String

Name

Maximum size of 64.
Not Null and not empty.

addresses.[]
.addressLine1

String

Street 1

Maximum size of 64.
Not Null and not empty.

addresses.[]
.addressLine2

String

Street 2

Maximum size of 64.

addresses.[]
.city

String

City

Maximum size of 64.
Not Null and not empty.

addresses.[]
.houseNumber

String

Housenumber

Maximum size of 16.

addresses.[]
.zipCode

String

Zip code

Maximum size of 16.
Not Null and not empty.

addresses.[]
.province

String

Province / State

Maximum size of 16.

addresses.[]
.country

String

The country code.

Maximum size of 2.
Not Null and not empty.

addresses.[]
.contactPerson

String

Name of the contact person

Maximum size of 64.

addresses.[]
.contactPhone

String

Phone number of the contact person

Maximum size of 32.

addresses.[]
.contactFax

String

Fax number of the contact person

Maximum size of 32.

addresses.[]
.contactEmail

String

E-mail address of the contact person

Maximum size of 256.

addresses.[]
.accountNumber

String

Account number at the carrier for this address, possibly the shipment is booked with this account number but the implementation can differ per carrier, contact your consultant / project manager for more information

Maximum size of 32.

additionalReferences

List wrapped in List

List of additional references

additionalReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

additionalReferences.[]
.value

String

The reference value

Maximum size of 1024.

statuses

List

List of shipment statuses

statuses.[]
.airwayBill

String

Airwaybill / barocde of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

statuses.[]
.code

String

The Transsmart generic status code

statuses.[]
.weight

String

The weight of the shipment. May be different from the shipments original weight in case the carrier has acknowledged another value as part of the delivery status feedback.

Maximum value is 999,999,999.99
Minimum value is 0

statuses.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Has to match pattern: (KG|
LB|
OZ|
)
Maximum size of 3.

statuses.[]
.pieces

Integer

Number of packages/colli in the shipment

Maximum value is 32767.

statuses.[]
.incoterms

String

Incoterms of the shipment

Maximum size of 16.

statuses.[]
.statusPrice

Double

Buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

statuses.[]
.statusPriceCurrency

String

Currency of the buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

statuses.[]
.statusSalesPrice

Double

Sell price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

statuses.[]
.statusSalesPriceCurrency

String

Currency of the sell price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

statuses.[]
.minimumTransitTime

Integer

Minimum transit time in hours

Maximum value is 32767.

statuses.[]
.maximumTransitTime

Integer

Maximum transit time in hours

Maximum value is 32767.

statuses.[]
.printDateTime

Date wrapped in String

Date and time the shipment was printed

Format yyyy-MM-dd HH:mm:ss.
Maximum size of 10.

statuses.[]
.printUser

String

User of who executed the print operation

Maximum size of 64.

statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

Format yyyy-MM-dd HH:mm:ss.

statuses.[]
.subStatus
.type

String

SubStatus type.

Maximum size of 256.

statuses.[]
.subStatus
.detail

String

SubStatus detail.

Maximum size of 256.

statuses.[]
.subStatus
.description

String

SubStatus description.

Maximum size of 256.

statuses.[]
.documents

List

A list of documents regarding this status, currently it holds only POD’s

statuses.[]
.documents.[]
.documentType

String

Type of the document like POD

Maximum size of 12.

statuses.[]
.documents.[]
.fileType

String

File type, like PNG, JPG, PDF, XPS

Maximum size of 8.

statuses.[]
.documents.[]
.documentData

String

Base64 encrypted document

Maximum size of 16777215.

shipmentLines

List

List of shipment lines and its statuses

shipmentLines.[]
.lineNumber

Integer

Sequential line number of this shipment line

Maximum value is 200000.

shipmentLines.[]
.shipmentLineId

String

Shipment line id

Maximum size of 32.

shipmentLines.[]
.description

String

Shipments description

Maximum size of 128.

shipmentLines.[]
.airwaybill

String

Airwaybill

Maximum size of 32.

shipmentLines.[]
.acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

shipmentLines.[]
.actualDeliveryDate

Date wrapped in String

Actual deliverydate

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

shipmentLines.[]
.plannedDeliveryDateFrom

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

shipmentLines.[]
.plannedDeliveryDateTo

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

shipmentLines.[]
.price

Decimal

Price of the shipment, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

shipmentLines.[]
.genericStatusCode

String

The generic status of the collo.

shipmentLines.[]
.carrierStatusCode

String

The carrier status of the collo.

Maximum size of 16.

shipmentLines.[]
.carrierStatusDescription

String

Description of the status code of the carrier

Maximum size of 128.

shipmentLines.[]
.length

Decimal

The Length of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is 0

shipmentLines.[]
.width

Decimal

The width of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is 0

shipmentLines.[]
.height

Decimal

The height of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is 0

shipmentLines.[]
.additionalReferences

List wrapped in List

List of additional references

shipmentLines.[]
.barcodeId

String

Airwaybill / barcode of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

shipmentLines.[]
.additionalReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

shipmentLines.[]
.additionalReferences.[]
.value

String

The reference value

Maximum size of 1024.

shipmentLines.[]
.statuses

List

List of shipment statuses

shipmentLines.[]
.statuses.[]
.lineNumber

Integer

Sequential line number of this shipment line

Maximum value is 2147483647.

shipmentLines.[]
.statuses.[]
.airwayBill

String

Airwaybill / barocde of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

shipmentLines.[]
.statuses.[]
.code

String

The Transsmart generic status code

shipmentLines.[]
.statuses.[]
.carrierStatus

String

The carrier status.

Maximum size of 16.

shipmentLines.[]
.statuses.[]
.carrierStatusDescription

String

Description of the status code of the carrier

Maximum size of 128.

shipmentLines.[]
.statuses.[]
.statusPrice

Double

Buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

shipmentLines.[]
.statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

Format yyyy-MM-dd HH:mm:ss.

shipmentLines.[]
.statuses.[]
.subStatus
.type

String

SubStatus type.

Maximum size of 256.

shipmentLines.[]
.statuses.[]
.subStatus
.detail

String

SubStatus detail.

Maximum size of 256.

shipmentLines.[]
.statuses.[]
.subStatus
.description

String

SubStatus description.

Maximum size of 256.

shipmentLines.[]
.statuses.[]
.documents

List

A list of documents regarding this status, currently it holds only POD’s

shipmentLines.[]
.statuses.[]
.documents.[]
.documentType

String

Type of the document like POD

Maximum size of 12.

shipmentLines.[]
.statuses.[]
.documents.[]
.fileType

String

File type, like PNG, JPG, PDF, XPS

Maximum size of 8.

shipmentLines.[]
.statuses.[]
.documents.[]
.documentData

String

Base64 encrypted document

Maximum size of 16777215.

tariffLogs

List

List of tariff information of the shipment

tariffLogs.[]
.tariffType

String

Tariff type.

tariffLogs.[]
.tariffValue

String

Tariff value.

tariffLogs.[]
.currency

String

Currency of the value.

tariffLogs.[]
.chargeGroup

String

The charge group.

tariffLogs.[]
.chargeType

String

The charge type.

tariffLogs.[]
.calcType

String

The calculation type.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 4940

{
  "reference" : "Transsmart_1681382068193",
  "accountId" : "DEVDOCS",
  "carrier" : "DPD",
  "costcenter" : "",
  "shipmentStatus" : "DEL",
  "incoterms" : "01",
  "trackAndTraceUrl" : "https://tracking.dpd.de/parcelstatus?query=MPS0522802136383820230413&locale=nl_NL&Tracking=Track",
  "airwaybill" : "05228021363838",
  "requestedDeliveryDateFrom" : "16-04-2023 15:00:00",
  "requestedDeliveryDateTo" : "16-04-2023 17:00:00",
  "plannedDeliveryDateFrom" : "14-04-2023 17:00:00",
  "plannedDeliveryDateTo" : "14-04-2023 00:00:00",
  "price" : 15.0,
  "priceCurrency" : "EUR",
  "pickupDateFrom" : "13-04-2023 08:00:00",
  "pickupDateTo" : "13-04-2023 10:00:00",
  "description" : "example-description",
  "instruction" : "example-instruction1",
  "weight" : "40.00",
  "weightUom" : "KG",
  "currency" : "EUR",
  "executingCarrier" : "DPD",
  "inbound" : 0,
  "pieces" : 2,
  "service" : "NON-DOCS",
  "serviceLevelTime" : "CLASSIC",
  "value" : 10.0,
  "valueCurrency" : "EUR",
  "addresses" : [ {
    "type" : "INVC",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNumber" : "1c",
    "addressLine2" : "2nd floor",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "province" : "",
    "country" : "NL",
    "contactPerson" : "Support",
    "contactPhone" : "0031881260300",
    "contactFax" : "0031881260301",
    "contactEmail" : "example@domain.com",
    "accountNumber" : "example-accountNumber"
  }, {
    "type" : "RECV",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNumber" : "1c",
    "addressLine2" : "2nd floor",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "province" : "",
    "country" : "NL",
    "contactPerson" : "Support",
    "contactPhone" : "0031881260300",
    "contactFax" : "0031881260301",
    "contactEmail" : "example@domain.com",
    "accountNumber" : "example-accountNumber"
  }, {
    "type" : "SEND",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNumber" : "1c",
    "addressLine2" : "2nd floor",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "province" : "",
    "country" : "NL",
    "contactPerson" : "Support",
    "contactPhone" : "0031881260300",
    "contactFax" : "0031881260301",
    "contactEmail" : "example@domain.com",
    "accountNumber" : "example-accountNumber"
  } ],
  "tariffLogs" : [ ],
  "additionalReferences" : [ {
    "type" : "ENGINEER",
    "value" : "example-engineer-additional-value-shipment-level"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  } ],
  "statuses" : [ {
    "airwayBill" : "05228021363838",
    "code" : "NEW",
    "weight" : "40.00",
    "weightUom" : "KG",
    "pieces" : 2,
    "incoterms" : "DAP",
    "statusPrice" : 15.0,
    "statusPriceCurrency" : "EUR",
    "minimumTransitTime" : 17,
    "maximumTransitTime" : 17,
    "statusDate" : "13-04-2023 12:34:28"
  }, {
    "airwayBill" : "05228021363838",
    "code" : "DEL",
    "weight" : "40.00",
    "weightUom" : "KG",
    "pieces" : 2,
    "incoterms" : "DAP",
    "statusPrice" : 15.0,
    "statusPriceCurrency" : "EUR",
    "minimumTransitTime" : 17,
    "maximumTransitTime" : 17,
    "statusDate" : "13-04-2023 12:34:29"
  } ],
  "shipmentLines" : [ {
    "lineNumber" : 1,
    "shipmentLineId" : "example-shippmentLineId",
    "airwaybill" : "05228021363838",
    "description" : "example-description",
    "barcodeId" : "%05032MD05228021363838101528",
    "genericStatusCode" : "DEL",
    "length" : 20.0,
    "width" : 20.0,
    "height" : 20.0,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "statuses" : [ {
      "lineNumber" : 1,
      "code" : "NEW",
      "statusDate" : "13-04-2023 12:34:28"
    }, {
      "lineNumber" : 1,
      "airwayBill" : "05228021363838",
      "code" : "NEW",
      "statusDate" : "13-04-2023 12:34:28"
    }, {
      "lineNumber" : 1,
      "airwayBill" : "05228021363838",
      "code" : "DEL",
      "statusDate" : "13-04-2023 12:34:29"
    } ]
  }, {
    "lineNumber" : 2,
    "shipmentLineId" : "example-shippmentLineId",
    "airwaybill" : "05228021363839",
    "description" : "example-description",
    "barcodeId" : "%05032MD05228021363839101528",
    "genericStatusCode" : "DEL",
    "length" : 20.0,
    "width" : 20.0,
    "height" : 20.0,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "statuses" : [ {
      "lineNumber" : 2,
      "code" : "NEW",
      "statusDate" : "13-04-2023 12:34:28"
    }, {
      "lineNumber" : 2,
      "airwayBill" : "05228021363839",
      "code" : "NEW",
      "statusDate" : "13-04-2023 12:34:28"
    }, {
      "lineNumber" : 2,
      "airwayBill" : "05228021363839",
      "code" : "DEL",
      "statusDate" : "13-04-2023 12:34:29"
    } ]
  } ]
}

Retrieve status for a shipment per reference with detailed information about the last status only

Path parameters

Table 19. /v2/statuses/{account}/shipments/{reference}
Parameter	Description
`account`	Account code
`reference`	Shipment reference

Request parameters

Parameter

Description

Constraints

isDetailed

Include the status history in chronological order.

Default is true.

currentStatusOnly

Only include the last status per shipment and collo, not the complete history, this parameter only works when the parameter 'isDetailed' set to true.

Default is false.

withPod

Include the POD in the response if set to true. This parameter only works when the parameter 'isDetailed' is set to true.

Default is false.

Response structure

Path

Type

Description

Constraints

reference

String

Shipment reference

Not Null and not empty.
The size must be between 1 and 32.

carrier

String

Carrier

Fixed length of 3.
Not Null and not empty.

costcenter

String

Costcenter. Only returned when the backend parameter extended is set to true, contact your consultant for more details

Maximum size of 32.

shipmentStatus

String

Latest shipment status code

trackAndTraceUrl

String

Track and trace url

Maximum size of 2048.

airwaybill

String

Airwaybill

Maximum size of 32.

accountId

String

Account of the shipment

Maximum size of 32.

incoterms

String

Incoterms of the shipment

Maximum size of 16.

acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

actualDeliveryDate

Date wrapped in String

Actual deliverydate

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

requestedDeliveryDateFrom

Date wrapped in String

Requested delivery date from, as sent during booking

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

requestedDeliveryDateTo

Date wrapped in String

Requested delivery date to, as sent during booking

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

plannedDeliveryDateFrom

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

plannedDeliveryDateTo

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

price

Decimal

Price of the shipment, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

priceCurrency

String

Currency of the price of the shipment

Maximum size of 3.

pickupDateFrom

Date wrapped in String

Pickup date from, of the shipment

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

pickupDateTo

Date wrapped in String

Pickup date to, of the shipment

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

description

String

Shipments description

Maximum size of 128.

instruction

String

Shipments instruction

Maximum size of 128.

weight

String

The weight of the shipment. May be different from the shipments original weight in case the carrier has acknowledged another value as part of the delivery status feedback.

Maximum value is 999,999,999.99
Minimum value is 0

weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Has to match pattern: (KG|
LB|
OZ|
)
Maximum size of 3.

currency

String

Currency of the price of the shipment

Maximum size of 3.

executingCarrier

String

The actual executing carrier in the 3 letter char code

Fixed length of 3.

inbound

Integer

Indicates if it is an inbound shipment (inbound =1 else 0)

Maximum value is 1.
Minimum value is 0.

pieces

Integer

Number of packages/colli in the shipment

Maximum value is 32767.
Minimum value is 0.

service

String

Service indicating DOCS or NON-DOCS

Maximum size of 16.

serviceLevelTime

String

Service level time like STANDARD, SAVER

Maximum size of 32.
Not Null and not empty.

serviceLevelOther

String

Service level other like COD, EVENING etc.

Maximum size of 32.

value

Decimal

Value of the goods, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

valueCurrency

String

Currency of the value of the goods

Maximum size of 3.

addresses

List

List of addresses of the shipment

addresses.[]
.type

String

Address type

Maximum size of 4.
Not Null and not empty.

addresses.[]
.name

String

Name

Maximum size of 64.
Not Null and not empty.

addresses.[]
.addressLine1

String

Street 1

Maximum size of 64.
Not Null and not empty.

addresses.[]
.addressLine2

String

Street 2

Maximum size of 64.

addresses.[]
.city

String

City

Maximum size of 64.
Not Null and not empty.

addresses.[]
.houseNumber

String

Housenumber

Maximum size of 16.

addresses.[]
.zipCode

String

Zip code

Maximum size of 16.
Not Null and not empty.

addresses.[]
.province

String

Province / State

Maximum size of 16.

addresses.[]
.country

String

The country code.

Maximum size of 2.
Not Null and not empty.

addresses.[]
.contactPerson

String

Name of the contact person

Maximum size of 64.

addresses.[]
.contactPhone

String

Phone number of the contact person

Maximum size of 32.

addresses.[]
.contactFax

String

Fax number of the contact person

Maximum size of 32.

addresses.[]
.contactEmail

String

E-mail address of the contact person

Maximum size of 256.

addresses.[]
.accountNumber

String

Maximum size of 32.

additionalReferences

List wrapped in List

List of additional references

additionalReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

additionalReferences.[]
.value

String

The reference value

Maximum size of 1024.

statuses

List

List of shipment statuses

statuses.[]
.airwayBill

String

Airwaybill / barocde of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

statuses.[]
.code

String

The Transsmart generic status code

statuses.[]
.weight

String

The weight of the shipment. May be different from the shipments original weight in case the carrier has acknowledged another value as part of the delivery status feedback.

Maximum value is 999,999,999.99
Minimum value is 0

statuses.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Has to match pattern: (KG|
LB|
OZ|
)
Maximum size of 3.

statuses.[]
.pieces

Integer

Number of packages/colli in the shipment

Maximum value is 32767.

statuses.[]
.incoterms

String

Incoterms of the shipment

Maximum size of 16.

statuses.[]
.statusPrice

Double

Buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

statuses.[]
.statusPriceCurrency

String

Currency of the buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

statuses.[]
.statusSalesPrice

Double

Sell price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

statuses.[]
.statusSalesPriceCurrency

String

Currency of the sell price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

statuses.[]
.minimumTransitTime

Integer

Minimum transit time in hours

Maximum value is 32767.

statuses.[]
.maximumTransitTime

Integer

Maximum transit time in hours

Maximum value is 32767.

statuses.[]
.printDateTime

Date wrapped in String

Date and time the shipment was printed

Format yyyy-MM-dd HH:mm:ss.
Maximum size of 10.

statuses.[]
.printUser

String

User of who executed the print operation

Maximum size of 64.

statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

Format yyyy-MM-dd HH:mm:ss.

statuses.[]
.subStatus
.type

String

SubStatus type.

Maximum size of 256.

statuses.[]
.subStatus
.detail

String

SubStatus detail.

Maximum size of 256.

statuses.[]
.subStatus
.description

String

SubStatus description.

Maximum size of 256.

statuses.[]
.documents

List

A list of documents regarding this status, currently it holds only POD’s

statuses.[]
.documents.[]
.documentType

String

Type of the document like POD

Maximum size of 12.

statuses.[]
.documents.[]
.fileType

String

File type, like PNG, JPG, PDF, XPS

Maximum size of 8.

statuses.[]
.documents.[]
.documentData

String

Base64 encrypted document

Maximum size of 16777215.

shipmentLines

List

List of shipment lines and its statuses

shipmentLines.[]
.lineNumber

Integer

Sequential line number of this shipment line

Maximum value is 200000.

shipmentLines.[]
.shipmentLineId

String

Shipment line id

Maximum size of 32.

shipmentLines.[]
.description

String

Shipments description

Maximum size of 128.

shipmentLines.[]
.airwaybill

String

Airwaybill

Maximum size of 32.

shipmentLines.[]
.acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

shipmentLines.[]
.actualDeliveryDate

Date wrapped in String

Actual deliverydate

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

shipmentLines.[]
.plannedDeliveryDateFrom

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

shipmentLines.[]
.plannedDeliveryDateTo

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

shipmentLines.[]
.price

Decimal

Price of the shipment, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

shipmentLines.[]
.genericStatusCode

String

The generic status of the collo.

shipmentLines.[]
.carrierStatusCode

String

The carrier status of the collo.

Maximum size of 16.

shipmentLines.[]
.carrierStatusDescription

String

Description of the status code of the carrier

Maximum size of 128.

shipmentLines.[]
.length

Decimal

The Length of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is 0

shipmentLines.[]
.width

Decimal

The width of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is 0

shipmentLines.[]
.height

Decimal

The height of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is 0

shipmentLines.[]
.barcodeId

String

Airwaybill / barcode of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

shipmentLines.[]
.additionalReferences

List wrapped in List

List of additional references

shipmentLines.[]
.additionalReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

shipmentLines.[]
.additionalReferences.[]
.value

String

The reference value

Maximum size of 1024.

shipmentLines.[]
.statuses

List

List of shipment statuses

shipmentLines.[]
.statuses.[]
.lineNumber

Integer

Sequential line number of this shipment line

Maximum value is 2147483647.

shipmentLines.[]
.statuses.[]
.airwayBill

String

Airwaybill / barocde of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

shipmentLines.[]
.statuses.[]
.code

String

The Transsmart generic status code

shipmentLines.[]
.statuses.[]
.carrierStatus

String

The carrier status.

Maximum size of 16.

shipmentLines.[]
.statuses.[]
.carrierStatusDescription

String

Description of the status code of the carrier

Maximum size of 128.

shipmentLines.[]
.statuses.[]
.statusPrice

Double

Buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

shipmentLines.[]
.statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

Format yyyy-MM-dd HH:mm:ss.

shipmentLines.[]
.statuses.[]
.subStatus
.type

String

SubStatus type.

Maximum size of 256.

shipmentLines.[]
.statuses.[]
.subStatus
.detail

String

SubStatus detail.

Maximum size of 256.

shipmentLines.[]
.statuses.[]
.subStatus
.description

String

SubStatus description.

Maximum size of 256.

shipmentLines.[]
.statuses.[]
.documents

List

A list of documents regarding this status, currently it holds only POD’s

shipmentLines.[]
.statuses.[]
.documents.[]
.documentType

String

Type of the document like POD

Maximum size of 12.

shipmentLines.[]
.statuses.[]
.documents.[]
.fileType

String

File type, like PNG, JPG, PDF, XPS

Maximum size of 8.

shipmentLines.[]
.statuses.[]
.documents.[]
.documentData

String

Base64 encrypted document

Maximum size of 16777215.

tariffLogs

List

List of tariff information of the shipment

tariffLogs.[]
.tariffType

String

Tariff type.

tariffLogs.[]
.tariffValue

String

Tariff value.

tariffLogs.[]
.currency

String

Currency of the value.

tariffLogs.[]
.chargeGroup

String

The charge group.

tariffLogs.[]
.chargeType

String

The charge type.

tariffLogs.[]
.calcType

String

The calculation type.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 4151

{
  "reference" : "Transsmart_1681382068193",
  "accountId" : "DEVDOCS",
  "carrier" : "DPD",
  "costcenter" : "",
  "shipmentStatus" : "DEL",
  "incoterms" : "01",
  "trackAndTraceUrl" : "https://tracking.dpd.de/parcelstatus?query=MPS0522802136383820230413&locale=nl_NL&Tracking=Track",
  "airwaybill" : "05228021363838",
  "requestedDeliveryDateFrom" : "16-04-2023 15:00:00",
  "requestedDeliveryDateTo" : "16-04-2023 17:00:00",
  "plannedDeliveryDateFrom" : "14-04-2023 17:00:00",
  "plannedDeliveryDateTo" : "14-04-2023 00:00:00",
  "price" : 15.0,
  "priceCurrency" : "EUR",
  "pickupDateFrom" : "13-04-2023 08:00:00",
  "pickupDateTo" : "13-04-2023 10:00:00",
  "description" : "example-description",
  "instruction" : "example-instruction1",
  "weight" : "40.00",
  "weightUom" : "KG",
  "currency" : "EUR",
  "executingCarrier" : "DPD",
  "inbound" : 0,
  "pieces" : 2,
  "service" : "NON-DOCS",
  "serviceLevelTime" : "CLASSIC",
  "value" : 10.0,
  "valueCurrency" : "EUR",
  "addresses" : [ {
    "type" : "INVC",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNumber" : "1c",
    "addressLine2" : "2nd floor",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "province" : "",
    "country" : "NL",
    "contactPerson" : "Support",
    "contactPhone" : "0031881260300",
    "contactFax" : "0031881260301",
    "contactEmail" : "example@domain.com",
    "accountNumber" : "example-accountNumber"
  }, {
    "type" : "RECV",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNumber" : "1c",
    "addressLine2" : "2nd floor",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "province" : "",
    "country" : "NL",
    "contactPerson" : "Support",
    "contactPhone" : "0031881260300",
    "contactFax" : "0031881260301",
    "contactEmail" : "example@domain.com",
    "accountNumber" : "example-accountNumber"
  }, {
    "type" : "SEND",
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "houseNumber" : "1c",
    "addressLine2" : "2nd floor",
    "city" : "Tilburg",
    "zipCode" : "5032MD",
    "province" : "",
    "country" : "NL",
    "contactPerson" : "Support",
    "contactPhone" : "0031881260300",
    "contactFax" : "0031881260301",
    "contactEmail" : "example@domain.com",
    "accountNumber" : "example-accountNumber"
  } ],
  "tariffLogs" : [ ],
  "additionalReferences" : [ {
    "type" : "ENGINEER",
    "value" : "example-engineer-additional-value-shipment-level"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  }, {
    "type" : "ROUTE_ID",
    "value" : "1234"
  } ],
  "statuses" : [ {
    "airwayBill" : "05228021363838",
    "code" : "DEL",
    "weight" : "40.00",
    "weightUom" : "KG",
    "pieces" : 2,
    "incoterms" : "DAP",
    "statusPrice" : 15.0,
    "statusPriceCurrency" : "EUR",
    "minimumTransitTime" : 17,
    "maximumTransitTime" : 17,
    "statusDate" : "13-04-2023 12:34:29"
  } ],
  "shipmentLines" : [ {
    "lineNumber" : 1,
    "shipmentLineId" : "example-shippmentLineId",
    "airwaybill" : "05228021363838",
    "description" : "example-description",
    "barcodeId" : "%05032MD05228021363838101528",
    "genericStatusCode" : "DEL",
    "length" : 20.0,
    "width" : 20.0,
    "height" : 20.0,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "statuses" : [ {
      "lineNumber" : 1,
      "airwayBill" : "05228021363838",
      "code" : "DEL",
      "statusDate" : "13-04-2023 12:34:29"
    } ]
  }, {
    "lineNumber" : 2,
    "shipmentLineId" : "example-shippmentLineId",
    "airwaybill" : "05228021363839",
    "description" : "example-description",
    "barcodeId" : "%05032MD05228021363839101528",
    "genericStatusCode" : "DEL",
    "length" : 20.0,
    "width" : 20.0,
    "height" : 20.0,
    "additionalReferences" : [ {
      "type" : "ORDER",
      "value" : "example-order-additional-value-package-level"
    } ],
    "statuses" : [ {
      "lineNumber" : 2,
      "airwayBill" : "05228021363839",
      "code" : "DEL",
      "statusDate" : "13-04-2023 12:34:29"
    } ]
  } ]
}

5.1.2 For multiple shipments

Retrieve status for shipments based on query parameters without detailed information

Path parameters

Table 20. /v2/statuses/{account}/shipments
Parameter	Description
`account`	Account code

Request parameters

Parameter

Description

Constraints

dateFrom

Date from.

Format yyyy-MM-dd HH:mm:ss., Mandatory.

dateTo

Date to.

Format yyyy-MM-dd HH:mm:ss.

carrier

Filter shipments based on the carriers. Use the carrier code in the transsmart back-end ask your consultant for use.

Mutiple entries are supported.

costCenter

Filter shipments based on the cost centers.

Mutiple entries are supported.

subAccount

Filter shipments based on (sub) accounts.

Mutiple entries are supported.

maxResults

Max number of status updates to collect.

Default is 1 and maximum is 1000

withPod

Include the POD in the last shipment or collo status (if available). This parameter only works when the parameter 'isDetailed' is set.

Default is false.

isIncremental

Only retrieve the information which was not returned before.

Default is true.

isDetailed

Include the status history in chronological order.

Default is true.

currentStatusOnly

Only include the last status per shipment and collo, not the complete history, this parameter only works when the parameter 'isDetailed' set to true.

Default is false.

Response structure

Path

Type

Description

Constraints

content

Object

List of multiple shipments

content.[]
.reference

String

Shipment reference

Not Null and not empty.
The size must be between 1 and 32.

content.[]
.carrier

String

Carrier

Fixed length of 3.
Not Null and not empty.

content.[]
.costcenter

String

Costcenter. Only returned when the backend parameter extended is set to true, contact your consultant for more details

Maximum size of 32.

content.[]
.shipmentStatus

String

Latest shipment status code

content.[]
.trackAndTraceUrl

String

Track and trace url

Maximum size of 2048.

content.[]
.airwaybill

String

Airwaybill

Maximum size of 32.

contentType

String

Definition of the content statically always Statuses

Has to match pattern: (Statuses)
Maximum size of 32.

numberOfItems

Integer

Number of items in this response

Maximum value is 32767.
Minimum value is 0.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

Retrieve status for shipments based on query parameters with detailed information

Path parameters

Table 21. /v2/statuses/{account}/shipments
Parameter	Description
`account`	Account code

Request parameters

Parameter

Description

Constraints

dateFrom

Date from.

Format yyyy-MM-dd HH:mm:ss., Mandatory.

dateTo

Date to.

Format yyyy-MM-dd HH:mm:ss.

carrier

Filter shipments based on the carriers. Use the carrier code in the transsmart back-end ask your consultant for use.

Mutiple entries are supported.

costCenter

Filter shipments based on the cost centers.

Mutiple entries are supported.

subAccount

Filter shipments based on (sub) accounts.

Mutiple entries are supported.

maxResults

Max number of status updates to collect.

Default is 1 and maximum is 1000

withPod

Include the POD in the last shipment or collo status (if available). This parameter only works when the parameter 'isDetailed' is set.

Default is false.

isIncremental

Only retrieve the information which was not returned before.

Default is true.

isDetailed

Include the status history in chronological order.

Default is true.

currentStatusOnly

Only include the last status per shipment and collo, not the complete history, this parameter only works when the parameter 'isDetailed' set to true.

Default is false.

Response structure

Path

Type

Description

Constraints

content

Object

List of multiple shipments

content.[]
.reference

String

Shipment reference

Not Null and not empty.
The size must be between 1 and 32.

content.[]
.carrier

String

Carrier

Fixed length of 3.
Not Null and not empty.

content.[]
.origin

String

The country of origin code.

Maximum size of 3.
Not Null and not empty.

content.[]
.costcenter

String

Costcenter. Only returned when the backend parameter extended is set to true, contact your consultant for more details

Maximum size of 32.

content.[]
.shipmentStatus

String

Latest shipment status code

content.[]
.trackAndTraceUrl

String

Track and trace url

Maximum size of 2048.

content.[]
.airwaybill

String

Airwaybill

Maximum size of 32.

content.[]
.accountId

String

Account of the shipment

Maximum size of 32.

content.[]
.incoterms

String

Incoterms of the shipment

Maximum size of 16.

content.[]
.acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

content.[]
.actualDeliveryDate

Date wrapped in String

Actual deliverydate

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.requestedDeliveryDateFrom

Date wrapped in String

Requested delivery date from, as sent during booking

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.requestedDeliveryDateTo

Date wrapped in String

Requested delivery date to, as sent during booking

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.plannedDeliveryDateFrom

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.plannedDeliveryDateTo

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.price

Decimal

Price of the shipment, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.priceCurrency

String

Currency of the price of the shipment

Maximum size of 3.

content.[]
.pickupDateFrom

Date wrapped in String

Pickup date from, of the shipment

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.pickupDateTo

Date wrapped in String

Pickup date to, of the shipment

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.description

String

Shipments description

Maximum size of 128.

content.[]
.instruction

String

Shipments instruction

Maximum size of 128.

content.[]
.weight

String

The weight of the shipment. May be different from the shipments original weight in case the carrier has acknowledged another value as part of the delivery status feedback.

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Has to match pattern: (KG|
LB|
OZ|
)
Maximum size of 3.

content.[]
.currency

String

Currency of the price of the shipment

Maximum size of 3.

content.[]
.executingCarrier

String

The actual executing carrier in the 3 letter char code

Fixed length of 3.

content.[]
.inbound

Integer

Indicates if it is an inbound shipment (inbound =1 else 0)

Maximum value is 1.
Minimum value is 0.

content.[]
.pieces

Integer

Number of packages/colli in the shipment

Maximum value is 32767.
Minimum value is 0.

content.[]
.service

String

Service indicating DOCS or NON-DOCS

Maximum size of 16.

content.[]
.serviceLevelTime

String

Service level time like STANDARD, SAVER

Maximum size of 32.
Not Null and not empty.

content.[]
.serviceLevelOther

String

Service level other like COD, EVENING etc.

Maximum size of 32.

content.[]
.value

Decimal

Value of the goods, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.valueCurrency

String

Currency of the value of the goods

Maximum size of 3.

content.[]
.addresses

List

List of addresses of the shipment

content.[]
.addresses.[]
.type

String

Address type

Maximum size of 4.
Not Null and not empty.

content.[]
.addresses.[]
.name

String

Name

Maximum size of 64.
Not Null and not empty.

content.[]
.addresses.[]
.addressLine1

String

Street 1

Maximum size of 64.
Not Null and not empty.

content.[]
.addresses.[]
.addressLine2

String

Street 2

Maximum size of 64.

content.[]
.addresses.[]
.city

String

City

Maximum size of 64.
Not Null and not empty.

content.[]
.addresses.[]
.houseNumber

String

Housenumber

Maximum size of 16.

content.[]
.addresses.[]
.zipCode

String

Zip code

Maximum size of 16.
Not Null and not empty.

content.[]
.addresses.[]
.province

String

Province / State

Maximum size of 16.

content.[]
.addresses.[]
.country

String

The country code.

Maximum size of 2.
Not Null and not empty.

content.[]
.addresses.[]
.contactPerson

String

Name of the contact person

Maximum size of 64.

content.[]
.addresses.[]
.contactPhone

String

Phone number of the contact person

Maximum size of 32.

content.[]
.addresses.[]
.contactFax

String

Fax number of the contact person

Maximum size of 32.

content.[]
.addresses.[]
.contactEmail

String

E-mail address of the contact person

Maximum size of 256.

content.[]
.addresses.[]
.accountNumber

String

Maximum size of 32.

content.[]
.additionalReferences

List wrapped in List

List of additional references

content.[]
.additionalReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

content.[]
.additionalReferences.[]
.value

String

The reference value

Maximum size of 1024.

content.[]
.statuses

List

List of shipment statuses

content.[]
.statuses.[]
.airwayBill

String

Airwaybill / barocde of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

content.[]
.statuses.[]
.code

String

The Transsmart generic status code

content.[]
.statuses.[]
.weight

String

The weight of the shipment. May be different from the shipments original weight in case the carrier has acknowledged another value as part of the delivery status feedback.

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.statuses.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Has to match pattern: (KG|
LB|
OZ|
)
Maximum size of 3.

content.[]
.statuses.[]
.pieces

Integer

Number of packages/colli in the shipment

Maximum value is 32767.

content.[]
.statuses.[]
.incoterms

String

Incoterms of the shipment

Maximum size of 16.

content.[]
.statuses.[]
.statusPrice

Double

Buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.statuses.[]
.statusPriceCurrency

String

Currency of the buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.statuses.[]
.statusSalesPrice

Double

Sell price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.statuses.[]
.statusSalesPriceCurrency

String

Currency of the sell price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.statuses.[]
.minimumTransitTime

Integer

Minimum transit time in hours

Maximum value is 32767.

content.[]
.statuses.[]
.maximumTransitTime

Integer

Maximum transit time in hours

Maximum value is 32767.

content.[]
.statuses.[]
.printDateTime

Date wrapped in String

Date and time the shipment was printed

Format yyyy-MM-dd HH:mm:ss.
Maximum size of 10.

content.[]
.statuses.[]
.printUser

String

User of who executed the print operation

Maximum size of 64.

content.[]
.statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

Format yyyy-MM-dd HH:mm:ss.

content.[]
.statuses.[]
.subStatus
.type

String

SubStatus type.

Maximum size of 256.

content.[]
.statuses.[]
.subStatus
.detail

String

SubStatus detail.

Maximum size of 256.

content.[]
.statuses.[]
.subStatus
.description

String

SubStatus description.

Maximum size of 256.

content.[]
.statuses.[]
.documents

List

A list of documents regarding this status, currently it holds only POD’s

content.[]
.statuses.[]
.documents.[]
.documentType

String

Type of the document like POD

Maximum size of 12.

content.[]
.statuses.[]
.documents.[]
.fileType

String

File type, like PNG, JPG, PDF, XPS

Maximum size of 8.

content.[]
.statuses.[]
.documents.[]
.documentData

String

Base64 encrypted document

Maximum size of 16777215.

content.[]
.shipmentLines

List

List of shipment lines and its statuses

content.[]
.shipmentLines.[]
.lineNumber

Integer

Sequential line number of this shipment line

Maximum value is 200000.

content.[]
.shipmentLines.[]
.shipmentLineId

String

Shipment line id

Maximum size of 32.

content.[]
.shipmentLines.[]
.description

String

Shipments description

Maximum size of 128.

content.[]
.shipmentLines.[]
.barcodeId

String

Airwaybill / barcode of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

content.[]
.shipmentLines.[]
.airwaybill

String

Airwaybill

Maximum size of 32.

content.[]
.shipmentLines.[]
.acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

content.[]
.shipmentLines.[]
.actualDeliveryDate

Date wrapped in String

Actual deliverydate

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.shipmentLines.[]
.plannedDeliveryDateFrom

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.shipmentLines.[]
.plannedDeliveryDateTo

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.shipmentLines.[]
.price

Decimal

Price of the shipment, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.shipmentLines.[]
.genericStatusCode

String

The generic status of the collo.

content.[]
.shipmentLines.[]
.carrierStatusCode

String

The carrier status of the collo.

Maximum size of 16.

content.[]
.shipmentLines.[]
.carrierStatusDescription

String

Description of the status code of the carrier

Maximum size of 128.

content.[]
.shipmentLines.[]
.length

Decimal

The Length of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.shipmentLines.[]
.width

Decimal

The width of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.shipmentLines.[]
.height

Decimal

The height of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.shipmentLines.[]
.additionalReferences

List wrapped in List

List of additional references

content.[]
.shipmentLines.[]
.additionalReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

content.[]
.shipmentLines.[]
.additionalReferences.[]
.value

String

The reference value

Maximum size of 1024.

content.[]
.shipmentLines.[]
.statuses

List

List of shipment statuses

content.[]
.shipmentLines.[]
.statuses.[]
.lineNumber

Integer

Sequential line number of this shipment line

Maximum value is 2147483647.

content.[]
.shipmentLines.[]
.statuses.[]
.airwayBill

String

Airwaybill / barocde of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

content.[]
.shipmentLines.[]
.statuses.[]
.code

String

The Transsmart generic status code

content.[]
.shipmentLines.[]
.statuses.[]
.carrierStatus

String

The carrier status.

Maximum size of 16.

content.[]
.shipmentLines.[]
.statuses.[]
.carrierStatusDescription

String

Description of the status code of the carrier

Maximum size of 128.

content.[]
.shipmentLines.[]
.statuses.[]
.statusPrice

Double

Buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.shipmentLines.[]
.statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

Format yyyy-MM-dd HH:mm:ss.

content.[]
.shipmentLines.[]
.statuses.[]
.subStatus
.type

String

SubStatus type.

Maximum size of 256.

content.[]
.shipmentLines.[]
.statuses.[]
.subStatus
.detail

String

SubStatus detail.

Maximum size of 256.

content.[]
.shipmentLines.[]
.statuses.[]
.subStatus
.description

String

SubStatus description.

Maximum size of 256.

content.[]
.shipmentLines.[]
.statuses.[]
.documents

List

A list of documents regarding this status, currently it holds only POD’s

content.[]
.shipmentLines.[]
.statuses.[]
.documents.[]
.documentType

String

Type of the document like POD

Maximum size of 12.

content.[]
.shipmentLines.[]
.statuses.[]
.documents.[]
.fileType

String

File type, like PNG, JPG, PDF, XPS

Maximum size of 8.

content.[]
.shipmentLines.[]
.statuses.[]
.documents.[]
.documentData

String

Base64 encrypted document

Maximum size of 16777215.

contentType

String

Definition of the content statically always Statuses

Has to match pattern: (Statuses)
Maximum size of 32.

numberOfItems

Integer

Number of items in this response

Maximum value is 32767.
Minimum value is 0.

tariffLogs

List

List of tariff information of the shipment

tariffLogs.[]
.tariffType

String

Tariff type.

tariffLogs.[]
.tariffValue

String

Tariff value.

tariffLogs.[]
.currency

String

Currency of the value.

tariffLogs.[]
.chargeGroup

String

The charge group.

tariffLogs.[]
.chargeType

String

The charge type.

tariffLogs.[]
.calcType

String

The calculation type.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 13883

{
  "content" : [ {
    "reference" : "Transsmart_1679902384330",
    "accountId" : "DEVDOCS",
    "carrier" : "DPD",
    "costcenter" : "",
    "shipmentStatus" : "DEL",
    "incoterms" : "01",
    "trackAndTraceUrl" : "https://tracking.dpd.de/parcelstatus?query=MPS0522802136179720230327&locale=nl_NL&Tracking=Track",
    "airwaybill" : "05228021361797",
    "requestedDeliveryDateFrom" : "30-03-2023 17:00:00",
    "requestedDeliveryDateTo" : "30-03-2023 17:00:00",
    "plannedDeliveryDateFrom" : "28-03-2023 17:00:00",
    "plannedDeliveryDateTo" : "28-03-2023 00:00:00",
    "price" : 15.0,
    "priceCurrency" : "EUR",
    "origin" : "API2",
    "pickupDateFrom" : "27-03-2023 08:00:00",
    "pickupDateTo" : "27-03-2023 10:00:00",
    "description" : "example-description",
    "instruction" : "example-instruction1",
    "weight" : "40.00",
    "weightUom" : "KG",
    "currency" : "EUR",
    "executingCarrier" : "DPD",
    "inbound" : 0,
    "pieces" : 2,
    "service" : "NON-DOCS",
    "serviceLevelTime" : "CLASSIC",
    "value" : 10.0,
    "valueCurrency" : "EUR",
    "addresses" : [ {
      "type" : "INVC",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    }, {
      "type" : "RECV",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    }, {
      "type" : "SEND",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    } ],
    "additionalReferences" : [ {
      "type" : "ENGINEER",
      "value" : "example-engineer-additional-value-shipment-level"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "INTERNAL_DPD_ROUTEID",
      "value" : "310485742"
    }, {
      "type" : "INTERNAL_DPD_ORIGINCOUNTRY",
      "value" : "528"
    }, {
      "type" : "INTERNAL_DPD_RESULTCOUNTRY",
      "value" : "528"
    }, {
      "type" : "INTERNAL_DPD_RESULTLOT",
      "value" : "normal parcel"
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICETEXT",
      "value" : "D"
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICEMARK",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICEINFO",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_RESULTVERSION",
      "value" : "20230102"
    }, {
      "type" : "INTERNAL_DPD_SERVICECODE",
      "value" : "101"
    }, {
      "type" : "INTERNAL_DPD_SERVICE_ELEMENTS",
      "value" : "001"
    }, {
      "type" : "INTERNAL_DPD_SERVICECODE_SWAP",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_PICKUPDEPOT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_DESTINATIONDEPOT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_DESTINATIONDEPOTCOUNTRY",
      "value" : "NL"
    }, {
      "type" : "INTERNAL_DPD_DSORT",
      "value" : "1_B"
    }, {
      "type" : "INTERNAL_DPD_DSORT_RETURN",
      "value" : "1_B"
    }, {
      "type" : "INTERNAL_DPD_OSORT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_ROUTETABLEVERSION",
      "value" : "20230102"
    } ],
    "statuses" : [ {
      "code" : "NEW",
      "weight" : "40.00",
      "weightUom" : "KG",
      "pieces" : 2,
      "incoterms" : "DAP",
      "statusPrice" : 15.0,
      "statusPriceCurrency" : "EUR",
      "minimumTransitTime" : 17,
      "maximumTransitTime" : 17,
      "statusDate" : "27-03-2023 09:33:06"
    }, {
      "airwayBill" : "05228021361797",
      "code" : "NEW",
      "weight" : "40.00",
      "weightUom" : "KG",
      "pieces" : 2,
      "incoterms" : "DAP",
      "statusPrice" : 15.0,
      "statusPriceCurrency" : "EUR",
      "minimumTransitTime" : 17,
      "maximumTransitTime" : 17,
      "statusDate" : "27-03-2023 09:33:06"
    }, {
      "airwayBill" : "05228021361797",
      "code" : "DEL",
      "weight" : "40.00",
      "weightUom" : "KG",
      "pieces" : 2,
      "incoterms" : "DAP",
      "statusPrice" : 15.0,
      "statusPriceCurrency" : "EUR",
      "minimumTransitTime" : 17,
      "maximumTransitTime" : 17,
      "statusDate" : "27-03-2023 09:33:07"
    } ],
    "shipmentLines" : [ {
      "lineNumber" : 1,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybill" : "05228021361797",
      "description" : "example-description",
      "barcodeId" : "%05032MD05228021361797101528",
      "genericStatusCode" : "DEL",
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "additionalReferences" : [ {
        "type" : "ORDER",
        "value" : "example-order-additional-value-package-level"
      } ],
      "statuses" : [ {
        "lineNumber" : 1,
        "code" : "NEW",
        "statusDate" : "27-03-2023 09:33:06"
      }, {
        "lineNumber" : 1,
        "airwayBill" : "05228021361797",
        "code" : "NEW",
        "statusDate" : "27-03-2023 09:33:06"
      }, {
        "lineNumber" : 1,
        "airwayBill" : "05228021361797",
        "code" : "DEL",
        "statusDate" : "27-03-2023 09:33:07"
      } ]
    }, {
      "lineNumber" : 2,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybill" : "05228021361798",
      "description" : "example-description",
      "barcodeId" : "%05032MD05228021361798101528",
      "genericStatusCode" : "DEL",
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "additionalReferences" : [ {
        "type" : "ORDER",
        "value" : "example-order-additional-value-package-level"
      } ],
      "statuses" : [ {
        "lineNumber" : 2,
        "code" : "NEW",
        "statusDate" : "27-03-2023 09:33:06"
      }, {
        "lineNumber" : 2,
        "airwayBill" : "05228021361798",
        "code" : "NEW",
        "statusDate" : "27-03-2023 09:33:06"
      }, {
        "lineNumber" : 2,
        "airwayBill" : "05228021361798",
        "code" : "DEL",
        "statusDate" : "27-03-2023 09:33:07"
      } ]
    } ]
  }, {
    "reference" : "Transsmart_1679902387240",
    "accountId" : "DEVDOCS",
    "carrier" : "DPD",
    "costcenter" : "",
    "shipmentStatus" : "DEL",
    "incoterms" : "01",
    "trackAndTraceUrl" : "https://tracking.dpd.de/parcelstatus?query=MPS0522802136179920230327&locale=nl_NL&Tracking=Track",
    "airwaybill" : "05228021361799",
    "requestedDeliveryDateFrom" : "30-03-2023 17:00:00",
    "requestedDeliveryDateTo" : "30-03-2023 17:00:00",
    "plannedDeliveryDateFrom" : "28-03-2023 17:00:00",
    "plannedDeliveryDateTo" : "28-03-2023 00:00:00",
    "price" : 15.0,
    "priceCurrency" : "EUR",
    "origin" : "API2",
    "pickupDateFrom" : "27-03-2023 08:00:00",
    "pickupDateTo" : "27-03-2023 10:00:00",
    "description" : "example-description",
    "instruction" : "example-instruction1",
    "weight" : "40.00",
    "weightUom" : "KG",
    "currency" : "EUR",
    "executingCarrier" : "DPD",
    "inbound" : 0,
    "pieces" : 2,
    "service" : "NON-DOCS",
    "serviceLevelTime" : "CLASSIC",
    "value" : 10.0,
    "valueCurrency" : "EUR",
    "addresses" : [ {
      "type" : "INVC",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    }, {
      "type" : "RECV",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    }, {
      "type" : "SEND",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    } ],
    "additionalReferences" : [ {
      "type" : "ENGINEER",
      "value" : "example-engineer-additional-value-shipment-level"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "INTERNAL_DPD_ROUTEID",
      "value" : "310485742"
    }, {
      "type" : "INTERNAL_DPD_ORIGINCOUNTRY",
      "value" : "528"
    }, {
      "type" : "INTERNAL_DPD_RESULTCOUNTRY",
      "value" : "528"
    }, {
      "type" : "INTERNAL_DPD_RESULTLOT",
      "value" : "normal parcel"
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICETEXT",
      "value" : "D"
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICEMARK",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICEINFO",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_RESULTVERSION",
      "value" : "20230102"
    }, {
      "type" : "INTERNAL_DPD_SERVICECODE",
      "value" : "101"
    }, {
      "type" : "INTERNAL_DPD_SERVICE_ELEMENTS",
      "value" : "001"
    }, {
      "type" : "INTERNAL_DPD_SERVICECODE_SWAP",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_PICKUPDEPOT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_DESTINATIONDEPOT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_DESTINATIONDEPOTCOUNTRY",
      "value" : "NL"
    }, {
      "type" : "INTERNAL_DPD_DSORT",
      "value" : "1_B"
    }, {
      "type" : "INTERNAL_DPD_DSORT_RETURN",
      "value" : "1_B"
    }, {
      "type" : "INTERNAL_DPD_OSORT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_ROUTETABLEVERSION",
      "value" : "20230102"
    } ],
    "statuses" : [ {
      "code" : "NEW",
      "weight" : "40.00",
      "weightUom" : "KG",
      "pieces" : 2,
      "incoterms" : "DAP",
      "statusPrice" : 15.0,
      "statusPriceCurrency" : "EUR",
      "minimumTransitTime" : 17,
      "maximumTransitTime" : 17,
      "statusDate" : "27-03-2023 09:33:07"
    }, {
      "airwayBill" : "05228021361799",
      "code" : "NEW",
      "weight" : "40.00",
      "weightUom" : "KG",
      "pieces" : 2,
      "incoterms" : "DAP",
      "statusPrice" : 15.0,
      "statusPriceCurrency" : "EUR",
      "minimumTransitTime" : 17,
      "maximumTransitTime" : 17,
      "statusDate" : "27-03-2023 09:33:07"
    }, {
      "airwayBill" : "05228021361799",
      "code" : "DEL",
      "weight" : "40.00",
      "weightUom" : "KG",
      "pieces" : 2,
      "incoterms" : "DAP",
      "statusPrice" : 15.0,
      "statusPriceCurrency" : "EUR",
      "minimumTransitTime" : 17,
      "maximumTransitTime" : 17,
      "statusDate" : "27-03-2023 09:33:08"
    } ],
    "shipmentLines" : [ {
      "lineNumber" : 1,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybill" : "05228021361799",
      "description" : "example-description",
      "barcodeId" : "%05032MD05228021361799101528",
      "genericStatusCode" : "DEL",
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "additionalReferences" : [ {
        "type" : "ORDER",
        "value" : "example-order-additional-value-package-level"
      } ],
      "statuses" : [ {
        "lineNumber" : 1,
        "code" : "NEW",
        "statusDate" : "27-03-2023 09:33:07"
      }, {
        "lineNumber" : 1,
        "airwayBill" : "05228021361799",
        "code" : "NEW",
        "statusDate" : "27-03-2023 09:33:07"
      }, {
        "lineNumber" : 1,
        "airwayBill" : "05228021361799",
        "code" : "DEL",
        "statusDate" : "27-03-2023 09:33:08"
      } ]
    }, {
      "lineNumber" : 2,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybill" : "05228021361800",
      "description" : "example-description",
      "barcodeId" : "%05032MD05228021361800101528",
      "genericStatusCode" : "DEL",
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "additionalReferences" : [ {
        "type" : "ORDER",
        "value" : "example-order-additional-value-package-level"
      } ],
      "statuses" : [ {
        "lineNumber" : 2,
        "code" : "NEW",
        "statusDate" : "27-03-2023 09:33:07"
      }, {
        "lineNumber" : 2,
        "airwayBill" : "05228021361800",
        "code" : "NEW",
        "statusDate" : "27-03-2023 09:33:07"
      }, {
        "lineNumber" : 2,
        "airwayBill" : "05228021361800",
        "code" : "DEL",
        "statusDate" : "27-03-2023 09:33:08"
      } ]
    } ]
  } ],
  "contentType" : "Statuses",
  "numberOfItems" : 2
}

Retrieve status for shipments based on query parameters with detailed information about the last status only

Path parameters

Table 22. /v2/statuses/{account}/shipments
Parameter	Description
`account`	Account code

Request parameters

Parameter

Description

Constraints

dateFrom

Date from.

Format yyyy-MM-dd HH:mm:ss., Mandatory.

dateTo

Date to.

Format yyyy-MM-dd HH:mm:ss.

carrier

Filter shipments based on the carriers. Use the carrier code in the transsmart back-end ask your consultant for use.

Mutiple entries are supported.

costCenter

Filter shipments based on the cost centers.

Mutiple entries are supported.

subAccount

Filter shipments based on (sub) accounts.

Mutiple entries are supported.

maxResults

Max number of status updates to collect.

Default is 1 and maximum is 1000

withPod

Include the POD in the last shipment or collo status (if available). This parameter only works when the parameter 'isDetailed' is set.

Default is false.

isIncremental

Only retrieve the information which was not returned before.

Default is true.

isDetailed

Include the status history in chronological order.

Default is true.

currentStatusOnly

Only include the last status per shipment and collo, not the complete history, this parameter only works when the parameter 'isDetailed' set to true.

Default is false.

Response structure

Path

Type

Description

Constraints

content

Object

List of multiple shipments

content.[]
.reference

String

Shipment reference

Not Null and not empty.
The size must be between 1 and 32.

content.[]
.origin

String

The country of origin code.

Maximum size of 3.
Not Null and not empty.

content.[]
.carrier

String

Carrier

Fixed length of 3.
Not Null and not empty.

content.[]
.costcenter

String

Costcenter. Only returned when the backend parameter extended is set to true, contact your consultant for more details

Maximum size of 32.

content.[]
.shipmentStatus

String

Latest shipment status code

content.[]
.trackAndTraceUrl

String

Track and trace url

Maximum size of 2048.

content.[]
.airwaybill

String

Airwaybill

Maximum size of 32.

content.[]
.accountId

String

Account of the shipment

Maximum size of 32.

content.[]
.incoterms

String

Incoterms of the shipment

Maximum size of 16.

content.[]
.acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

content.[]
.actualDeliveryDate

Date wrapped in String

Actual deliverydate

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.requestedDeliveryDateFrom

Date wrapped in String

Requested delivery date from, as sent during booking

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.requestedDeliveryDateTo

Date wrapped in String

Requested delivery date to, as sent during booking

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.plannedDeliveryDateFrom

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.plannedDeliveryDateTo

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.price

Decimal

Price of the shipment, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.priceCurrency

String

Currency of the price of the shipment

Maximum size of 3.

content.[]
.pickupDateFrom

Date wrapped in String

Pickup date from, of the shipment

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.pickupDateTo

Date wrapped in String

Pickup date to, of the shipment

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.description

String

Shipments description

Maximum size of 128.

content.[]
.instruction

String

Shipments instruction

Maximum size of 128.

content.[]
.weight

String

The weight of the shipment. May be different from the shipments original weight in case the carrier has acknowledged another value as part of the delivery status feedback.

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Has to match pattern: (KG|
LB|
OZ|
)
Maximum size of 3.

content.[]
.currency

String

Currency of the price of the shipment

Maximum size of 3.

content.[]
.executingCarrier

String

The actual executing carrier in the 3 letter char code

Fixed length of 3.

content.[]
.inbound

Integer

Indicates if it is an inbound shipment (inbound =1 else 0)

Maximum value is 1.
Minimum value is 0.

content.[]
.pieces

Integer

Number of packages/colli in the shipment

Maximum value is 32767.
Minimum value is 0.

content.[]
.service

String

Service indicating DOCS or NON-DOCS

Maximum size of 16.

content.[]
.serviceLevelTime

String

Service level time like STANDARD, SAVER

Maximum size of 32.
Not Null and not empty.

content.[]
.serviceLevelOther

String

Service level other like COD, EVENING etc.

Maximum size of 32.

content.[]
.value

Decimal

Value of the goods, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.valueCurrency

String

Currency of the value of the goods

Maximum size of 3.

content.[]
.addresses

List

List of addresses of the shipment

content.[]
.addresses.[]
.type

String

Address type

Maximum size of 4.
Not Null and not empty.

content.[]
.addresses.[]
.name

String

Name

Maximum size of 64.
Not Null and not empty.

content.[]
.addresses.[]
.addressLine1

String

Street 1

Maximum size of 64.
Not Null and not empty.

content.[]
.addresses.[]
.addressLine2

String

Street 2

Maximum size of 64.

content.[]
.addresses.[]
.city

String

City

Maximum size of 64.
Not Null and not empty.

content.[]
.addresses.[]
.houseNumber

String

Housenumber

Maximum size of 16.

content.[]
.addresses.[]
.zipCode

String

Zip code

Maximum size of 16.
Not Null and not empty.

content.[]
.addresses.[]
.province

String

Province / State

Maximum size of 16.

content.[]
.addresses.[]
.country

String

The country code.

Maximum size of 2.
Not Null and not empty.

content.[]
.addresses.[]
.contactPerson

String

Name of the contact person

Maximum size of 64.

content.[]
.addresses.[]
.contactPhone

String

Phone number of the contact person

Maximum size of 32.

content.[]
.addresses.[]
.contactFax

String

Fax number of the contact person

Maximum size of 32.

content.[]
.addresses.[]
.contactEmail

String

E-mail address of the contact person

Maximum size of 256.

content.[]
.addresses.[]
.accountNumber

String

Maximum size of 32.

content.[]
.additionalReferences

List wrapped in List

List of additional references

content.[]
.additionalReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

content.[]
.additionalReferences.[]
.value

String

The reference value

Maximum size of 1024.

content.[]
.statuses

List

List of shipment statuses

content.[]
.statuses.[]
.airwayBill

String

Airwaybill / barocde of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

content.[]
.statuses.[]
.code

String

The Transsmart generic status code

content.[]
.statuses.[]
.weight

String

The weight of the shipment. May be different from the shipments original weight in case the carrier has acknowledged another value as part of the delivery status feedback.

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.statuses.[]
.weightUom

String

The weight unit of measure (e.g. KG, LB, OZ).

Has to match pattern: (KG|
LB|
OZ|
)
Maximum size of 3.

content.[]
.statuses.[]
.pieces

Integer

Number of packages/colli in the shipment

Maximum value is 32767.

content.[]
.statuses.[]
.incoterms

String

Incoterms of the shipment

Maximum size of 16.

content.[]
.statuses.[]
.statusPrice

Double

Buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.statuses.[]
.statusPriceCurrency

String

Currency of the buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.statuses.[]
.statusSalesPrice

Double

Sell price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.statuses.[]
.statusSalesPriceCurrency

String

Currency of the sell price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.statuses.[]
.minimumTransitTime

Integer

Minimum transit time in hours

Maximum value is 32767.

content.[]
.statuses.[]
.maximumTransitTime

Integer

Maximum transit time in hours

Maximum value is 32767.

content.[]
.statuses.[]
.printDateTime

Date wrapped in String

Date and time the shipment was printed

Format yyyy-MM-dd HH:mm:ss.
Maximum size of 10.

content.[]
.statuses.[]
.printUser

String

User of who executed the print operation

Maximum size of 64.

content.[]
.statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

Format yyyy-MM-dd HH:mm:ss.

content.[]
.statuses.[]
.subStatus
.type

String

SubStatus type.

Maximum size of 256.

content.[]
.statuses.[]
.subStatus
.detail

String

SubStatus detail.

Maximum size of 256.

content.[]
.statuses.[]
.subStatus
.description

String

SubStatus description.

Maximum size of 256.

content.[]
.statuses.[]
.documents

List

A list of documents regarding this status, currently it holds only POD’s

content.[]
.statuses.[]
.documents.[]
.documentType

String

Type of the document like POD

Maximum size of 12.

content.[]
.statuses.[]
.documents.[]
.fileType

String

File type, like PNG, JPG, PDF, XPS

Maximum size of 8.

content.[]
.statuses.[]
.documents.[]
.documentData

String

Base64 encrypted document

Maximum size of 16777215.

content.[]
.shipmentLines

List

List of shipment lines and its statuses

content.[]
.shipmentLines.[]
.lineNumber

Integer

Sequential line number of this shipment line

Maximum value is 200000.

content.[]
.shipmentLines.[]
.shipmentLineId

String

Shipment line id

Maximum size of 32.

content.[]
.shipmentLines.[]
.description

String

Shipments description

Maximum size of 128.

content.[]
.shipmentLines.[]
.barcodeId

String

Airwaybill / barcode of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

content.[]
.shipmentLines.[]
.airwaybill

String

Airwaybill

Maximum size of 32.

content.[]
.shipmentLines.[]
.acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

content.[]
.shipmentLines.[]
.actualDeliveryDate

Date wrapped in String

Actual deliverydate

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.shipmentLines.[]
.plannedDeliveryDateFrom

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.shipmentLines.[]
.plannedDeliveryDateTo

Date wrapped in String

Planned delivery date as sent back from the carrier during status processing

Has to match pattern: \d{2}:\d{2}:\d{4} \d{2}:\d{2}

content.[]
.shipmentLines.[]
.price

Decimal

Price of the shipment, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.shipmentLines.[]
.genericStatusCode

String

The generic status of the collo.

content.[]
.shipmentLines.[]
.carrierStatusCode

String

The carrier status of the collo.

Maximum size of 16.

content.[]
.shipmentLines.[]
.carrierStatusDescription

String

Description of the status code of the carrier

Maximum size of 128.

content.[]
.shipmentLines.[]
.length

Decimal

The Length of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.shipmentLines.[]
.width

Decimal

The width of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.shipmentLines.[]
.height

Decimal

The height of the package of this shipment line, note length on shipment level is deprecated and will always return 0, rounden down to a accuracy of two fractions

Maximum value is 999,999,999.99
Minimum value is 0

content.[]
.shipmentLines.[]
.additionalReferences

List wrapped in List

List of additional references

content.[]
.shipmentLines.[]
.additionalReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

content.[]
.shipmentLines.[]
.additionalReferences.[]
.value

String

The reference value

Maximum size of 1024.

content.[]
.shipmentLines.[]
.statuses

List

List of shipment statuses

content.[]
.shipmentLines.[]
.statuses.[]
.lineNumber

Integer

Sequential line number of this shipment line

Maximum value is 2147483647.

content.[]
.shipmentLines.[]
.statuses.[]
.airwayBill

String

Airwaybill / barocde of the shipment or first collo if it is a multicollo shipment

Maximum size of 256.

content.[]
.shipmentLines.[]
.statuses.[]
.code

String

The Transsmart generic status code

content.[]
.shipmentLines.[]
.statuses.[]
.carrierStatus

String

The carrier status.

Maximum size of 16.

content.[]
.shipmentLines.[]
.statuses.[]
.carrierStatusDescription

String

Description of the status code of the carrier

Maximum size of 128.

content.[]
.shipmentLines.[]
.statuses.[]
.statusPrice

Double

Buy price of the shipment, rounden down to a accuracy of two fractions.

Maximum value is 999,999,999.99
Minimum value is -999,999,999.99

content.[]
.shipmentLines.[]
.statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

Format yyyy-MM-dd HH:mm:ss.

content.[]
.shipmentLines.[]
.statuses.[]
.subStatus
.type

String

SubStatus type.

Maximum size of 256.

content.[]
.shipmentLines.[]
.statuses.[]
.subStatus
.detail

String

SubStatus detail.

Maximum size of 256.

content.[]
.shipmentLines.[]
.statuses.[]
.subStatus
.description

String

SubStatus description.

Maximum size of 256.

content.[]
.shipmentLines.[]
.statuses.[]
.documents

List

A list of documents regarding this status, currently it holds only POD’s

content.[]
.shipmentLines.[]
.statuses.[]
.documents.[]
.documentType

String

Type of the document like POD

Maximum size of 12.

content.[]
.shipmentLines.[]
.statuses.[]
.documents.[]
.fileType

String

File type, like PNG, JPG, PDF, XPS

Maximum size of 8.

content.[]
.shipmentLines.[]
.statuses.[]
.documents.[]
.documentData

String

Base64 encrypted document

Maximum size of 16777215.

contentType

String

Definition of the content statically always Statuses

Has to match pattern: (Statuses)
Maximum size of 32.

numberOfItems

Integer

Number of items in this response

Maximum value is 32767.
Minimum value is 0.

tariffLogs

List

List of tariff information of the shipment

tariffLogs.[]
.tariffType

String

Tariff type.

tariffLogs.[]
.tariffValue

String

Tariff value.

tariffLogs.[]
.currency

String

Currency of the value.

tariffLogs.[]
.chargeGroup

String

The charge group.

tariffLogs.[]
.chargeType

String

The charge type.

tariffLogs.[]
.calcType

String

The calculation type.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 11577

{
  "content" : [ {
    "reference" : "Transsmart_1679902384330",
    "accountId" : "DEVDOCS",
    "carrier" : "DPD",
    "costcenter" : "",
    "shipmentStatus" : "DEL",
    "incoterms" : "01",
    "trackAndTraceUrl" : "https://tracking.dpd.de/parcelstatus?query=MPS0522802136179720230327&locale=nl_NL&Tracking=Track",
    "airwaybill" : "05228021361797",
    "requestedDeliveryDateFrom" : "30-03-2023 17:00:00",
    "requestedDeliveryDateTo" : "30-03-2023 17:00:00",
    "plannedDeliveryDateFrom" : "28-03-2023 17:00:00",
    "plannedDeliveryDateTo" : "28-03-2023 00:00:00",
    "price" : 15.0,
    "priceCurrency" : "EUR",
    "origin" : "API2",
    "pickupDateFrom" : "27-03-2023 08:00:00",
    "pickupDateTo" : "27-03-2023 10:00:00",
    "description" : "example-description",
    "instruction" : "example-instruction1",
    "weight" : "40.00",
    "weightUom" : "KG",
    "currency" : "EUR",
    "executingCarrier" : "DPD",
    "inbound" : 0,
    "pieces" : 2,
    "service" : "NON-DOCS",
    "serviceLevelTime" : "CLASSIC",
    "value" : 10.0,
    "valueCurrency" : "EUR",
    "addresses" : [ {
      "type" : "INVC",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    }, {
      "type" : "RECV",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    }, {
      "type" : "SEND",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    } ],
    "additionalReferences" : [ {
      "type" : "ENGINEER",
      "value" : "example-engineer-additional-value-shipment-level"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "INTERNAL_DPD_ROUTEID",
      "value" : "310485742"
    }, {
      "type" : "INTERNAL_DPD_ORIGINCOUNTRY",
      "value" : "528"
    }, {
      "type" : "INTERNAL_DPD_RESULTCOUNTRY",
      "value" : "528"
    }, {
      "type" : "INTERNAL_DPD_RESULTLOT",
      "value" : "normal parcel"
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICETEXT",
      "value" : "D"
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICEMARK",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICEINFO",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_RESULTVERSION",
      "value" : "20230102"
    }, {
      "type" : "INTERNAL_DPD_SERVICECODE",
      "value" : "101"
    }, {
      "type" : "INTERNAL_DPD_SERVICE_ELEMENTS",
      "value" : "001"
    }, {
      "type" : "INTERNAL_DPD_SERVICECODE_SWAP",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_PICKUPDEPOT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_DESTINATIONDEPOT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_DESTINATIONDEPOTCOUNTRY",
      "value" : "NL"
    }, {
      "type" : "INTERNAL_DPD_DSORT",
      "value" : "1_B"
    }, {
      "type" : "INTERNAL_DPD_DSORT_RETURN",
      "value" : "1_B"
    }, {
      "type" : "INTERNAL_DPD_OSORT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_ROUTETABLEVERSION",
      "value" : "20230102"
    } ],
    "statuses" : [ {
      "airwayBill" : "05228021361797",
      "code" : "DEL",
      "weight" : "40.00",
      "weightUom" : "KG",
      "pieces" : 2,
      "incoterms" : "DAP",
      "statusPrice" : 15.0,
      "statusPriceCurrency" : "EUR",
      "minimumTransitTime" : 17,
      "maximumTransitTime" : 17,
      "statusDate" : "27-03-2023 09:33:07"
    } ],
    "shipmentLines" : [ {
      "lineNumber" : 1,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybill" : "05228021361797",
      "description" : "example-description",
      "barcodeId" : "%05032MD05228021361797101528",
      "genericStatusCode" : "DEL",
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "additionalReferences" : [ {
        "type" : "ORDER",
        "value" : "example-order-additional-value-package-level"
      } ],
      "statuses" : [ {
        "lineNumber" : 1,
        "airwayBill" : "05228021361797",
        "code" : "DEL",
        "statusDate" : "27-03-2023 09:33:07"
      } ]
    }, {
      "lineNumber" : 2,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybill" : "05228021361798",
      "description" : "example-description",
      "barcodeId" : "%05032MD05228021361798101528",
      "genericStatusCode" : "DEL",
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "additionalReferences" : [ {
        "type" : "ORDER",
        "value" : "example-order-additional-value-package-level"
      } ],
      "statuses" : [ {
        "lineNumber" : 2,
        "airwayBill" : "05228021361798",
        "code" : "DEL",
        "statusDate" : "27-03-2023 09:33:07"
      } ]
    } ]
  }, {
    "reference" : "Transsmart_1679902387240",
    "accountId" : "DEVDOCS",
    "carrier" : "DPD",
    "costcenter" : "",
    "shipmentStatus" : "DEL",
    "incoterms" : "01",
    "trackAndTraceUrl" : "https://tracking.dpd.de/parcelstatus?query=MPS0522802136179920230327&locale=nl_NL&Tracking=Track",
    "airwaybill" : "05228021361799",
    "requestedDeliveryDateFrom" : "30-03-2023 17:00:00",
    "requestedDeliveryDateTo" : "30-03-2023 17:00:00",
    "plannedDeliveryDateFrom" : "28-03-2023 17:00:00",
    "plannedDeliveryDateTo" : "28-03-2023 00:00:00",
    "price" : 15.0,
    "priceCurrency" : "EUR",
    "origin" : "API2",
    "pickupDateFrom" : "27-03-2023 08:00:00",
    "pickupDateTo" : "27-03-2023 10:00:00",
    "description" : "example-description",
    "instruction" : "example-instruction1",
    "weight" : "40.00",
    "weightUom" : "KG",
    "currency" : "EUR",
    "executingCarrier" : "DPD",
    "inbound" : 0,
    "pieces" : 2,
    "service" : "NON-DOCS",
    "serviceLevelTime" : "CLASSIC",
    "value" : 10.0,
    "valueCurrency" : "EUR",
    "addresses" : [ {
      "type" : "INVC",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    }, {
      "type" : "RECV",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    }, {
      "type" : "SEND",
      "name" : "Transsmart",
      "addressLine1" : "Ellen Pankhurststraat",
      "houseNumber" : "1c",
      "addressLine2" : "2nd floor",
      "city" : "Tilburg",
      "zipCode" : "5032MD",
      "country" : "NL",
      "contactPerson" : "Support",
      "contactPhone" : "0031881260300",
      "contactFax" : "0031881260301",
      "contactEmail" : "example@domain.com",
      "accountNumber" : "example-accountNumber"
    } ],
    "additionalReferences" : [ {
      "type" : "ENGINEER",
      "value" : "example-engineer-additional-value-shipment-level"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "ROUTE_ID",
      "value" : "1234"
    }, {
      "type" : "INTERNAL_DPD_ROUTEID",
      "value" : "310485742"
    }, {
      "type" : "INTERNAL_DPD_ORIGINCOUNTRY",
      "value" : "528"
    }, {
      "type" : "INTERNAL_DPD_RESULTCOUNTRY",
      "value" : "528"
    }, {
      "type" : "INTERNAL_DPD_RESULTLOT",
      "value" : "normal parcel"
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICETEXT",
      "value" : "D"
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICEMARK",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_RESULTSERVICEINFO",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_RESULTVERSION",
      "value" : "20230102"
    }, {
      "type" : "INTERNAL_DPD_SERVICECODE",
      "value" : "101"
    }, {
      "type" : "INTERNAL_DPD_SERVICE_ELEMENTS",
      "value" : "001"
    }, {
      "type" : "INTERNAL_DPD_SERVICECODE_SWAP",
      "value" : ""
    }, {
      "type" : "INTERNAL_DPD_PICKUPDEPOT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_DESTINATIONDEPOT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_DESTINATIONDEPOTCOUNTRY",
      "value" : "NL"
    }, {
      "type" : "INTERNAL_DPD_DSORT",
      "value" : "1_B"
    }, {
      "type" : "INTERNAL_DPD_DSORT_RETURN",
      "value" : "1_B"
    }, {
      "type" : "INTERNAL_DPD_OSORT",
      "value" : "0525"
    }, {
      "type" : "INTERNAL_DPD_ROUTETABLEVERSION",
      "value" : "20230102"
    } ],
    "statuses" : [ {
      "airwayBill" : "05228021361799",
      "code" : "DEL",
      "weight" : "40.00",
      "weightUom" : "KG",
      "pieces" : 2,
      "incoterms" : "DAP",
      "statusPrice" : 15.0,
      "statusPriceCurrency" : "EUR",
      "minimumTransitTime" : 17,
      "maximumTransitTime" : 17,
      "statusDate" : "27-03-2023 09:33:08"
    } ],
    "shipmentLines" : [ {
      "lineNumber" : 1,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybill" : "05228021361799",
      "description" : "example-description",
      "barcodeId" : "%05032MD05228021361799101528",
      "genericStatusCode" : "DEL",
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "additionalReferences" : [ {
        "type" : "ORDER",
        "value" : "example-order-additional-value-package-level"
      } ],
      "statuses" : [ {
        "lineNumber" : 1,
        "airwayBill" : "05228021361799",
        "code" : "DEL",
        "statusDate" : "27-03-2023 09:33:08"
      } ]
    }, {
      "lineNumber" : 2,
      "shipmentLineId" : "example-shippmentLineId",
      "airwaybill" : "05228021361800",
      "description" : "example-description",
      "barcodeId" : "%05032MD05228021361800101528",
      "genericStatusCode" : "DEL",
      "length" : 20.0,
      "width" : 20.0,
      "height" : 20.0,
      "additionalReferences" : [ {
        "type" : "ORDER",
        "value" : "example-order-additional-value-package-level"
      } ],
      "statuses" : [ {
        "lineNumber" : 2,
        "airwayBill" : "05228021361800",
        "code" : "DEL",
        "statusDate" : "27-03-2023 09:33:08"
      } ]
    } ]
  } ],
  "contentType" : "Statuses",
  "numberOfItems" : 2
}

5.2 Status stream

The push status functionality utilises webhooks for pushing per shipment status events to provided end-points.

Required Configurations

A URL to which status events should be streamed; if it is a protected URL, correct credentials must also be provided.

Frequency of notifications

A notication is sent for each shipment line/package/collo status event.

Payload

The payload sent in status notification is the same as the response to status retrieval requests, chapter 5.1.

5.3 Status update

For the status update we have 2 types:

Per shipment with a query per reference
A list of shipments.

5.3.1 For a single shipment

Status update for a shipment per reference

Path parameters

Table 23. /v2/statuses/{account}/shipments/{reference}
Parameter	Description
`account`	Account code
`reference`	The shipment reference

Request structure

Path

Type

Description

Constraints

shipmentStatusCode

String

The status of the shipment.

colloStatusCode

String

The status of the collo.

deliveryDate

String

The delivery date.

Format yyyy-MM-dd.

deliveryTime

String

The delivery time.

Format HH:mm.

acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

awb

String

The airway bill number.

Maximum size of 32.

addReferences

List

No decription found

addReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

addReferences.[]
.value

String

The reference value

Maximum size of 1024.

Response structure

Path

Type

Description

Constraints

reference

String

Shipment reference

Not Null and not empty.
The size must be between 1 and 32.

customerId

String

Customer id

Maximum size of 10.

shipmentStatusCode

String

The status of the shipment.

statusUpdate

String

The execution result.

Has to match pattern: (OK|
NOK)
Maximum size of 8.

colloStatusCode

String

The status of the collo.

description

String

Shipments description

Maximum size of 128.

Curl Example requests

Click here to show/hide example

Http example:

Click here to show/hide example

Example response

Click here to show/hide example

5.3.2 For a list of shipments

Status update for a list of shipment

Path parameters

Table 24. /v2/statuses/{account}/shipments
Parameter	Description
`account`	Account code

Request parameters

Path

Type

Description

Constraints

[]
.reference

String

Shipment reference

Not Null and not empty.
The size must be between 1 and 32.

[]
.referenceType

String

The reference type.

Maximum size of 32.

[]
.shipmentStatusCode

String

The status of the shipment.

[]
.colloStatusCode

String

The status of the collo.

[]
.deliveryDate

String

The delivery date.

Format yyyy-MM-dd.

[]
.deliveryTime

String

The delivery time.

Format HH:mm.

[]
.acceptedBy

String

Name of who signed of on receipt of the goods

Maximum size of 64.

[]
.awb

String

The airway bill number.

Maximum size of 32.

[]
.addReferences

List

No decription found

[]
.addReferences.[]
.type

String

Type of the additional reference

Maximum size of 64.

[]
.addReferences.[]
.value

String

The reference value

Maximum size of 1024.

Response structure

Path

Type

Description

Constraints

[]
.reference

String

Shipment reference

Not Null and not empty.
The size must be between 1 and 32.

[]
.customerId

String

Customer id

Maximum size of 10.

[]
.shipmentStatusCode

String

The status of the shipment.

[]
.statusUpdate

String

The execution result.

Has to match pattern: (OK|
NOK)
Maximum size of 8.

[]
.colloStatusCode

String

The status of the collo.

[]
.description

String

Shipments description

Maximum size of 128.

Table 25. /v2/addresses/{account}
Parameter	Description
`account`	The account that owns the address.

Request fields

Path

Type

Description

Constraints

[].name

String

The name.

The size must be between 1 and 128.

[].addressLine1

String

The first address line; mostly the primary street name.

Maximum size of 64.

[].addressLine2

String

The second address line.

Maximum size of 64.

[].addressLine3

String

The third address line.

Maximum size of 64.

[].houseNumber

String

The house number.

Maximum size of 16.

[].zipCode

String

The zip/postal code.

Maximum size of 16.

[].city

String

The city.

Maximum size of 64.

[].province

String

The province or state.

Maximum size of 16.

[].country

String

The country code.

Maximum size of 2.

[].language

String

The language code.

Maximum size of 2.

[].contact.name

String

The name.

Maximum size of 64.

[].contact.email

String

The email address.

Maximum size of 256.

[].contact.phone

String

The phone number.

Maximum size of 32.

[].contact.fax

String

The fax number.

Maximum size of 32.

[].accountNumber

String

The carrier account number for this address.

Maximum size of 32.

[].customerNumber

String

The customer number for this address.

Maximum size of 32.

[].vatNumber

String

The VAT Number.

Maximum size of 32.

[].costCenter

String

The cost center.

Maximum size of 127.

[].type

String

Address type; can be SEND (sender) or RECV (receiver) address.

Has to match pattern: (SEND|
RECV|
INVC|
3PTY)
The size must be between 1 and 4.

[].instructions

String

The instructions for the address.

Maximum size of 256.

[].billingAddress.name

String

The name.

The size must be between 1 and 128.

[].billingAddress.addressLine1

String

The first address line; mostly the primary street name.

Maximum size of 64.

[].billingAddress.addressLine2

String

The second address line.

Maximum size of 64.

[].billingAddress.addressLine3

String

The third address line.

Maximum size of 64.

[].billingAddress.houseNumber

String

The house number.

Maximum size of 16.

[].billingAddress.zipCode

String

The zip/postal code.

Maximum size of 16.

[].billingAddress.city

String

The city.

Maximum size of 64.

[].billingAddress.province

String

The province or state.

Maximum size of 16.

[].billingAddress.country

String

The country code.

Maximum size of 2.

[].billingAddress.contact.name

String

The name.

Maximum size of 64.

[].billingAddress.contact.email

String

The email address.

Maximum size of 256.

[].billingAddress.contact.phone

String

The phone number.

Maximum size of 32.

[].billingAddress.contact.fax

String

The fax number.

Maximum size of 32.

[].billingAddress.accountNumber

String

The carrier account number for this address.

Maximum size of 32.

[].billingAddress.customerNumber

String

The customer number for this address.

Maximum size of 32.

[].billingAddress.vatNumber

String

The VAT Number.

Maximum size of 32.

Example request body

[ {
  "name" : "Anouk en Marcel 2",
  "addressLine1" : "Zoete Inval",
  "addressLine2" : "Test",
  "addressLine3" : "Test",
  "houseNumber" : "1",
  "zipCode" : "4815 HK",
  "city" : "Breda",
  "province" : "NB",
  "country" : "NL",
  "language" : "NL",
  "contact" : {
    "name" : "Anoiuk",
    "phone" : "1260303",
    "fax" : "1260303",
    "email" : "test@transsmart.com"
  },
  "accountNumber" : "1260303",
  "customerNumber" : "1260304",
  "costCenter" : "Test",
  "vatNumber" : "Test",
  "type" : "RECV",
  "instructions" : "Test",
  "billingAddress" : {
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "addressLine2" : "2nd floor",
    "addressLine3" : "Test",
    "houseNumber" : "1c",
    "zipCode" : "5032MD",
    "city" : "Tilburg",
    "province" : "NB",
    "country" : "NL",
    "contact" : {
      "name" : "Support",
      "phone" : "+31(0)88 126 03 03",
      "fax" : "+31(0)88 126 03 03",
      "email" : "support@transsmart.com"
    },
    "accountNumber" : "54321",
    "customerNumber" : "1260305",
    "vatNumber" : "Test"
  }
}, {
  "name" : "Transsmart",
  "addressLine1" : "Ellen Pankhurststraat",
  "addressLine2" : "2nd floor",
  "addressLine3" : "Test",
  "houseNumber" : "1c",
  "zipCode" : "5032MD",
  "city" : "Tilburg",
  "province" : "NB",
  "country" : "NL",
  "contact" : {
    "name" : "Support",
    "phone" : "+31(0)88 126 03 03",
    "fax" : "+31(0)88 126 03 03",
    "email" : "support@transsmart.com"
  },
  "accountNumber" : "12345",
  "customerNumber" : "1260306",
  "costCenter" : "Test",
  "vatNumber" : "Test",
  "type" : "RECV",
  "instructions" : "Don't ring the bell, the door is open",
  "billingAddress" : {
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "addressLine2" : "2nd floor",
    "addressLine3" : "Test",
    "houseNumber" : "1c",
    "zipCode" : "5032MD",
    "city" : "Tilburg",
    "province" : "NB",
    "country" : "NL",
    "contact" : {
      "name" : "Support",
      "phone" : "+31(0)88 126 03 03",
      "fax" : "+31(0)88 126 03 03",
      "email" : "support@transsmart.com"
    },
    "accountNumber" : "54321",
    "customerNumber" : "1260308",
    "vatNumber" : "Test"
  }
} ]

Curl Example requests

Click here to show/hide example

$ curl 'https://accept-api.transsmart.com/v2/addresses/DEVDOCS' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '[ {
  "name" : "Anouk en Marcel 2",
  "addressLine1" : "Zoete Inval",
  "addressLine2" : "Test",
  "addressLine3" : "Test",
  "houseNumber" : "1",
  "zipCode" : "4815 HK",
  "city" : "Breda",
  "province" : "NB",
  "country" : "NL",
  "language" : "NL",
  "contact" : {
    "name" : "Anoiuk",
    "phone" : "1260303",
    "fax" : "1260303",
    "email" : "test@transsmart.com"
  },
  "accountNumber" : "1260303",
  "customerNumber" : "1260304",
  "costCenter" : "Test",
  "vatNumber" : "Test",
  "type" : "RECV",
  "instructions" : "Test",
  "billingAddress" : {
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "addressLine2" : "2nd floor",
    "addressLine3" : "Test",
    "houseNumber" : "1c",
    "zipCode" : "5032MD",
    "city" : "Tilburg",
    "province" : "NB",
    "country" : "NL",
    "contact" : {
      "name" : "Support",
      "phone" : "+31(0)88 126 03 03",
      "fax" : "+31(0)88 126 03 03",
      "email" : "support@transsmart.com"
    },
    "accountNumber" : "54321",
    "customerNumber" : "1260305",
    "vatNumber" : "Test"
  }
}, {
  "name" : "Transsmart",
  "addressLine1" : "Ellen Pankhurststraat",
  "addressLine2" : "2nd floor",
  "addressLine3" : "Test",
  "houseNumber" : "1c",
  "zipCode" : "5032MD",
  "city" : "Tilburg",
  "province" : "NB",
  "country" : "NL",
  "contact" : {
    "name" : "Support",
    "phone" : "+31(0)88 126 03 03",
    "fax" : "+31(0)88 126 03 03",
    "email" : "support@transsmart.com"
  },
  "accountNumber" : "12345",
  "customerNumber" : "1260306",
  "costCenter" : "Test",
  "vatNumber" : "Test",
  "type" : "RECV",
  "instructions" : "Don't ring the bell, the door is open",
  "billingAddress" : {
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "addressLine2" : "2nd floor",
    "addressLine3" : "Test",
    "houseNumber" : "1c",
    "zipCode" : "5032MD",
    "city" : "Tilburg",
    "province" : "NB",
    "country" : "NL",
    "contact" : {
      "name" : "Support",
      "phone" : "+31(0)88 126 03 03",
      "fax" : "+31(0)88 126 03 03",
      "email" : "support@transsmart.com"
    },
    "accountNumber" : "54321",
    "customerNumber" : "1260308",
    "vatNumber" : "Test"
  }
} ]'

Http example

Click here to show/hide example

POST /v2/addresses/DEVDOCS HTTP/1.1
Content-Type: application/json
Content-Length: 2210
Host: accept-api.transsmart.com

[ {
  "name" : "Anouk en Marcel 2",
  "addressLine1" : "Zoete Inval",
  "addressLine2" : "Test",
  "addressLine3" : "Test",
  "houseNumber" : "1",
  "zipCode" : "4815 HK",
  "city" : "Breda",
  "province" : "NB",
  "country" : "NL",
  "language" : "NL",
  "contact" : {
    "name" : "Anoiuk",
    "phone" : "1260303",
    "fax" : "1260303",
    "email" : "test@transsmart.com"
  },
  "accountNumber" : "1260303",
  "customerNumber" : "1260304",
  "costCenter" : "Test",
  "vatNumber" : "Test",
  "type" : "RECV",
  "instructions" : "Test",
  "billingAddress" : {
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "addressLine2" : "2nd floor",
    "addressLine3" : "Test",
    "houseNumber" : "1c",
    "zipCode" : "5032MD",
    "city" : "Tilburg",
    "province" : "NB",
    "country" : "NL",
    "contact" : {
      "name" : "Support",
      "phone" : "+31(0)88 126 03 03",
      "fax" : "+31(0)88 126 03 03",
      "email" : "support@transsmart.com"
    },
    "accountNumber" : "54321",
    "customerNumber" : "1260305",
    "vatNumber" : "Test"
  }
}, {
  "name" : "Transsmart",
  "addressLine1" : "Ellen Pankhurststraat",
  "addressLine2" : "2nd floor",
  "addressLine3" : "Test",
  "houseNumber" : "1c",
  "zipCode" : "5032MD",
  "city" : "Tilburg",
  "province" : "NB",
  "country" : "NL",
  "contact" : {
    "name" : "Support",
    "phone" : "+31(0)88 126 03 03",
    "fax" : "+31(0)88 126 03 03",
    "email" : "support@transsmart.com"
  },
  "accountNumber" : "12345",
  "customerNumber" : "1260306",
  "costCenter" : "Test",
  "vatNumber" : "Test",
  "type" : "RECV",
  "instructions" : "Don't ring the bell, the door is open",
  "billingAddress" : {
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "addressLine2" : "2nd floor",
    "addressLine3" : "Test",
    "houseNumber" : "1c",
    "zipCode" : "5032MD",
    "city" : "Tilburg",
    "province" : "NB",
    "country" : "NL",
    "contact" : {
      "name" : "Support",
      "phone" : "+31(0)88 126 03 03",
      "fax" : "+31(0)88 126 03 03",
      "email" : "support@transsmart.com"
    },
    "accountNumber" : "54321",
    "customerNumber" : "1260308",
    "vatNumber" : "Test"
  }
} ]

Example response

Click here to show/hide example

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2524

[ {
  "links" : [ {
    "rel" : "self",
    "href" : "https://accept-api.transsmart.com/v2/addresses/DEVDOCS/DEVDOCS31744076"
  } ],
  "id" : "DEVDOCS31744076",
  "name" : "Anouk en Marcel 2",
  "addressLine1" : "Zoete Inval",
  "addressLine2" : "Test",
  "addressLine3" : "Test",
  "houseNumber" : "1",
  "zipCode" : "4815 HK",
  "city" : "Breda",
  "province" : "NB",
  "country" : "NL",
  "language" : "NL",
  "contact" : {
    "name" : "Anoiuk",
    "phone" : "1260303",
    "fax" : "1260303",
    "email" : "test@transsmart.com"
  },
  "accountNumber" : "1260303",
  "customerNumber" : "1260304",
  "costCenter" : "Test",
  "vatNumber" : "Test",
  "type" : "RECV",
  "instructions" : "Test",
  "billingAddress" : {
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "addressLine2" : "2nd floor",
    "addressLine3" : "Test",
    "houseNumber" : "1c",
    "zipCode" : "5032MD",
    "city" : "Tilburg",
    "province" : "NB",
    "country" : "NL",
    "contact" : {
      "name" : "Support",
      "phone" : "+31(0)88 126 03 03",
      "fax" : "+31(0)88 126 03 03",
      "email" : "support@transsmart.com"
    },
    "accountNumber" : "54321",
    "customerNumber" : "1260306",
    "vatNumber" : "Test"
  }
}, {
  "links" : [ {
    "rel" : "self",
    "href" : "https://accept-api.transsmart.com/v2/addresses/DEVDOCS/DEVDOCS01744100"
  } ],
  "id" : "DEVDOCS01744100",
  "name" : "Transsmart",
  "addressLine1" : "Ellen Pankhurststraat",
  "addressLine2" : "2nd floor",
  "addressLine3" : "Test",
  "houseNumber" : "1c",
  "zipCode" : "5032MD",
  "city" : "Tilburg",
  "province" : "NB",
  "country" : "NL",
  "contact" : {
    "name" : "Support",
    "phone" : "+31(0)88 126 03 03",
    "fax" : "+31(0)88 126 03 03",
    "email" : "support@transsmart.com"
  },
  "accountNumber" : "12345",
  "customerNumber" : "1260305",
  "costCenter" : "Test",
  "vatNumber" : "Test",
  "type" : "RECV",
  "instructions" : "Don't ring the bell, the door is open",
  "billingAddress" : {
    "name" : "Transsmart",
    "addressLine1" : "Ellen Pankhurststraat",
    "addressLine2" : "2nd floor",
    "addressLine3" : "Test",
    "houseNumber" : "1c",
    "zipCode" : "5032MD",
    "city" : "Tilburg",
    "province" : "NB",
    "country" : "NL",
    "contact" : {
      "name" : "Support",
      "phone" : "+31(0)88 126 03 03",
      "fax" : "+31(0)88 126 03 03",
      "email" : "support@transsmart.com"
    },
    "accountNumber" : "54321",
    "customerNumber" : "1260308",
    "vatNumber" : "Test"
  }
} ]

6.2a Single address retrieval

Path parameters

Table 26. /v2/addresses/{account}/{id}
Parameter	Description
`account`	The account that owns the address.
`id`	Identifier of the address to be deleted.

Response structure

Path Type Description

_links

Object

links

_links.self

String

Self reference

_links.self.href

String

The URL to the resource

id

String

The id of the address.

name

String

The name.

addressLine1

String

The first address line; mostly the primary street name.

addressLine2

String

The second address line.

addressLine3

String

The third address line.

houseNumber

String

The house number.

zipCode

String

The zip/postal code.

city

String

The city.

province

String

The province or state.

country

String

The country code.

language

String

The language code.

contact.name

String

The name.

contact.email

String

The email address.

contact.phone

String

The phone number.

contact.fax

String

The fax number.

accountNumber

String

The carrier account number for this address.

customerNumber

String

The customer number for this address.

vatNumber

String

The VAT Number.

costCenter

String

The cost center.

type

String

Address type; can be SEND (sender) or RECV (receiver) address.

instructions

String

The instructions for the address.

billingAddress

Object

The billing/invoice address.

billingAddress.links

Object

links

billingAddress.links.[].rel

String

Relationship

billingAddress.links.[].href

String

The URL to the resource

billingAddress.name

String

The name.

billingAddress.addressLine1

String

The first address line; mostly the primary street name.

billingAddress.addressLine2

String

The second address line.

billingAddress.addressLine3

String

The third address line.

billingAddress.houseNumber

String

The house number.

billingAddress.zipCode

String

The zip/postal code.

billingAddress.city

String

The city.

billingAddress.province

String

The province or state.

billingAddress.country

String

The country code.

billingAddress.contact

String

The contact information for this address.

billingAddress.contact.name

String

The name.

billingAddress.contact.email

String

The email address.

billingAddress.contact.phone

String

The phone number.

billingAddress.contact.fax

String

The fax number.

billingAddress.accountNumber

String

The carrier account number for this address.

billingAddress.customerNumber

String

The customer number for this address.

billingAddress.vatNumber

String

The VAT Number.

Table 27. /v2/addresses/{account}
Parameter	Description
`account`	The account that owns the address.

Request parameters

Parameter Description

size

Maximum number of addresses in the results.

page

Requested results page.

Response structure

Path Type Description

contentType

String

isLastPage

Boolean

Indicates if this is the last page.

totalItems

Integer

Total amount of items.

totalPages

Integer

Total amount of pages.

pageSize

Integer

The amount of items per page.

currentPage

Integer

The current page.

isFirstPage

Boolean

Indicates if this is the first page.

numberOfItems

Integer

Number of items in this page.

content

Object

The content of this page.

content.[].links

Array

links

content.[].links.[].rel

String

Relationship

content.[].links.[].href

String

The URL to the resource

content.[].id

String

The id of the address.

content.[].