API Reference

Create Ops Group

post
https://v3.api.hypertrack.com/drivers/ops-groups/

Create an ops group to manage your workforce and orders

Body Params
string
required

Unique identifier for an Ops Group

string
required

Display name for an Ops Group

string
enum
required

Configuration to identify where routes are expected to start

Allowed:
string
enum
required

Configuration to identify where routes are expected to end

Allowed:
string | null
enum
Defaults to null

Configuration to identify the metric used by the solver when generating optimized routes

Allowed:
string | null
Defaults to null
deprecated

Order tracking mode associated with the ops-group

order_tracking_automation
object | null

A configuration object to enable/disable and customize automatic order tracking. Note that only the following are currently supported: {"type": "manual"}, {"type": "shift", "mode": "auto_stop"}, and {"type": "order", "mode": "auto_start"}. Please reach out to us if you would like to use the other options.

ops_group_home
object | null

Location of the Ops Group

string | null
Defaults to null

Default time HH:mm when the shift starts for drivers

string | null
Defaults to null

Default time HH:mm when the shift ends for drivers

integer | null
Defaults to null

Maximum number of orders in a route

integer | null
Defaults to null

Maximum distance in meters used by the route solver to constrain each route distance

string
Defaults to UTC

IANA timezone of the Ops Group

string | null
enum
Defaults to manual

Flag to start/stop availability of all drivers based on the ops group shift

Allowed:
Responses

Updated 7 months ago

Language
Credentials
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago