HYhypertrack
Orders

Get Routes

Retrieve routes based on the filter parameters provided Unplanned orders may include planning_failure_reason, a customer-facing explanation of why automated planning could not assign the order.

get/orders/routes/

Request

Query parameters

completed_at_datestring nullable

Filter for routes completed on specified date (YYYY-MM-DD)

completed_at_fromstring nullable

Filter for routes completed after specified timestamp (YYYY-MM-DD HH:mm:ss)

completed_at_tostring nullable

Filter for routes completed before specified timestamp (YYYY-MM-DD HH:mm:ss)

created_at_datestring nullable

Filter for routes created on specified date (YYYY-MM-DD)

created_at_fromstring nullable

Filter for routes created after specified timestamp (YYYY-MM-DD HH:mm:ss)

created_at_tostring nullable

Filter for routes created before specified timestamp (YYYY-MM-DD HH:mm:ss)

worker_handlestring nullable

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

driver_handlestring nullable

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

ops_group_handlestring nullable

Filter for routes on specified ops group handle or list of comma separated handles

plan_mode'on_demand' | 'scheduled' | 'manual' | 'null' nullable

Filter for routes on specified plan mode (manual -> routes created manually, scheduled -> routes created automatically)

planned_at_datestring nullable

Filter for routes planned on specified date (YYYY-MM-DD).

planned_at_fromstring nullable

Filter for routes planned after specified timestamp (YYYY-MM-DD HH:mm:ss)

planned_at_tostring nullable

Filter for routes planned before specified timestamp (YYYY-MM-DD HH:mm:ss)

region_filterstring nullable

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

route_metadata_filterstring nullable

JSON object representing route metadata to be used to filter routes

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

Sort route responses by asc or desc on the created_at timestamp

start_by_datestring nullable

Date (YYYY-MM-DD) used as a filter to retrieve routes that need to start by the given date

start_by_fromstring nullable

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

start_by_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve routes that need to start within a timeframe

started_at_datestring nullable

Date (YYYY-MM-DD) used as a filter to retrieve routes that started on a given date

started_at_fromstring nullable

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

started_at_tostring nullable

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

scheduled_start_at_fromstring nullable

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

scheduled_start_at_tostring nullable

Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve routes that scheduled start within a timeframe

statusstring nullable

Filter for routes that are planned, assigned, tracking, or completed, to filter for multiple statuses, pass them as comma separated values

track_mode'full_shift' | 'on_shift' | 'pre_shift' | 'null' nullable

Filter for routes that are on_time, flex, on_shift, pre_shift or full_shift

pagination_tokenstring nullable

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

search_termstring nullable

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

limitinteger nullable

Max results to fetch

device_switch_modeunknown

Filter for routes with a device_switch_mode

plan_idstring nullable

Filter by plan id

device_idstring nullable

Filter by device id

device_metadata_filterstring nullable

JSON object representing device metadata to be used to filter routes

route_handlestring nullable

List of route handles (UUIDs) as comma separated strings used to fetch a specific subset of routes.

Response

Successful response

pagination_tokenstring nullable

Changes

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