Read a consignment

GET /consignments/{consignmentId}

get

/consignments/{consignmentId}

getConsignment

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.

Parâmetros

Caminho

consignmentId*Obrigatóriostring
The consignment's own identifier.

Respostas

200

The consignment.

application/json

objectConsignmentOne consignment, as the API sees it.

id*ObrigatóriostringApenas leitura
reference*Obrigatóriostringcomprimento mín 1comprimento máx 120
status*ObrigatóriostringConsignmentStatusbooked | loading | sailing | landed | cancelledWhere a consignment has got to.
createdAtstringApenas leitura
parentanyConsignmentRefere-se a si próprio; expandido acima.
tagsarray<string>únicos
Cada elemento
string
metadataobject
Qualquer outra propriedade
string

json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "reference": "string",
  "status": "booked",
  "createdAt": "2026-01-01T09:00:00Z",
  "parent": null,
  "tags": [
    "string"
  ],
  "metadata": {}
}

404

Something went wrong, described the same way every time.

application/problem+json

objectProblem

title*ObrigatóriostringA short, human-readable summary.
status*Obrigatóriointegermín 400máx 599
detailstring | null

json

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

Enviar um pedido

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"
}'

Editar esta página