Versión obsoleta
Está consultando la documentación de v2.x, que está obsoleta y ya no se actualiza. Considere actualizar a v3.x. Ir a v3.x
Esta página aún no está disponible en tu idioma
La estás leyendo en English (UK).
Book a consignment
POST /consignments
post
/consignmentscreateConsignment
Autorización
Cualquiera de estos
apiKeyapiKey · X-Api-Key · CabeceraA key from the account page.
Cualquiera de estos
bearerhttp · bearerA token obtained from the authorisation server.
Cuerpo de la solicitud Obligatorio
application/json
objectConsignmentConsignmentOne consignment, as 2.x sees it.
idstringSolo lecturareference*Obligatoriostringlongitud mín 1longitud máx 120Called `label` in 1.x.status*Obligatoriostringbooked | sailing | landedCalled `state` in 1.x. `cancelled` is new in 3.x.createdAtstringSolo lectura
The smallest body that works
json
{
"reference": "HB-1042",
"status": "booked"
}Respuestas
201
Booked.Cabeceras
Location*Obligatoriostring
application/json
objectConsignmentConsignmentOne consignment, as 2.x sees it.
id*ObligatoriostringSolo lecturareference*Obligatoriostringlongitud mín 1longitud máx 120Called `label` in 1.x.status*Obligatoriostringbooked | sailing | landedCalled `state` in 1.x. `cancelled` is new in 3.x.createdAtstringSolo lectura
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
title*Obligatoriostringstatus*Obligatoriointegermín 400máx 599
json
{
"title": "string",
"status": 400
}Enviar una solicitud
curl 'https://api.example.org/v2/consignments?limit=20&cursor=string'