Cancel a consignment

delete

/consignments/{consignmentId}

Deprecated

cancelConsignment

Deprecated. Use the batch endpoint, which takes the same identifiers and reports what it could not do.

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.

Parameters

Path

consignmentId*Requiredstring

Responses

204

Gone.

No body.

Send a request

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