Bringg

Search results for "{{ search.query }}"

No results found for "{{search.query}}". 
View All Results
Suggest Edits

Create Order

Create Order (or create Task) is usually the main and most important API call to Bringg.

Since we support many different use cases of single pickup and delivery, multi pickup / delivery combination and even long routes, it's hard to document any and every option, which is why we will explain the concepts that are being used.

An order describes the general (meta) information of the request. Each order has a customer that is owning the order and sees all stops along the way. Often this is the end consumer but not always.

The order has one or more stops along the way. This could be for pickups, drop-offs, or just visits. We call those Waypoints. The order calls has an array of way points, which can be only one. The way point describes the actual consumer details: name, address, expected times, and so on.

The way point will include specific rules for this stop if they exists, or will inherit the rules from the tag or other configuration.

A way point as some additional optional objects under it:

Customer - if there is a specific customer for this way point that is different from the order customer, or that some attributes change for this customer.

Inventory - if this specific way point is for collecting inventory (parcel, food, menu, and so on) or delivering them.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
   "title":"Generic Title",
   "external_id":"ABC15D",
   "scheduled_at" : "2017-10-31T12:00:00-5",
   "customer":{
      "name":"Mr. Customer",
      "address":"1900 Wall st, New York, NY",
      "phone":"0545454545",
      "allow_sending_sms": true,
     "allow_sending_email": false,
   },
   "way_points":[
      {
         "customer":{
            "name":"restaurant",
            "phone":"0123456789",
           "allow_sending_sms": true,
     "allow_sending_email": false,
         },
         "scheduled_at" : "2017-10-31T11:00:00-5",
			   "address":"4196 Water St. New York, NY 10002",
         "city": "New York"
      },
      {
         "customer":{
            "name":"Mr. Customer",
            "phone":"05456974815",
           "allow_sending_sms": true,
     "allow_sending_email": false,
         },
         "scheduled_at" : "2017-10-31T12:00:00-5",
         "address":"416 Water St. New York, NY 10002",
         "delivery_confirmation_signature" : "2",
         "note": "Please don't ring the bell. Baby is sleeping.",
         "inventory": [{
            "name": "temp",
            "price": 10.4,
            "external_id": "12321312",
            "description": "This is a cool setup",
            "quantity": 5,
            "scan_string": "34242342342323432432234"
        }]
      }
   ],
	"teams" : [4248, 8419]
}
{
	"title" : "Order Title Goes Here",
	"external_id" : "EXT1234",
	"customer_id" : 45678,
	"way_points" : [{
			"customer" : {
				"name" : "Warehouse",
				"address" : "350 5th Ave, New York, NY 10118",
				"address_second_line" : "1st floor, 3rd door on the right"
			},
			"scheduled_at" : "2017-03-31T11:00:00-5",
			"note" : "Here is the note on the 1st waypoint",
			"inventory" : [{
					"name" : "Acme Cat Litter 1kg",
					"pending" : true,
					"quantity" : 0,
					"original_quantity" : 1,
					"scan_string" : "9209176"
				}, {
					"name" : "Yum Yum Cat Food 100g",
					"pending" : true,
					"quantity" : 0,
					"original_quantity" : 5,
					"scan_string" : "9210615"
				}, {
					"id" : 72407,
					"quantity" : 0,
					"original_quantity" : 2
				}
			],
			"must_approve_inventory" : true
		}, {
			"customer_id" : 45678,
			"scheduled_at" : "2017-03-31T12:00:00-5",
			"note" : "Here is the note on the 2nd waypoint",
			"inventory" : [{
					"name" : "Acme Cat Litter 1kg",
					"pending" : false,
					"quantity" : 0,
					"original_quantity" : 1,
					"scan_string" : "9209176"
				}, {
					"name" : "Yum Yum Cat Food 100g",
					"pending" : false,
					"quantity" : 0,
					"original_quantity" : 5,
					"scan_string" : "9210615"
				}
			],
			"must_approve_inventory" : true
		}
	],
	"teams" : [4248, 8419]
}
<?php
$TeamId = '8194';
date_default_timezone_set('Asia/Jerusalem');
$TodaysDate = date("d/m/Y");
$mDueDate = date('Y-m-d');
$DeliveryTime = date('H:i:s');
$ScheduledAt = print_r($mDueDate . 'T' . $DeliveryTime . ':00z',true);

$url = 'http://admin-api.bringg.com//services/Link/To-get-from-control-panel/webhooks and api/';    // The s has been removed from the https:// also - for testing ... On live - must return!

$jason = print_r('{
   "company_id": 1234,
   "title": "Food-Delivery",      // Title for the Task being created.
   "external_id": "Ext1555",     // ID of the task in your Company\'s system...
   "scheduled_at": "' . $ScheduledAt . '",   // Here the  $ScheduledAt variable is an example for the date and time format.
   "note": "This is a note for the whole task - It will be shown on the dashboard and on the driver app",
   "teams": "' . $TeamId . '",        // $TeamId = Which teams this task is assigned to
   "customer": {
      "name": "Sherlock Holmes",
      "address": "1200 Wall st, New York, NY",
      "phone": "0506661111111",
      "email": "Holmes@sherlock.com"
   },
   //"customer_id": 123456,     You can also create a Customer beforehand and then just provide the customer_id here instead of the customer above
   "way_points":[
      {
         "customer":{
            "name": "Chinese Restaurant",
            "address": "53 Fifth Ave. New York, NY 10002",
            "phone": "0555555555",
            "email": "China@Buyfood.com"
         },
         "address":"53 Fifth Ave. New York, NY 10002",
         "inventory": [{
            "name": "Kung-Pao-Chicken",
            "price": 101.5,
            "image": "http://some.url.com/image.png",
            "external_id": "12321312",
            "description": "Chicken Dish",
            "quantity": 0,
			"original_quantity": 3,
            "pending": "true",             // This indicates that this inventory is for pick-up
            "scan_string": "2232",
            "note": "This is a note for the Item inventory"
        }],
        "allow_editing_inventory": "true", // Allow driver to edit the Inventory e.g. change quantities?
        "must_approve_inventory": "true",   // Driver must approve pick up inventory e.g. by scanning it. The driver won\'t be allowed to leave location without doing this.
        "allow_scanning_inventory": "true"  // Allow to scan inventory via phone camera (on the Driver App)
      },
      {
         "customer":{
            "name":"Sir, Holmes Sherlock",
            "phone":"050000022222",
            "email": "Holmes@sherlock.com"
         },
         "address":"1200 Wall st, New York, NY",
         "inventory": [{
            "name": "Kung-Pao-Chicken",
            "price": 101.5,
            "image": "http://some.url.com/image.png",
            "external_id": "12321312",
            "description": "Chicken Dish",
            "quantity": 0,
			"original_quantity": 3,
            "pending": "false",				// This indicates that this inventory is for drop-off
            "scan_string": "2232",
            "note": "This is a note for the Item inventory"
        }],
        "allow_editing_inventory": "true",    // Allow driver to edit the Inventory e.g. change quantities?
        "must_approve_inventory": "true",   // Driver must approve drop off inventory e.g. by scanning it. The driver won\'t be allowed to leave location and finish the task without doing this.
        "allow_scanning_inventory": "true" // Allow to scan inventory via phone camera (on the Driver App)
      }
   ]
}',true);



$json = json_decode($jason);
echo '<pre>';
//print_r($json);
echo '<pre>';
print_r("The content: " . $jason);
// $data_string = json_encode($data);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $jason);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($jason))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
echo '<pre>';
print_r($response);

?>
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

title
string

Task Title

customer_id
int32

Optional: Customer ID for the task itself. Use when you know the existing Customer ID.

customer
object

Customer details to create. See here: http://developers.bringg.com/reference#create-customer

 
user_id
string

Optional: User ID for the driver to be assigned

external_id
string

Optional: External ID to be used

total_price
int32

Total price of task

delivery_price
string

Delivery price for this task

payment_method
string

Payment method. See bellow

tip
string

Was tip paid

left_to_be_paid
string

Cash payment

way_points
object
delivery_confirmation_photo
int32

Does the driver need to take a photo on the waypoint? For possible values, see below

delivery_confirmation_signature
int32

Does the driver need to get a signature on the waypoint? For possible values, see below

delivery_confirmation_note
int32

Does the driver need to make a note on the waypoint? For possible values, see below

delivery_confirmation_form
int32

Does the driver need to complete the driver form on the waypoint? For possible values, see below

delivery_confirmation_scan
int32

Does the driver need to do a scan on the waypoint? For possible values, see below

teams
array of integers

Array of team ids to add to this task

asap
boolean

Creates with ASAP flag

note
string
priority
int32

Sets the Priority (order ranking) of the task, if used

share_location
boolean

Create a shared location context and return its id for usage in tracking SDK

 

There always needs to be a Customer on the Task itself. In the waypoint array, you can include the Customer as well. If it's an existing customer and you have the Bringg Customer ID, you can use the customer_id field and that will pull through all the customer details e.g. address, phone number. If the customer does not already exist in Bringg, then use the "customer" field/object to create it.

Payment Methods:

unknown: 0,
cash: 1,
credit: 2
cheque: 3

Delivery Confirmation Options

Manual (optional for driver) => 0
After Checkin => 1
Before Checkout => 2
Default => 3 (takes the value from the global settings)

curl -H "Content-Type: application/json" -X POST -d '{"title": "Generic Title", "external_id": "ABC15D", "customer": {"name": "Mr. Customer", "company_id": XXX, "address": "1 Wall st, New York, NY", "phone": "0545674815"}}' http://admin-api.bringg.com/services/6f15901b/b7012168-c9b6-4c64-9aeb-4272a345dbb0/54efd3d9-d3ed-4e53-8a44-039ade4305b0/
Suggest Edits

Update Order

The update order service call has the same concepts and parameters as the Create Order call. See it for more updated information

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"task": {
		"id": 1234,
		"status": 4
	}
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32

This is the Task ID

status
int32

e.g. 4 is done, 7 is cancelled. See http://developers.bringg.com/reference#task-status for a reference to other task statuses.

 

See Create Order for more information

Suggest Edits

Cancel Task

Cancels an active task

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
    "id" : 1234
}
A binary file was returned

You couldn't be authenticated

{
  "success": true,
  "task": {
    "title": "Test to cancel",
    "user_id": null,
    "created_at": "2017-04-28T15:04:32.444Z",
    "scheduled_at": "2017-04-28T15:34:10.410Z",
    "status": 7,
    "id": 2874444
  }
}

Body Params

id
int32

Bringg's unique task ID

 
Suggest Edits

Create Note

This adds a note to a specific waypoint.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"task_id": 1234,
	"note": "Note content",
	"way_point_id": 123456789
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

task_id
int32

This is the Task ID

way_point_id
int32

ID of the relevant waypoint

note
string

Content of the note

 
Suggest Edits

Create User

Create a User - Admin, Dispatcher or Driver

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
  "company_id": 1,
  "team_ids": [7990],
  "name": "User Name",
  "email": "test@test-company.com",    
  "password": "example-password",
  "external_id": "1",
  "job_description": "Site Manager",
  "admin": false,
  "driver": true,
  "dispatcher": false
}
A binary file was returned

You couldn't be authenticated

{
  "success": true,
  "user": {
    "id": REDACTED,
    "access_token": null,
    "name": "Manager One",
    "password_hash": null,
    "created_at": "2017-02-14T03:57:32.624Z",
    "updated_at": "2017-02-14T03:57:32.624Z",
    "email": "REDACTED",
    "authentication_token": "REDACTED",
    "status": "offline",
    "sub": null,
    "lat": null,
    "lng": null,
    "profile_image": null,
    "phone": null,
    "merchant_id": 9931,
    "beta": null,
    "admin": false,
    "push_token": null,
    "job_description": "Cafe Manager",
    "uuid": "2cd2eb1a-ce70-4455-aa88-a580174b8d11",
    "uploaded_profile_image": {
      "url": null
    },
    "average_rating": null,
    "debug": false,
    "delete_at": null,
    "original_phone_number": null,
    "confirmation_code": null,
    "active_shift_id": null,
    "partner_user": null,
    "feature_flags": null,
    "driver": true,
    "belongs_to_partner": false,
    "external_id": "1",
    "battery": null,
    "mobile_type": null,
    "driver_sign_in_count": 0,
    "driver_current_sign_in_at": null,
    "driver_last_sign_in_at": null,
    "current_task_id": null,
    "mobile_version": null,
    "dispatcher": false,
    "authorization_flags": {},
    "blocked_email": false,
    "default_user_activity": 5,
    "dispatcher_push_token": null,
    "device_model": null,
    "language": null,
    "estimated_last_waypoint_id": null,
    "estimated_last_lat": null,
    "estimated_last_lng": null,
    "estimated_last_etl": null,
    "num_ratings": 0,
    "force_change_password_token": null,
    "force_change_password_date": null,
    "user_type_id": null,
    "estimated_last_address": null,
    "at_home": false,
    "confirmation_code_sent_at": null,
    "company": null,
    "eta_to_home": null,
    "privilege_id": null,
    "private_vehicle": true,
    "vehicle_type_id": null
  }
}

