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.

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.

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. beta developments, user acceptance and production.

Some information about the basic booking flow can be found in our help center.

Integration endpoints

Transsmart offers two integration endpoints:

  • SOAP webservice

  • RESTful API

The SOAP webservice is the longest-living integration endpoint of Transsmart. Download SOAP webservice documentation

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

Directives

The API is offered as a RESTful web service.
The API assumes a plural-based resources naming convention.

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.

Environments

Environment Base URL Description

BETA

https://beta-api.transsmart.com

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

ACCEPT

https://accept-api.transsmart.com

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

PRODUCTION

https://api.transsmart.com

Production environment

Postman and help center

We offer a Postman package with examples and tests to help developers understand our API and make the initial implementation easier.

We also offer more information, guides and explanations about several other integration topics. This information can be found in our help center.

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.

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

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

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. See chapter 'Rate limiter' below for more information.

500 Internal Server Error

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

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.

Localization

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

Parameter Description

language

ISO 639-1 two letter code in lower case.

country

ISO 3166-1 two letter code in upper case.

currency

ISO 4217 three letter code in upper case.

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.

Supported characters

The shipment reference can be present in the REST request path for a shipment. The list of supported characters for this value is limited.

Supported characters:

Character Name

a-z, A-Z, 0-9

Alphanumericals

.

Period, dot

-

Hyphen, dash

_

Underscore

` `

Space

Unsupported characters:

Character Name

%

Percentage symbol

\

Backslash

`‘ ’ ' `

Grave accent, single quotation mark, Apostrophe

+

Plus symbol

:

Colon

?

Question mark

;

Semicolon

``

Tab, carriage return, line feed

For all other special characters, we are not sure if all carriers accept those. We decided not to put them in the column ‘unsupported characters’ because they might work, however, we cannot guarantee that. Therefore, we recommend sticking to the supported characters only.

MyTranssmart dashboard

In a nutshell: MyTranssmart is the dashboard which can be used to manage shipments. The dashboard is fully connected to our API backend, so all actions in the dashboard are done via API request calls and responses. When opening the Developer Tools in the internet browser, the Network tab will show wich Request URL is called when doing a specific action. This way you can understand in a more visual way which calls are being used for which purpose and which responses are given.

These are the URL’s:

Environment URL

BETA

https://beta-my.transsmart.com/

ACCEPT

https://accept-my.transsmart.com/

PRODUCTION

https://my.transsmart.com/

The MyTranssmart dashboard 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=cQBauM7gcQBauM7g…​&reference=71117854
Note: key and reference in this example 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=…

Explanation:

  • key = the login key

  • reference = the reference of a shipment

  • account = optionally, 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. See chapter 'Act on behalf' below for more information.

Accounts hierarchy

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

Act on Behalf

The 'Act on Behalf' feature of the API makes it possible to use a child or grandchild account in the same way as the account where you are logged into, which we call the main or (grand)parent account. Note that a child account is also sometimes referred to as a subaccount. Both terms mean the same. You can perform the same actions on the child account as which you can do on the logged in main account. This can be done by replacing the account code in the URL by the account code that you want the action to be performed on.

Example of booking a shipment in the main account:
1. You log in as a user of main account "DEMO"
2. You perform a booking with this URL: POST request to /v2/shipments/DEMO/BOOK
3. This will book the shipment on account "DEMO"

Example of booking a shipment in the child account:
Now for example, account "DEMOSUB" is a child account of "DEMO". If you want to book on account "DEMOSUB" the flow is:
1. You log in as a user of main account "DEMO" (so the same user as above which is a user that only exists in the main account).
2. You perform a booking with this URL: POST request to /v2/shipments/DEMOSUB/BOOK
3. This wil book the shipment on account "DEMOSUB"

The Account information endpoint provides information to which account the Act on Behalf can be performed.

Permissions

You keep the same permissions as you have on the parent account, even if the child account has less permissions.

Example:
Your main account has Reporting permissions and you log in with an user with Reporting permissions. The child account does not have Reporting permissions which means that users that directly connect to that account will not be able to download a report. If the user that logs into the main account uses Act on Behalf to log into the child account, that user will be able to download a report for that child account.

Reported errors

Depending on the error there are three type of error structures that can be returned. For instance, in the error response of a booking call, all three structures are possible so you need to be sure you can handle all three types.

Normal error:

