Orders

Trigger Planning for a Plan

API to Trigger Planning for a plan

post/orders/plans/{plan_id}/trigger

Request

Base URL
https://v3.api.hypertrack.com
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/orders/plans/:plan_id/trigger/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

plan_idstring required

Request body

plan_mode'scheduled' | 'on_demand' | 'null' nullable

Mode of planning to be used to plan orders

profile_filterobject nullable

Optional filter on worker profile metadata. When provided, only workers whose profile matches the given key/values are considered for planning (cohort planning).

Response

Successful response

messagestring nullable

Message on the status of planning. Provided if the request does not have plan_mode as manual

Changes

No recorded changes to this operation across all 1 revision of this API.