Workers

Create Ops Group

Create an ops group to manage your workforce and orders

post/workers/ops-groups/

Request

Base URL
https://v3.api.hypertrack.com
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/workers/ops-groups/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

ops_group_handlestring required

Unique identifier for an Ops Group

ops_group_labelstring required

Display name for an Ops Group

route_start_location'driver_home' | 'ops_group_home' | 'live_location'

Configuration to identify where routes are expected to start

route_completion_type'end_at_last_order' | 'return_to_start_location' | 'manual'

Configuration to identify where routes are expected to end

objective_fn'minimise_time' | 'minimise_distance' | 'null' nullable

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

order_tracking_modestring nullable

Order tracking mode associated with the ops-group

default_shift_start_timestring nullable

Default time HH:mm when the shift starts for drivers

default_shift_end_timestring nullable

Default time HH:mm when the shift ends for drivers

route_capacityinteger nullable

Maximum number of orders in a route

route_max_distanceinteger nullable

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

operations_radiusinteger nullable

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

enforce_operations_radiusboolean nullable

Whether to enforce operations_radius validation at order creation time

timezonestring

IANA timezone of the Ops Group

shift_availability_mode'auto' | 'manual' | 'null' nullable

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

app_configobject nullable

Configuration specific to order's app

Response

Successful response

ops_group_handlestring required

Unique identifier for an Ops Group

ops_group_labelstring required

Identifier label for an Ops Group

timezonestring required

IANA timezone of the Ops Group

route_start_locationstring

Configuration to identify where routes are expected to start

route_completion_typestring

Configuration to identify where routes are expected to end

objective_fnstring

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

default_shift_start_timestring

Default time HH:mm when the shift starts for drivers

default_shift_end_timestring

Default time HH:mm when the shift ends for drivers

route_capacityinteger required

Maximum number of orders in a route

route_max_distanceinteger required

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

deletedboolean

Flag to include deleted ops groups

deleted_atstring

Timestamp at which the OpsGroup was deleted

shift_availability_modestring required