/shipments/{shipmentId}/legs

List a shipment's legs in transport-path order — the first mile first, then each onward leg, so no leg is listed before a leg it depends on. Order is derived from the addresses, not stored: a split writes every leg in one transaction, so creation time cannot express the journey. Each leg carries its position: how many handovers separate it from the shipment's own pickup, where 0 is the first mile. Legs that leave the same address in parallel (a split across several tours) share a position and keep creation order between them; a leg the transport path cannot reach carries no position at all. This is the only leg listing that reports position — the tenant-wide and tour-scoped listings have no shipment leg set to derive it from. A shipment carries a small, bounded number of legs, so the complete set is returned in a single page (no pagination cursor).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the shipment whose legs to list.

Responses

401

Unauthorized - invalid or missing API key.

404

Shipment not found.

500

A stored leg of this shipment could not be read. This response feeds a full-replace write, so an unreadable leg fails the read rather than being silently omitted.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json