Skip to main content
GET
Read one merchant-owned shipment

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Path Parameters

shipmentId
string<uuid>
required

Response

Minimal partner-safe shipment

id
string<uuid>
required
reference
string
required
status
enum<string>
required
Available options:
CREATED,
ASSIGNED,
PICKED_UP,
OUT_FOR_DELIVERY,
DELIVERED,
FAILED,
CANCELLED
trackingUrl
string<uri-reference>
required
createdAt
string<date-time>
required
version
integer<int64>
required
Required range: x >= 0
codAmount
number<decimal> | null
Required range: x >= 0