{
    "status": "BAD_REQUEST",
    "timestamp": "2024-02-29T12:42:49.450320273",
    "code": "TS222122",
    "message": "Failed to print",
    "description": "No printer found for type: LASER",
}

Validation errors:

{
    "status": "BAD_REQUEST",
    "timestamp": "2024-02-29T12:42:49.450320273",
    "code": "TS10002",
    "message": "Invalid input shipment data",
    "details": [{
            "reference": "this_reference_is_too_long_so_an_error_will_be_reported",
            "validationErrors": [{
                    "object": "Shipment",
                    "field": "reference",
                    "rejectedValue": "this_reference_is_too_long_so_an_error_will_be_reported",
                    "message": "size must be between 1 and 32"
                }, {
                    "object": "Shipment",
                    "field": "carrier",
                    "rejectedValue": "too_long_carrier",
                    "message": "Carrier must be 3 characters"
                }
            ]
        }
    ]
}

Errors with detail information:

{
    "status": "BAD_REQUEST",
    "timestamp": "2024-02-29T12:42:49.450320273",
    "code": "TS10002",
    "message": "Batch booking error",
    "description": "Booking failed for all shipments",
    "details": [{
            "errorCode": "TS222122",
            "errorDescription": "Shipment with reference 12345 already exists with status LABL and cannot be changed.",
            "errorTitle": "Batch booking failed"
        }
    ]

}

This 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.

Endpoints

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.

Explanation

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)

1.0 Authenticating

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:

GET request to environment_base_url/login

Use basic authentication with valid user credentials.
As response a JWT token is returned which is valid for 24 hours.

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

When the token is expired, you will receive a response that the token has expired and you will have to make sure to request for a new token.
Alternatively, you can also just 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 will be given, indicating a probable cause.

2.0 Shipment management

This involves creating, booking, printing, manifesting, deleting and retrieving 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/source system 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 responses are different and described below.
Consult your project manager or (implementation) consultant for more information on specific implementation needs.
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 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.

Delivery Note Lines

Currently, it is possible to send in Delivery Note Lines on shipment level but we strongly advice you to send them in on package level only.
We notice more and more carriers, especially when it concerns dangerous goods or customs shipments outside EU, expect the item information of each parcel to be registered on package level. For that reason in the future we plan the Delivery Note Lines on shipment level to go EOL (End of life). In case you already have an integration with us based on shipment level, we strongly advice you to change it to package level. Of course we will communicate any change regarding this in time.

Book 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

Deprecated; replaced by monetaryDetails.type = SPOTPRICE

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

0.00

[]
.spotPriceCurrency

String

Deprecated; replaced by monetaryDetails.type = SPOTPRICE

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

Object

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

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.articleThumbnailUrl

String

Url to a thumbnail of the product.

Maximum size of 1024.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.articleImageUrls

List

List of url towards images of the product.

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.articleImageUrls.[]
.url

String

A link to the image of the product.

Mandatory.
Maximum size of 128.

[]
.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. Preferred value: ADRCONTENT_ID AGENTREFERENCE CONSOLIDATION_REF CUSTOMER CUSTOMERORDER DELIVERYID DELIVERYNOTE DRIVER_ID ENGINEER INVOICE LOCATION ORDER OTHER PROJECT ROUTE_ID SERVICEPOINT YOUR_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|
IVCO|
3PTO|
IMPO|
EXPO|
BRKR)
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. Preferred value: ADRCONTENT_ID AGENTREFERENCE CONSOLIDATION_REF CUSTOMER CUSTOMERORDER DELIVERYID DELIVERYNOTE DRIVER_ID ENGINEER INVOICE LOCATION ORDER OTHER PROJECT ROUTE_ID SERVICEPOINT YOUR_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

Object

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.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleThumbnailUrl

String

Url to a thumbnail of the product.

Maximum size of 1024.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleImageUrls

List

List of url towards images of the product.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleImageUrls.[]
.url

String

A link to the image of the product.

Mandatory.
Maximum size of 128.

[]
.packages.[]
.dangerousGoodsInformation

Object

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

Object

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.

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
Book and print

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

user

The user name (not the email that is used to login) from whom the print setting should be used. If the user can not be found the login user print settings are used.

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.

printer_zpl

ZPL printer name

printer_pdf

PDF printer name

printer_doc

Document printer name

Book and print 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

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.

Book validation error

The same parameters and request input as book only is applicable