Body Params

name
string
email
string
phone
string
password
string
admin
boolean
dispatcher
boolean
driver
boolean
job_description
string
team_ids
array of integers
 
Suggest Edits

Get User

Get all the details on a particular user via their User ID

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
    "id" : 12345
}
A binary file was returned

You couldn't be authenticated

{
  "id": 12345,
  "name": "Driver Name",
  "status": "offline",
  "sub": null,
  "lat": null,
  "lng": null,
  "profile_image": "/images/avatar.png",
  "authentication_token": null,
  "phone": "+15555555555",
  "admin": false,
  "driver": true,
  "dispatcher": false,
  "current_task": null,
  "beta": false,
  "debug": false,
  "email": "",
  "job_description": null,
  "driver_current_sign_in_at": null,
  "driver_sign_in_count": 0,
  "average_rating": null,
  "num_ratings": 0,
  "last_sign_in_at": null,
  "active_shift_id": null,
  "created_at": "2017-02-28T10:28:55.341Z",
  "partner_user": false,
  "feature_flags": null,
  "authorization_flags": {},
  "confirmed_at": null,
  "confirmation_sent_at": null,
  "battery": null,
  "uuid": "a9d7bc52-faa9-4ff0-a7f8-2280c2e84ad6",
  "mobile_type": null,
  "mobile_version": null,
  "device_model": null,
  "default_user_activity": 5,
  "language": null,
  "merchant_id": 10570,
  "locked": false,
  "user_type_id": null,
  "privilege_id": null,
  "estimated_last_address": null,
  "estimated_last_lat": null,
  "estimated_last_lng": null,
  "estimated_last_etl": null,
  "at_home": false,
  "company": null,
  "private_vehicle": true,
  "team_ids": []
}

Body Params

id
int32

User ID

 
Suggest Edits

Update User

Update a User - Admin, Dispatcher or Driver

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"id" : 12345,
	"user": {
		"name": "New driver name",
		"driver" : true,
		"job_description" : "Job description goes here",
		"language" : "es",
		"phone" : "0555555555",
		"external_id" : "DriverA"
	},
	"team_ids" : [12345],
	"password" : "ABC123456"
}
A binary file was returned

You couldn't be authenticated

{
  "success": true,
  "user": {
    "id": 12345,
    "name": "New driver name",
    "status": "offline",
    "sub": "Free",
    ....
}

Body Params

id
int32

This is the ID of the user

name
string

Name of driver / user

email
string
phone
string
job_description
string
admin
boolean

Is the user an Admin?

dispatcher
boolean

Is the user a Dispatcher?

driver
boolean

Is the user a Driver?

default_user_activity
int32
language
string
company
string
home_address
string
home_lat
string
home_lng
string
external_id
string
password
string
team_ids
array of integers
 

Please note: Except for id, all the params are nested within the "user" object.

Activity Types

0 - Unknown
1 - Stationary
2 - Walking
3 - Running
4 - Bicycle
5 - Driving

Suggest Edits

Import Users From CSV

Upload a CSV file and import users in bulk

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
curl --request POST \
  --url https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

File
string

CSV file

 

How to configure user field

Currently structure of CSV can only be done with the help of our support. In the future we will also enable UI configuration.

Suggest Edits

Start Shift

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
curl --request POST \
  --url https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{success: true}

Body Params

user_id
int32

ID of driver to start the shift

 
Suggest Edits

End Shift

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
curl --request POST \
  --url https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{success: true}

Body Params

user_id
int32

User id of the driver to end the shift for

 
Suggest Edits

Arrived to Location (Check-in)

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
  "id": 1234
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32

Will update task status to "check-in" (status=3)

 
Suggest Edits

Left Location (Check-out)

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"id":1234
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32

Will update task status to "done" (status=4)

 
Suggest Edits

Create Customer

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
  "customer": {
    "external_id": "EXT123",
    "name": "John Smith",
    "address": "1405 Lexington Ave, New York",
    "phone": "555-555-5555",
    "email": "john@company.com"
  }
}
A binary file was returned

You couldn't be authenticated

{success: true, rc: 0, customer: [customer]}

Path Params

Customer
object
required

See below for more info

 

Body Params

name
string
address
string

This address needs to be geo-located in Google Maps

address_second_line
string

This is where the extra address information goes e.g. "First floor", "Apartment 1"

lat
int32

Latitude of customer's address

long
int32

Longitude of customer's address

phone
int32
email
string
external_id
string

This is the ID of the Customer in your database

zipcode
string
borough
string
city
string
allow_sending_sms
boolean

Do you want the Customer to receive SMS notifications? e.g. if the customer is a restaurant (1st waypoint), you might not want them to receive SMSes

allow_sending_email
boolean

Do you want the Customer to receive email notifications? e.g. if the customer is a restaurant (1st waypoint), you might not want them to receive emails

 

Customer Object:

Name:
Address:
Address_second_line:
lat:
lng:
phone:
image:
email:
external_id:
zipcode:
city:
allow_sending_sms:
borough:

Suggest Edits

Update Customer

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"id" : 123456,
	"name": "Updated customer name",
	"external_id": "New9876",
	"address" : "New Street Address, London",
	"address_second_line" : "1st floor",
	"phone" : "0551111111",
	"email" : "new@email.com"
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "rc": 0,
    "customer": {
        "id": 123456,
        "name": "Updated customer name",
        "address": "New Street Address, London",
        "lat": 51.5073509,
        "lng": -0.1277583,
        "created_at": "2017-08-27T10:05:53.224Z",
        "updated_at": "2017-08-27T11:22:27.751Z",
        "phone": "+972551111111",
        "merchant_id": 10570,
        "image": null,
        "access_token": "c2c84424-0341-4d6b-af8f-d716ae53d85b",
        "confirmation_code": "2958",
        "salt": null,
        "approved": false,
        "push_token": null,
        "uuid": "7003205c-ac2b-41ad-aa48-ee253dcf94cc",
        "email": "new@email.com",
        "external_id": "New9876",
        "delete_at": null,
        "facebook_id": null,
        "extras": null,
        "original_lat_lng_changed": null,
        "encrypted_password": "",
        "blocked_email": false,
        "address_second_line": "1st floor",
        "zipcode": null,
        "allow_login": false,
        "stripe_id": null,
        "original_phone_number": "0551111111",
        "last_open_at": null,
        "last_order_at": null,
        "uploaded_profile_image": {
            "url": null
        },
        "original_lat": null,
        "original_lng": null,
        "consecutive_checkins_out_of_geofence": 0,
        "allow_sending_email": true,
        "allow_sending_sms": true,
        "reset_password_token": null,
        "reset_password_sent_at": null,
        "mobile_version": null,
        "mobile_type": 0,
        "mobile_maker": null,
        "client_version": null,
        "client_name": null,
        "city": null,
        "borough": null,
        "state": null,
        "dev": false,
        "business_code": null,
        "language": null,
        "district": null,
        "house_number": null,
        "street": null
    }
}

Body Params

id
int32
required

Customer ID in Bringg

name
string

Customer Name

external_id
string

Customer ID specified in your system

address
string
address_second_line
string
phone
string
email
string
 
Suggest Edits

Create Team

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
  "team": {
    "name": "New team",
    "merchant_id": 12345,
    "description": "Team description",
    "address": "416 Water St. New York, NY 10002",
    "external_id": "12345",
    "zipcode": "12345",
    "lat": "45.5",
    "lng": "312.5",
    "contact_phone":"+15555555",
    "time_zone":"America/Los_Angeles"
  }
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

merchant_id
int32
required

Company ID

name
string
required

Team name

description
string
address
string
external_id
string
zipcode
string
lat
string
lng
string
contact_phone
string
time_zone
string
 
Suggest Edits

Show All Teams

Get a list of all the teams for a particular merchant account

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
    "id" : 12345
}
A binary file was returned

You couldn't be authenticated

{
  "teams": [
    {
      "name": "London Team",
      "description": "London",
      "parent_team_id": null,
      "merchant_id": 12345,
      "id": 4248,
      "external_id": "",
      "extras": null,
      "contact_phone": "5555555555",
      "lat": null,
      "lng": null,
      "address": null,
      "distance_pay_per_km": null,
      "allow_access_to_all_open_tasks": null,
      "time_zone": "America/New_York",
      "home_area": [],
      "service_zipcodes": [
        "N5V",
        "n5w",
        "N6a6k3",
        "n6b3b6",
        "N5V 3V7",
        "5678"
      ],
      "service_boroughs": [],
      "service_cities": [
        "london"
      ],
      "required_coc_type": 0,
      "beacon_ids": []
    },
    {
      "name": "Tel Aviv Team",
      "description": null,
      "parent_team_id": null,
      "merchant_id": 12345,
      "id": 8419,
      "external_id": "8419",
      "extras": null,
      "contact_phone": null,
      "lat": null,
      "lng": null,
      "address": null,
      "distance_pay_per_km": null,
      "allow_access_to_all_open_tasks": null,
      "time_zone": "Asia/Jerusalem",
      "home_area": [],
      "service_zipcodes": [
        "123",
        "456",
        "1234"
      ],
      "service_boroughs": [
        "mercaz"
      ],
      "service_cities": [
        "tel aviv"
      ],
      "required_coc_type": 0,
      "beacon_ids": []
    },
    {
      "name": "New York Team",
      "description": null,
      "parent_team_id": null,
      "merchant_id": 12345,
      "id": 8492,
      "external_id": "8492",
      "extras": null,
      "contact_phone": null,
      "lat": null,
      "lng": null,
      "address": null,
      "distance_pay_per_km": null,
      "allow_access_to_all_open_tasks": null,
      "time_zone": "America/New_York",
      "home_area": [],
      "service_zipcodes": [
        "123456"
      ],
      "service_boroughs": [
        "staten island",
        "staten",
        "manhattan",
        "bronx"
      ],
      "service_cities": [
        "new york"
      ],
      "required_coc_type": 0,
      "beacon_ids": []
    }
  ],
  "success": true
}

Body Params

id
int32

This is the Merchant ID

 
Suggest Edits

Get Team Details

Get all the details about a Team from its ID

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
    "id" : 1234
}
A binary file was returned

You couldn't be authenticated

{
  "success": true,
  "team": {
    "name": "Acme Team",
    "description": null,
    "parent_team_id": null,
    "merchant_id": 12345,
    "id": 1234,
    "external_id": "1234",
    "extras": null,
    "contact_phone": null,
    "lat": null,
    "lng": null,
    "address": null,
    "distance_pay_per_km": null,
    "allow_access_to_all_open_tasks": null,
    "time_zone": "America/New_York",
    "home_area": [],
    "service_zipcodes": [
      "123",
      "456",
      "1234"
    ],
    "service_boroughs": [
      "bronx"
    ],
    "service_cities": [
      "new york"
    ],
    "required_coc_type": 0,
    "beacon_ids": []
  }
}

Body Params

id
int32

Specify the Team ID

 
Suggest Edits

Update Team

Update the details of a Team.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
    "id" : 1234,
    "team": {
        "name": "New Team Name",
      	"description": "Updated description"
    }
}
A binary file was returned

You couldn't be authenticated

{
  "success": true,
  "team": {
    "id": 1234,
    "name": "New Team Name",
    "description": "Updated description",
    ....
}

Body Params

id
int32

This is the relevant Team ID you are updating.

name
string

Name of the team

description
string

Team description

address
string

Home base / address of the team

external_id
string

The ID of the Team in your database

zipcode
string

Zipcode of the team

lat
int32

Latitude co-ordinate of the team's address

long
int32

Longitude co-ordinate of the team's address

contact_phone
int32

Team phone number

time_zone
string

e.g. "America/Chicago"

 

Please note: Except for id, all the other params are nested within the team object.

Suggest Edits

Delete Team

Delete a team by specifying its ID

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
    "id" : 12345
}
A binary file was returned

You couldn't be authenticated

{
  "success": true,
  "message": "Team deleted"
}

Body Params

id
int32

This is the Team ID

 
Suggest Edits

Get Share

Receives share location if allowed and if task has been started by the driver.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
    "id" : 12345
}
A binary file was returned

You couldn't be authenticated

{
  "shared_location": {
    "id": 3258206,
    "url": "https://app.bringg.com/she.html?9420334d",
    "expired": false,
    "way_point_id": 3938924,
    "customer_id": 123456,
    "first_seen_on": null,
    "failure_reason": null,
    "shared_successfully": null,
    "shared_on": "2017-04-30T16:17:24.472Z",
    "view_counter": 0,
    "uuid": "9420334d",
    "sharing_method": 5,
    "was_forwarded": false
  },
  "success": true
}

Body Params

