Retrieve a shipment
API reference
Retrieve a shipment
Get one shipment by reference for the authenticated workspace.
GET
Retrieve a shipment
Look up a shipment by its
The shipment is wrapped in
SHP- reference. Unknown references, and shipments that belong to another workspace, return 404.
string
required
Shipment reference, for example
SHP-12345.data:
string
required
Unique
SHP- reference.object
required
id, name, email, and optional id_number.object
required
address, lat, and lng.object
required
address, lat, and lng.number
required
Package weight in kilograms.
number
required
Quoted distance.
object
required
distance, weight, base, total, and currency.string
required
Delivery status. See Shipment statuses.
string
required
Payment status.
string
required
ISO 8601 timestamp.
string
required
ISO 8601 timestamp.