Eingestellte Version
Sie lesen die Dokumentation von v1.x. Diese Version hat das Ende ihrer Lebensdauer erreicht und erhält keine Änderungen mehr. Zu v3.x wechseln
Diese Seite ist noch nicht in deiner Sprache verfügbar
Du liest sie auf English (UK).
Book a shipment
POST /shipments
post
/shipmentscreateShipment
Autorisierung
apiKeyapiKey · X-Api-Key · KopfzeileA key from the account page.
Anfragekörper Erforderlich
application/json
objectShipmentShipmentOne shipment, as the first API saw it.
idstringNur lesbarlabel*ErforderlichstringMindestlänge 1Höchstlänge 120Renamed to `reference` in 2.x.state*Erforderlichstringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.createdAtstringNur lesbar
json
{
"label": "string",
"state": "booked"
}Antworten
201
Booked.application/json
objectShipmentShipmentOne shipment, as the first API saw it.
id*ErforderlichstringNur lesbarlabel*ErforderlichstringMindestlänge 1Höchstlänge 120Renamed to `reference` in 2.x.state*Erforderlichstringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.createdAtstringNur lesbar
json
{
"id": "00000000-0000-4000-8000-000000000000",
"label": "string",
"state": "booked",
"createdAt": "2026-01-01T09:00:00Z"
}Anfrage senden
curl 'https://api.example.org/v2/consignments?limit=20&cursor=string'