Skip to main content
GET
List and synchronise shipments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Language
string
default:en

Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.

Example:

"da-DK, da;q=0.9, en;q=0.8"

Request-ID
string

Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the Request-ID response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

teamUuid
string<uuid>
required

Team uuid. All resources are scoped to this team.

Query Parameters

carrier
string

Filter by carrier code.

service
string

Filter by composite service code.

tracking_number
string

Exact parcel tracking number.

state
enum<string>

Filter by current shipment state. Avoid mutable state filters during complete synchronisation. pending: accepted in an open batch. queued: waiting to start booking. booking: the carrier/document/code workflow is running. booked: carrier accepted and all required documents/codes are ready. failed: the workflow failed or reached its final deadline. cancelling: cancellation running. cancelled: cancelled internally without confirmed carrier cancellation; also used for unstarted batch members stopped before booking. voided: internally cancelled and carrier cancellation confirmed. A rare late success may change failed to booked or cancelled to voided. Delivery status belongs to tracking.

Available options:
pending,
queued,
booking,
booked,
failed,
cancelling,
cancelled,
voided
identifier
string

Exact private shipment reference. Multiple shipments may match.

reference
string

Exact public shipment reference. Multiple shipments may match.

batch_uuid
string<uuid>

Members of the specified batch.

created_since
string<date-time>

Inclusive lower creation boundary.

created_until
string<date-time>

Inclusive upper creation boundary.

updated_since
string<date-time>

Inclusive lower lifecycle-update boundary. Uses updated_at ordering.

updated_until
string<date-time>

Inclusive fixed upper boundary. On the first sync page the server assigns this when omitted and returns meta.sync_until; every next link retains it.

include_deleted
boolean
default:false

Include minimal DeletedShipment markers for synchronisation; requires updated_since. Only time filters are permitted with this flag. Deletion advances the internal ordering timestamp. Ordinary GET still returns 404.

sort
enum<string>

Default -created_at, or updated_at when update filters are supplied. Update filters require updated_at sorting. Internal unique ID is the non-null tie-breaker.

Available options:
-created_at,
created_at,
updated_at
cursor
string

Opaque cursor returned by this endpoint. Omit it for the first page. Keep all filters, sort order and per_page unchanged within a page sequence. For tracking polls, use the documented resume_cursor once next is null.

Minimum string length: 1
per_page
integer
default:100

Maximum number of resources per page.

Required range: 1 <= x <= 1000

Response

Current shipments or requested deletion markers.

data
object[]
required

Current immutable booking input plus evolving lifecycle and results. Each shipment has one logical booking. Full event and print histories are retrieved through their own paginated endpoints. A failed document workflow may still have a carrier booking; never blindly rebook such a result.

Navigation links for a cursor-paginated collection. Follow next or prev with GET; returned URLs preserve the selected filters, sort order, page size and sync boundary where applicable.

meta
object
required

Cursor pagination metadata with the additional sync_until boundary for shipment synchronisation.