Kommende Version

Sie lesen die Dokumentation einer kommenden Version. Dokumentation und Funktionen können sich noch ändern.

Diese Seite ist noch nicht in deiner Sprache verfügbar

Du liest sie auf English (UK).

Book a consignment

post

/consignments

createConsignment

Books one consignment and tells you where it ended up.

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.

Parameter

Kopfzeile

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

Anfragekörper Erforderlich

The consignment to book.

objectNewConsignmentOne consignment, as the API sees it.

idstringNur lesbar
reference*ErforderlichstringMindestlänge 1Höchstlänge 120
status*ErforderlichstringConsignmentStatusbooked | loading | sailing | landed | cancelledWhere a consignment has got to.
createdAtstringNur lesbar
parentanyConsignmentVerweist auf sich selbst; oben ausgeklappt.
tagsarray<string>eindeutig
Jedes Element
string
metadataobject
Jede weitere Eigenschaft
string
callbackUrlstringWhere to send the callback once the load is aboard.

The smallest body that works

json

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

With the paperwork attached

json

{
  "reference": "HB-1042",
  "status": "booked",
  "callbackUrl": "https://example.org/hooks/harbour",
  "tags": [
    "refrigerated"
  ]
}

Antworten

201

Booked.

Kopfzeilen

Location*Erforderlichstring
Where the new consignment can be read.

application/json

objectConsignmentOne consignment, as the API sees it.

id*ErforderlichstringNur lesbar
reference*ErforderlichstringMindestlänge 1Höchstlänge 120
status*ErforderlichstringConsignmentStatusbooked | loading | sailing | landed | cancelledWhere a consignment has got to.
createdAtstringNur lesbar
parentanyConsignmentVerweist auf sich selbst; oben ausgeklappt.
tagsarray<string>eindeutig
Jedes Element
string
metadataobject
Jede weitere Eigenschaft
string

json

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

422

Something went wrong, described the same way every time.

application/problem+json

objectProblem

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

json

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

Rückrufe

consignmentLoaded

post

{$request.body#/callbackUrl}

Sent once the consignment has been loaded.

application/json

objectConsignmentOne consignment, as the API sees it.

idstringNur lesbar
reference*ErforderlichstringMindestlänge 1Höchstlänge 120
status*ErforderlichstringConsignmentStatusbooked | loading | sailing | landed | cancelledWhere a consignment has got to.
createdAtstringNur lesbar
parentanyConsignmentVerweist auf sich selbst; oben ausgeklappt.
tagsarray<string>eindeutig
Jedes Element
string
metadataobject
Jede weitere Eigenschaft
string

json

{
  "reference": "string",
  "status": "booked",
  "parent": null,
  "tags": [
    "string"
  ],
  "metadata": {}
}

Erwartete Antwort

204
Acknowledged.

Anfrage senden

curl 'https://api.example.org/v3/consignments?limit=20&cursor=string&status=%5B%0A++%22booked%22%0A%5D&session=string' \
  -H 'Authorization: Bearer demo-token' \
  -H 'X-Request-Id: 00000000-0000-4000-8000-000000000000'

Diese Seite bearbeiten