Response structure Booking validation error
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
Http example:
Click here to show/hide example
Example response BOOK
Click here to show/hide example
Book 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

Deprecated; replaced by monetaryDetails.type = SPOTPRICE

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

0.00

spotPriceCurrency

String

Deprecated; replaced by monetaryDetails.type = SPOTPRICE

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

Object

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. Preferred value: ADRCONTENT_ID AGENTREFERENCE CONSOLIDATION_REF CUSTOMER CUSTOMERORDER DELIVERYID DELIVERYNOTE DRIVER_ID ENGINEER INVOICE LOCATION ORDER OTHER PROJECT ROUTE_ID SERVICEPOINT YOUR_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|
IVCO|
3PTO|
IMPO|
EXPO|
BRKR)
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. Preferred value: ADRCONTENT_ID AGENTREFERENCE CONSOLIDATION_REF CUSTOMER CUSTOMERORDER DELIVERYID DELIVERYNOTE DRIVER_ID ENGINEER INVOICE LOCATION ORDER OTHER PROJECT ROUTE_ID SERVICEPOINT YOUR_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

Object

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

Object

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

Object

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.

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. Preferred value: ADRCONTENT_ID AGENTREFERENCE CONSOLIDATION_REF CUSTOMER CUSTOMERORDER DELIVERYID DELIVERYNOTE DRIVER_ID ENGINEER INVOICE LOCATION ORDER OTHER PROJECT ROUTE_ID SERVICEPOINT YOUR_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

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

Deprecated; replaced by monetaryDetails.type = SPOTPRICE

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

spotPriceCurrency

String

Deprecated; replaced by monetaryDetails.type = SPOTPRICE

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

Object

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

deliveryNoteInformation
.deliveryNoteLines.[]
.articleThumbnailUrl

String

Url to a thumbnail of the product.

Maximum size of 1024.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleImageUrls

List

List of url towards images of the product.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleImageUrls.[]
.url

String

A link to the image of the product.

Mandatory.
Maximum size of 128.

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. Preferred value: ADRCONTENT_ID AGENTREFERENCE CONSOLIDATION_REF CUSTOMER CUSTOMERORDER DELIVERYID DELIVERYNOTE DRIVER_ID ENGINEER INVOICE LOCATION ORDER OTHER PROJECT ROUTE_ID SERVICEPOINT YOUR_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|
IVCO|
3PTO|
IMPO|
EXPO|
BRKR)
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. Preferred value: ADRCONTENT_ID AGENTREFERENCE CONSOLIDATION_REF CUSTOMER CUSTOMERORDER DELIVERYID DELIVERYNOTE DRIVER_ID ENGINEER INVOICE LOCATION ORDER OTHER PROJECT ROUTE_ID SERVICEPOINT YOUR_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

Object

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.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleThumbnailUrl

String

Url to a thumbnail of the product.

Maximum size of 1024.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleImageUrls

List

List of url towards images of the product.

packages.[]
.deliveryNoteInfo
.deliveryNoteLines.[]
.articleImageUrls.[]
.url

String

A link to the image of the product.

Mandatory.
Maximum size of 128.

packages.[]
.dangerousGoodsInformation

Object

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

Object

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

Object

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

Object

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

Object

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 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
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

reference

The reference wildcard. Optional

referenceType

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

carrierCode

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

accountCode

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

costCenter

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

createdFrom

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

createdTo

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

extended

Flag to turn on the extended shipment retrieval. Optional

pickUpDateFrom

The pickup date from. Optional

pickUpDateTo

The pickup date to. Optional

page

The desired page.

size

The amount of items per page.

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

Which objects this page contains

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

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 parameters
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 parameters
Table 9. /v2/shipments/{account}
Parameter Description

account

The account to which the shipment belongs.

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: 4

true

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

date

The pickup date.

dateTo

The pickup date until.

pagedResult

Return the results in transsmart pages.

carrier

The carrier.

costCenter

The costCenter (optional).

slt

The service level time (optional).

slo

The service level other (optional).

receiverCountry

The country of the receiver (optional).

Response structure
Path Type Description Constraints

contentType

String

Which objects this page contains

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
.costCenters

List

The cost centers found to be manifested.

content
.manifests

List

The shipments to be manifested.

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

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
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

date

The pickup date.

dateTo

The pickup date until.

carrier

The carrier.

costCenter

The costCenter (optional).

slt

The service level time (optional).

slo

The service level other (optional).

