Tool to start the planning/optimization process for a specified date or date range. Use when you need to generate optimized routes for orders and drivers. Requires orders to be created before planning can begin.
datestringTarget date for planning in YYYY-MM-DD format. Required if dateRange is not specified
lockTypestringConstrains route modifications - NONE (no constraints), ROUTES (lock routes), or RESOURCES (lock resources). Default: NONE. Only applicable when startWith is CURRENT
balanceBystringBalancing criteria - WT (working time) or NUM (order count). Default: WT
balancingstringRoute balancing mode - OFF (no balancing), ON (balanced routes), or ON_FORCE (force balancing). Default: OFF
dateRangeobjectDate range for weekly planning.
startWithstringEMPTY starts fresh planning, CURRENT uses existing routes. Default: EMPTY
useOrdersarrayDeprecated - use useOrderObjects instead. List of order identifiers
clusteringbooleanMinimizes route overlap when enabled. Default: false
depotTripsbooleanEnables warehouse reload scheduling. Default: false
useDriversarraySelected drivers to include in planning. Empty array uses all available drivers
balancingFactornumberWeighting for balanced routes, range 0.0-1.0. Default: 0.3
useOrderObjectsarrayOrders to optimize (maximum 500 orders per request). Each object contains either orderNo or id. Empty includes all valid orders
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.