Shipments
List Shipments
Retrieve all shipments for your account
GET
Retrieve all shipments for your API key’s location groups. List reads are served from our DB
without making provider calls — an hourly background sync keeps shipments reasonably fresh
(within the last few hours). For a force-refreshed view of one shipment, use
Get Shipment.
Request
This endpoint takes no request parameters.Response
On success, the API returns200 OK with an array of shipment objects.
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 has a
status (free-form provider-sourced label) and time (ISO 8601). Empty array if no events
observed yet.Appointments linked to this shipment, oldest-link first. Each entry is
{ id, added_at };
cross-reference each id against Get Appointment for the
full appointment payload. Empty array when no appointments are linked.Creation timestamp (ISO 8601).
Last update timestamp (ISO 8601). May be
null.Error responses
| Status | Description |
|---|---|
403 | Forbidden — your API key does not have access to this operation. |
500 | Internal server error. |