Versão obsoleta

Você está lendo a documentação de v2.x, que está obsoleta e não recebe mais atualizações. Considere atualizar para v3.x. Ir para v3.x

Esta página ainda não está disponível no seu idioma

Você está lendo em English (UK).

Book a consignment

POST /consignments

post

/consignments

createConsignment

Autorização

Qualquer um destes
- apiKeyapiKey · X-Api-Key · Cabeçalho
  A key from the account page.
Qualquer um destes
- bearerhttp · bearer
  A token obtained from the authorisation server.

application/json

objectConsignmentConsignmentOne consignment, as 2.x sees it.

idstringApenas leitura
reference*Obrigatóriostringcomprimento mín 1comprimento máx 120Called `label` in 1.x.
status*Obrigatóriostringbooked | sailing | landedCalled `state` in 1.x. `cancelled` is new in 3.x.
createdAtstringApenas leitura

The smallest body that works

json

{
  "reference": "HB-1042",
  "status": "booked"
}

201

Booked.

application/json

objectConsignmentConsignmentOne consignment, as 2.x sees it.

id*ObrigatóriostringApenas leitura
reference*Obrigatóriostringcomprimento mín 1comprimento máx 120Called `label` in 1.x.
status*Obrigatóriostringbooked | sailing | landedCalled `state` in 1.x. `cancelled` is new in 3.x.
createdAtstringApenas leitura

json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "reference": "string",
  "status": "booked",
  "createdAt": "2026-01-01T09:00:00Z"
}

422

Something went wrong, described the same way every time.

application/problem+json

objectProblem

json

{
  "title": "string",
  "status": 400
}

curl 'https://api.example.org/v2/consignments?limit=20&cursor=string'