id
int32
 
Suggest Edits

Create Customer

Create a Customer

 
posthttps://developer-api.bringg.com/partner_api/customers
<?
$url = 'http://developer-api.bringg.com/partner_api/customers';

$data_string = array(
  'access_token' => "<YOUR ACCESS TOKEN>",
  'timestamp' => date('Y-m-d H:i:s'),
  'name' => "test c",
	'company_id' => "<THE COMPANY ID>",
	'email' => "abctest@test.com",
  'allow_sending_sms' => "true"
);
$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);

?>
{
	"name": "Ralph M. Anderson",
	"company_id": 1,
	"address": "3895 Ray Court Pinehurst, NC 28374",
	"address_second_line": "2nd line",
	"phone": "910-295-9731",
	"email": "ralph@domain.com",
	"lat": 32.453453,
	"lng": 34.434233,
	"external_id": "1234",
	"allow_login": true,
	"confirmation_code": "1234",
	"allow_sending_email": false,
	"allow_sending_sms": false,
	"timestamp": "1414421210832",
	"access_token": "K6PAAwvx6-3PtAA4zvEV",
	"signature": "db00061fa75f869c968f72d48449e457ae06959a"
}
A binary file was returned

You couldn't be authenticated

{
	"success": true,
	"customer": {
		"id": 16439,
		"name": "Mr. Customer",
		"address": "3895 Ray Court Pinehurst, NC 28374",
		"address_second_line": null,
		"zipcode": null,
		"borough": null,
		"city": null,
		"state": null,
		"lat": 35.3456518,
		"lng": -79.4190808,
		"phone": "+19174378391",
		"image": "/images/avatar.png",
		"email": "Customer7752@bringg.com",
		"company_id": 9910,
		"external_id": "7752",
		"confirmation_code": "7752"
	}
}
{
    "success": false,
    "message": "failure description"
}

Body Params

name
string
required

Name of customer

company_id
int32
required

Unique identifier representing a company (Merchant ID)

address
string

Address of customer

address_second_line
string

2nd line of address

phone
string
required

Phone of customer. Required (if no E-mail)

email
string

E-mail of customer. Required (if no Phone)

lat
double

Latitude component of customer location

lng
double

Longitude component of customer location

external_id
string

Customer external ID

allow_login
boolean

Access customer to login (values: "true", "false" or 0, 1)

confirmation_code
string

Confirmation code to approve login via phone number

allow_sending_email
boolean

Allows to opt out of email sharing for customer (values: "true", "false" or 0, 1)

allow_sending_sms
boolean

Allows to opt out of phone sharing for customer (values: "true", "false" or 0, 1)

language
string

2-letter language code e.g. "en", "fr". Used to set the language in which the Customer App appears (if you want it to be different from the merchant account default)

 

The Create Customer endpoint creates a new customer entity. The customer must be created with either phone or e-mail.
If a customer with the same phone or e-mail exists - the existing customer will be updated and returned and a new customer won't be created.

What is Customer?

A customer is a person waiting somewhere. This is the person we don’t want to be waiting unknowingly: whether they are the restaurant waiting for the driver pick up or the consumer waiting for their food - they are both contacts the driver will see and will communicate with.

What is Confirmation Code?

This is a String, generated by you, that is used to help in the verification of the customer's identity when authenticating by phone number.

Using the Mobile SDK

if you are using the mobile sdk and would want to sign-in your customer using bringg, your create customer request must include:
1) confirmation_code.
2) allow_login : true

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{ \"company_id\": 1, \"name\": \"Ralph M. Anderson\", \"email\": \"ralph@domain.com\", \"address\": \"3895 Ray Court Pinehurst, NC 28374\", \"phone\": \"910-295-9731\", \"lat\": 32.453453, \"lan\": 34.434233, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/customers/
Suggest Edits

Update Customer

Update a Customer

 
patchhttps://developer-api.bringg.com/partner_api/customers/id
curl --request PATCH \
  --url https://developer-api.bringg.com/partner_api/customers/id
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://developer-api.bringg.com/partner_api/customers/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/customers/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://developer-api.bringg.com/partner_api/customers/id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/customers/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "customer": {
        "id": 1,
        "name": "Ralph M. Anderson",
        "address": "3895 Ray Court Pinehurst, NC 28374",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "910-295-9731",
        "email": "ralph@domain.com",
        "confirmation_code": "12345"
    }
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a customer

Body Params

company_id
int32
required

Unique identifier representing a company

name
string

Name of customer

address
string

Address of customer

address_second_line
string

2nd line of address

phone
string

Phone of customer

email
string

E-mail of customer

lat
double

Latitude component of customer location

lng
double

Longitude component of customer location

external_id
string

Customer external ID

confirmation_code
string

Confirmation code for the customer

customer_access_token
string

Access token of customer for a login process

allow_sending_email
boolean

Allows to opt out of email sharing for customer

allow_sending_phone
boolean

Allows to opt out of phone sharing for customer

language
string

2-letter language code e.g. "en", "fr". Used to set the language in which the Customer App appears (if you want it to be different from the merchant account default)

 

The Update Customer endpoint can modify each and every attribute of an existing customer.

curl --include \
     --request PATCH \
     --header "Content-Type: application/json" \
     --data-binary "{ \"company_id\": 1, \"name\": \"Ralph M. Anderson\", \"email\": \"ralph@domain.com\", \"address\": \"3895 Ray Court Pinehurst, NC 28374\", \"phone\": \"910-295-9731\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/customers/{id}
Suggest Edits

Get Customer

