HYhypertrack
Orders

Get Orders

Planning failure reasons

When an order is left unplanned by automated planning, planning_failure_reason may contain one of these values:

  • No Worker was available for this plan.
  • No Worker schedule overlaps with this order's time window.
  • This order is outside the available Worker working hours.
  • Worker location is unavailable, so travel time could not be evaluated.
  • Worker start location is unavailable for the configured route start setting.
  • No Worker supports the required product type for this order.
  • Route was being modified concurrently and this order needs to be re-planned.
  • The optimizer dropped this order to satisfy planning constraints for the overall plan.
  • The optimizer could not find a feasible plan for the provided constraints.
  • Travel time calculation failed for this planning attempt.
  • Ops group configuration is incomplete for automated planning.
  • Assigning this order would exceed route or Worker capacity.
  • No Worker can reach this order before scheduled_at.
  • Assigning this order would delay an already planned downstream order.
  • Assigning this order would exceed the Worker's shift end time.
  • Existing assigned route conflicts with the Worker schedule, so this order could not be inserted into the plan.
  • Existing assigned route exceeds the Worker's shift, so this order could not be inserted into the plan.
  • Existing assigned route has conflicting appointment windows, so this order could not be inserted into the plan.
  • Existing assigned route exceeds route or Worker capacity, so this order could not be inserted into the plan.
  • Existing assigned route exceeds the configured maximum route distance, so this order could not be inserted into the plan.
  • Existing assigned routes were preserved, so this order could not be inserted into the plan.
  • Assigning this order would exceed the configured maximum route distance.
  • The optimizer reached its planning limit before it could assign this order.
  • Automated planning could not assign this order with the provided constraints.
get/orders/

Request

Query parameters

worker_handlestring nullable

Unique customer provided identifier of the worker to used retrieve orders associated with the specified worker

place_handlestring nullable

Unique customer provided identifier of the place to be used retrieve orders associated with the specified place

search_termstring nullable

String representing the search term. Search will be done on order_handle, ops_group_handle, worker_handle and metadata fields.

ops_group_handlestring nullable

Unique Handle of Ops Group to fetch orders for

order_metadata_filterstring nullable

JSON encoded string for order metadata to filter orders by

risk_statusstring nullable

Filter for risk status of order

region_filterstring nullable

JSON object containing city, state, or country used to filter orders

statusstring nullable

String representation of Order status to fetch orders for. It can be comma separated list, each item in list can be one of completed, cancelled, rescheduled, disabled, ongoing, unplanned, assigned, planned. eg. ?status=completed,cancelled or ?status=completed to filter for one status

device_idstring nullable

Filter for orders associated with this device id.

destination_geohashstring nullable

Geohash of the area where order destination must lie.

plan_modeunknown

Mode of planning to be used to filter orders

plan_idstring nullable

Filter for orders in this plan id.

route_handlestring nullable

Unique Handle of the route to fetch orders for

track_modeunknown

Tracking mode to filter orders by. See pre_shift, on_shift documentation. full_shift includes both pre-shift and on-shift tracking. Note that on_time and flex are deprecated modes.

device_switch_modeunknown

Device switch mode to filter orders by.

created_at_datestring nullable

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

created_at_fromstring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that created within a timeframe.

created_at_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that created within a timeframe.

planned_at_datestring nullable

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

planned_at_fromstring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders planned within a timeframe.

planned_at_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders planned within a timeframe.

scheduled_at_datestring nullable

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

scheduled_at_date_without_tzstring nullable

Date (YYYY-MM-DD) used as a filter to retrieve orders that are scheduled on a given date irrespective of timezone.

completed_at_date_without_tzstring nullable

Date (YYYY-MM-DD) used as a filter to retrieve orders that are completed on a given date irrespective of timezone.

scheduled_at_fromstring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders which have scheduled_at within a timeframe.

scheduled_at_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that which have scheduled_at within a timeframe.

scheduled_at_without_tz_fromstring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders of that day in all timezone.

scheduled_at_without_tz_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders of that day in all timezone.

cancelled_at_datestring nullable

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

cancelled_at_fromstring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that cancelled within a timeframe.

cancelled_at_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that cancelled within a timeframe.

completed_at_datestring nullable

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

completed_at_fromstring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that completed within a timeframe.

completed_at_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that completed within a timeframe.

rescheduled_marked_at_datestring nullable

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

rescheduled_marked_at_fromstring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that rescheduled within a timeframe.

rescheduled_marked_at_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that rescheduled within a timeframe.

route_started_at_datestring nullable

Date (YYYY-MM-DD) used as a filter to retrieve orders for which route started on a given date.

route_started_at_fromstring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders for which route started within a timeframe.

route_started_at_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders for which route started within a timeframe.

completed_at_without_tz_fromstring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders of that day for all timezone for completed orders.

completed_at_without_tz_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders of that day for all timezone for completed orders.

created_at_without_tz_fromstring nullable

Start Date (YYYY-MM-DD ) of the window to retrieve orders from that day for all timezone for created orders.

created_at_without_tz_tostring nullable

End Date (YYYY-MM-DD ) of the window to retrieve orders till that day for all timezone for created orders.

created_at_date_without_tzstring nullable

Date (YYYY-MM-DD) used as a filter to retrieve orders that are created on a given date irrespective of timezone.

driver_handlestring nullable

Unique customer provided identifier of the driver to used retrieve orders associated with the specified driver

sort_directionunknown

String indicating the preferred sorting type

fulfillment_attemptinteger nullable

Filter for fulfillment attempt number

aggregateboolean nullable

Flag to fetch order's aggregated data.

limitinteger nullable

Limit to number of results in response

pagination_tokenstring nullable

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

send_outageboolean nullable

Boolean to send the outage in aggregation

tracking_status'tracked' | 'untracked' | 'null' nullable

Parameter to filter for tracked and untracked orders

filter_outage_categorystring nullable

List of outage category as comma separated strings used for filtering associated orders within time range

worker_profile_filterstring Encoded JSON nullable

JSON encoded string metadata associated with the worker to filter orders

worker_inside_destinationboolean nullable

Boolean flag to filter orders based on whether the worker is inside the destination or not.

order_handlestring nullable

List of order handles as comma separated strings used to fetch a specific subset of orders.

Response

Successful response

pagination_tokenstring nullable

Changes

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