List consignments

get

/consignments

listConsignments

Returns a page of consignments, newest first.

Paging is by cursor; the value comes from the previous response's next field and is opaque.

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.
statusarray<string>unique
Each item
stringConsignmentStatusbooked | loading | sailing | landed | cancelledWhere a consignment has got to.
Only consignments in these states.
style=form explode=false
sessionstring
The same session, for callers that cannot set the cookie — a page cannot, because `Cookie` is a header the browser refuses to let a script write. Deliberately the same *name* in a second location: OpenAPI identifies a parameter by the pair `(name, in)`, so these are two parameters, and a reference that keyed its try-it form on the name alone would send one box's answer to both.

Header

X-Request-Idstring
An identifier echoed back on every response.

Cookie

sessionstring
An optional session, for a personalised order.

Responses

200

A page of consignments.

Headers

X-Request-Id*Requiredstring

object

items*Requiredarray<object>7
Each item
objectConsignmentOne consignment, as the API sees it.
- id*RequiredstringRead-only
- reference*Requiredstringmin length 1max length 120
- status*RequiredstringConsignmentStatusbooked | loading | sailing | landed | cancelledWhere a consignment has got to.
- createdAtstringRead-only
- parentanyConsignmentRefers to itself; expanded above.
- tagsarray<string>unique
  Each item
  string
- metadataobject
  Any other property
  string
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",
      "parent": null,
      "tags": [
        "string"
      ],
      "metadata": {}
    }
  ],
  "next": "string"
}

What to do next

NextPagelistConsignments
The same call again, with `cursor` set from `next`.

400

Something went wrong, described the same way every time.

application/problem+json

objectProblem

title*RequiredstringA short, human-readable summary.
status*Requiredintegermin 400max 599
detailstring | null

json

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

default

Something went wrong, described the same way every time.

application/problem+json

objectProblem

title*RequiredstringA short, human-readable summary.
status*Requiredintegermin 400max 599
detailstring | null

json

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

Send a request

curl 'https://api.example.org/v3/consignments' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer demo-token' \
  -H 'X-Request-Id: 00000000-0000-4000-8000-000000000000' \
  -d '{
  "reference": "HB-1042",
  "status": "booked"
}'

Edit this page