Skip to content
duxt

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.

Authorisation

  • Any one of these

    • apiKeyapiKey · X-Api-Key · Header

      A key from the account page.

  • Any one of these

    • bearerhttp · bearer

      A token obtained from the authorisation server.

Request body

application/json

objectConsignmentOne consignment, as the API sees it.
  • idstringRead-only
  • reference*Requiredstringmin length 1max length 120
  • status*RequiredstringConsignmentStatusbooked | loading | sailing | landed | cancelledWhere a consignment has got to.
  • createdAtstringRead-only
  • parentanyConsignmentRefers to itself; expanded above.
  • tagsarray<string>unique

    Each item

    string
  • metadataobject

    Any other property

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

Responses

200
Acknowledged.

No body.

Send a request

Authentication

What you type here stays in this tab, is never stored, and is sent only to the server you chose.

This body cannot be drawn as a form: edit it as JSON.

The request is sent by your browser, straight to that server.

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"
}'
Edit this page