Kommende Version

Sie lesen die Dokumentation einer kommenden Version. Dokumentation und Funktionen können sich noch ändern.

Diese Seite ist noch nicht in deiner Sprache verfügbar

Du liest sie auf English (UK).

Follow a consignment

get

/consignments/{consignmentId}/events

streamConsignmentEvents

Holds the connection open and writes one event per line as the consignment moves, in the text/event-stream format.

The response is not a document, which is the interesting part for a reference: there is a schema for one event, and none for the body as a whole.

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

Pfad

consignmentId*Erforderlichstring

Kopfzeile

Last-Event-IDstring
Resume after the event you last saw.

Antworten

200

The stream, until you close it.

text/event-stream

objectConsignmentEventOne thing that happened to a consignment.

id*ErforderlichstringThe value to send back as `Last-Event-ID`.
at*Erforderlichstring
status*ErforderlichstringConsignmentStatusbooked | loading | sailing | landed | cancelledWhere a consignment has got to.
berthstring | nullWhere it is, once it is anywhere.

json

{
  "id": "string",
  "at": "2026-01-01T09:00:00Z",
  "status": "booked",
  "berth": "string"
}

404

Something went wrong, described the same way every time.

application/problem+json

objectProblem

title*ErforderlichstringA short, human-readable summary.
status*Erforderlichintegermin 400max 599
detailstring | null

json

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

Anfrage senden

curl 'https://api.example.org/v3/consignments?limit=20&cursor=string&status=%5B%0A++%22booked%22%0A%5D&session=string' \
  -H 'Authorization: Bearer demo-token' \
  -H 'X-Request-Id: 00000000-0000-4000-8000-000000000000'

Diese Seite bearbeiten