A consignment changed

post

consignmentChanged

Webhook

Sent to the address registered for your account whenever a consignment you can see changes. Answer with any 2xx.

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.

Anfragekörper

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": {}
}

Antworten

200

Acknowledged.

Kein Inhalt.

Anfrage senden

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"
}'

Diese Seite bearbeiten