receiverCountry

The country of the receiver (optional).

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
Retrieve list filter on addref

Retrieve a list of shipments ready to be manifested and are filtered on additional 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

date

The pickup date.

dateTo

The pickup date until.

carrier

The carrier.

costCenter

The costCenter (optional).

slt

The service level time (optional).

slo

The service level other (optional).

receiverCountry

The country of the receiver (optional).

reference

The value of the aditional reference (optional).

referenceType

The aditional reference type (optional).

Curl Example requests
Click here to show/hide example
Http example:
Click here to show/hide example
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

from

The from pickup date.

to

The to pickup date.

carrier

The carrier.

costCenter

The costCenter (optional).

receiverCountry

The country of the receiver (optional).

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 addref

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

Path parameters
Table 14. /v2/shipments/{account}/manifest
Parameter Description

account

The account to which the shipment(s) belong(s).

Request parameters
Parameter Description

from

The from pickup date.

to

The to pickup date.

carrier

The carrier.

costCenter

The costCenter (optional).

receiverCountry

The country of the receiver (optional).

reference

The value of the aditional reference (optional).

referenceType

The aditional reference type (optional).

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.
More information about the working of tariffs, can be found in our help center.

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
Table 15. /v2/rates/{account}
Parameter Description

account

The account.

Request parameters
Parameter Description

action

calculate (default), preBooking or filtered, see above for explanation.

Request fields
Path Type Description Constraints

[]
.reference

String

Shipment reference.

Maximum size of 32.

[]
.carrier

String

The carrier.

Maximum size of 3.

[]
.costCenter

String

The cost center.

Maximum size of 32.

[]
.mailType

Integer wrapped in String

The mail type.

[]
.value

Decimal

The shipment monetary value. (Precision of 2).

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

[]
.currency

String

General currency for shipment monetary fields.

Maximum size of 3.

[]
.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.

[]
.service

String

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

Maximum size of 16.

[]
.serviceLevelTime

String

The requested service level time.

Maximum size of 32.

[]
.serviceLevelOther

String

The service level other.

Maximum size of 32.

[]
.incoterms

String

The inco terms.

Maximum size of 16.

[]
.inbound

Boolean wrapped in 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.

[]
.measurements

Measurements

The total measurements of the shipment, deprecated use measurements in packages.

[]
.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.

[]
.addresses.[]
.addressLine1

String

The first address line.

Maximum size of 64.

[]
.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.

[]
.addresses.[]
.zipCode

String

The zip code.

Maximum size of 16.

[]
.addresses.[]
.state

String

The state.

Maximum size of 16.

[]
.addresses.[]
.country

String

The country code.

Maximum size of 2.

[]
.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.

[]
.packages

List

The packages/collo.

[]
.packages.[]
.description

String

The description of the goods.

Maximum size of 128.

[]
.packages.[]
.lineNo

Integer

The line number for this package.

Maximum value is 200000.

[]
.packages.[]
.packageType

String

The package type.

Maximum size of 16.

[]
.packages.[]
.quantity

Integer

The quantity.

[]
.packages.[]
.stackable

Boolean

Is the package stackable?

[]
.packages.[]
.stackHeight

Integer

The stack height.

Maximum value is 32767.

[]
.packages.[]
.measurements
.length

Decimal

The length. (Precision of 2) Note that the length on shipment level is deprecated and will always return 0.

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

[]
.packages.[]
.measurements
.width

Decimal

The width. (Precision of 2) Note that the width on shipment level is deprecated and will always return 0.

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

[]
.packages.[]
.measurements
.height

Decimal

The height. (Precision of 2) Note that the height on shipment level is deprecated and will always return 0.

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

[]
.packages.[]
.measurements
.weight

Decimal

The weight. (Precision of 2).

Mandatory.
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).

Has to match pattern: (CM|
FT|
IN|
YD|
)
Maximum size of 3.

[]
.packages.[]
.measurements
.massUom

String

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

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

Response structure
Path Type Description Constraints

[]
.shipmentDetails

Shipment

The shipment for which the rating is calculated.

[]
.shipmentDetails
.reference

String

Shipment reference.

Maximum size of 32.

[]
.shipmentDetails
.carrier

String

The carrier.

Maximum size of 3.

[]
.shipmentDetails
.costCenter

String

The cost center.

Maximum size of 32.

[]
.shipmentDetails
.mailType

Integer wrapped in String

The mail type.

