Zum Inhalt springen
duxt
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).

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

Authentifizierung

Was Sie hier eingeben, bleibt in diesem Tab, wird nicht gespeichert und geht nur an den gewählten Server.

Dieser Body lässt sich nicht als Formular darstellen: bitte als JSON bearbeiten.

Die Anfrage sendet Ihr Browser direkt an diesen Server.

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