API Reference

Create Ops Group

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

Create an ops group to manage your workforce and orders

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Unique identifier for an Ops Group

string
required

Display name for an Ops Group

string
enum
Defaults to live_location

Configuration to identify where routes are expected to start

Allowed:
string
enum
Defaults to end_at_last_order

Configuration to identify where routes are expected to end

Allowed:
string | null
enum
Defaults to minimise_time

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

Controls how and when worker tracking is automatically started and stopped. If null, the default behavior is equivalent to: {"type": "manual"}.

work_status_automation
array of objects | null
Defaults to null

List of configuration object to enable/disable and customize automatic work status updation. If null, the default behavior is equivalent to: {"type": "manual"}.

work_status_automation
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

integer | null
Defaults to null

Maximum distance in meters from the ops group home within which order destinations are allowed

boolean | null
Defaults to null

Whether to enforce operations_radius validation at order creation time

string
Defaults to UTC

IANA timezone of the Ops Group

string | null
enum
Defaults to manual
deprecated

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

Allowed:
schedule
array | null
Defaults to null

List of schedules used for ops group workers matching during order planning and auto start/stop of availability or tracking of the workers

schedule
app_config
object | null

Configuration specific to order's app

Responses

Updated 7 days ago

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

Updated 7 days ago