0. Introduction

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

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

Target Audience

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

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

What is on offer?

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

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

Transsmart integration endpoints

Transsmart offers two integration endpoints: * SOAP webservice * RESTful API

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

SOAP webservice documentation

The documentation of the SOAP webservice can be downloaded below.

RESTful API

The API is offered as a RESTful web service

API description

The descriptions provide the following API properties;

  • Supported data formats

  • Supported verbs

  • Request/response status codes and error messages.

  • Data type.

  • Data Constrains (if applicable).

  • Data default (if applicable).

Release Notes 2018-09-06

  • Minor bugfixes on the location select service regarding geocoordinate determination

  • Upgrade and improvement of core infrastructure and libraries for high availability, stability and monitoring

  • Report performance improved and several minor bugs have been fixed

Release Notes 2018-07-18

Click here to show/hide the release notes

Release Notes 2018-06-28

Click here to show/hide the release notes

Environments

Environment Base URL

User acceptance

https://accept-api.transsmart.com

Production

https://api.transsmart.com

Prerequisites

  • A valid and active Transsmart account.

  • A valid user attached to the Transsmart client account to be used.

  • Basic knowledge of web-services (in particular RESTful services) and the HTTP protocol.

  • Working knowledge of JSON or XML

  • Familiarity with the logistics domain.

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

HTTP verbs

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

Verb Usage

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.

500 Internal Server Error

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

Supported Data formats

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

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

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

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

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

API V2 Documentation

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

API Resources

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

The API assumes a plural-based resources naming convention.

1.0 Authenticating

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

1.1 Requesting for a token

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

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

Example header key Authorization with value Bearer eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ…​

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

2.0 Shipment management

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

Main resource: v2/shipments

2.1 Shipment Booking

Action parameter

The action parameter can be either BOOK or PRINT. With BOOK the shipment is booked, in this case the parameter rawJob is obsolete. 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 of the booking can be specified in the http header 'TranssmartOrigin' if this header is not specified then the value of the http header 'origin' is taken. For the three combinations (BOOK, PRINT and PRINT as rawJob) the same input is used but all three response are described because there are all differend. Consult your project manager / consultant for more information on implementation. The example shows a shipment with all possible values.

Using units

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

Shipment Booking only
Path parameters
Table 1. /v2/shipments/{account}/{action}
Parameter Description

account

The account to which the shipment belongs.

action

Action to be performed; posible values are 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 128.

[]
.value

Decimal

The shipment monetary value. (Precision of 2)

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

0.00

[]
.valueCurrency

String

The shipment monetary value currency.

Maximum size of 3.

[]
.spotPrice

Decimal

The spot price. (Precision of 2)

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

0.00

[]
.spotPriceCurrency

String

The spot price currency.

Maximum size of 3.

EUR

[]
.pickupDate

String

The pickup date.

Format yyyy-MM-dd.

Depends on routing rules.

[]
.pickupTime

String

The earliest pickup time.

Format HH:mm.

Depends on routing rules.

[]
.pickupTimeTo

String

The latest shipment pickup time.

Format HH:mm.

Depends on routing rules.

[]
.requestedDeliveryDate

String

The requested delivery date.

Format yyyy-MM-dd.

Depends on routing rules.

[]
.requestedDeliveryTime

String

The requested earliest delivery time

Format HH:mm.

Depends on routing rules.

[]
.requestedDeliveryTimeTo

String

The requested lates delivery time.

Format HH:mm.

Depends on routing rules.

[]
.service

String

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

Maximum size of 16.

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

[]
.incoterms

String

The inco terms.

Maximum size of 16.

[]
.inbound

Integer

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

Maximum value is 1.
Minimum value is 0.

0

[]
.loadmeters

Decimal

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

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

[]
.numberOfPackages

Integer

Maximum value is 32767.

0

[]
.deliveryNoteInformation

Delivery note

The number of packages/collin in the shipment.

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

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. (Precision of 2)

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

[]
.deliveryNoteInformation
.deliveryNoteLines.[]
.nettWeight

Decimal

