General

Pagination

Before you start making requests, please be aware that the response of a single API request is limited to 100 items.

This mechanism is called pagination and the cursor in the pageInfo field at the end of the response indicates that further items exist.

To retrieve the rest of the items, call the request again by adding the cursor to it:

https://api.transporeon.com/rtv/v1/...?cursor=c2l4Zm9sZF9hcGlfZXhhbXBsZQ==

Repeat this step with the newly returned cursor value until it returns a pageInfo object without cursor field:

"page_info": {}

Transport and Delivery Identifiers

In all APIs, a number of identifying fields are used for transport/delivery. These can be separated into two sections:

Transporeon transport/delivery reference

Transporeon Internal references, which are unique on the Transporeon Platform:

  • transport_id

  • Delivery_id

Customer references

References that are provided by the creator of the Transport, usually a shipper or LSP customer. These are not unique. They can either be reused by different customers or over a period of time (depending on the customer) by one customer. 

  • transport_number

  • delivery_number

  • order_number

  • purchase_order_number