HyperTrackDocs
Orders

Trigger Planning for a Plan

API to Trigger Planning for a plan

POST
/orders/plans/{plan_id}/trigger

API to Trigger Planning for a plan

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

plan_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/orders/plans/string/trigger" \  -H "Content-Type: application/json" \  -d '{}'
{  "message": "Order Planning Initiated",  "plan": {    "id": "a7a92072e-bf31-44f5-8a59-c4fffb5f9d4",    "href": "/orders/plans/a7a92072e-bf31-44f5-8a59-c4fffb5f9d4"  }}
{  "detail": {},  "message": "string"}
{  "detail": {},  "message": "string"}
{  "detail": {    "<location>": {      "<field_name>": [        "string"      ]    }  },  "message": "string"}

Reassign Order POST

Reassign an order to a worker. The order will be added in an optimal position if the worker already has an associated route

Reschedule Order POST

Reschedule an order identified by the given order_handle. When an order has already been dispatched, this will automatically cancel and recreate a new order with the new scheduled timestamps in an `unplanned` state. When an order is in assigned/planned state, this will automatically remove it from the route and schedule is updated.