Skip to main content
GET
cURL

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

Privacy-controlled canonical tracking projection

shipmentId
string<uuid>
required
lifecycleState
enum<string>
required
Available options:
PENDING_APPROVAL,
READY_FOR_DISPATCH,
OFFERED,
ACCEPTED,
DISPATCH_UNRESOLVED,
PICKED_UP,
OUT_FOR_DELIVERY,
DELIVERED,
DELIVERY_FAILED,
CANCELLED
locationStatus
enum<string>
required
Available options:
NOT_ASSIGNED,
WAITING_FOR_DRIVER_ACCEPTANCE,
LOCATION_UNAVAILABLE,
AVAILABLE,
STALE,
TERMINAL_NO_LIVE_LOCATION
Required range: 5 <= x <= 60
driverLocation
object | null