Order Planning Failed · HyperTrack Docs

Order Planning Failed Webhook Payload

[
  {
   "created_at":"2021-01-01T14:01:00.000000Z",
   "recorded_at":"2021-01-01T14:00:00.000000Z",
   "account_id":"6784e919-7168-4f61-b686-2020f547637f",
   "type":"order",
   "data":{
      "value":"planning_failed",
      "planning_sequence_number": 1,
      "plan_id": "f9212af2-71e8-40f0-84bd-005424a80a4d",
      "failure_reason": "No Worker was available for this plan.",
      "num_orders": 10,
      "num_unplanned_orders": 2,
      "started_at": "2021-01-01T14:00:00.000000Z",
      "fulfillment_date": "2021-01-01",
      "ops_group_handle": "OPS_123",
      "unplanned_order_reasons": [
        {
          "reason": "No Worker was available for this plan.",
          "num_orders": 2
        }
      ]
     },
   "version":"3.0.0"
  }
]

Name	Type	Mandatory	Description
data.value	string	Yes	`planning_failed`
data.planning_sequence_number	integer	Yes	Sequence Number of the plan for this specific plan ID
data.plan_id	string	Yes	Unique identifier of the plan which is getting planned
data.num_orders	integer	Yes	Number of orders submitted for planning
data.failure_reason	string	Yes	Faiure reason for Planning
data.num_unplanned_orders	integer	Yes	Number of Orders which could not be planned
data.started_at	string	Yes	Timestamp at which plan was started
data.fulfillment_date	string or null	Yes	Date for which orders are being planned for. `null` when the plan has no fulfillment date
data.ops_group_handle	string	Yes	Ops group handle for which the planning is triggered
data.unplanned_order_reasons	array	No	Number of unplanned orders for each reason. Each item has `reason` (string) and `num_orders` (integer). Items are sorted by `num_orders`, highest first. Present only when at least one order could not be planned. For the `reason` values, see Unplanned order reasons