Stops of a plan
list_plan_stopsRetrieve all stops for a plan, including type, route, ETA, delivery state, and packages. Contact details and proof-of-delivery links are omitted unless include_contact_details is set.
Instructions
Every stop of one plan with its type (start/stop/end), route, position, 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 |
|---|---|---|---|
| plan_id | Yes | Plan ID (plans/<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 |