Eingestellte Version

Sie lesen die Dokumentation von v1.x. Diese Version hat das Ende ihrer Lebensdauer erreicht und erhält keine Änderungen mehr. Zu v3.x wechseln

Diese Seite ist noch nicht in deiner Sprache verfügbar

Du liest sie auf English (UK).

List shipments

get

/shipments

listShipments

Returns a page of shipments, oldest first.

Autorisierung

- apiKeyapiKey · X-Api-Key · Kopfzeile
  A key from the account page.

Parameter

Abfrage

pageintegermin 1
Which page to return, counting from one.

Antworten

200

A page of shipments.

application/json

object

items*Erforderlicharray<object>
Jedes Element
objectShipmentShipmentOne shipment, as the first API saw it.
- id*ErforderlichstringNur lesbar
- label*ErforderlichstringMindestlänge 1Höchstlänge 120Renamed to `reference` in 2.x.
- state*Erforderlichstringbooked | sailing | landedRenamed to `status` in 2.x, and gained `cancelled`.
- createdAtstringNur lesbar
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
}

Anfrage senden

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

Diese Seite bearbeiten