Fin de vie

Vous consultez la documentation de v1.x, qui a atteint sa fin de vie et ne recevra plus aucune modification. Aller à v3.x

Cette page n’est pas encore disponible dans votre langue

Vous la lisez en English (UK).

List shipments

get

/shipments

listShipments

Returns a page of shipments, oldest first.

Autorisation

- apiKeyapiKey · X-Api-Key · En-tête
  A key from the account page.

Paramètres

Requête

pageintegermin 1
Which page to return, counting from one.

Réponses

200

A page of shipments.

application/json

object

items*Obligatoirearray<object>
Chaque élément
objectShipmentShipmentOne shipment, as the first API saw it.
- id*ObligatoirestringLecture seule
- label*Obligatoirestringlongueur min 1longueur max 120Renamed to `reference` in 2.x.
- state*Obligatoirestringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.
- createdAtstringLecture seule
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
}

Envoyer une requête

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

Modifier cette page