Plan route stops
cxt_plan_routesGenerate a proposed re-sequencing of the stops of existing routes for one route date (stops move between the output routes, with times, distance and unassigned stops). Proposal only: nothing changes until cxt_save_route_plan is called. Needs ITINERARY_PLANNING_ACCESS. POST /v3/ItineraryPlanning/Routes/{postDate}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| goal | No | Optimization goal (default QUICKEST_ROUTE). | |
| end_time | Yes | Local date-time without timezone, e.g. 2026-10-01T08:00:00. | |
| post_date | Yes | Route date, yyyy-mm-dd. | |
| start_time | Yes | Local date-time without timezone, e.g. 2026-10-01T08:00:00. | |
| input_route_ids | Yes | Route ids to take stops from. | |
| enhanced_routing | No | Enhanced routing (default OFF). | |
| num_placeholders | No | ||
| output_route_ids | Yes | Route ids to assign stops to. | |
| excluded_stop_ids | No | Stop ids to leave out of planning. | |
| max_stops_per_route | No | ||
| grace_period_per_stop | No | Grace period per stop, minutes. | |
| service_time_per_stop | No | Service time per stop, minutes. |