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

List consignments

get

/consignments

listConsignments

Returns a page of consignments, newest first.

Changed in 2.0. Paging is by cursor rather than by page number; the value comes from the previous response's next field.

Autorización

Cualquiera de estos
- apiKeyapiKey · X-Api-Key · Cabecera
  A key from the account page.
Cualquiera de estos
- bearerhttp · bearer
  A token obtained from the authorisation server.

Parámetros

Consulta

limitintegermín 1máx 100
How many consignments to return.
cursorstring
Where to continue from.

Respuestas

200

A page of consignments.

application/json

object

items*Obligatorioarray<object>
Cada elemento
objectConsignmentConsignmentOne consignment, as 2.x sees it.
- id*ObligatoriostringSolo lectura
- reference*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
nextstring | nullThe cursor for the following page, if any.

json

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

400

Something went wrong, described the same way every time.

application/problem+json

objectProblem

title*Obligatoriostring
status*Obligatoriointegermín 400máx 599

json

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

Enviar una solicitud

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

Editar esta página