USusenash
Dispatch plans

Create Dispatch Plan

Changed on

Create a draft dispatch plan from orderIds (source orders, the default), or copy routeIds and the unassigned orderIds into a snapshot that leaves the live routes as they are. To take live routes into a plan, which archives them, use POST /v1/plans:from-routes. Needs write.plan; a plan source or label rollout that is off for your organization returns 403. Returns the plan id, its draft revision and how many orders start unplanned.

post/v1/plans

Request

Request body

startDatestring date nullable
endDatestring date nullable
timezoneIdstring nullable
zoneIdsstring[]
namestring required
tagsstring[]
source'orders' | 'snapshot'
orderIdsstring[]
routeIdsstring[]

Response

OK

planIdstring required
revisioninteger required
unplannedOrderCountinteger required

Changes