HYhypertrack
Orders

Get Plan

API to fetch plan by Plan ID Unplanned orders may include planning_failure_reason, a customer-facing explanation of why automated planning could not assign the order.

get/orders/plans/{plan_id}

Request

Path parameters

plan_idstring required

Response

Successful response

plan_idstring required

Unique ID of the plan.

sequence_numberinteger required

Sequence number of the latest planning run.

status'failed' | 'completed' | 'planning' required

Status of the plan based on the latest planning run.

started_atstring required

Timestamp representing the start time of latest planning run for the plan.

created_atstring required

Timestamp representing the creation time of the plan.

ops_group_handlestring required

Unique Handle of ops group handle of the plan.

fulfillment_datestring required

Date (YYYY-MM-DD) representing the fulfillment date of plan.

failure_reasonstring

Reason of failure of the latest planning run for plan. Sample values are listed below.</br><ul><li> Ops group location cannot be the same as an order location</li> <li>Could not resolve country when planning orders</li> <li>Could not resolve ISO3 country_code for country</li> <li>Route planning is currently not enabled for country</li></ul>

Changes

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