Get a Customer

 
gethttps://developer-api.bringg.com/partner_api/customers/id
curl --request GET \
  --url 'https://developer-api.bringg.com/partner_api/customers/id?company_id=company_id'
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/customers/id',
  qs: { company_id: 'company_id' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/customers/id?company_id=company_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/customers/id?company_id=company_id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/customers/id"

querystring = {"company_id":"company_id"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"success": true,
	"customer": {
		"id": 289715,
		"name": "Mr. Customer",
		"address": null,
		"address_second_line": null,
		"zipcode": null,
		"borough": null,
		"city": null,
		"state": null,
		"lat": null,
		"lng": null,
		"phone": "+19172127764",
		"image": "/images/avatar.png",
		"email": "",
		"company_id": 1,
		"external_id": "289715",
		"confirmation_code": "4930"
	}
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a user

Query Params

company_id
int32
required

Unique identifier representing a company

timestamp
string

Current system time in miliseconds

access_token
string

Provided developer access token

signature
string

Signature encoded using the private key

 

The Get Customer endpoint returns details about a single customer by it's phone number.

curl --include \
     -X GET \
     -H "Content-Type: application/json", "Authorization: authKey" \
https://developer-api.bringg.com/partner_api/{id}
Suggest Edits

Get By Phone

Get a Customer by phone

 
gethttps://developer-api.bringg.com/partner_api/customers/phone/phone
curl --request GET \
  --url 'https://developer-api.bringg.com/partner_api/customers/phone/phone?company_id=company_id'
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/customers/phone/phone',
  qs: { company_id: 'company_id' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/customers/phone/phone?company_id=company_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/customers/phone/phone?company_id=company_id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/customers/phone/phone"

querystring = {"company_id":"company_id"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"success": true,
	"customer": {
		"id": 4,
		"name": " ",
		"address": "2407 West North Ave. Melrose Park, IL 60160",
		"address_second_line": null,
		"zipcode": "60160",
		"borough": null,
		"city": null,
		"state": null,
		"lat": 41.9088878,
		"lng": -87.8629193,
		"phone": "+19175271294",
		"image": "/images/avatar.png",
		"email": null,
		"company_id": 9910,
		"external_id": "4",
		"confirmation_code": "7853"
	}
}
{
    "success": false,
    "message": "failure description"
}

Path Params

phone
string
required

Phone of user

Query Params

company_id
int32
required

Unique identifier representing a company

 

The Get Customer endpoint returns details about a single customer by it's phone number.

curl --include \
     -X GET \
     -H "Content-Type: application/json", "Authorization: authKey" \
http://api.bringg.com/partner_api/customers/{phone}
Suggest Edits

Delete Customer

Delete unused customers

 
deletehttps://developer-api.bringg.com/partner_api/customers/customer_id
curl --request DELETE \
  --url https://developer-api.bringg.com/partner_api/customers/customer_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://developer-api.bringg.com/partner_api/customers/customer_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/customers/customer_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://developer-api.bringg.com/partner_api/customers/customer_id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/customers/customer_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

customer_id
int32
required

Body Params

company_id
int32
 

Notice: only unused customers can be deleted

If a customer belongs to an undeleted task or way point, the deletion would fail and a response explaining the reason will be returned

Suggest Edits

Customers

Get all customers

 
gethttps://developer-api.bringg.com/partner_api/customers
curl --request GET \
  --url 'https://developer-api.bringg.com/partner_api/customers?company_id=company_id'
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/customers',
  qs: { company_id: 'company_id' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/customers?company_id=company_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/customers?company_id=company_id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/customers"

querystring = {"company_id":"company_id"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
        "id": 1,
        "name": "Ralph M. Anderson",
        "address": "3895 Ray Court Pinehurst, NC 28374",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "910-295-9731",
        "email": "ralph@domain.com",
        "confirmation_code": "12345"},
  {
        "id": 2,
        "name": "Ralph M. Anderson",
        "address": "3895 Ray Court Pinehurst, NC 28374",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "910-295-9731",
        "email": "ralph@domain.com",
        "confirmation_code": "12345"},
  {
        "id": 3,
        "name": "Ralph M. Anderson",
        "address": "3895 Ray Court Pinehurst, NC 28374",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "910-295-9731",
        "email": "ralph@domain.com",
        "confirmation_code": "12345"}
]
{
    "success": false,
    "message": "failure description"
}

Query Params

company_id
int32
required

Unique identifier representing a company

page
int32

page number (each returns 50 results)

 

The Customers endpoint returns information about all customers.

curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/customers
Suggest Edits

Customer Count

Receive customer count

 
gethttps://developer-api.bringg.com/partner_api/customers/count
curl --request GET \
  --url https://developer-api.bringg.com/partner_api/customers/count
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/customers/count' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/customers/count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/customers/count");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/customers/count"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{success: true, customer_count: 1000}
 
Suggest Edits

Create Task

Create a new task

 
posthttps://developer-api.bringg.com/partner_api/tasks
<?
$url = 'http://developer-api.bringg.com/partner_api/tasks';

$data_string = array(
	'access_token' => "<YOUR ACCESS TOKEN>",
	'timestamp' => date('Y-m-d H:i:s'),
	'company_id' => <THE COMPANY ID>,
	'customer_id' => 2,
	'title' => "Pizza Delivery",
	'address' => "416 Water St. New York, NY 10002",
	'scheduled_at' => "2014-11-29T04:16:00-5",
	'team_id' => 4,
	'lat' => 45.5,
	'lan' => 12.5,
	'inventory' => '[{"id": 72407, "original_quantity":25, "quantity":0}, {"id": 72408, "original_quantity":20, "quantity":0}]',
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
?>
{
	"access_token": "[FILTERED]",
	"timestamp": "2017-03-09 13:22:39",
	"company_id": 10570,
	"customer_id": 957226,
	"title": "Pizza Delivery",
	"address": "416 Water St. New York, NY 10002",
	"lat": 12.9715987,
	"lng": 77.5945627,
	"note": "Product Name: ??? x 2",
	"scheduled_at": "2017-03-19T14:16:09.123Z",
	"team_id": 8419,
	"inventory": "[{\"id\": 72407, \"original_quantity\":25, \"quantity\":0}, {\"id\": 72408, \"original_quantity\":20, \"quantity\":0}]",
	"signature": "9efceaa32107b9d2053e1c57d1917ab0038fd314"
}
A binary file was returned

You couldn't be authenticated

{
  "success": true,
  "task": {
    "title": "Test Order 999",
    "user_id": null,
    "created_at": "2016-11-14T13:16:07.435Z",
    "scheduled_at": "2016-11-30T16:16:09.123Z",
    "lat": 0.0,
    "lng": 34.8340582,
    "status": 0,
    "id": 140,
    "address": "",
    "active_way_point_id": 210,
    "started_time": null,
    "ended_time": null,
    "asap": false,
    "late": false,
    "late_reason": null,
    "extras": null,
    "company_name": null,
    "external_id": "140",
    "uuid": "2ba9f7e5-dc93-460e-a611-9955ba746db4",
    "priority": 140,
    "total_price": null,
    "delivery_price": null,
    "left_to_be_paid": null,
    "distance_traveled": null,
    "cancelled_at": null,
    "discount": null,
    "tip_driver_enabled": false,
    "customer": {
      "id": 2,
      "name": "John Smith",
      "address": "",
      "address_second_line": "",
      "zipcode": null,
      "lat": 0.0,
      "lng": 34.8340582,
      "phone": "+1555555555",
      "image": "/images/avatar.png",
      "email": "",
      "company_id": 2,
      "external_id": "11437",
      "confirmation_code": "3333"
    },
    "user": null,
    "task_notes": [
      {
        "title": "14 Nov, 2016 01:16 PM, by unknown",
        "note": {
          "headers": "",
          "data": ""
        },
        "created_at": "2016-11-14T13:16:07.507Z",
        "author_name": "SPICE AS 5",
        "id": 68,
        "way_point_id": 210,
        "url": null,
        "type": "FormattedTaskNote",
        "user_id": null
      }
    ],
    "way_points": [
      {
        "id": 210,
        "scheduled_at": "2016-11-30T16:16:09.123Z",
        "task_id": 140,
        "customer_id": 2,
        "done": false,
        "lat": 0.0,
        "lng": 34.8340582,
        "address": "",
        "address_second_line": "",
        "zipcode": null,
        "position": 1,
        "checkin_time": null,
        "checkin_lat": null,
        "checkin_lng": null,
        "checkout_time": null,
        "checkout_lat": null,
        "checkout_lng": null,
        "note": null,
        "find_me": false,
        "asap": false,
        "late": false,
        "etl": "2016-11-30T16:21:09.123Z",
        "eta": null,
        "silent": false,
        "automatic_checkin": false,
        "automatic_checkout": false,
        "phone": "+97223333338",
        "title": null,
        "no_later_than": null,
        "no_earlier_than": null,
        "customer": {
          "id": 2,
          "name": "Jane Doe",
          "address": "",
          "address_second_line": "",
          "zipcode": null,
          "lat": 0.0,
          "lng": 34.8340582,
          "phone": "+1555222222",
          "image": "/images/avatar.png",
          "email": "",
          "company_id": 2,
          "external_id": "11437",
          "confirmation_code": "3333"
        },
        "rating": null,
        "scans": []
      }
    ],
    "shared_locations": [],
    "task_inventories": [],
    "team_ids": []
  }
}
{
    "success": false,
    "message": "failure description"
}

Body Params

customer_id
int32
required

Unique identifier representing a customer

company_id
int32
required

Unique identifier representing a company. required only if developer has more than one company

user_id
int32

Unique identifier representing a user

title
string

Title of order

team_id
int32

Unique identifier representing a team

silent
boolean

Cancel notifications for customer

note
string

Note to the driver

formatted_note
string
scheduled_at
string

Scheduled time for order (format: %Y-%m-%dT%H:%M:%S%z)

asap
boolean

Sets scheduled time for order to now

lat
double

Latitude component of way point location

lng
double

Longitude component of way point location

address
string

Address of way point

address_second_line
string

2nd line of address

extras

Custom parameters

external_id
string

External ID used for displaying purposes only

place_id
int32

Place ID

total_price
double

Price of order

left_to_be_paid
double

Cash part of the payment

delivery_price
double

Delivery Fee

priority
int32

Priority of the task, if used

price_before_tax
double
tax_price
double
inventory
array of mixed types

inventory attached to this task, for example inventory: 'inventory' => '[{"id": 10, "quantity":25}, {"id": 11, "quantity":20}]'

anonymous
boolean

Creates an anonymous customer instead of a real one

share_location
boolean

Create a shared location context and return its id for usage in tracking SDK

tag_id
int32

Tag ID

task_type
int32

Task type id represents a predefined tasks that has a predefined duration. To enable this paid feature please speak to your account manager

 

The Create Task endpoint creates a new task entity with a single way point. For creating task with more than one way point use Create Task with Way Points .

What is Task?

Tasks and Orders are the “unit of action” which connects between the company, the driver and the customer. A task has from one to many customers (or contacts), one to many waypoints where the driver has to stop, it has notes, images and other meta data optionally attached to it. It is required to create a customer before creating the task, and using the ID returned in the call to create task.

Task Status map

created: 0, assigned: 1, on_the_way: 2, checked_in: 3, done: 4, :accepted: 6, cancelled: 7, rejected: 8, unacknowledged: 9

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{ \"title\": \"Pizza Delivery\", \"address\": \"416 Water St. New York, NY 10002\", \"scheduled_at\": \"2014-11-29T04:16:09.123Z\", \"company_id\": 154, \"team_id\": 4, \"lat\": 45.5, \"lan\": 12.5, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/
Suggest Edits

Create Task with Way Points

Create a new task with more than one way point

 
posthttps://developer-api.bringg.com/partner_api/tasks/create_with_way_points
<?
$url = 'https://developer-api.bringg.com/partner_api/tasks/create_with_way_points';

$data_string = array(
  	'access_token' => "<YOUR ACCESS TOKEN>",
  	'timestamp' => date('Y-m-d H:i:s'),
  	'customer_id' => '<CUSTOMER ID>',
  	'company_id' => '<YOUR COMPANY ID>',
  	'way_points' => json_encode(array(
    	array(
      		'customer_id' => '<CUSTOMER 1 ID>',
	      	'address' => '',
    	  	'lat' => '',
      		'lng' => '',
	      	'scheduled_at' => ''
   		 ),
    	array(
	 	  	'customer_id' => '<CUSTOMER 2 ID>',
	      	'address' => '',
   	   		'lat' => '',
    			'lng' => '',
    	  	'scheduled_at' => '',
          'delivery_confirmation_signature' => '2'
    	)
  	))
);
$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
?>
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "task": {
        "id": 1,
        "title": "Pizza Delivery",
        "address": "416 Water St. New York, NY 10002",
        "scheduled_at": "2014-12-29T04:16:09.123Z",
        "company_id": 154,
        "team_id": 4,
        "lat": 45.5,
        "lan": 12.5,
        "way_points": [
            {
                "id": 1,
                "customer_id": 1,
                "scheduled_at": "2013-10-17T22:47:58.000Z",
                "address": "416 Water St. New York, NY 10002",
                "lat": 32.4345345,
                "lng": 34.534534
            },
            {
                "id": 2,
                "customer_id": 1,
                "scheduled_at": "2013-10-17T22:47:58.000Z",
                "address": "416 Water St. New York, NY 10002",
                "lat": 32.4345345,
                "lng": 34.534534
            },
            {
                "id": 3,
                "customer_id": 1,
                "scheduled_at": "2013-10-17T22:47:58.000Z",
                "address": "416 Water St. New York, NY 10002",
                "lat": 32.4345345,
                "lng": 34.534534
            }
        ]
    }
}
{
    "success": false,
    "message": "failure description"
}

Body Params

customer_id
int32
required

Unique identifier representing a customer

company_id
int32
required

Unique identifier representing a company. required only if developer has more than one company

user_id
int32

Unique identifier representing a user

title
string

Title of task

team_id
int32

Unique identifier representing a team

silent
boolean

Cancel notifications for customer

note
string

Note to the driver

extras

Custom parameters

way_points
array of mixed types

List of the task's way points

 

The Create Task with Way Points endpoint creates a new task entity with a more than one way point (To create a task with a single way point, use Create Task).

curl --include 
			--request POST 
      --header "Content-Type: application/json" 
      --data-binary "{\"title\":\"Pizza Delivry\",\"company_id\":154,\"customer_id\":197,\"way_points\":[{\"address\":\"416 Water St. New York, NY 10002\",\"scheduled_at\":\"2014-12-29T04:16:09.123Z\",\"lat\":45.5,\"lng\":12.5}],\"timestamp\":1468925734,\"access_token\":\"Qy7DBBsmo3J_f1hpybY4\",\"signature\":\"2c54a1d4b025883a853d5f8c9463c7305eff1aa4\"}"
 http://localhost:3000/partner_api/tasks/create_with_way_points
Suggest Edits

Create Task From CSV

Upload a csv file of tasks per configuration as described here: http://bringg.com/user-guide/using-the-dashboard/importing-csv-files/

 
posthttps://developer-api.bringg.com/partner_api/v1/tasks/create_from_csv
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/v1/tasks/create_from_csv
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/v1/tasks/create_from_csv' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/v1/tasks/create_from_csv")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/v1/tasks/create_from_csv");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/v1/tasks/create_from_csv"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{success: true}
{success: false}

Body Params

csv_file_url
string

URL to download the CSV from

 

Notice: This is a beta only feature - you need to request to get access to this API

Suggest Edits

Update Task

Update a Task

 
patchhttps://developer-api.bringg.com/partner_api/tasks/id
<?
$url = 'http://developer-api.bringg.com/partner_api/tasks/1234567';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s'),
 'company_id' => <YOUR COMPANY ID>,
 'title' => "Updated title",
 'team_id' => 1234
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
?>
{
	"title": "Pizza Delivery",
	"address": "416 Water St. New York, NY 10002",
	"scheduled_at": "2014-19-29T04:16:09.123Z",
	"company_id": 154,
	"team_id": 4,
	"lat": 45.5,
	"lan": 12.5,
	"inventory": "[{\"id\": 72407, \"quantity\":25}, {\"id\": 72408, \"quantity\":20}]",
	"timestamp": "1414421210832",
	"access_token": "[FILTERED]",
	"signature": "db000623e3e23e968f72d48449e457ae06959a"
}
A binary file was returned

You couldn't be authenticated

{
    "id": 1,
    "title": "Pizza Delivery",
    "address": "416 Water St. New York, NY 10002",
    "scheduled_at": "2014-19-29T04:16:09.123Z",
    "company_id": 154,
    "team_id": 4,
    "lat": 45.5,
    "lan": 12.5
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a task (path parameter - not required in the body)

Body Params

company_id
int32
required

Unique identifier representing a company. required only if developer has more than one company

customer_id
int32

Unique identifier representing a customer

user_id
int32

Unique identifier representing a user

title
string

Title of order

extras

Custom parameters

total_price
double

Price of order

status
int32

For cancel task: update task with status => 7

team_id
int32
priority
int32

Position of an order in a route

 

The Update Task endpoint can modify each and every attribute of an existing task.

curl --include \
     --request PATCH \
     --header "Content-Type: application/json" \
     --data-binary "{ \"title\": \"Pizza Delivery\", \"address\": \"416 Water St. New York, NY 10002\", \"scheduled_at\": \"2014-19-29T04:16:09.123Z\", \"company_id\": 154, \"team_id\": 4, \"lat\": 45.5, \"lan\": 12.5, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{id}
Suggest Edits

Start Task

Remotely start a task

 
posthttps://developer-api.bringg.com/partner_api/tasks/id/start
<?
$url = 'http://developer-api.bringg.com/partner_api/tasks/<TASK ID>/start';

$data_string = array(
  	'access_token' => "<YOUR ACCESS TOKEN>",
  	'timestamp' => date('Y-m-d H:i:s'),
	  'company_id' => "<YOUR COMPANY ID>"
);
$secret_key = "<YOUR SECRET KEY>";


// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);

?>
A binary file was returned

You couldn't be authenticated

{
    "success": true
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
string
required

Unique identifier representing a task

Body Params

company_id
string
required

Unique identifier representing a company

 

The Start Task endpoint changes the status of the task to * on_the_way". Read more about the different types of task statuses Task Status.

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{id}/start
Suggest Edits

Cancel Task

A shortcut to cancel a task

 

To cancel a task what you would actually do is update a task with status CANCELLED

Call Update Task with Task Status cancelled

Suggest Edits

Tasks

The Tasks endpoint returns information about all tasks.

 
gethttps://developer-api.bringg.com/partner_api/tasks
<?
$url = 'http://developer-api.bringg.com/partner_api/tasks';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s'),
 'company_id' => <THE COMPANY ID>,
 'page' => 3
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
?>
A binary file was returned

You couldn't be authenticated

[
    {
        "id": 1,
        "title": "Pizza Delivery",
        "address": "416 Water St. New York, NY 10002",
        "scheduled_at": "2014-19-29T04:16:09.123Z",
        "company_id": 154,
        "team_id": 4,
        "lat": 45.5,
        "lan": 12.5
    },
    {
        "id": 2,
        "title": "Pizza Delivery",
        "address": "416 Water St. New York, NY 10002",
        "scheduled_at": "2014-19-29T04:16:09.123Z",
        "company_id": 154,
        "team_id": 4,
        "lat": 45.5,
        "lan": 12.5
    },
    {
        "id": 3,
        "title": "Pizza Delivery",
        "address": "416 Water St. New York, NY 10002",
        "scheduled_at": "2014-19-29T04:16:09.123Z",
        "company_id": 154,
        "team_id": 4,
        "lat": 45.5,
        "lan": 12.5
    }
]
{
    "success": false,
    "message": "failure description"
}

Query Params

company_id
int32
required

Unique identifier representing a company

page
int32

page number (each returns 50 results)

 

The Tasks endpoint returns information about all tasks.

curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks
Suggest Edits

Opened Tasks

Get a list of currently opened tasks

 
gethttps://developer-api.bringg.com/partner_api/tasks/open
curl --request GET \
  --url 'https://developer-api.bringg.com/partner_api/tasks/open?company_id=company_id'
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/tasks/open',
  qs: { company_id: 'company_id' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/tasks/open?company_id=company_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/tasks/open?company_id=company_id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/tasks/open"

querystring = {"company_id":"company_id"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
    {
        "id": 1,
        "title": "Pizza Delivery",
        "address": "416 Water St. New York, NY 10002",
        "scheduled_at": "2014-19-29T04:16:09.123Z",
        "company_id": 154,
        "team_id": 4,
        "lat": 45.5,
        "lan": 12.5
    },
    {
        "id": 2,
        "title": "Pizza Delivery",
        "address": "416 Water St. New York, NY 10002",
        "scheduled_at": "2014-19-29T04:16:09.123Z",
        "company_id": 154,
        "team_id": 4,
        "lat": 45.5,
        "lan": 12.5
    },
    {
        "id": 3,
        "title": "Pizza Delivery",
        "address": "416 Water St. New York, NY 10002",
        "scheduled_at": "2014-19-29T04:16:09.123Z",
        "company_id": 154,
        "team_id": 4,
        "lat": 45.5,
        "lan": 12.5
    }
]
{
    "success": false,
    "message": "failure description"
}

Query Params

company_id
int32
required

Unique identifier representing a company

 

The Opened Tasks endpoint returns information about the tasks which haven't been done yet.

curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/open
Suggest Edits

Get Task

The Get Task endpoint returns details about a single task.

 
gethttps://developer-api.bringg.com/partner_api/tasks/id
<?
$url = 'https://developer-api.bringg.com/partner_api/tasks/1234567';

$data_string = array(
  'access_token' => "<YOUR ACCESS TOKEN>",
  'timestamp' => date('Y-m-d H:i:s'),
  'company_id' => <YOUR COMPANY ID>
  
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);

?>
A binary file was returned

You couldn't be authenticated

{
    "id": 1,
    "title": "Pizza Delivery",
    "address": "416 Water St. New York, NY 10002",
    "scheduled_at": "2014-19-29T04:16:09.123Z",
    "company_id": 154,
    "team_id": 4,
    "lat": 45.5,
    "lan": 12.5
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a task

Query Params

company_id
int32
required

Unique identifier representing a company

 

The Get Task endpoint returns details about a single task.

curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{id}
Suggest Edits

Add Task To Team

Assign an existing task to a team / Add a team to an existing task

 
posthttps://developer-api.bringg.com/partner_api/tasks/id/teams/team_id
<?
$url = 'http://developer-api.bringg.com/partner_api/tasks/2137214/teams/8492';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s')
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);
$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);

?>
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

id
int32
required

Unique identifier representing a task

team_id
int32
required

Unique identifier representing a team

 
Suggest Edits

Cancel Task

Cancel a Task

 
posthttps://developer-api.bringg.com/partner_api/tasks/id/cancel
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/tasks/id/cancel
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/tasks/id/cancel' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/tasks/id/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/tasks/id/cancel");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/tasks/id/cancel"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated


{
    "success": true
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a task

Body Params

company_id
int32
required

Unique identifier representing a company

 

The Cancel Task endpoint changes the status of the task to *Cancelled. Read more about the different types of task statuses here.

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{id}/cancel
Suggest Edits

Task Status - List

 

The different types of task status are:

name
id
meaning

created

0

Task was created & not assigned to a driver

assigned

1

Task was created & assigned to a driver

accepted

6

Task was accepted by a driver

on_the_way

2

Driver is on the way to a way point

checked_in

3

Driver arrived to a way_point

done

4

Task ended (all way points arrived and left)

cancelled

7

Task was cancelled

rejected

8

Task was offered to driver and was rejected

Suggest Edits

Get Task Locations

Once a task was done, you can use this call to receive all locations of drivers during this task to draw a map for example

 
gethttps://developer-api.bringg.com/partner_api/tasks/:task_id/locations
curl --request GET \
  --url https://developer-api.bringg.com/partner_api/tasks/:task_id/locations
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/tasks/:task_id/locations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/tasks/:task_id/locations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/tasks/:task_id/locations");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/tasks/:task_id/locations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {lat: 34.333333, lng: 32.3355342}, 
  {lat: 34.333332, lng: 32.3333432}
]

Query Params

id
int32

Unique identifier representing a task

 
Suggest Edits

Get Share

Receives share location if allowed and if task has been started by the driver.

 
gethttps://developer-api.bringg.com/partner_api/tasks/id/share
<?
$url = 'https://developer-api.bringg.com/partner_api/tasks/1234567/share';

$data_string = array(
  'access_token' => "<YOUR ACCESS TOKEN>",
  'timestamp' => date('Y-m-d H:i:s'),
  'company_id' => <YOUR COMPANY ID>
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);

?>
A binary file was returned

You couldn't be authenticated

(
    [success] => 1
    [shared_location] => Array
        (
            [id] => 123456
            [uuid] => 535ea0fd
            [expired] =>
            [user_id] => 1234
            [task_id] => 2817312
            [created_at] => 2017-04-30T16:01:58.397Z
            [updated_at] => 2017-04-30T16:01:58.397Z
            [customer_id] => 123456
            [way_point_id] => 3938924
            [shared_on] => 2017-04-30T16:01:58.424Z
            [shared_successfully] =>
            [failure_reason] =>
            [first_seen_on] =>
            [view_counter] => 0
            [shared_type] => 1
            [sharing_method] => 5
            [url] => https://app.bringg.com/she.html?535ea0fd
            [alerting_token] => 6a3a63e5-431b-4926-9431-6d1411d91a2f
            [rating_token] => 1bdd3837-1c71-4baa-b503-f2ffb2d72bc9
            [merchant_id] => 12345
            [message_id] =>
            [note_token] => 77e4b53a-595f-4d05-bd04-5719a036eb53
            [tip_token] => caf43a62-5107-43a9-8aad-d8d1d16a4acf
            [find_me_token] => 92b8d79e-9491-4556-ae39-6532195a312d
            [sms_price] =>
            [tag_id] => 7498
            [sms_delivered] =>
            [update_customer_token] => 7df89f0a-b27d-4b89-8db3-d78cda7a8127
            [pickup_uuid] => ED7F2
        )

)

Path Params

id
int32
required

task id

 

NOTE: If you want to use embed the driver tracking URL for the customer in your own notification / app / website, use the "url" value in the response.

Suggest Edits

Create Way Point

Add a single Way Point to an existing Task

 
posthttps://developer-api.bringg.com/partner_api/tasks/task_id/way_points
<?
$url = 'http://developer-api.bringg.com/partner_api/tasks/3466874/way_points';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s'),
 'company_id' => <THE COMPANY ID>,
 'customer_id' => "1",
 'scheduled_at' => "2017-06-30T21:00:00.000Z",
 'address' => "416 Water St.",
 'city' => "New York",
 'zipcode' => "10002"
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
?>
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "way_point": {
        "id": 1,
        "customer_id": 1,
        "scheduled_at": "2013-10-17T22:47:58.000Z",
        "address": "416 Water St. New York, NY 10002",
        "lat": 32.4345345,
        "lng": 34.534534
    }
}
{
    "success": false,
    "message": "failure description"
}

Path Params

task_id
int32
required

Unique identifier representing a task

Body Params

customer_id
int32
required

Unique identifier representing a customer

company_id
int32
required

Unique identifier representing a company

scheduled_at
string

Scheduled time for way point (format: %Y-%m-%dT%H:%M:%S%z)

address
string

Address of way point

address_second_line
string

2nd line of address

city
string
borough
string

This can be a borough e.g. Bronx, or any neighborhood / zone

zipcode
string
lat
double

Latitude component of way point location

lng
double

Longitude component of way point location

note
string

Note to the driver

allow_scanning_inventory
boolean

Allow scanning inventory at this way point

must_approve_inventory
boolean

Driver can't leave way point before scanning inventory

allow_editing_inventory
boolean

Allow driver to change inventory

no_earlier_than
date-time

Task window bottom limit

no_later_than
date-time

Task window top limit

position
int32

e.g. 1st stop = 1; 2nd stop = 2

 

The Create Way Point endpoint adds a single way point to an existing task. for adding more than one way point use Create Route.

What is Way Point?

A waypoint, AKA a stop point, is somewhere along the driver’s route they have to stop and do something. Sometimes there’s only one of those for an order - for example when a driver takes some food from a restaurant, but sometimes there are two - if a driver works with more than one restaurant so they need to know WHICH restaurant is the stop point and then the final customer. Sometimes there are even more than 2 - for example when a driver takes several dishes at once from a restaurant, or a school bus has many stops along the way.

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"customer_id\":1, \"scheduled_at\": \"2013-10-17T22:47:58.000Z\", \"address\": \"416 Water St. New York, NY 10002\", \"lat\": 32.4345345, \"lng\": 34.534534, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{task_id}/way_points
Suggest Edits

Update Way Point

Update a Way Point

 
patchhttps://developer-api.bringg.com/partner_api/tasks/task_id/way_points/id
<?
$url = 'http://developer-api.bringg.com/partner_api/tasks/2089727/way_points/2888360';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s'),
 'company_id' => <YOUR COMPANY ID>,
 'address_second_line' => "First floor, apartment 3",
 'borough' => "Bronx",
 'zipcode' => "10002",
 'city' => "New York"
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
?>
A binary file was returned

You couldn't be authenticated

{
    "id": 1,
    "customer_id": 1,
    "scheduled_at": "2013-10-17T22:47:58.000Z",
    "address": "416 Water St. New York, NY 10002",
    "lat": 32.4345345,
    "lng": 34.534534
}
{
    "success": false,
    "message": "failure description"
}

Path Params

task_id
int32
required

Unique identifier representing a task

id
int32
required

Unique identifier representing a way point

Body Params

company_id
int32
required

Unique identifier representing a company

scheduled_at
string

Scheduled time for way point (format: %Y-%m-%dT%H:%M:%S%z)

address
string

Address of way point

address_second_line
string

2nd line of address

borough
string
city
string
zipcode
string
lat
double

Latitude component of way point location

lng
double

Longitude component of way point location

silent
boolean

Cancel notifications for customer

 

The Update Way Point endpoint can modify each and every attribute of an existing way point.

curl --include \
     --request PATCH \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"customer_id\":1, \"scheduled_at\": \"2013-10-17T22:47:58.000Z\", \"address\": \"416 Water St. New York, NY 10002\", \"lat\": 32.4345345, \"lng\": 34.534534, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{task_id}/way_points{id}
Suggest Edits

Get Way Point

Get a Way Point

 
gethttps://developer-api.bringg.com/partner_api/tasks/task_id/way_points/id
curl --request GET \
  --url https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "way_point": {
        "id": 1,
        "customer_id": 1,
        "scheduled_at": "2013-10-17T22:47:58.000Z",
        "address": "416 Water St. New York, NY 10002",
        "lat": 32.4345345,
        "lng": 34.534534
    }
}
{
    "success": false,
    "message": "failure description"
}

Path Params

task_id
int32
required

Unique identifier representing a task

id
int32
required

Unique identifier representing a way point

 

The Get Way Point endpoint returns details about a single way point.

curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{task_id}/way_points/{id}
Suggest Edits

Create Route

Add Way Points to Task

 
posthttps://developer-api.bringg.com/partner_api/tasks/task_id/way_points/route
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/route
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/route' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/route")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/route");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/route"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "way_points": [
        {
            "id": 1,
            "customer_id": 1,
            "scheduled_at": "2013-10-17T22:47:58.000Z",
            "address": "416 Water St. New York, NY 10002",
            "lat": 32.4345345,
            "lng": 34.534534
        },
        {
            "id": 2,
            "customer_id": 1,
            "scheduled_at": "2013-10-17T22:47:58.000Z",
            "address": "416 Water St. New York, NY 10002",
            "lat": 32.4345345,
            "lng": 34.534534
        },
        {
            "id": 3,
            "customer_id": 1,
            "scheduled_at": "2013-10-17T22:47:58.000Z",
            "address": "416 Water St. New York, NY 10002",
            "lat": 32.4345345,
            "lng": 34.534534
        }
    ]
}
{
    "success": false,
    "message": "failure description"
}

Path Params

task_id
int32
required

Unique identifier representing a task

Body Params

way_points
array of mixed types
required

List of the task's way points

company_id
int32
required

Unique identifier representing a company

 

The Create Route endpoint adds a a list of way points for an existing task. for adding a single way point use Create Way Point.

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, way_points=[{\"customer_id\":1, \"scheduled_at\": \"2013-10-17T22:47:58.000Z\", \"address\": \"416 Water St. New York, NY 10002\", \"lat\": 32.4345345, \"lng\": 34.534534},{\"customer_id\":2, \"scheduled_at\": \"2013-10-17T22:52:58.000Z\", \"address\": \"416 Water St. New York, NY 10002\", \"lat\": 32.4345345, \"lng\": 34.534534},{\"customer_id\":3, \"scheduled_at\": \"2013-10-17T22:52:58.000Z\", \"address\": \"416 Water St. New York, NY 10002\", \"lat\": 32.4345345, \"lng\": 34.534534}], \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{task_id}/way_points/routes
Suggest Edits

Create Note

Create a Note on the task or a specific way point for the driver and customer support to see

 
posthttps://developer-api.bringg.com/partner_api/tasks/task_id/way_points/way_point_id/notes
<?
$url = 'http://developer-api.bringg.com/partner_api/tasks/<TASK ID>/way_points/<WAY_POINT_ID>/notes';

$data_string = array(
  	'access_token' => "<YOUR ACCESS TOKEN>",
  	'timestamp' => date('Y-m-d H:i:s'),
	'company_id' => "<COMPANY ID>",
	'type' => 2,
	'note' => "note test",
	'url' => 'https://www.google.com'
	
);
$secret_key = "<YOUR SECRET KEY>";


// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);

?>
<?
$url = 'http://developer-api.bringg.com/partner_api/tasks/<TASK ID>/way_points/<WAY_POINT_ID>/notes';

$data_string = array(
  'access_token' => "<YOUR ACCESS TOKEN>",
  'timestamp' => date('Y-m-d H:i:s'),
  'company_id' => "<COMPANY ID>",
  'type' => 1,
  'note' => json_encode(array(
    
    //Table headers
    array("Item","Quantity","Price"),
    
    //Table body 
    array("Fresh juice",2,20),
    array("Hamburger",2,60)
    )
  )
);
$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

print("The signature: " + $signature);

$data_string["signature"] = $signature;

print("this is the data string: ");
print_r($data_string);

$content = json_encode($data_string);

print("The content: " + $content);
// $data_string = json_encode($data);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);

print_r($response);
?>
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "note": "some text"
}
{
    "success": false,
    "message": "failure description"
}

Path Params

task_id
string
required

Unique identifier representing a task

way_point_id
string
required

Unique identifier representing a way point

Body Params

note
string
required

Way point note

company_id
int32
required

Unique identifier representing a company

user_id
int32

Unique identifier representing a user

type
int32

Note type - 0: Text; 1: Formatted; 2: HTML;

 

The Create Note endpoint adds a note to a way point.

What is Note?

Note are general meta data attached to a task or a way point. They can be text, image, signature, form and more. Each note has the content, timestamp of creation and ownership.

Note Type
What is it
More Details

0

Free Text

1

Formatted Note: A note that is displayed as a table

Header: array of x header titles

Example: ['Item', 'Price', 'Quantity']

Body: array of array of data (should be length of x per internal array)

Example: [['Chicken Breast', '10$', 1], ['French Fries', '3$', 5]]

2

HTML Note

note: the text to be displayed
url: the url to open when the text is clicked

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"note\": \"some text\", \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{task_id}/way_points/{way_point_id}/notes
curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{\"note\": [[\"header1\",\"header2\"],[\"row1_data1\",\"row1_data2\"]], \"type\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"yguRVwczRyt69exGW2Vf\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/tasks/{task_id}/way_points/{way_point_id}/notes
Suggest Edits

Add extra customers to way point

A way point can have more than one customers.

 
posthttps://developer-api.bringg.com/partner_api/way_points/:way_point_id/customers
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/way_points/:way_point_id/customers
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/way_points/:way_point_id/customers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/way_points/:way_point_id/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/way_points/:way_point_id/customers");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/way_points/:way_point_id/customers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{success: true}

Body Params

customer_id
int32

the customer id to add

 

A way point has at least one customer, however - sometimes it can have more than one. You might want all of the customer to watch and follow the same task.

Suggest Edits

Update Note

 
patchhttps://developer-api.bringg.com/partner_api/tasks/task_id/way_points/way_point_id/notes/id
curl --request PATCH \
  --url https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/way_point_id/notes/id
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/way_point_id/notes/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/way_point_id/notes/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/way_point_id/notes/id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/tasks/task_id/way_points/way_point_id/notes/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

task_id
int32
required

Related task ID

way_point_id
int32
required

Related way point ID

id
int32
required

ID of the note to update

Body Params

note
string

The replacing string

type
int32

Type of note to be updated

 
Suggest Edits

Create User

Create a User

 
posthttps://developer-api.bringg.com/partner_api/users
<?
$url = 'http://developer-api.bringg.com/partner_api/users';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s'),
 'company_id' => <THE COMPANY ID>,
 'name' => "User Name",
 'email' => "email@address.com",
 'password' => "123456",
 'phone' => "0555555555",
 'driver' => 1,
 'admin' => 0,
 'dispatcher' => 0
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
print("\n\n\n RESPONSE \n\n\n\n");
print_r($response);
?>
A binary file was returned

You couldn't be authenticated

{
	"id": 3,
	"name": "Automation User",
	"status": "offline",
	"sub": null,
	"lat": null,
	"lng": null,
	"profile_image": "/images/avatar.png",
	"authentication_token": null,
	"phone": "+19175613649",
	"admin": true,
	"driver": true,
	"beta": false,
	"debug": false,
	"email": "automation@bringg.com",
	"job_description": "Automation Tester",
	"push_token": null,
	"company": null,
	"average_rating": null,
	"num_ratings": 0,
	"last_sign_in_at": null,
	"active_shift_id": null,
	"created_at": "2017-02-13T16:02:09.599Z",
	"partner_user": false,
	"feature_flags": null,
	"authorization_flags": {},
	"confirmed_at": null,
	"confirmation_sent_at": null,
	"battery": null,
	"uuid": "8bbb96a0-96b5-4b1a-a4a7-4d510fa56cef",
	"team_ids": [],
	"existing_user": true
}
{
    "success": false,
    "message": "failure description"
}
param is missing or the value is empty: Email and phone
  

Body Params

company_id
int32
required

Unique identifier representing a company

name
string

Name of user

email
string
required

E-mail of user

password
string
required

Password of user (Policy - Capital & Small letters, numbers, signs).

phone
string
required

Phone of user

admin
boolean

Administrator user

driver
boolean

User is a driver

dispatcher
boolean

User is a dispatcher

job_description
string

Job description to be shown to customer

timestamp
string

In milis

access_token
string
signature
string
 

Mandatory Fields

While all three fields above (password, email and phone) are marked mandatory, in reality either phone for a driver OR email/password pairs are mandatory - we need one of them to allow a user to login.

The Create User endpoint creates a new user entity.

Optional return flags:

existing_user: true - user already existed and not created
undeleted_user: true - user was deleted and now undeleted

What is User?

Users are the employees of the company. Usually they are the drivers using the native apps. Users with Admin rights can log in the web.

Users are identified uniquely by email or phone. If a phone or an email exist in the system the user would be returned and not created.

Assigning a Team to a User

This needs to be done in a separate API call : Add User To Team

If a user that is uniquely identified by email or phone already exists with a different company, you have no access to this user and cannot create another

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{ \"company_id\": 1, \"name\": \"mrs. kallie conroy\", \"email\": \"kallie@bringg.com\", \"password\": \"123456789\", \"phone\": \"+19174756306\", \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/users/
Suggest Edits

Add User To Team

Add a User to Team

 
puthttps://developer-api.bringg.com/partner_api/teams/id/user/user_id
<?
$url = 'http://developer-api.bringg.com/partner_api/teams/<teamID>/user/<userID>';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s'),
 'company_id' => <THE COMPANY ID>
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
print("\n\n\n RESPONSE \n\n\n\n");
print_r($response);
?>
A binary file was returned

You couldn't be authenticated


{
    "success": true
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a team

user_id
int32
required

Unique identifier representing a user

Body Params

company_id
int32
required

Unique identifier representing a company

 

The Add User endpoint adds a user to a team.

curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/teams/{id}/user/{id}
Suggest Edits

Delete User

Delete a User

 
deletehttps://developer-api.bringg.com/partner_api/users/id
curl --request DELETE \
  --url https://developer-api.bringg.com/partner_api/users/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://developer-api.bringg.com/partner_api/users/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/users/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://developer-api.bringg.com/partner_api/users/id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/users/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a user

Body Params

company_id
int32
required

Unique identifier representing a company

 

The Delete User endpoint removes the user.

Be Careful

There is no way to undo this action. the user will be removed forever.

curl --include \
     --request DELETE \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/users/{id}
Suggest Edits

Users

The Users endpoint returns information about all the users of the company.

 
gethttps://developer-api.bringg.com/partner_api/users
<?
$url = 'http://developer-api.bringg.com/partner_api/users';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s'),
 'company_id' => <YOUR COMPANY ID>
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
?>
'use strict';

var CryptoJS = require('crypto-js');
var requestify = require('requestify');

var BRINGG_COMPANY_ID = <YOUR COMPANY ID>;
var BRINGG_ACCESS_TOKEN = '<ACCESS TOKEN>';
var BRINGG_SECRET_KEY = '<SECRET KEY>';

var params = {
 access_token: BRINGG_ACCESS_TOKEN,
 timestamp: Date.now(),
 company_id: BRINGG_COMPANY_ID
};

var query_params = '';
for (var key in params) {
 var value = params[key];
 if (query_params.length > 0) {
   query_params += '&';
 }
 query_params += key + '=' + encodeURIComponent(value);
}

params.signature = CryptoJS.HmacSHA1(query_params, BRINGG_SECRET_KEY).toString();

var queryString = '?' + query_params + '&signature=' + params.signature;

requestify.request('https://developer-api.bringg.com/partner_api/users' + queryString, {
 method: 'GET',
 headers: {
   'Content-type': 'application/json'
 },
 body: JSON.stringify(params)
}).then(function (response) {
 console.log(response);
}).fail(function (response) {
 console.log(response);
});
A binary file was returned

You couldn't be authenticated

[
    {
        "id": 1,
        "name": "mrs. kallie conroy",
        "status": "online",
        "sub": "Free",
        "lat": 32.453453,
        "lng": 34.434233,
        "profile_image": "http://bringg.com/wp-content/uploads/2014/05/logo_851.png",
        "authentication_token": "ZVkd8yCysK6ffhAkPTiQ",
        "phone": "910-295-9731",
        "email": "ralph@domain.com",
        "admin": false,
        "current_task": 12
    },
    {
        "id": 2,
        "name": "mrs. kallie conroy",
        "status": "online",
        "sub": "Free",
        "lat": 32.453453,
        "lng": 34.434233,
        "profile_image": "http://bringg.com/wp-content/uploads/2014/05/logo_851.png",
        "authentication_token": "ZVkd8yCysK6ffhAkPTiQ",
        "phone": "910-295-9731",
        "email": "ralph@domain.com",
        "admin": false,
        "current_task": 12
    },
    {
        "id": 3,
        "name": "mrs. kallie conroy",
        "status": "online",
        "sub": "Free",
        "lat": 32.453453,
        "lng": 34.434233,
        "profile_image": "http://bringg.com/wp-content/uploads/2014/05/logo_851.png",
        "authentication_token": "ZVkd8yCysK6ffhAkPTiQ",
        "phone": "910-295-9731",
        "email": "ralph@domain.com",
        "admin": false,
        "current_task": 12
    }
]
{
    "success": false,
    "message": "failure description"
}

Query Params

company_id
int32
required

Unique identifier representing a company

page
int32

Page number

 
curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/users
Suggest Edits

Update User

Update a User

 
patchhttps://developer-api.bringg.com/partner_api/users/id
curl --request PATCH \
  --url https://developer-api.bringg.com/partner_api/users/id
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://developer-api.bringg.com/partner_api/users/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/users/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://developer-api.bringg.com/partner_api/users/id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/users/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "id": 1,
    "name": "mrs. kallie conroy",
    "status": "online",
    "sub": "Free",
    "lat": 32.453453,
    "lng": 34.434233,
    "profile_image": "http://bringg.com/wp-content/uploads/2014/05/logo_851.png",
    "authentication_token": "ZVkd8yCysK6ffhAkPTiQ",
    "phone": "910-295-9731",
    "email": "ralph@domain.com",
    "admin": false,
    "current_task": 12
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a user

Body Params

company_id
int32
required

Unique identifier representing a company

name
string

Name of user

email
string

E-mail of user

password
string

Password of user

phone
string

Phone of user

admin
boolean

Administrator user

driver
boolean

User is a driver

dispatcher
boolean

User is a dispatcher

job_description
string

Job Description to be shown to customer

 

The Update User endpoint can modify each and every attribute of an existing user.

curl --include \
     --request PATCH \
     --header "Content-Type: application/json" \
     --data-binary "{ \"company_id\": 1, \"name\": \"mrs. kallie conroy\", \"email\": \"kallie@bringg.com\", \"password\": \"123456789\", \"phone\": \"+19174756306\", \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/users/{id}
Suggest Edits

Get User

Get all the details on a particular user via their User ID

 
gethttps://developer-api.bringg.com/partner_api/users/id
<?
$url = 'http://developer-api.bringg.com/partner_api/users/123456';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s'),
 'company_id' => <YOUR COMPANY ID>
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

print("The signature: " + $signature);

$data_string["signature"] = $signature;

print("this is the data string: ");
print_r($data_string);

$content = json_encode($data_string);

print("The content: " + $content);
// $data_string = json_encode($data);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
print("\n\n\n RESPONSE \n\n\n\n");
print_r($response);
?>
A binary file was returned

You couldn't be authenticated

{
    "id": 1,
    "name": "mrs. kallie conroy",
    "status": "online",
    "sub": "Free",
    "lat": 32.453453,
    "lng": 34.434233,
    "profile_image": "http://bringg.com/wp-content/uploads/2014/05/logo_851.png",
    "authentication_token": "ZVkd8yCysK6ffhAkPTiQ",
    "phone": "910-295-9731",
    "email": "ralph@domain.com",
    "admin": false,
    "current_task": 12
}
{
    "success": false,
    "message": "failure description"
}

Query Params

id
int32
required

Unique identifier representing a user

company_id
int32
required

Unique identifier representing a company

 

The Get User endpoint returns details about a single user.

curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/users/{uuid}
Suggest Edits

Upload User Profile Image

 
posthttps://developer-api.bringg.com/partner_api/user_id/profile_image
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/user_id/profile_image
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/user_id/profile_image' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/user_id/profile_image")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/user_id/profile_image");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/user_id/profile_image"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{"success": true}

Path Params

user_id
int32
required

Body Params

company_id
int32
file
file
 
Suggest Edits

Update User Location

 
posthttps://developer-api.bringg.com/partner_api/users/user_id/update_user_location
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/users/user_id/update_user_location
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/users/user_id/update_user_location' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/users/user_id/update_user_location")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/users/user_id/update_user_location");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/users/user_id/update_user_location"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

user_id
int32
required

User ID

Body Params

location_data
object

Location data

 

location_data is structure

coords: { lat: 32.5434, lng:34.3423432}
battery: battery_level (optional, 1-100)
a: accuracy of location reported
t: time since last updated in ms

Suggest Edits

User Count

Get number of total users

 
gethttps://developer-api.bringg.com/partner_api/users/count
curl --request GET \
  --url https://developer-api.bringg.com/partner_api/users/count
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/users/count' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/users/count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/users/count");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/users/count"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{success: true, user_count: 1000}
 
Suggest Edits

Schedule

Request the current schedule of all users

 
gethttps://developer-api.bringg.com/partner_api/users/schedule
curl --request GET \
  --url https://developer-api.bringg.com/partner_api/users/schedule
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/users/schedule' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/users/schedule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/users/schedule");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/users/schedule"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{"success"=>true,
 "schedule"=>
  6=>
  {Mon, 19 Sep 2016=>
    60844839774924148238142269859916978064086373404491991975915826011673682734432134714646288481719754139091013723359270405284690822168610426907578157328806806119856417378962370441098516368027172400671582678279255116968452403213272927868695455817299040387801261755686553388803530044023089230411007101935427558565054277323159033900567342506926412629345693693213275385656106821339455434116446029665416945791437119987662871290136667153764351},
 8=>
  {Mon, 19 Sep 2016=>
    60844839774924148238142269859916978064086373404491991975915826011673682734432134714646288481719754139091013723359270405284690822168610426907578157328806806119856417378962370441098516368027172400671582678279255116968452403213272927868695455817299040387801261755686553388803530044023089230411007101935427558565054277323159033900567342506926412629345693693213275385656106821339455434116446029665422379675483888723751302053399093202391039},
 2=>
  {Mon, 19 Sep 2016=>
    60844839774924148238142269859916978064086373404491991975915826011673682734432134714646288481719754139091013723359270405284690822168610426907578157328806806119856417378962370441098516368027172400671582678279255116968452403213272927868695455817299040387801261755686553388803530044023089230411007101935427558565054277323159033900567342506926412629345693693213275385656106821339455434116446029665416945791437119987662871290136667153764351},
 3=>
  {Mon, 19 Sep 2016=>
    60844839774924148238142269859916978064086373404491991975915826011673682734432134714646288481719754139091013723359270405284690822168610426907578157328806806119856417378962370441098516368027172400671582678279255116968452403213272927868695455817299040387801261755686553388803530044023089230411007101935427558565054277323159033900567342506926412629345693693213275385656106821339455434116446029665416945791437119987662871290136667153764351},
 4=>
  {Mon, 19 Sep 2016=>
    60844839774924148238142269859916978064086373404491991975915826011673682734432134714646288481719754139091013723359270405284690822168610426907578157328806806119856417378962370441098516368027172400671582678279255116968452403213272927868695455817299040387801261755686553388803530044023089230411007101935427558565054277323159033900567342506926412629345693693213275385656106821339455434116446029665422379675483888723751302053399093202391039},
 5=>
  {Mon, 19 Sep 2016=>
    60844839774924148238142269859916978064086373404491991975915826011673682734432134714646288481719754139091013723359270405284690822168610426907578157328806806119856417378962370441098516368027172400671582678279255116968452403213272927868695455817299040387801261755686553388803530044023089230411007101935427558565054277323159033900567342506926412629345693693213275385656106821339455434116446029665422379675483888723751302053399093202391039},
 7=>
  {Mon, 19 Sep 2016=>
    60844839774924148238142269859916978064086373404491991975915826011673682734432134714646288481719754139091013723359270405284690822168610426907578157328806806119856417378962370441098516368027172400671582678279255116968452403213272927868695455817299040387801261755686553388803530044023089230411007101935427558565054277323159033900567342506926412629345693693213275385656106821339455434116446029665422379675483888723751302053399093202391039}}
}

Query Params

time_window
int32

time window to report back

page
int32

page number to query if. There are 50 drivers per page.

borough
string

borough or suburb within a given city, must be defined in teams configuration

city
string

city of team, must be defined in team configuration

 

This is a paid feature!

Please contact your delivery consultant for pricing and details about this api

Use Shifts!

This API call is influenced by "available" driver time which you configure by using Bringg's Shifts feature - available in the UI or through services.

In order to understand and plan your teams schedule, we allow you to query the "current" schedule. This can potentially change at any given time, depending how your operational needs: for next day deliveries the changes are less frequent than on demand delivery, etc.

The response is an array of drivers, for each driver a hash of dates, for each date availability array. The bits in the array are either free (0) or busy (1). Each bit, by default, is one minute, but you can changed that for any window (10 minutes, 30 minutes, an hour) by using the "time_window" parameter.

Suggest Edits

Create Company

Create a Company

 
posthttps://developer-api.bringg.com/partner_api/companies
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/companies
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/companies' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/companies");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "company": {
        "id": 1,
        "name": "Bringg LTD",
        "address": "Habarzel 1, Tel Aviv",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "+1.917.475.6306"
    }
}
{
    "success": false,
    "message": "failure description"
}

Body Params

name
string
required

Name of company

test
boolean
required

Is this a test account only TEST ACCOUNTS ARE PURGED

phone
string
required

Phone of company

address
string

address of company

lat
double

Latitude component of company location

lng
double

Longitude component of company location

 

The Create Company endpoint creates a new company entity.

What is Company?

A Company is a single business using the system. A developer can have one company or multiple companies. All users/drivers, tasks/orders and customers belong to a single company.

Test Accounts

Companies are by default test account. They will be deleted after a week. If you want your company NOT to be deleted, have the parameter TEST be false

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{\"test\": \"true\", \"name\": \"Bringg LTD\", \"address\": \"Habarzel 1, Tel Aviv\", \"lat\": 32.453453, \"lng\": 34.434233, \"phone\": \"+1.917.475.6306\", \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/companies/
Suggest Edits

Update Company

Update an existing company

 
patchhttps://developer-api.bringg.com/partner_api/companies/company_id/
curl --request PATCH \
  --url https://developer-api.bringg.com/partner_api/companies/company_id/
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://developer-api.bringg.com/partner_api/companies/company_id/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies/company_id/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://developer-api.bringg.com/partner_api/companies/company_id/");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies/company_id/"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "company": {
        "id": 1,
        "name": "Bringg LTD",
        "address": "Habarzel 1, Tel Aviv",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "+1.917.475.6306"
    }
}
{
    "success": false,
    "message": "failure description"
}

Path Params

company_id
string
required

Body Params

name
string

Name of company

address
string

address of company

lat
double

Latitude component of company location

lng
double

Longitude component of company location

phone
string

Phone of company

country_code
string

Company country code

 

The Update Company endpoint updates an existing company entity.

curl --include \
     --request PATCH \
     --header "Content-Type: application/json" \
     --data-binary "{\"name\": \"Bringg LTD\", \"address\": \"Habarzel 1, Tel Aviv\", \"lat\": 32.453453, \"lng\": 34.434233, \"phone\": \"+1.917.475.6306\", \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/companies/:company_id 
Suggest Edits

Delete Company

Delete a company

 
deletehttps://developer-api.bringg.com/partner_api/companies/id
curl --request DELETE \
  --url https://developer-api.bringg.com/partner_api/companies/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://developer-api.bringg.com/partner_api/companies/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://developer-api.bringg.com/partner_api/companies/id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a company

 

The Delete Company endpoint removes the company.

Be Careful

There is no way to undo this action. the company will be removed forever.

curl --include \
     --request DELETE \
     --header "Content-Type: application/json" \
     --data-binary "{\"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/companies/{id}
Suggest Edits

Get Company

Get a company

 
gethttps://developer-api.bringg.com/partner_api/companies/id
curl --request GET \
  --url https://developer-api.bringg.com/partner_api/companies/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/companies/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/companies/id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "company": {
        "id": 1,
        "name": "Bringg LTD",
        "address": "Habarzel 1, Tel Aviv",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "+1.917.475.6306"
    }
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a company

 

