Get Routes

get

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

Retrieve routes based on the filter parameters provided

Query Params

completed_at_date

string | null

Defaults to null

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

completed_at_from

string | null

Defaults to null

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

completed_at_to

string | null

Defaults to null

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

created_at_date

string | null

Defaults to null

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

created_at_from

string | null

Defaults to null

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

created_at_to

string | null

Defaults to null

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

worker_handle

string | null

Defaults to null

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

driver_handle

string | null

Defaults to null

deprecated

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

ops_group_handle

string | null

Defaults to null

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

plan_mode

string | null

enum

Defaults to null

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

Allowed:

planned_at_date

string | null

Defaults to null

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

planned_at_from

string | null

Defaults to null

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

planned_at_to

string | null

Defaults to null

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

region_filter

string | null

Defaults to null

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

route_metadata_filter

string | null

Defaults to null

JSON object representing route metadata to be used to filter routes

sort_direction

string | null

enum

Defaults to null

Sort route responses by asc or desc on the created_at timestamp

Allowed:

start_by_date

string | null

Defaults to null

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

start_by_from

string | null

Defaults to null

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

start_by_to

string | null

Defaults to null

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

started_at_date

string | null

Defaults to null

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

started_at_from

string | null

Defaults to null

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

started_at_to

string | null

Defaults to null

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

scheduled_start_at_from

string | null

Defaults to null

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

scheduled_start_at_to

string | null

Defaults to null

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

status

string | null

Defaults to null

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

track_mode

string | null

enum

Defaults to null

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

Allowed:

pagination_token

string | null

Defaults to null

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

search_term

string | null

Defaults to null

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

limit

integer | null

Defaults to null

Max results to fetch

device_switch_mode

enum

Defaults to null

Filter for routes with a device_switch_mode

Allowed:

plan_id

string | null

Defaults to null

Filter by plan id

device_id

string | null

Defaults to null

Filter by device id

device_metadata_filter

string | null

Defaults to null

JSON object representing device metadata to be used to filter routes

Responses

200Successful response

401Authentication error

422Validation error