Start route planning
optimoroute_start_planningStart OptimoRoute's route optimization for a date (or a dateRange for weekly planning, if the plan allows). With the default startWith EMPTY, existing routes for that date are REPLACED; use startWith CURRENT (+ lockType) to keep them. Returns a planningId — poll it with optimoroute_get_planning_status, then read the result with optimoroute_get_routes. Can be cancelled with optimoroute_stop_planning. OptimoRoute: POST /start_planning.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Date to plan, YYYY-MM-DD. Ignored if dateRange is set. | |
| lockType | No | With CURRENT: NONE allow changes; ROUTES keep planned routes; RESOURCES keep driver per order. | |
| balanceBy | No | Balance by WT working time or NUM order count. | |
| balancing | No | OFF best routes; ON balance workload; ON_FORCE balance and use every driver. | |
| dateRange | No | Plan several days at once (weekly planning). | |
| startWith | No | EMPTY (default) plans from scratch; CURRENT starts from existing routes. | |
| clustering | No | Minimize overlap between drivers' routes. | |
| depotTrips | No | Let drivers return to the depot to reload. | |
| useDrivers | No | Only plan with these drivers. Default: all available drivers. | |
| balancingFactor | No | 0.0-1.0, how much balancing outweighs route cost (ON_FORCE only). | |
| useOrderObjects | No | Only plan these orders. Default: all valid orders on the date. | |
| depotVisitDuration | No | Minutes spent at a depot visit. | |
| midRouteDepotVisits | No | Allow mid-route depot visits (needs Dynamic Mid-Route Depots on the account). | |
| includeScheduledOrders | No | When planning a subset, keep other orders already scheduled on those drivers (default true). |