Shipments
Get Shipment
Retrieve a shipment by its reference ID
GET
Retrieve a single shipment by its reference ID. The endpoint always force-refreshes the shipment
from the logistics provider before returning, so the
status and status_updates reflect the
provider’s latest known state.
Request
Path parameters
Shipment reference ID (e.g.,
P2604154821).Response
On success, the API returns200 OK with the shipment object.
Shipment reference identifier.
Shipment lifecycle status. One of
pending, in_transit, delivered, fault, or cancelled.Logistics provider. One of
go, dhl, or tof.External tracking number from the logistics provider. May be
null.Pickup address. May be
null.Delivery address. Same structure as
origin. May be null.Scheduled pickup window. May be
null.Optional notes. May be
null.Chronological lifecycle events from the logistics provider (oldest first). Each entry contains
the raw provider-sourced status label and a timestamp. Empty array if the provider has not
reported any events yet. Use this for debug / audit; rely on
status for canonical current state.Appointments linked to this shipment, oldest-link first. Empty array when no appointments are
linked. Cross-reference each
id against Get
Appointment for the full appointment payload.Creation timestamp (ISO 8601).
Last update timestamp (ISO 8601). May be
null.Error responses
| Status | Description |
|---|---|
400 | Invalid ID format. |
403 | Forbidden — your API key does not have access to this operation or the shipment is outside your access context. |
404 | Shipment not found. |
500 | Internal server error. |