The nett weight. (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 nett price. (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.

Maximum size of 64.

[]
.additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

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

Maximum value is 127.

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

Maximum size of 64.

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

String

The additional reference.

Maximum size of 1024.

[]
.packages.[]
.deliveryNoteInfo

Delivery note

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

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteId

String

The identification for the delivery note.

Maximum size of 64.

[]
.packages.[]
.deliveryNoteInfo
.currency

String

The currency of the price.

Maximum size of 3.

[]
.packages.[]
.deliveryNoteInfo
.price

Decimal

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

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

0.00

[]
.packages.[]
.deliveryNoteInfo
.deliveryNoteLines

List

The deliverynote lines.

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

String

The deliverynote id.

Maximum size of 64.

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

Integer

The sequential line number.

Maximum value is 200000.

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

Integer

The quantity of products in the shipment.

Maximum value is 200000.

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

String

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

Maximum size of 32.

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

Integer

The quantity that is ordered.

Maximum value is 200000.

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

Integer

The quantity that is in back order.

Maximum value is 200000.

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

String

The article id.

Maximum size of 64.

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

String

The article name.

Maximum size of 128.

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

String

The description of the article.

Maximum size of 256.

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

String

The HS Code.

Maximum size of 25.

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

String

The country of origin code.

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. (Precision of 2)

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

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

Decimal

The nett weight. (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 nett price. (Precision of 2)

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

0.00

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

Decimal

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

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

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

Decimal

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

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

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

Decimal

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

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

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

Decimal

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

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

[]
.packages.[]
.dangerousGoodsInformation

Dangerous goods

The dangerousgoods information.

[]
.packages.[]
.dangerousGoodsInformation
.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.[]
.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.[]
.flashPointDegree

Decimal

Flashpoint degree. (Precision of 2)

Maximum value is 9,999.99
Minimum value is -9,999.99

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

Measurements

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

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

[]
.incoterms

String

The incoterms

[]
.price

Decimal

The price.

[]
.currency

String

The 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

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
Shipment Booking and printing

The same request input as book only is applicable

Path parameters PRINT
Table 2. /v2/shipments/{account}/{action}
Parameter Description

account

The account to which the shipment belongs.

action

With PRINT, the shipment is booked first and then printed .

Shipment Booking and printing as rawjob

The same request input as book only is applicable

Path parameters PRINT as rawJob
Table 3. /v2/shipments/{account}/{action}
Parameter Description

account

The account to which the shipment belongs.

action

With PRINT, the shipment is booked first and then printed .

Request parameters PRINT as rawJob
Parameter Description Constraints

rawJob

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

Default is false.

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 4. /v2/shipments/{account}/{reference}
Parameter Description

account

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

value

Decimal

The shipment monetary value. (Precision of 2)

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

valueCurrency

String

The shipment monetary value currency.

Maximum size of 3.

currency

String

General currency for shipment monetary fields.

Maximum size of 3.

spotPrice

Decimal

The spot price. (Precision of 2)

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

spotPriceCurrency

String

The spot price currency.

Maximum size of 3.

price

Decimal

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

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

salesPrice

Decimal

The shipment sales price. (Precision of 2)

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

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

Date

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.

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

executedServiceLevelOther

String

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

Maximum size of 32.

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

deliveryNoteInformation

Delivery note

The number of packages/collin in the shipment.

deliveryNoteInformation
.deliveryNoteId

String

The identification for the delivery note.

Maximum size of 64.

deliveryNoteInformation
.currency

String

The currency of the price.

Maximum size of 3.

deliveryNoteInformation
.price

Decimal

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

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

deliveryNoteInformation
.deliveryNoteLines

List

The deliverynote lines.

deliveryNoteInformation
.deliveryNoteLines.[]
.deliveryNoteId

String

The deliverynote id.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.lineNumber

Integer

The sequential line number.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantity

Integer

The quantity of products in the shipment.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityUom

String

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

Maximum size of 32.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityOrder

Integer

The quantity that is ordered.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.quantityBackorder

Integer

The quantity that is in back order.

Maximum value is 200000.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleId

String

The article id.

Maximum size of 64.

deliveryNoteInformation
.deliveryNoteLines.[]
.articleName

String

The article name.

Maximum size of 128.

deliveryNoteInformation
.deliveryNoteLines.[]
.description

String

The description of the article.

Maximum size of 256.

deliveryNoteInformation
.deliveryNoteLines.[]
.hsCode

String

The HS Code.

Maximum size of 25.

deliveryNoteInformation
.deliveryNoteLines.[]
.countryOrigin

String

The country of origin code.

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.[]
.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. (Precision of 2)

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

deliveryNoteInformation
.deliveryNoteLines.[]
.nettWeight

Decimal

The nett weight. (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 nett price. (Precision of 2)

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

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceFreightCharges

Decimal

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

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

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceInsuranceCharges

Decimal

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

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

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceDiscounts

Decimal

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

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

deliveryNoteInformation
.deliveryNoteLines.[]
.proformaInvoiceOtherCharges

Decimal

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

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

measurements
.length

Decimal

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

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

measurements
.width

Decimal

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

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

measurements
.height

Decimal

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

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

measurements
.weight

Decimal

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

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

measurements
.linearUom

String

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

Maximum size of 3.

measurements
.massUom

String

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

Maximum size of 3.

measurements
.calculatedWeight

Decimal

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

measurements
.calculatedWeightUom

String

The unit of measure for the calculated shipment weight.

Maximum size of 16.

additionalReferences

List

The additional references.

additionalReferences.[]
.type

String

The type of the additional reference.

Maximum size of 64.

additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

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

Maximum value is 127.

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.

Maximum size of 64.

packages.[]
.additionalReferences.[]
.value

String

The additional reference.

Maximum size of 1024.

packages.[]
.deliveryNoteInfo

Delivery note

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

packages.[]
.deliveryNoteInfo
.deliveryNoteId

String

The identification for the delivery note.

Maximum size of 64.

packages.[]
.deliveryNoteInfo
.currency

String

The currency of the price.

Maximum size of 3.

packages.[]
.deliveryNoteInfo
.price

Decimal

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

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

packages.[]
.deliveryNoteInfo
.deliveryNoteLines

List

The deliverynote lines.

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

String

The deliverynote id.

Maximum size of 64.

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

Integer

The sequential line number.

Maximum value is 200000.

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

Integer

The quantity of products in the shipment.

Maximum value is 200000.

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

String

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

Maximum size of 32.

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

Integer

The quantity that is ordered.

Maximum value is 200000.

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

Integer

The quantity that is in back order.

Maximum value is 200000.

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

String

The article id.

Maximum size of 64.

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

String

The article name.

Maximum size of 128.

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

String

The description of the article.

Maximum size of 256.

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

String

The HS Code.

Maximum size of 25.

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

String

The country of origin code.

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.[]
.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. (Precision of 2)

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

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

Decimal

The nett weight. (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 nett price. (Precision of 2)

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

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

Decimal

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

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

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

Decimal

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

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

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

Decimal

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

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

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

Decimal

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

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

packages.[]
.dangerousGoodsInformation

Dangerous goods

The dangerousgoods information.

packages.[]
.dangerousGoodsInformation
.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.[]
.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.[]
.flashPointDegree

Decimal

Flashpoint degree. (Precision of 2)

Maximum value is 9,999.99
Minimum value is -9,999.99

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

Object

Field dangerousGoodsGds not found

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.

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

account

The account to which the shipment belongs.

Request parameters
Parameter Description Constraints

reference

The reference wildcard. Optional

Default is all reference

page

The desired page.

Default is 1.

size

The amount of items per page.

Default is 20.

Response structure
Path Type Description Constraints

content

Object

The content op this page.

content.[]
.reference

String

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

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

contentType

String

pageSize

Integer

The amount of items per page.

currentPage

Integer

The current page.

totalPages

Integer

Total amount of pages.

totalItems

Integer

Total amount of items.

numberOfItems

Integer

Number of items in this page.

isLastPage

Boolean

Indicates if this is the last page.

isFirstPage

Boolean

Indicates if this is the first page.

Curl Example requests
Click here to show/hide example
Http example:
Click here to show/hide example
Example response
Click here to show/hide example

2.3 Shipment Deletion

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

Single shipment deletion
Path variables
Table 6. /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;charset=UTF-8
Content-Length: 4

true
Multiple shipments deletion
Path variables
Table 7. /v2/shipments/{account}
Parameter Description

account

The account to which the shipment belongs.

Request parameters
Parameter Description Constraints

reference

The references of the shipments to be deleted.

Mutiple entries are supported.

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;charset=UTF-8
Content-Length: 4

true

Shipment Manifesting

Manifesting of shipments.

Retrieve list

Retrieve a list of shipments ready to be manifested.

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

account

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

Request parameters
Parameter Description Constraints

date

The pickup date.

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

carrier

The carrier.

Fixed length of 3.

costCenter

The costCenter.

Maximum size of 32.

slt

The service level time.

Maximum size of 32.

slo

The service level other.

Maximum size of 32.

receiverCountry

The country of the receiver.

Maximum size of 3.

pagedResult

Indicate whether the manifest list is returned in pages.

Maximum size of 32.

size

The page size.

page

The page to retrieve.

Page counting start at 0.

Response structure
Path Type Description Constraints

contentType

String

isLastPage

Boolean

Indicates if this is the last page.

isFirstPage

Boolean

Indicates if this is the first page.

totalItems

Integer

Total amount of items.

totalPages

Integer

Total amount of pages.

pageSize

Integer

The amount of items per page.

currentPage

Integer

The current page.

numberOfItems

Integer

Number of items in this page.

content

Object

The content op this page.

content.[]
.reference

String

The reference of the shipment.

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

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

String

The airwaybill of the shipment.

Maximum size of 256.

content.[]
.name

String

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

Maximum size of 64.
Not Null and not empty.

content.[]
.zipCode

String

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

Maximum size of 16.
Not Null and not empty.

content.[]
.city

String

The city where the shipment is send to.

Maximum size of 64.
Not Null and not empty.

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

Integer

The amount of packages.

Maximum value is 32767.

content.[]
.weight

Decimal

The weight of the shipment.

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

content.[]
.value

Decimal

The value of the shipment.

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

content.[]
.costCenter

String

The costCenter of the shipment.

Maximum size of 32.

Curl Example requests
Click here to show/hide example
Http example:
Click here to show/hide example
Example response
Click here to show/hide example
2.4 Manifest shipments

Manifest shipments that are ready to be manifested.

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

account

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

Request parameters
Parameter Description Constraints

from

The from pickup date.

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

to

The to pickup date.

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

carrier

The carrier.

Fixed length of 3.

costCenter

The costCenter.

Maximum size of 32.

receiverCountry

The country of the receiver.

Maximum size of 3.

Response structure

Returns true if shipments where manifested, else false.

Curl Example requests
Click here to show/hide example
Http example:
Click here to show/hide example
Example response
Click here to show/hide example

3.0 Rates calculation

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

Main resource: v2/rates

3.1 Calculating rates

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

There two calculation:

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

account

The account.

Request parameters
Parameter Description Constraints

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

4.0 Document printing

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

Main resource: v2/prints

4.1 Print document

Print a shipment by reference

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

Path variables
Table 11. /v2/prints/{account}/{reference}
Parameter Description

account

Account on which the shipment has been booked.

reference

Reference of shipment to be printed

Request variables
Parameter Description Constraints

rawJob

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

Default is false.

Response structure print
Path Type Description Constraints

qzHostIp

String

No decription found

qzPort

Integer

No decription found

printWithSmartPrint

Boolean

No decription found

smartPrint

String

No decription found

qzPrintMessages

List

No decription found

qzInitMessage

V2Message

No decription found

qzInitMessage.uid

String

No decription found

qzInitMessage.promise

Promise

No decription found

qzInitMessage.timestamp

String

No decription found

qzInitMessage.signature

String

No decription found

qzInitMessage.certificate

String

No decription found

qzPrintMessages.[].params

Params

No decription found

qzPrintMessages.[].params.printer

Object

The printer.

qzPrintMessages.[].params.printer.name

String

No decription found

qzPrintMessages.[].params.options

Object

The option used to print.

qzPrintMessages.[].params.options.colorType

String

No decription found

qzPrintMessages.[].params.options.copies

String

No decription found

qzPrintMessages.[].params.options.jobName

String

No decription found

qzPrintMessages.[].params.options.density

String

No decription found

qzPrintMessages.[].params.options.fallbackDensity

String

No decription found

qzPrintMessages.[].params.options.duplex

Boolean

No decription found

qzPrintMessages.[].params.options.interpolation

String

No decription found

qzPrintMessages.[].params.options.margins

Integer

No decription found

qzPrintMessages.[].params.options.orientation

Integer

No decription found

qzPrintMessages.[].params.options.paperThickness

String

No decription found

qzPrintMessages.[].params.options.printerTray

String

No decription found

qzPrintMessages.[].params.options.rotation

Integer

No decription found

qzPrintMessages.[].params.options.rasterize

Boolean

No decription found

qzPrintMessages.[].params.options.scaleContent

Boolean

No decription found

qzPrintMessages.[].params.options.size

PaperSize

No decription found

qzPrintMessages.[].params.options.units

String

No decription found

qzPrintMessages.[].params.options.altPrinting

Boolean

No decription found

qzPrintMessages.[].params.options.encoding

String

No decription found

qzPrintMessages.[].params.options.endOfDoc

String

No decription found

qzPrintMessages.[].params.options.perSpool

String

No decription found

qzPrintMessages.[].params.data

Array

qzPrintMessages.[].params.data.[].type

String

No decription found

qzPrintMessages.[].params.data.[].format

String

No decription found

qzPrintMessages.[].params.data.[].data

String

No decription found

qzPrintMessages.[].call

String

No decription found

qzPrintMessages.[].promise

Promise

No decription found

qzPrintMessages.[].timestamp

String

No decription found

qzPrintMessages.[].signature

String

No decription found

qzPrintMessages.[].uid

String

No decription found

Curl Example requests
Click here to show/hide example
Http example:
Click here to show/hide example
Example response print
Click here to show/hide example
Response structure rawJob
Click here to show/hide example
Example response rawJob
Click here to show/hide example

5.0 Shipment status tracking

This involves status tracking after a shipment is successfully booked.

Main resource: v2/statuses

5.1 Status retrieval:

For the status retrieval we have 2 types of retrievals:

  • Per shipment with a query per reference

  • A list of shipments based on query parameters.

5.1 For a single shipment
Path parameters
Table 12. /v2/statuses/{account}/shipments/{reference}
Parameter Description

account

Account code

reference

Shipment reference

Request parameters
Parameter Description Constraints

isDetailed

Include the status history in chronological order.

Default is true.

currentStatusOnly

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

Default is false.

Response structure
Path Type Description

reference

String

Shipment reference

carrier

String

Carrier

costcenter

String

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

shipmentStatus

String

Latest shipment status code

trackAndTraceUrl

String

Track and trace url

airwaybill

String

Airwaybill

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
Path parameters
Table 13. /v2/statuses/{account}/shipments/{reference}
Parameter Description

account

Account code

reference

Shipment reference

Request parameters
Parameter Description Constraints

isDetailed

Include the status history in chronological order.

Default is true.

currentStatusOnly

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

Default is false.

Response structure
Path Type Description

reference

String

Shipment reference

carrier

String

Carrier

costcenter

String

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

shipmentStatus

String

Latest shipment status code

trackAndTraceUrl

String

Track and trace url

airwaybill

String

Airwaybill

accountId

String

Account of the shipment

incoterms

String

Incoterms of the shipment

acceptedBy

String

Name of who signed of on receipt of the goods

actualDeliveryDate

Date wrapped in String

Actual deliverydate

requestedDeliveryDateFrom

Date wrapped in String

Requested delivery date from, as sent during booking

requestedDeliveryDateTo

Date wrapped in String

Requested delivery date to, as sent during booking

plannedDeliveryDateFrom

Date wrapped in String

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

plannedDeliveryDateTo

Date wrapped in String

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

price

Decimal

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

pickupDateFrom

Date wrapped in String

Pickup date from, of the shipment

pickupDateTo

Date wrapped in String

Pickup date to, of the shipment

description

String

Shipments description

instruction

String

Shipments instruction

weight

String

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

weightUom

String

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

currency

String

Currency of the price of the shipment

executingCarrier

String

The actual executing carrier in the 3 letter char code

inbound

Integer

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

pieces

Integer

Number of packages/colli in the shipment

service

String

Service indicating DOCS or NON-DOCS

serviceLevelTime

String

Service level time like STANDARD, SAVER

serviceLevelOther

String

Service level other like COD, EVENING etc.

value

Decimal

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

valueCurrency

String

Currency of the value of the goods

addresses

List

List of addresses of the shipment

addresses.[]
.type

String

Address type

addresses.[]
.name

String

Name

addresses.[]
.addressLine1

String

Street 1

addresses.[]
.addressLine2

String

Street 2

addresses.[]
.city

String

City

addresses.[]
.houseNumber

String

Housenumber

addresses.[]
.zipCode

String

Zip code

addresses.[]
.province

String

Province / State

addresses.[]
.country

String

The country code.

addresses.[]
.contactPerson

String

Name of the contact person

addresses.[]
.contactPhone

String

Phone number of the contact person

addresses.[]
.contactFax

String

Fax number of the contact person

addresses.[]
.contactEmail

String

E-mail address of the contact person

addresses.[]
.accountNumber

String

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

additionalReferences

List wrapped in List

List of additional references

additionalReferences.[]
.type

Field type not found

Field type not found

additionalReferences.[]
.value

Field value not found

Field value not found

statuses

List

List of shipment statuses

statuses.[]
.airwayBill

String

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

statuses.[]
.code

String

The Transsmart generic status code

statuses.[]
.weight

String

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

statuses.[]
.weightUom

String

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

statuses.[]
.pieces

Integer

Number of packages/colli in the shipment

statuses.[]
.incoterms

String

Incoterms of the shipment

statuses.[]
.statusPrice

Double

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

statuses.[]
.statusPriceCurrency

String

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

statuses.[]
.statusSalesPrice

Double

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

statuses.[]
.statusSalesPriceCurrency

String

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

statuses.[]
.minimumTransitTime

Integer

Minimum transit time in hours

statuses.[]
.maximumTransitTime

Integer

Maximum transit time in hours

statuses.[]
.printDateTime

Date wrapped in String

Date and time the shipment was printed

statuses.[]
.printUser

String

User of who executed the print operation

statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

statuses.[]
.documents

List

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

statuses.[]
.documents.[]
.documentType

Field documentType not found

Field documentType not found

statuses.[]
.documents.[]
.fileType

Field fileType not found

Field fileType not found

statuses.[]
.documents.[]
.documentData

Field documentData not found

Field documentData not found

shipmentLines

List

List of shipment lines and its statuses

shipmentLines.[]
.lineNumber

Integer

Sequential line number of this shipment line

shipmentLines.[]
.shipmentLineId

String

Shipment line id

shipmentLines.[]
.description

String

Shipments description

shipmentLines.[]
.airwaybill

String

Airwaybill

shipmentLines.[]
.acceptedBy

String

Name of who signed of on receipt of the goods

shipmentLines.[]
.actualDeliveryDate

Date wrapped in String

Actual deliverydate

shipmentLines.[]
.plannedDeliveryDateFrom

Date wrapped in String

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

shipmentLines.[]
.plannedDeliveryDateTo

Date wrapped in String

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

shipmentLines.[]
.price

Decimal

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

shipmentLines.[]
.genericStatusCode

String

The generic status of the collo.

shipmentLines.[]
.carrierStatusCode

String

The carrier status of the collo.

shipmentLines.[]
.carrierStatusDescription

String

Description of the status code of the carrier

shipmentLines.[]
.length

Decimal

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

shipmentLines.[]
.width

Decimal

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

shipmentLines.[]
.height

Decimal

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

shipmentLines.[]
.additionalReferences

List wrapped in List

List of additional references

shipmentLines.[]
.additionalReferences.[]
.type

Field type not found

Field type not found

shipmentLines.[]
.additionalReferences.[]
.value

Field value not found

Field value not found

shipmentLines.[]
.statuses

List

List of shipment statuses

shipmentLines.[]
.statuses.[]
.lineNumber

Integer

Sequential line number of this shipment line

shipmentLines.[]
.statuses.[]
.airwayBill

String

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

shipmentLines.[]
.statuses.[]
.code

String

The Transsmart generic status code

shipmentLines.[]
.statuses.[]
.carrierStatus

String

The carrier status.

shipmentLines.[]
.statuses.[]
.carrierStatusDescription

String

Description of the status code of the carrier

shipmentLines.[]
.statuses.[]
.statusPrice

Double

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

shipmentLines.[]
.statuses.[]
.statusDate

Date wrapped in String

Date of the actual status chang

shipmentLines.[]
.statuses.[]
.documents

List

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

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

String

Type of the document like POD

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

String

File type, like PNG, JPG, PDF, XPS

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

String

Base64 encrypted document

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
Path parameters
Table 14. /v2/statuses/{account}/shipments/{reference}
Parameter Description

account

Account code

reference

Shipment reference

Request parameters
Parameter Description Constraints

isDetailed

Include the status history in chronological order.

Default is true.

currentStatusOnly

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

Default is false.

Response structure
Path Type Description

reference

String

Shipment reference

carrier

String

Carrier

costcenter

String

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

shipmentStatus

String

Latest shipment status code

trackAndTraceUrl

String

Track and trace url

airwaybill

String

Airwaybill

accountId

String

Account of the shipment

incoterms

String

Incoterms of the shipment

acceptedBy

String

Name of who signed of on receipt of the goods

actualDeliveryDate

Date wrapped in String

Actual deliverydate

requestedDeliveryDateFrom

Date wrapped in String

Requested delivery date from, as sent during booking

requestedDeliveryDateTo

Date wrapped in String

Requested delivery date to, as sent during booking

plannedDeliveryDateFrom

Date wrapped in String

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

plannedDeliveryDateTo

Date wrapped in String

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

price

Decimal

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

pickupDateFrom

Date wrapped in String

Pickup date from, of the shipment

pickupDateTo

Date wrapped in String

Pickup date to, of the shipment

description

String

Shipments description

instruction

String

Shipments instruction

weight

String

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

weightUom

String

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

currency

String

Currency of the price of the shipment

executingCarrier

String

The actual executing carrier in the 3 letter char code

inbound

Integer

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

pieces

Integer

Number of packages/colli in the shipment

service

String

Service indicating DOCS or NON-DOCS

serviceLevelTime

String

Service level time like STANDARD, SAVER

serviceLevelOther

String

Service level other like COD, EVENING etc.

value

Decimal

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

valueCurrency

String

Currency of the value of the goods

addresses

List

List of addresses of the shipment

addresses.[]
.type

String

Address type

addresses.[]
.name

String

Name

addresses.[]
.addressLine1

String

Street 1

addresses.[]
.addressLine2

String

Street 2

addresses.[]
.city

String

City

addresses.[]
.houseNumber

String

Housenumber

addresses.[]
.zipCode

String

Zip code

addresses.[]
.province

String

Province / State

addresses.[]
.country

String

The country code.

addresses.[]
.contactPerson

String

Name of the contact person

addresses.[]
.contactPhone

String

Phone number of the contact person

addresses.[]
.contactFax

String

Fax number of the contact person

addresses.[]
.contactEmail

String

E-mail address of the contact person

addresses.[]
.accountNumber

String

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

additionalReferences

List wrapped in List

List of additional references

additionalReferences.[]
.type

Field type not found

Field type not found

additionalReferences.[]
.value

Field value not found

Field value not found

statuses

List

List of shipment statuses

statuses.[]
.airwayBill

String

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

statuses.[]
.code

String

The Transsmart generic status code

statuses.[]
.weight

String

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

statuses.[]
.weightUom

String

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

statuses.[]
.pieces

Integer

Number of packages/colli in the shipment

statuses.[]
.incoterms

String

Incoterms of the shipment

statuses.[]
.statusPrice

Double

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

statuses.[]
.statusPriceCurrency

String

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

statuses.[]
.statusSalesPrice

Double

Sell