Get Orders
Get orders with optional query parameters ### 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.` - `Automated planning could not assign this order with the provided constraints.`
Get orders with optional query parameters
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.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 for risk status of order
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.
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": "on_time", "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" } ]}{ "detail": {}, "message": "string"}{ "detail": { "<location>": { "<field_name>": [ "string" ] } }, "message": "string"}