Veraltete Version

Sie lesen die Dokumentation von v2.x. Diese Version ist veraltet und wird nicht mehr gepflegt. Erwägen Sie ein Upgrade auf v3.x. Zu v3.x wechseln

Diese Seite ist noch nicht in deiner Sprache verfügbar

Du liest sie auf English (UK).

Book a consignment

POST /consignments

post

/consignments

createConsignment

Autorisierung

Eines davon genügt
- apiKeyapiKey · X-Api-Key · Kopfzeile
  A key from the account page.
Eines davon genügt
- bearerhttp · bearer
  A token obtained from the authorisation server.

application/json

objectConsignmentConsignmentOne consignment, as 2.x sees it.

idstringNur lesbar
reference*ErforderlichstringMindestlänge 1Höchstlänge 120Called `label` in 1.x.
status*Erforderlichstringbooked | sailing | landedCalled `state` in 1.x. `cancelled` is new in 3.x.
createdAtstringNur lesbar

The smallest body that works

json

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

201

Booked.

application/json

objectConsignmentConsignmentOne consignment, as 2.x sees it.

id*ErforderlichstringNur lesbar
reference*ErforderlichstringMindestlänge 1Höchstlänge 120Called `label` in 1.x.
status*Erforderlichstringbooked | sailing | landedCalled `state` in 1.x. `cancelled` is new in 3.x.
createdAtstringNur lesbar

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'