Veraltete Version

Sie lesen die Dokumentation von v2.x. Diese Version ist veraltet und wird nicht mehr gepflegt. Erwägen Sie ein Upgrade auf v3.x. Zu v3.x wechseln

Diese Seite ist noch nicht in deiner Sprache verfügbar

Du liest sie auf 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.

Autorisierung

Eines davon genügt
- apiKeyapiKey · X-Api-Key · Kopfzeile
  A key from the account page.
Eines davon genügt
- bearerhttp · bearer
  A token obtained from the authorisation server.

Parameter

Abfrage

limitintegermin 1max 100
How many consignments to return.
cursorstring
Where to continue from.

Antworten

200

A page of consignments.

application/json

object

items*Erforderlicharray<object>
Jedes Element
objectConsignmentConsignmentOne consignment, as 2.x sees it.
- id*ErforderlichstringNur lesbar
- reference*ErforderlichstringMindestlänge 1Höchstlänge 120Called `label` in 1.x.
- status*Erforderlichstringbooked | sailing | landedCalled `state` in 1.x. `cancelled` is new in 3.x.
- createdAtstringNur lesbar
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*Erforderlichstring
status*Erforderlichintegermin 400max 599

json

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

Anfrage senden

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

Diese Seite bearbeiten