Get Orders

get

https://v3.api.hypertrack.com/orders/

Get orders with optional query parameters

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

worker_handle

string | null

Defaults to null

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

place_handle

string | null

Defaults to null

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

search_term

string | null

Defaults to null

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

ops_group_handle

string | null

Defaults to null

Unique Handle of Ops Group to fetch orders for

order_metadata_filter

string | null

Defaults to null

JSON encoded string for order metadata to filter orders by

risk_status

string | null

Defaults to null

Filter for risk status of order

region_filter

string | null

Defaults to null

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

status

string | null

Defaults to null

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_id

string | null

Defaults to null

Filter for orders associated with this device id.

destination_geohash

string | null

Defaults to null

Geohash of the area where order destination must lie.

plan_mode

enum

Defaults to null

Mode of planning to be used to filter orders

Allowed:

plan_id

string | null

Defaults to null

Filter for orders in this plan id.

route_handle

string | null

Defaults to null

Unique Handle of the route to fetch orders for

track_mode

enum

Defaults to null

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.

Allowed:

device_switch_mode

enum

Defaults to null

Device switch mode to filter orders by.

Allowed:

created_at_date

string | null

Defaults to null

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

created_at_from

string | null

Defaults to null

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

created_at_to

string | null

Defaults to null

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

planned_at_date

string | null

Defaults to null

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

planned_at_from

string | null

Defaults to null

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

planned_at_to

string | null

Defaults to null

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

scheduled_at_date

string | null

Defaults to null

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

scheduled_at_date_without_tz

string | null

Defaults to null

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_tz

string | null

Defaults to null

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

scheduled_at_from

string | null

Defaults to null

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

scheduled_at_to

string | null

Defaults to null

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_from

string | null

Defaults to null

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_to

string | null

Defaults to null

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

cancelled_at_date

string | null

Defaults to null

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

cancelled_at_from

string | null

Defaults to null

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

cancelled_at_to

string | null

Defaults to null

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

completed_at_date

string | null

Defaults to null

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

completed_at_from

string | null

Defaults to null

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

completed_at_to

string | null

Defaults to null

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

rescheduled_marked_at_date

string | null

Defaults to null

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

rescheduled_marked_at_from

string | null

Defaults to null

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

rescheduled_marked_at_to

string | null

Defaults to null

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

route_started_at_date

string | null

Defaults to null

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

route_started_at_from

string | null

Defaults to null

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_to

string | null

Defaults to null

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_from

string | null

Defaults to null

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_to

string | null

Defaults to null

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_from

string | null

Defaults to null

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

created_at_without_tz_to

string | null

Defaults to null

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

created_at_date_without_tz

string | null

Defaults to null

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

driver_handle

string | null

Defaults to null

deprecated

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

sort_direction

enum

Defaults to null

String indicating the preferred sorting type

Allowed:

fulfillment_attempt

integer | null

Defaults to null

Filter for fulfillment attempt number

aggregate

boolean | null

Defaults to null

Flag to fetch order's aggregated data.

limit

integer | null

Defaults to null

Limit to number of results in response

pagination_token

string | null

Defaults to null

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

send_outage

boolean | null

Defaults to null

Boolean to send the outage in aggregation

tracking_status

string | null

enum

Defaults to null

Parameter to filter for tracked and untracked orders

Allowed:

filter_outage_category

string | null

Defaults to null

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

worker_profile_filter

string | null

Defaults to null

JSON encoded string metadata associated with the worker to filter orders

worker_inside_destination

boolean | null

Defaults to null

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

Responses

200Successful response

401Authentication error

422Validation error