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.
In: header
Query Parameters
Unique customer provided identifier of the worker to used retrieve orders associated with the specified worker
Unique customer provided identifier of the place to be used retrieve orders associated with the specified place
String representing the search term. Search will be done on order_handle, ops_group_handle, worker_handle and metadata fields.
Unique Handle of Ops Group to fetch orders for
JSON encoded string for order metadata to filter orders by
Filter orders by risk status. True returns only orders at risk (at least one risk element is yellow or red). False returns only orders not at risk. With aggregate=true, only True is applied. The value is case-sensitive. See risk_status on GET /orders.
JSON object containing city, state, or country used to filter orders
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
Filter for orders associated with this device id.
Geohash of the area where order destination must lie.
Mode of planning to be used to filter orders
Filter for orders in this plan id.
Unique Handle of the route to fetch orders for
Device switch mode to filter orders by.
Date (YYYY-MM-DD) used as a filter to retrieve orders that are created on a given date.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that created within a timeframe.
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that created within a timeframe.
Date (YYYY-MM-DD) used as a filter to retrieve orders that are planned on a given date.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders planned within a timeframe.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders planned within a timeframe.
Date (YYYY-MM-DD) used as a filter to retrieve orders that are scheduled on a given date.
Date (YYYY-MM-DD) used as a filter to retrieve orders that are scheduled on a given date irrespective of timezone.
Date (YYYY-MM-DD) used as a filter to retrieve orders that are completed on a given date irrespective of timezone.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders which have scheduled_at within a timeframe.
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that which have scheduled_at within a timeframe.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders of that day in all timezone.
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders of that day in all timezone.
Date (YYYY-MM-DD) used as a filter to retrieve orders that are cancelled on a given date.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that cancelled within a timeframe.
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that cancelled within a timeframe.
Date (YYYY-MM-DD) used as a filter to retrieve orders that are completed on a given date.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that completed within a timeframe.
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that completed within a timeframe.
Date (YYYY-MM-DD) used as a filter to retrieve orders that are rescheduled on a given date.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that rescheduled within a timeframe.
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that rescheduled within a timeframe.
Date (YYYY-MM-DD) used as a filter to retrieve orders for which route started on a given date.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders for which route started within a timeframe.
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders for which route started within a timeframe.
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders of that day for all timezone for completed orders.
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders of that day for all timezone for completed orders.
Start Date (YYYY-MM-DD ) of the window to retrieve orders from that day for all timezone for created orders.
End Date (YYYY-MM-DD ) of the window to retrieve orders till that day for all timezone for created orders.
Date (YYYY-MM-DD) used as a filter to retrieve orders that are created on a given date irrespective of timezone.
Unique customer provided identifier of the driver to used retrieve orders associated with the specified driver
String indicating the preferred sorting type
Filter for fulfillment attempt number
Flag to fetch order's aggregated data.
Limit to number of results in response
Encoded value provided by our API to retrieve the next page of orders
Boolean to send the outage in aggregation
Parameter to filter for tracked and untracked orders
List of outage category as comma separated strings used for filtering associated orders within time range
JSON encoded string metadata associated with the worker to filter orders
Boolean flag to filter orders based on whether the worker is inside the destination or not.
List of order handles as comma separated strings used to fetch a specific subset of orders.
Comma separated arrival outcomes to filter orders by: no_show, late, on_time. The outcome compares the geofence arrival with the customer scheduled_at plus the account grace (default 15 minutes); a cancelled order with a customer cancellation_reason takes its outcome from the reason. Open, rescheduled, never-started and unscheduled orders match no value. Also applies with aggregate=true.
With issue: an open order (not on_shift) also matches no_show when its moving_away_from_destination risk is yellow or red, and late when its delayed_from_scheduled_at risk is yellow or red.
Comma separated primary causes of a late or no-show shift to filter orders by: late_departure, dc_sched, stop_on_the_way, dc_detour, dc_traffic, dc_vicinity, dc_unmeas, dc_unexplained, invisible, switched_off, other, none (no cause). Only ended, started shifts have a cause. Also applies with aggregate=true.
missing_end: only shifts that arrived and completed with no geofence exit. Also applies with aggregate=true.
no: only completed, on_time or late orders with an arrival whose end is not verified (no geofence exit, tag missing_end). Also applies with aggregate=true.
Comma separated optional fields to add to the response. reliability: the per-order shift reliability outcome in the list; with aggregate=true, the shift reliability rates and counts (aggregate.reliability, reasons, tags, daily, previous, as_of).
With aggregate=true&include=reliability: adds daily, one bucket per day, week (starts Monday) or month of the order local scheduled day, each with order counts and shift reliability. Only on the daily rollup path (see aggregate.as_of).
With aggregate=true&include=reliability: first day (YYYY-MM-DD) of the period that prev_pct and change_pts compare with. Needs compare_to and a whole-day scheduled_at_without_tz range; only on the daily rollup path. Default: the period of equal length that ends the day before the range.
With aggregate=true&include=reliability: last day (YYYY-MM-DD) of the compare period. Needs compare_from.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/orders/"{ "orders": [ { "order_handle": "order-1", "fulfillment_attempt": 0, "status": "completed", "destination": { "geometry": { "type": "Point", "coordinates": [ -121.9007247, 37.3811932 ] }, "address": "1028 E Brokaw Rd, San Jose, CA 95131", "radius": 100 }, "ops_group_handle": "store-SF", "track_mode": "full_shift", "plan_mode": "manual", "scheduled_at": "2023-10-31T04:00:00.000Z", "type": "drop", "type_index": 0, "expected_service_time": 0, "capacity_used": 1, "metadata": { "customerID": "12654" }, "region": { "country": "United States", "city": "San Jose", "state": "California" }, "product_type": [ "frozen", "fragile" ], "completed_at": "2023-10-31T23:13:21.287Z", "device_id": "52193948-1A79-14GF-AB81-2FB0A59536S3", "worker_handle": "james@ht.com", "created_at": "2023-10-30T23:41:47.489Z", "assigned_at": "2023-10-31T23:13:03.712Z", "route_handle": "a3f6e79c-c830-4766-8a3d-9eeaa5099ce2" } ]}{ "title": "string", "detail": "string"}{ "code": "string", "title": "string", "detail": "string"}