[]
.shipmentDetails
.value

Decimal

The shipment monetary value. (Precision of 2).

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

[]
.shipmentDetails
.currency

String

General currency for shipment monetary fields.

Maximum size of 3.

[]
.shipmentDetails
.pickupDate

String

The pickup date.

Format yyyy-MM-dd.

[]
.shipmentDetails
.pickupTime

String

The earliest pickup time.

Format HH:mm.

[]
.shipmentDetails
.pickupTimeTo

String

The latest shipment pickup time.

Format HH:mm.

[]
.shipmentDetails
.requestedDeliveryDate

String

The requested delivery date.

Format yyyy-MM-dd.

[]
.shipmentDetails
.requestedDeliveryTime

String

The requested earliest delivery time

Format HH:mm.

[]
.shipmentDetails
.requestedDeliveryTimeTo

String

The requested lates delivery time.

Format HH:mm.

[]
.shipmentDetails
.service

String

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

Maximum size of 16.

[]
.shipmentDetails
.serviceLevelTime

String

The requested service level time.

Maximum size of 32.

[]
.shipmentDetails
.serviceLevelOther

String

The service level other.

Maximum size of 32.

[]
.shipmentDetails
.incoterms

String

The inco terms.

Maximum size of 16.

[]
.shipmentDetails
.inbound

Boolean wrapped in Integer

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

Maximum value is 1.
Minimum value is 0.

[]
.shipmentDetails
.loadmeters

Decimal

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

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

[]
.shipmentDetails
.numberOfPackages

Integer

Maximum value is 32767.

[]
.shipmentDetails
.measurements
.length

Decimal

The length. (Precision of 2) Note that the length on shipment level is deprecated and will always return 0.

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

[]
.shipmentDetails
.measurements
.width

Decimal

The width. (Precision of 2) Note that the width on shipment level is deprecated and will always return 0.

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

[]
.shipmentDetails
.measurements
.height

Decimal

The height. (Precision of 2) Note that the height on shipment level is deprecated and will always return 0.

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

[]
.shipmentDetails
.measurements
.weight

Decimal

The weight. (Precision of 2).

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

[]
.shipmentDetails
.measurements
.linearUom

String

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

Has to match pattern: (CM|
FT|
IN|
YD|
)
Maximum size of 3.

[]
.shipmentDetails
.measurements
.massUom

String

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

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

[]
.shipmentDetails
.addresses

List

The addresses, the address indicates the type.

[]
.shipmentDetails
.addresses.[]
.type

String

The type of the address.

[]
.shipmentDetails
.addresses.[]
.name

String

The name.

Maximum size of 64.

[]
.shipmentDetails
.addresses.[]
.addressLine1

String

The first address line.

Maximum size of 64.

[]
.shipmentDetails
.addresses.[]
.addressLine2

String

The second address line.

Maximum size of 64.

[]
.shipmentDetails
.addresses.[]
.addressLine3

String

The third address line.

Maximum size of 64.

[]
.shipmentDetails
.addresses.[]
.houseNo

String

The house number.

Maximum size of 16.

[]
.shipmentDetails
.addresses.[]
.city

String

The city.

Maximum size of 64.

[]
.shipmentDetails
.addresses.[]
.zipCode

String

The zip code.

Maximum size of 16.

[]
.shipmentDetails
.addresses.[]
.state

String

The state.

Maximum size of 16.

[]
.shipmentDetails
.addresses.[]
.country

String

The country code.

Maximum size of 2.

[]
.shipmentDetails
.addresses.[]
.contact

String

The contact information.

Maximum size of 64.

[]
.shipmentDetails
.addresses.[]
.telNo

String

The phone number.

Maximum size of 32.

[]
.shipmentDetails
.addresses.[]
.faxNo

String

The fax number.

Maximum size of 32.

[]
.shipmentDetails
.addresses.[]
.email

String

The email address.

Maximum size of 256.

[]
.shipmentDetails
.addresses.[]
.accountNumber

String

The account number.

Maximum size of 32.

[]
.shipmentDetails
.addresses.[]
.customerNumber

String

The customer number.

Maximum size of 32.

[]
.shipmentDetails
.addresses.[]
.vatNumber

String

The vat number.

Maximum size of 32.

[]
.shipmentDetails
.addresses.[]
.residential

Boolean wrapped in Integer

Indicator for residential addresses.

Maximum value is 1.
Minimum value is 0.

