End of life
You're browsing the documentation for v1.x, which has reached the end of its life and receives no further changes. Go to v3.x
Book a shipment
POST /shipments
post
/shipmentscreateShipment
Authorisation
apiKeyapiKey · X-Api-Key · HeaderA key from the account page.
Request body Required
application/json
objectShipmentShipmentOne shipment, as the first API saw it.
idstringRead-onlylabel*Requiredstringmin length 1max length 120Renamed to `reference` in 2.x.state*Requiredstringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.createdAtstringRead-only
json
{
"label": "string",
"state": "booked"
}Responses
201
Booked.application/json
objectShipmentShipmentOne shipment, as the first API saw it.
id*RequiredstringRead-onlylabel*Requiredstringmin length 1max length 120Renamed to `reference` in 2.x.state*Requiredstringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.createdAtstringRead-only
json
{
"id": "00000000-0000-4000-8000-000000000000",
"label": "string",
"state": "booked",
"createdAt": "2026-01-01T09:00:00Z"
}Send a request
curl 'https://api.example.org/v2/consignments?limit=20&cursor=string'