Skip to main content
GET
Get external merchant shipment

Authorizations

Authorization
string
header
required

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

Headers

Accept-Language
string

Preferred response language when a localized representation is available.

Maximum string length: 64
Example:

"en"

Path Parameters

shipmentId
string<uuid>
required

Response

Merchant-safe canonical shipment

shipmentId
string<uuid>
required
shipmentNumber
string
required
externalReference
string | null
required
Maximum string length: 128
state
enum<string>
required
Available options:
PENDING_APPROVAL,
READY_FOR_DISPATCH,
OFFERED,
ACCEPTED,
DISPATCH_UNRESOLVED,
PICKED_UP,
OUT_FOR_DELIVERY,
DELIVERED,
DELIVERY_FAILED,
CANCELLED
recipientName
string
required
maskedRecipientPhone
string
required

Only the final four digits are visible.

totalWeightKilograms
number
required
declaredValue
number
required
codAmount
number
required
currency
string
required
paymentMethod
enum<string>
required
Available options:
PREPAID,
COD
pickupWindowStart
string<date-time>
required
pickupWindowEnd
string<date-time>
required
createdAt
string<date-time>
required
approvedAt
string<date-time> | null
required
version
integer<int64>
required
Required range: x >= 0
destination
object
required
pickup
object | null
required
items
object[]
required
requirements
string[]
required
timelineMedia
object[]

Existing READY assets attached only to the resulting shipment.created event.

Maximum array length: 10