v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Shipments API

List shipments

Retrieve a list of all shipments created for a specific order.

The results are paginated.

🔑 Access with

API key

Advanced access token with shipments.read

OAuth access with shipments.read

get/orders/{orderId}/shipments

Query parameters

fromstring

Example:shp_5x4xQJDWGNcY3tKGL7X5J

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable

Example:50

The maximum number of items to return. Defaults to 50 items.

sortstring

Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

Possible values: asc desc

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

A list of shipment objects.