Run Object

The Run object is included in some API calls. For example, the Create Order and Update Order API calls. It is also included in some Webhooks, including the Planning Done and Optimization Applied webhooks. Note: If on a single API call contradicting ids exist on the task level and on the run object, a new run will be created according to the id in the run object. i.e. on the task level run external id (or run internal id) = A, but in the run object run external id (or run internal id) = B, the task will appear in run B.

Run Object Attributes

Parameter NameDescriptionValidations
external_id
Int32
Your external system's ID for this run. Appears as planned_route_external_id when included outside of the run object.
id
Int32
The ID Bringg assigns to a run when it is created.Use only in theupdate_task API request. When using update_task, either id or external_id can be indicated in the run object.
planned_route_id
Int32
Bringg's ID for the planned route. Planned routes are created in advanced (not created using AutoDispatch).
run_configuration_id
Int32
Refers to the GPS configuration (x seconds between location updates) per user status. Values include: Free =>10, "Started" =>10, "Assigned" =>10, "Checked-In" =>10, "Late" =>10}
scheduled_end_time
datetime
The date and time when this route is scheduled to end, formatted as "%Y-%m-%dT%H:%M:%S%z" and according to the UTC time zone.
scheduled_start_time
datetime
The date and time when this route is scheduled to begin, formatted as "%Y-%m-%dT%H:%M:%S%z" and according to the UTC time zone.
start_method
int32
Indicates the method used to start this route.Possible values:
0 - manually using the Driver App
1 - automatic check-in or check-out via geofence
2 - driver's action when prompted by the Driver App
4 - auto-corrected by client
5 - auto-corrected by server
6 - automated by activity trigger
7 - updated in the Bringg platform
8 - updated in the store app
9 - from run end
10 - updated by Bringg automation
tasks
array
An array of order (task) objects. Read more about the Order (Task) Object
team_id
Int32
Bringg's ID for the team assigned to this route.Can be indicated in the task object or run object. If indicated in task object, team_id must be omitted or match in run object.
user
object
An object including the details of the driver assigned to this route.
user_id
Int32
Bringg's ID for the driver assigned to this route.Can be indicated in the task object or run object. If indicated in task object, user_id must be omitted or match in run object.
vehicle_id
Int32
Bringg's ID for the vehicle assigned to a route.