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

Book a consignment

POST /consignments

post

/consignments

createConsignment

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.

application/json

objectConsignmentConsignmentOne consignment, as 2.x sees it.

idstringRead-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

The smallest body that works

json

{
  "reference": "HB-1042",
  "status": "booked"
}

201

Booked.

application/json

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

json

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

422

Something went wrong, described the same way every time.

application/problem+json

objectProblem

json

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

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