Deprecated version

You're browsing the documentation for v2.x, which is deprecated and no longer updated. Consider upgrading to v3.x. Go to v3.x

List consignments

get

/consignments

listConsignments

Returns a page of consignments, newest first.

Changed in 2.0. Paging is by cursor rather than by page number; the value comes from the previous response's next field.

Authorisation

Any one of these
- apiKeyapiKey · X-Api-Key · Header
  A key from the account page.
Any one of these
- bearerhttp · bearer
  A token obtained from the authorisation server.

Parameters

Query

limitintegermin 1max 100
How many consignments to return.
cursorstring
Where to continue from.

Responses

200

A page of consignments.

application/json

object

items*Requiredarray<object>
Each item
objectConsignmentConsignmentOne consignment, as 2.x sees it.
- id*RequiredstringRead-only
- reference*Requiredstringmin length 1max length 120Called `label` in 1.x.
- status*Requiredstringbooked | sailing | landedCalled `state` in 1.x. `cancelled` is new in 3.x.
- createdAtstringRead-only
nextstring | nullThe cursor for the following page, if any.

json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "reference": "string",
      "status": "booked",
      "createdAt": "2026-01-01T09:00:00Z"
    }
  ],
  "next": "string"
}

400

Something went wrong, described the same way every time.

application/problem+json

objectProblem

title*Requiredstring
status*Requiredintegermin 400max 599

json

{
  "title": "string",
  "status": 400
}

Send a request

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

Edit this page