The Get Company endpoint returns details about a single company.

curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --data-binary "{\"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/companies/{id}
Suggest Edits

Companies

Get all companies

 
gethttps://developer-api.bringg.com/partner_api/companies
curl --request GET \
  --url https://developer-api.bringg.com/partner_api/companies
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/companies' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://developer-api.bringg.com/partner_api/companies");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[{
        "id": 1,
        "name": "Bringg LTD",
        "address": "Habarzel 1, Tel Aviv",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "+1.917.475.6306"
},
{
        "id": 1,
        "name": "Bringg LTD",
        "address": "Habarzel 1, Tel Aviv",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "+1.917.475.6306"
},
{
        "id": 1,
        "name": "Bringg LTD",
        "address": "Habarzel 1, Tel Aviv",
        "lat": 32.453453,
        "lng": 34.434233,
        "phone": "+1.917.475.6306"
}]
{
    "success": false,
    "message": "failure description"
}

Query Params

page
int32

page number (each returns 50 results)

 

The Companies endpoint returns information about all companies.

curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --data-binary "{\"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/companies 
Suggest Edits

Upload Company Delivery Pin

Upload a company delivery pin

 
posthttps://developer-api.bringg.com/partner_api/companies/id/delivery_pin
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/companies/id/delivery_pin
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/companies/id/delivery_pin' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies/id/delivery_pin")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/companies/id/delivery_pin");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies/id/delivery_pin"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "url": "http://bringg.com/wp-content/uploads/2014/05/logo_851.png"
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a company

