HYhypertrack
Orders

Get Plans

API to fetch list of plans based on a set of filters Unplanned orders may include planning_failure_reason, a customer-facing explanation of why automated planning could not assign the order.

get/orders/plans/

Request

Query parameters

fulfillment_datestring nullable

Date (YYYY-MM-DD) used as a filter to retrieve plans that are fulfilled on a given date.

ops_group_handlestring nullable

Unique Handle of Ops Group to fetch plans for

pagination_tokenstring nullable

Encoded value provided by our API to retrieve the next page of plans

status'failed' | 'completed' | 'planning' | 'null' nullable

String representation of Plan status to fetch plans for.

sort_direction'desc' | 'asc' | 'null' nullable

String indicating the preferred sorting type

include_summaryboolean nullable

Flag to fetch summary also for each plan.

limitinteger nullable

Number of plans to be fetched.

Response

Successful response

pagination_tokenstring nullable

Token representing the pointer to the last object in current page, in case more pages are present

Changes

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