API Reference

Update Driver Location

Send this API call each time the geolocation of the driver changes.
You can use:

NOTE: "reported_time" is optional.

❗️

Rate Limits

Bringg actively monitors and enforces rate limits to ensure availability and stability of our API services for all customers and partners, and to prevent any abuse or inappropriate usage.

Please read the Rate Limits / Request Limits documentation to make sure that you know how to check your limits and not exceed them.

EXAMPLE PAYLOAD

{
  "user_external_id": "<Your Driver ID>",
  "lat": 40.771629,
  "lng": -73.975033,
  "reported_time": 1595592696000,
  "started_tasks" :[{task_id:234323},{task_id:7896544}]
}
{
  "user_id": 662319,
  "lat": 40.771629,
  "lng": -73.975033,
  "reported_time": 1595592696000,
  "started_tasks" :[{task_id:234323},{task_id:7896544}]
}

BODY PARAMS

user_external_id

string

The ID of the driver in your system

user_id

Int32

Bringg's unique ID for this driver

lat

double

The latitude value of the driver's location

lng

double

The longitude value of the driver's location

reported_time

Int32

Unix Epoch time in milliseconds when the location was sent

started_tasks

Array

List of Bringg task ids the driver is currently handling. OPTIONAL

📘

What Bringg will send you in response

{
    "success": true,
    "rc": 0
}
{
    "success": false,
    "message": "Missing user id/external_id"
}

POSSIBLE ERROR MESSAGES

ERROR MESSAGEMEANING
Missing user id/external_id You have not included either the "user_id" or the "external_id" field in your payload