Body Params

file
file
required

JPG, JPEG, GIF or PNG file

 

The Upload Company Delivery Pin endpoint uploads a customized delivery pin to be displayed on both customer notification and management system maps.

Recommended dimensions

height: 64px, width: 64px. Note: The file itself ('canvas') may in fact be of greater dimensions than those of the actual pin, if shadows or other backgrounds elements are added to enable contrast against the map.

curl -F file=@localfile.jpg \
http://api.bringg.com/partner_api/companies/{id}/delivery_pin
Suggest Edits

Reset Company Delivery Pin

Reset the Company Delivery Pin

 
posthttps://developer-api.bringg.com/partner_api/companies/id/delivery_pin_reset
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/companies/id/delivery_pin_reset
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/companies/id/delivery_pin_reset' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies/id/delivery_pin_reset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/companies/id/delivery_pin_reset");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies/id/delivery_pin_reset"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a company

 

The Reset Company Delivery Pin endpoint resets delivery pin to default.

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{\"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/companies/{id}/delivery_pin_reset
Suggest Edits

Upload Company Destination Pin

Upload a company destination pin

 
posthttps://developer-api.bringg.com/partner_api/companies/id/destination_pin
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/companies/id/destination_pin
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/companies/id/destination_pin' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies/id/destination_pin")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/companies/id/destination_pin");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies/id/destination_pin"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "url": "http://bringg.com/wp-content/uploads/2014/05/logo_851.png"
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a company

Body Params

file
file
required
 

The Upload Company Destination Pin endpoint uploads a customized destination pin to be displayed on both customer notification and management system maps.

Recommended dimensions

Height: 64px
Width: 64px.

Note: The file itself ('canvas') may in fact be of greater dimensions than those of the actual pin, if shadows or other backgrounds elements are added to enable contrast against the map.

curl -F file=@localfile.jpg \
http://api.bringg.com/partner_api/companies/{id}/destination_pin
Suggest Edits

Reset Company Destination Pin

Reset a Company Destination Pin

 
posthttps://developer-api.bringg.com/partner_api/companies/id/destination_pin_reset
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/companies/id/destination_pin_reset
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/companies/id/destination_pin_reset' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies/id/destination_pin_reset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/companies/id/destination_pin_reset");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies/id/destination_pin_reset"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated


{
    "success": true
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a company

 

The Reset Company Destination Pin endpoint resets destination pin to default.

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{\"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/companies/{id}/destination_pin_reset
Suggest Edits

User Configurations

 
  • allow_take_picture : allow driver to take pictures on site
  • allow_take_signature : allow driver to take signature while on site
  • allow_take_note : allow driver to take notes on site
  • cancel_task_by_driver : allow driver to cancel task
  • automatic_checkin : allow driver to automatically check in
  • automatic_checkout : allow driver to automatically check out
  • email_task_list_on_start_shift : email driver when shifts starts with list of tasks
  • default_user_activity : define default user activity. the possible activities are:
    1 - stationary
    2 - walking
    3 - running
    4 - bicycling
    5 - driving
Suggest Edits

Update User Configuration

 
patchhttps://developer-api.bringg.com/partner_api/companies/company_id/user_configuration
<?
$url = 'http://developer-api.bringg.com/partner_api/companies/<YOUR COMPANY ID>/user_configuration';

$data_string = array(
 'access_token' => "<YOUR ACCESS TOKEN>",
 'timestamp' => date('Y-m-d H:i:s'),
 'user_configuration' => array(
    'allow_take_picture' => "false"
 )
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
 die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
?>
A binary file was returned

You couldn't be authenticated

{success: true, user_configration: user_configration}

Path Params

company_id
int32
required

Company ID to update

Query Params

allow_take_picture
boolean
 

Possible User Configuration Flags

For a complete list of flags check out the User Configurations section.

Suggest Edits

Company Configurations

 
  • start_on_accept: Once a task is accepted it is also started (default: false)
  • allow_share_location: Allow driver to decide when to share location (default: false)
  • auto_share_location: Share location automatically (default: true)
  • allow_take_picture: Allow driver to take pictures (default: true)
  • allow_take_payment: Allow driver to take payments (default: false)
  • allow_take_signature: Allow driver to take signature (default: true)
  • allow_take_note: Allow driver to take notes (default: true)
  • auto_accept_tasks: Driver automatically accepts tasks (default: false)
  • alert_on_checkout: Alert customer when driver checks out a site (default: false)
  • alert_on_checkin: Alert customer when a driver checks in a site (default: false)
  • notnow_button_string: Change the text of the Not Now button for driver (default: nil)
  • accept_button_string: Change the text of the Accept button for driver (default: nil)
  • heading_to_you_button_string: Change the text of the Heading To You button for driver (default: nil)
  • arrived_button_string: Change the text of the Arrived button for driver (default: nil)
  • left_location_button_string: Change the text of the Left button for driver (default: nil)
  • side_menu_features: Changes the options for side menu:
  • inventory
  • phone_call_string: Changes text for the phone call
  • show_bringg_logo: Show the bringg logo on the customer app (default: true)
  • notify_by_email: Notify customer by email if phone is not found (default: false)
  • distance_threshold: Defines distance (in Meters) from destination, which beyond it the app reports it’s location less frequently (default: 15,000)
  • speed_threshold: defines speed of driving (in Meters per Hour), which slower than - the app reports it’s location less frequently (default: 10,000)
  • update_location_max_idle_time: defines the maximal time period (in milliseconds) which the app can avoid reporting it’s location (default: 240,000)
  • cancel_task_by_driver: Allows the driver to cancel a task (default:true)
  • allow_access_to_all_open_tasks: Allow drivers to receive any unassigned tasks
  • reply_to_shared_email: if location is shared via email and customer replies to - this is where it's going
  • default_user_activity: 2 -> Walking. 4 -> Cycling, 5 -> Driving (default : 5)
  • auto_dispatch: is auto dispatch set
Suggest Edits

Update Company Configuration

Allows updating of the company configuration

 
patchhttps://developer-api.bringg.com/partner_api/companies/company_id/company_configuration
<?
$url = 'http://developer-api.bringg.com/partner_api/companies/<YOUR COMPANY ID>/company_configuration';

$data_string = array(
  'access_token' => "<YOUR ACCESS TOKEN>",
  'timestamp' => date('Y-m-d H:i:s'),
  'merchant_configuration' => array(
    'start_on_accept' =>"true",
    'allow_share_location' => "false",
    'allow_take_picture' => "false",
    'allow_take_note' => "true"
  )
);
$secret_key = "<YOUR SECRET KEY>";


// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

$data_string["signature"] = $signature;

$content = json_encode($data_string);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);
?>
A binary file was returned

You couldn't be authenticated

{success: true, company_configration: company_configration}

Path Params

company_id
int32
required

Company/merchant ID that needs to be updated

Body Params

start_on_accept
boolean
 

Possible Configuration Flags

For a complete list of flags check out the Company Configurations section.

Example

Suggest Edits

Configure Form

Configure a form

 
posthttps://developer-api.bringg.com/partner_api/companies/id/form
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/companies/id/form
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/companies/id/form' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/companies/id/form")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/companies/id/form");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/companies/id/form"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a company

Body Params

enabled
boolean

Enables the form feature

fields
object
required

JSON object represents the fields structure as defined below

title
string

The title of the form

button_label
string

The label of the button opens the form

 

The Configure Form endpoint creates a structure of form, which the driver can fill on site. the definition of any field is:

parameter
type
Description

key

String

name of field

label

String

display label

type

Number

value type:
0 - NUMBER
1 - TEXT
2 - BOOLEAN
3 - LIST

control

Number

UI control
0 - INPUT
1 - CHECKBOX
2 - SWITCH
3 - RADIO
4 - DROPDOWN

mandatory

Boolean

define if the field is required

defaultValue

Object

default value of field

list_values

Array

list of options (only for type LIST)

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{ \"title\": \"Form Title\", \"button_label\": \"Form Button Label\", \"enabled\": true, \"fields\": \"{\"key\":\"tow\",\"label\":\"Tow\",\"type\":2,\"control\":2},{\"key\":\"3\",\"label\":\"Windscreen wiper\",\"type\":2,\"control\":2},{\"key\":\"4\",\"label\":\"Scented tree\",\"type\":2,\"control\":2},{\"key\":\"price\",\"label\":\"Price\",\"type\":0,\"control\":0},{\"key\":\"description\",\"label\":\"Description\",\"type\":1,\"control\":0}]\", \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/companies/{id}/form
Suggest Edits

Create Place

A place is a location with a name (like a specific restaurant in a complex or a company inside a building)

 
posthttps://developer-api.bringg.com/partner_api/places
curl --request POST \
  --url https://developer-api.bringg.com/partner_api/places
var request = require("request");

var options = { method: 'POST',
  url: 'https://developer-api.bringg.com/partner_api/places' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/places")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://developer-api.bringg.com/partner_api/places");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/places"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{success: true, place: {id: 40, name: "Place Name", Address: "The corner of this and that", lat: "34.34343", lng: "32.32334"}
{
    "success": false,
    "message": "failure description"
}

Body Params

Name
string

Name of place

Address
string

Address for this location

lat
double

Latitude component of place location

lng
double

Longitude component of place location

 
$.post('http://api.bringg.com/partner_api/places/', {name: "Somewhere", address: "Corner of this and that"}, function(data) {
    console.log(data);
});
Suggest Edits

Create Team

Create a Team

 
posthttps://developer-api.bringg.com/partner_api/teams
<?
$url = 'http://developer-api.bringg.com/partner_api/teams';

$data_string = array(
  'access_token' => "<YOUR ACCESS TOKEN>",
  'timestamp' => date('Y-m-d H:i:s'),
  'company_id' => <THE COMPANY ID>,
  'name' => "Team A2",
  'description' => "NY Only",
  'parent_team_id' => 124,
  'extras' => array(
    'value' => "key")
);

$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

print("The signature: " + $signature);

$data_string["signature"] = $signature;

print("this is the data string: ");
print_r($data_string);

$content = json_encode($data_string);

print("The content: " + $content);
// $data_string = json_encode($data);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);

print_r($result);
?>
A binary file was returned

You couldn't be authenticated

{
    "id": 1,
    "name": "Team A2",
    "description": "NY Only",
    "parent_team_id": 124
}
{
    "success": false,
    "message": "failure description"
}

Body Params

name
string
required

Name of team

company_id
int32
required

Unique identifier representing a company

description
string

Description of team

parent_team_id
int32

Unique identifier representing a team

extras
object

Custom parameters

 

The Create Team endpoint creates a new team entity.

What is Team?

Optionally, if hierarchy exists in your organization, drivers can be separated to teams. When using this method, tasks can also be assigned to teams - which then helps the dispatcher to allocate the task to the right team member.

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{ \"company_id\": 1, \"name\": \"Team A2\", \"description\": \"NY Only\", \"parent_team_id\": 124, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/teams/
Suggest Edits

Update Team

Update a Team

 
patchhttps://developer-api.bringg.com/partner_api/teams/id
<?
$url = 'http://developer-api.bringg.com/partner_api/teams/3';

$data_string = array(
  'access_token' => "<YOUR ACCESS TOKEN>",
  'timestamp' => date('Y-m-d H:i:s'),
  'name' => "Update name",
  'company_id' => <THE COMPANY ID>,
  'description' => "team sdescription",
  'extras' => array(
    'value'=>"key"),
);


$secret_key = "<YOUR SECRET KEY>";

// OpenSSL::HMAC.hexdigest("sha1", @partner.hmac_secret, to_query(canonical_params))
$signature = hash_hmac("sha1", http_build_query($data_string), $secret_key);

print("The signature: " + $signature);

$data_string["signature"] = $signature;

print("this is the data string: ");
print_r($data_string);

$content = json_encode($data_string);

print("The content: " + $content);
// $data_string = json_encode($data);

$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:application/json',
'Content-Length: ' . strlen($content))
);

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ( $status != 200 ) {
  die("Error: call to URL $url failed with status $status, response $json_response, curl_error " . curl_error($curl) . ", curl_errno " . curl_errno($curl));
}

curl_close($ch);

$response = json_decode($json_response, true);

print_r($result);
?>
A binary file was returned

You couldn't be authenticated

{
    "id": 1,
    "name": "Team A2",
    "description": "NY Only",
    "parent_team_id": 124
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a team

Body Params

company_id
int32
required

Unique identifier representing a company

name
string

Name of team

description
string

Description of team

parent_team_id
int32

Unique identifier representing a team

extras
object

Custom parameters

 

The Update Team endpoint can modify each and every attribute of an existing team.

curl --include \
     --request PATCH \
     --header "Content-Type: application/json" \
     --data-binary "{ \"company_id\": 1, \"name\": \"Team A2\", \"description\": \"NY Only\", \"parent_team_id\": 124, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/teams/{id}
Suggest Edits

Delete Team

Delate a Team

 
deletehttps://developer-api.bringg.com/partner_api/teams/id
curl --request DELETE \
  --url https://developer-api.bringg.com/partner_api/teams/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://developer-api.bringg.com/partner_api/teams/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/teams/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://developer-api.bringg.com/partner_api/teams/id");

xhr.send(data);
import requests

url = "https://developer-api.bringg.com/partner_api/teams/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated


{
    "success": true
}
{
    "success": false,
    "message": "failure description"
}

Path Params

id
int32
required

Unique identifier representing a team

Body Params

company_id
int32
required

Unique identifier representing a company

 

The Delete Team endpoint removes the team.

Be Careful

There is no way to undo this action. the team will be removed forever.

curl --include \
     --request DELETE \
     --header "Content-Type: application/json" \
     --data-binary "{\"company_id\": 1, \"timestamp\":\"1414421210832\", \"access_token\":\"K2Pxkwvx6-3PtW44zvEV\", \"signature\":\"db00061fa75f869c968f72d48449e457ae06959a\"}" \
http://api.bringg.com/partner_api/teams/{id}
Suggest Edits

Teams

Get Teams

 
gethttps://developer-api.bringg.com/partner_api/teams
curl --request GET \
  --url 'https://developer-api.bringg.com/partner_api/teams?company_id=company_id'
var request = require("request");

var options = { method: 'GET',
  url: 'https://developer-api.bringg.com/partner_api/teams',
  qs: { company_id: 'company_id' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://developer-api.bringg.com/partner_api/teams?company_id=company_id")

http = Net::HTTP.new(