Stops of a route
list_route_stopsRetrieve ordered stops for a dispatch route, including delivery state, outcome, ETA, time window, and packages. Enable contact details to include recipient info, proof of delivery, and tracking links.
Instructions
The stops of one route (one driver's run) in the order the API returns them, with delivery state and outcome, ETA, time window and packages. By default recipients are withheld, addresses are summarised to the locality, and proof-of-delivery links, signee names and recipient tracking links are left out; set include_contact_details to get them.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| route_id | Yes | Route ID (routes/<id> or the bare <id>) | |
| page_token | No | next_page_token from a previous call, to continue the same list | |
| external_id | No | Only the stop(s) whose recipient.externalId equals this value exactly (the API's filter.externalId) | |
| max_results | No | Minimum number of records to return; whole pages are returned, so a few more may come back | |
| include_contact_details | No | Include recipient name, email, phone and external ID, the full address with coordinates, signee names, proof-of-delivery photo and signature links, the tracking link, and unredacted notes |