Fin de vida
Está consultando la documentación de v1.x, que ha llegado al final de su vida útil y no recibirá más cambios. Ir a v3.x
Esta página aún no está disponible en tu idioma
La estás leyendo en English (UK).
List shipments
get
/shipmentslistShipments
Returns a page of shipments, oldest first.
Autorización
apiKeyapiKey · X-Api-Key · CabeceraA key from the account page.
Parámetros
Consulta
pageintegermín 1Which page to return, counting from one.
Respuestas
200
A page of shipments.application/json
object
items*Obligatorioarray<object>Cada elemento
objectShipmentShipmentOne shipment, as the first API saw it.id*ObligatoriostringSolo lecturalabel*Obligatoriostringlongitud mín 1longitud máx 120Renamed to `reference` in 2.x.state*Obligatoriostringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.createdAtstringSolo lectura
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 una solicitud
curl 'https://api.example.org/v2/consignments?limit=20&cursor=string'