[]
.shipmentDetails
.packages

List

The packages/collo.

[]
.shipmentDetails
.packages.[]
.lineNo

Integer

The line number for this package.

Maximum value is 200000.

[]
.shipmentDetails
.packages.[]
.description

String

The description of the goods.

Maximum size of 128.

[]
.shipmentDetails
.packages.[]
.packageType

String

The package type.

Maximum size of 16.

[]
.shipmentDetails
.packages.[]
.quantity

Integer

The quantity.

[]
.shipmentDetails
.packages.[]
.stackable

Boolean

Is the package stackable?

[]
.shipmentDetails
.packages.[]
.stackHeight

Integer

The stack height.

Maximum value is 32767.

[]
.shipmentDetails
.packages.[]
.measurements
.length

Decimal

The length. (Precision of 2) Note that the length on shipment level is deprecated and will always return 0.

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

[]
.shipmentDetails
.packages.[]
.measurements
.width

Decimal

The width. (Precision of 2) Note that the width on shipment level is deprecated and will always return 0.

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

[]
.shipmentDetails
.packages.[]
.measurements
.height

Decimal

The height. (Precision of 2) Note that the height on shipment level is deprecated and will always return 0.

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

[]
.shipmentDetails
.packages.[]
.measurements
.weight

Decimal

The weight. (Precision of 2).

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

[]
.shipmentDetails
.packages.[]
.measurements
.linearUom

String

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

Has to match pattern: (CM|
FT|
IN|
YD|
)
Maximum size of 3.

[]
.shipmentDetails
.packages.[]
.measurements
.massUom

String

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

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

[]
.rates

List

List of calculated rates.

[]
.rates.[]
.description

String

The description for this rate.

Maximum size of 128.

[]
.rates.[]
.currency

String

The currency.

Maximum size of 3.

[]
.rates.[]
.salesPrice

Decimal

The sales price. (Precision of 2).

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

[]
.rates.[]
.salesCurrency

String

The sales currency.

Maximum size of 3.

[]
.rates.[]
.weight

Decimal

The weight. (Precision of 2).

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

[]
.rates.[]
.weightUom

String

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

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

[]
.rates.[]
.calculatedWeight

Decimal

The calculated weight. (Precision of 2).

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

[]
.rates.[]
.calculatedWeightType

String

The calculated weight type.

Maximum size of 45.

[]
.rates.[]
.calculatedWeightUom

String

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

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

[]
.rates.[]
.executingCarrier

String

The executing carrier.

Fixed length of 3.

[]
.rates.[]
.transitTimeDescription

String

The description of the transit times (in Dutch).

Maximum size of 128.

[]
.rates.[]
.transitTimeHours

Integer wrapped in Decimal

The hours of transit based on requested pickup and delivery date times.

Maximum value is 32767.
Minimum value is 0.

[]
.rates.[]
.carrier

String

The carrier.

Fixed length of 3.

[]
.rates.[]
.carrierDescription

String

The carrier name.

Maximum size of 128.

[]
.rates.[]
.serviceLevelTime

String

The service level time.

Maximum size of 32.

[]
.rates.[]
.serviceLevelOther

String

The service level other.

Maximum size of 32.

[]
.rates.[]
.serviceLevelTimeDescription

String

The service level time description.

Maximum size of 128.

[]
.rates.[]
.serviceLevelOtherDescription

String

The service level other description.

Maximum size of 128.

[]
.rates.[]
.pickupDate

Date wrapped in String

Pickup date, note that this can differ from the originally desired pickup date due to the carrier’s logistics.

Format yyyy-MM-dd.
Maximum size of 10.

[]
.rates.[]
.deliveryDate

Date wrapped in String

Delivery date, note that this can differ from the originally desired delivery date due to carrier’s logistics.

Format yyyy-MM-dd.
Maximum size of 10.

[]
.rates.[]
.deliveryTime

Date wrapped in String

Delivery time, note that this can differ from the originally desired delivery time due to carrier’s logistics.

Format HH:mm.

[]
.rates.[]
.price

Decimal

Calculated price.

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

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 insurance premiums for your configured insurance company.

Path parameters
Table 16. /v2/rates/{account}/insurance
Parameter Description

account

The account.

Request parameters
Parameter Description

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

[]
.charges

List

The included Taxes.

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

3.3 Get insurance information

Get the insurance information for the shipment.

Path parameters
Table 17. /v