End of life

You're browsing the documentation for v1.x, which has reached the end of its life and receives no further changes. Go to v3.x

List shipments

get

/shipments

listShipments

Returns a page of shipments, oldest first.

Authorisation

- apiKeyapiKey · X-Api-Key · Header
  A key from the account page.

Parameters

Query

pageintegermin 1
Which page to return, counting from one.

Responses

200

A page of shipments.

application/json

object

items*Requiredarray<object>
Each item
objectShipmentShipmentOne shipment, as the first API saw it.
- id*RequiredstringRead-only
- label*Requiredstringmin length 1max length 120Renamed to `reference` in 2.x.
- state*Requiredstringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.
- createdAtstringRead-only
pagesintegerHow many pages there are in total.

json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "label": "string",
      "state": "booked",
      "createdAt": "2026-01-01T09:00:00Z"
    }
  ],
  "pages": 0
}

Send a request

curl 'https://api.example.org/v2/consignments?limit=20&cursor=string'

Edit this page