Fim da vida útil
Você está lendo a documentação de v1.x, que chegou ao fim da vida útil e não recebe mais alterações. Ir para v3.x
Esta página ainda não está disponível no seu idioma
Você está lendo em English (UK).
Book a shipment
POST /shipments
post
/shipmentscreateShipment
Autorização
apiKeyapiKey · X-Api-Key · CabeçalhoA key from the account page.
Corpo do pedido Obrigatório
application/json
objectShipmentShipmentOne shipment, as the first API saw it.
idstringApenas leituralabel*Obrigatóriostringcomprimento mín 1comprimento máx 120Renamed to `reference` in 2.x.state*Obrigatóriostringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.createdAtstringApenas leitura
json
{
"label": "string",
"state": "booked"
}Respostas
201
Booked.application/json
objectShipmentShipmentOne shipment, as the first API saw it.
id*ObrigatóriostringApenas leituralabel*Obrigatóriostringcomprimento mín 1comprimento máx 120Renamed to `reference` in 2.x.state*Obrigatóriostringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.createdAtstringApenas leitura
json
{
"id": "00000000-0000-4000-8000-000000000000",
"label": "string",
"state": "booked",
"createdAt": "2026-01-01T09:00:00Z"
}Enviar um pedido
curl 'https://api.example.org/v2/consignments?limit=20&cursor=string'