Deprecated version
You're browsing the documentation for v2.x, which is deprecated and no longer updated. Consider upgrading to v3.x. Go to v3.x
Update a consignment
PATCH /consignments/{consignmentId}
patch
/consignments/{consignmentId}updateConsignment
Authorisation
Any one of these
apiKeyapiKey · X-Api-Key · HeaderA key from the account page.
Any one of these
bearerhttp · bearerA token obtained from the authorisation server.
Parameters
Path
consignmentId*Requiredstring
Request body Required
application/json
object
referencestringmin length 1max length 120statusstringbooked | sailing | landed
json
{
"reference": "string",
"status": "booked"
}Responses
200
The consignment as it now stands.application/json
objectConsignmentConsignmentOne consignment, as 2.x sees it.
id*RequiredstringRead-onlyreference*Requiredstringmin length 1max length 120Called `label` in 1.x.status*Requiredstringbooked | sailing | landedCalled `state` in 1.x. `cancelled` is new in 3.x.createdAtstringRead-only
json
{
"id": "00000000-0000-4000-8000-000000000000",
"reference": "string",
"status": "booked",
"createdAt": "2026-01-01T09:00:00Z"
}404
Something went wrong, described the same way every time.application/problem+json
objectProblem
title*Requiredstringstatus*Requiredintegermin 400max 599
json
{
"title": "string",
"status": 400
}Send a request
curl 'https://api.example.org/v2/consignments?limit=20&cursor=string'