Create Route

post

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

This API is used to plan a set of unplanned orders into a route

Body Params

orders

array of objects

required

length ≥ 1

List of unplanned orders to be added to the route

orders*

track_mode

string | null

enum

Defaults to null

Filter routes on the specified track_mode

Allowed:

ops_group_handle

string | null

Defaults to null

Filter routes on the specified ops group

optimise

boolean | null

Defaults to null

Flag to determine whether orders sequence needs to be updated to minimise total travel distance.

driver_handle

string | null

Defaults to null

deprecated

Unique customer provided identifier for the driver to whom the route needs to be assigned to

worker_handle

string | null

Defaults to null

Unique customer provided identifier for the worker to whom the route needs to be assigned to

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful response