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).

List shipments

get

/shipments

listShipments

Returns a page of shipments, oldest first.

Autorização

- apiKeyapiKey · X-Api-Key · Cabeçalho
  A key from the account page.

Parâmetros

Consulta

pageintegermín 1
Which page to return, counting from one.

Respostas

200

A page of shipments.

application/json

object

items*Obrigatórioarray<object>
Cada elemento
objectShipmentShipmentOne shipment, as the first API saw it.
- id*ObrigatóriostringApenas leitura
- label*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
pagesintegerHow many pages there are in total.

json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "label": "string",
      "state": "booked",
      "createdAt": "2026-01-01T09:00:00Z"
    }
  ],
  "pages": 0
}

Enviar um pedido

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

Editar esta página