Upcoming version

You're browsing the documentation for an upcoming version. Its documentation and features are subject to change.

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.

Authorisation

Any one of these
- apiKeyapiKey · X-Api-Key · Header
  A key from the account page.
Any one of these
- bearerhttp · bearer
  A token obtained from the authorisation server.

Parameters

Path

consignmentId*Requiredstring

Header

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

Responses

200

The stream, until you close it.

text/event-stream

objectConsignmentEventOne thing that happened to a consignment.

id*RequiredstringThe value to send back as `Last-Event-ID`.
at*Requiredstring
status*RequiredstringConsignmentStatusbooked | 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*RequiredstringA short, human-readable summary.
status*Requiredintegermin 400max 599
detailstring | null

json

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

Send a request

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'

Edit this page