Bringg

Suggest Edits

Create Order (Task)

Use to create an order (task). The Create Order service is the Bringg Service you can use to create the “unit of action” connecting the company, the driver, and the customer. An order describes the general or meta information for each "unit of action" request. The Create Order service, also called Create Task, supports various use cases by combining the attributes and objects described below for robust order creation including:

  • single pickup and delivery

  • a multi pickup and delivery combination

  • long routes.

An order includes:

  • A customer - the owner of the order. The customer can view all stops in the order and is frequently the last stop in the order. For information about the customer object, see Customer Object.

  • A user - the driver associated with the order.

  • Order pricing, scheduling, geoposition latitude and longitude, and notes, as well as other feature details associated with orders.

  • A way point or way points - one or more stops in the order including pickups, drop-offs, and visits. For information about the way point object, see Way Point Object. Each way point can including the following:

    • Customer (order owner) details - if the customer attributes for a way point differ from the customer attributes for the order or the other way points, the way point object includes a customer object with those details.

    • Consumer details - information about the consumer at each way point, including name, address, and expected times, as well as additional, optional information. Consumer details are customer objects contained in way point objects.

    • Inventory - items to collect or delivery at each way point, for example parcels, food, and menu items. For information about the inventory object, see Inventory Object.

    • Rules - delivery rules for each way point, if rules exist. Rules are also inherited from tags or other configurations.

The Create Order service requires a customer. The customer can be either an existing customer or a new customer. To create an order for an existing customer, use the Bringg Customer Id. The details of the existing customer will appear on the order. To create an order for a new customer, use the Customer object and include the new customer's details. Additionally, you can include a customer in each way point.

NOTE: Some order details are associated with the entire order while other details are associated with individual way points or customers at individual way points. For example, the payment method is associated with the order and is an attribute of the Create Order service. On the other hand, the delivery confirmation options are associated with individual way points and is an attribute of way point objects within the order.

 
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",
            "original_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,
					"original_quantity" : 1,
					"scan_string" : "9209176"
				}, {
					"name" : "Yum Yum Cat Food 100g",
					"pending" : true,
					"original_quantity" : 5,
					"scan_string" : "9210615"
				}, {
					"id" : 72407,
					"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,
					"original_quantity" : 1,
					"scan_string" : "9209176"
				}, {
					"name" : "Yum Yum Cat Food 100g",
					"pending" : false,
					"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

{
    "success": true,
    "task": {
        "title": "Generic Title",
        "user_id": null,
        "created_at": "2018-01-08T09:33:40.517Z",
        "scheduled_at": "2017-10-31T16:00:00.000Z",
        "lat": 40.7076612,
        "lng": -74.0031032,
        "status": 9,
        "id": 9368408,
        "address": "4196 Water St. , NY 10002",
        "active_way_point_id": 11617699,
        "started_time": null,
        "cancelled_at": null,
        "late": false,
        "extras": null,
        "external_id": "ABC15D",
        "customer_id": 5140241,
        "asap": null,
        "ended_time": null,
        "priority": 9368408,
        "distance_traveled": null,
        "total_price": null,
        "delivery_price": null,
        "tip": null,
        "pre_delivery_tip": null,
        "post_delivery_tip_cash": null,
        "post_delivery_tip_credit": null,
        "left_to_be_paid": null,
        "task_cancellation_reason": null,
        "dispatcher_id": null,
        "uuid": "a4de35d4-9c84-458e-910c-21790600fe9f",
        "ready_to_execute": true,
        "discount": null,
        "tip_driver_enabled": true,
        "tax_price": null,
        "price_before_tax": null,
        "tag_id": 8994,
        "group_uuid": null,
        "group_leader_id": null,
        "automatically_cancelled": 0,
        "parent_task_id": null,
        "payment_method": null,
        "payment_type_name": null,
        "linked_task_id": null,
        "task_notes": [
            {
                "title": "08 Jan, 2018 09:33 AM, John Smith",
                "note": "Please don't ring the bell. Baby is sleeping.",
                "created_at": "2018-01-08T09:33:40.473Z",
                "author_name": "John Smith",
                "id": 10410218,
                "way_point_id": 11617700,
                "url": null,
                "type": "TaskNote",
                "user_id": 59172,
                "lat": 32.1068165,
                "lng": 34.8348318
            }
        ],
        "way_points": [
            {
                "id": 11617699,
                "scheduled_at": "2017-10-31T16:00:00.000Z",
                "has_to_leave_by": null,
                "task_id": 9368408,
                "customer_id": 5140245,
                "done": false,
                "lat": 40.7076612,
                "lng": -74.0031032,
                "address": "4196 Water St. , NY 10002",
                "address_second_line": null,
                "zipcode": null,
                "position": 1,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": "2017-10-31T16:05:00.000Z",
                "eta": null,
                "silent": false,
                "city": "New York",
                "borough": null,
                "full_address": "4196 Water St. , NY 10002, New York",
                "automatic_checkin": false,
                "automatic_checkout": false,
                "phone": null,
                "email": null,
                "no_later_than": null,
                "no_earlier_than": null,
                "rating": null,
                "checkin_lat": null,
                "checkin_lng": null,
                "checkout_lat": null,
                "checkout_lng": null,
                "district": null,
                "house_number": null,
                "company_name": null,
                "customer": {
                    "id": 5140245,
                    "name": "restaurant",
                    "address": null,
                    "address_second_line": null,
                    "zipcode": null,
                    "lat": null,
                    "lng": null,
                    "phone": null,
                    "image": "/images/avatar.png",
                    "email": null,
                    "merchant_id": 11271,
                    "external_id": "5140245",
                    "confirmation_code": "9683",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "customer_notes": []
                }
            },
            ...
        ],
        "shared_locations": [
            {
                "id": 10366781,
                "url": "https://app.bringg.com/she.html?36fe259a&e=2",
                "expired": false,
                "way_point_id": 11617699,
                "customer_id": 5140245,
                "first_seen_on": null,
                "failure_reason": null,
                "shared_successfully": false,
                "shared_on": null,
                "view_counter": 0,
                "uuid": "36fe259a",
                "sharing_method": 4,
                "was_forwarded": false
            }
        ],
        "team_ids": [
            15130
        ],
        "task_inventories": [
            {
                "id": 43006516,
                "task_id": 9368408,
                "inventory_id": 1031813,
                "quantity": 0,
                "original_quantity": 5,
                "merchant_id": 11271,
                "name": "temp",
                "price": 10.4,
                "image": "/images/product-placeholder.png",
                "way_point_id": 11617700,
                "scan_string": "34242342342323432432234",
                "pending": null,
                "note": null,
                "parent_task_inventory_id": null,
                "coc_type": 0,
                "external_id": "12321312",
                "size": null,
                "source_task_id": null
            }
        ],
        "scans": []
    }
}
{
    "success": true,
    "task": {
        "title": "Order Title Goes Here",
        "user_id": null,
        "created_at": "2018-01-08T09:47:37.010Z",
        "scheduled_at": "2017-03-31T16:00:00.000Z",
        "lat": 40.7485411,
        "lng": -73.9857629,
        "status": 9,
        "id": 9368472,
        "address": "350 5th Ave, New York, NY 10118",
        "active_way_point_id": 11617787,
        "started_time": null,
        "cancelled_at": null,
        "late": false,
        "extras": null,
        "external_id": "EXT1234",
        "customer_id": 4646655,
        "asap": null,
        "ended_time": null,
        "priority": 9368472,
        "distance_traveled": null,
        "total_price": null,
        "delivery_price": null,
        "tip": null,
        "pre_delivery_tip": null,
        "post_delivery_tip_cash": null,
        "post_delivery_tip_credit": null,
        "left_to_be_paid": null,
        "task_cancellation_reason": null,
        "dispatcher_id": null,
        "uuid": "45fe756b-1daf-4c9f-846b-a5731739a059",
        "ready_to_execute": true,
        "discount": null,
        "tip_driver_enabled": true,
        "tax_price": null,
        "price_before_tax": null,
        "tag_id": 8994,
        "group_uuid": null,
        "group_leader_id": null,
        "automatically_cancelled": 0,
        "parent_task_id": null,
        "payment_method": null,
        "payment_type_name": null,
        "linked_task_id": null,
        "task_notes": [
            {
                "title": "08 Jan, 2018 09:47 AM, Avi Eliav",
                "note": "Here is the note on the 1st waypoint",
                "created_at": "2018-01-08T09:47:36.891Z",
                "author_name": "Avi Eliav",
                "id": 10410498,
                "way_point_id": 11617787,
                "url": null,
                "type": "TaskNote",
                "user_id": 59172,
                "lat": 32.1068165,
                "lng": 34.8348318
            },
            ...
        ],
        "way_points": [
            {
                "id": 11617787,
                "scheduled_at": "2017-03-31T16:00:00.000Z",
                "has_to_leave_by": null,
                "task_id": 9368472,
                "customer_id": 5064922,
                "done": false,
                "lat": 40.7485411,
                "lng": -73.9857629,
                "address": "350 5th Ave, New York, NY 10118",
                "address_second_line": "1st floor, 3rd door on the right",
                "zipcode": null,
                "position": 1,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": "2017-03-31T16:05:00.000Z",
                "eta": null,
                "silent": false,
                "city": null,
                "borough": null,
                "full_address": "350 5th Ave, New York, NY 10118",
                "automatic_checkin": false,
                "automatic_checkout": false,
                "phone": null,
                "email": null,
                "no_later_than": null,
                "no_earlier_than": null,
                "rating": null,
                "checkin_lat": null,
                "checkin_lng": null,
                "checkout_lat": null,
                "checkout_lng": null,
                "district": null,
                "house_number": null,
                "company_name": null,
                "customer": {
                    "id": 5064922,
                    "name": "Warehouse",
                    "address": "350 5th Ave, New York, NY 10118",
                    "address_second_line": "1st floor, 3rd door on the right",
                    "zipcode": null,
                    "lat": 40.7485411,
                    "lng": -73.9857629,
                    "phone": null,
                    "image": "/images/avatar.png",
                    "email": null,
                    "merchant_id": 11271,
                    "external_id": "5064922",
                    "confirmation_code": "7336",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "customer_notes": []
                }
            },
            ...
        ],
        "shared_locations": [
            {
                "id": 10367047,
                "url": "https://app.bringg.com/she.html?445dc279&e=2",
                "expired": false,
                "way_point_id": 11617787,
                "customer_id": 5064922,
                "first_seen_on": null,
                "failure_reason": null,
                "shared_successfully": false,
                "shared_on": null,
                "view_counter": 0,
                "uuid": "445dc279",
                "sharing_method": 4,
                "was_forwarded": false
            }
        ],
        "team_ids": [
            15130
        ],
        "task_inventories": [
            {
                "id": 43006572,
                "task_id": 9368472,
                "inventory_id": 1012459,
                "quantity": 0,
                "original_quantity": 1,
                "merchant_id": 11271,
                "name": "Acme Cat Litter 1kg",
                "price": null,
                "image": "/images/product-placeholder.png",
                "way_point_id": 11617787,
                "scan_string": "9209176",
                "pending": true,
                "note": null,
                "parent_task_inventory_id": null,
                "coc_type": 0,
                "external_id": "1012459",
                "size": null,
                "source_task_id": null
            },
            ...
        ],
        "scans": []
    }
}
{
    "success": false,
    "message": "Customer 99999 does not exist"
}

Body Params

customer

An object containing detailed information about a new customer to create and associate with this order. NOTE: Use either the customer object attribute (create a new customer) or the customer_id attribute (an existing customer). For more information about customer object attributes, see Customer Object.

customer_id
int32

The Id of an existing customer to associate with this order. NOTE: Use either the customer object attribute (create a new customer) or the customer_id attribute (an existing customer).

delivery_price
float

The delivery price for this order.

discount
float

The discount amount of this order.

external_id

The order's external Id (the order Id in your system).

external_user_id

The external user's (driver's) Id associated with this order (the user or driver's Id in your system).

left_to_be_paid
float

The unpaid balance of this total order.

merchant_id
int32
required

The Id of the company. The merchant_id may be null, if the developer works with only one company.

note

The text of a note associated with the new order (task). If a value is input, this creates a task_note object.

payment_method
int32

The payment method for this order. The values are: 0: unknown, 1: cash, 2: credit, 3: check.

post_delivery_tip_cash
float

The tip (gratuity) paid to the user (driver) in cash after this order delivery.

post_delivery_tip_credit
float

The tip (gratuity) paid to the user (driver) by credit after this order delivery.

pre_delivery_tip
float

The tip (gratuity) paid to the user (driver) before this order delivery.

price_before_tax
float

The net price of this order not including taxes.

priority
int32

The priority of this order.

ready_to_execute

Indicates whether this order is in planning and not visible to users (drivers). The values are: false or 0 - is not in planning and is visible to users (drivers), true or 1 - is in planning and is not visible to users (drivers)

tag_id
int32

The Id of the tag, if tags are enabled.

tax_price
float

The gross price of this order including taxes.

teams

An array of integers containing the Ids of all teams assigned to this order.

tip
float

The tip (gratuity) paid to the user (driver) by the customer for this order.

tip_driver_enabled

Indicates whether the user (driver) is allowed to be tipped. The values are: false or 0 - the user (driver) cannot be tipped, true or 1 - the user (driver can be tipped.

title

This order's title. The maximum length is 255 characters.

total_price
float

The total price of this order.

user_id
int32

The Id of the user (driver) associated with this order. If user_id is input, the order is assigned to the user. If user_id is not input, the order is unassigned.

share_location

Indicates whether to create a shared location context and return its Id for use in the tracking SDK. The values are: false or 0 - do not create a shared location, true or 1 - create a shared location.

way_points

An array of objects containing way_point information. NOTE: The way point object includes inventory, task note, and other way point attributes not attributes. For more information about way point object attributes, see Way Point Object.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The unique Id of this order.

id

Int32

The unique Id of this order.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

automatically_assigned

boolean

Indicates whether this order was automatically assigned. The values are:

  • false or 0 - this order was not automatically assigned
  • true or 1 - this order was automatically assigned.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

An object containing detailed information about the customer associated with this order, see Customer.

customer_id

Int32

The Id of the customer associated with this order.

external_id

string

The order's external Id.

fleet_id

Int32

If this order is assigned to an external fleet, this is the Id of that external fleet.

late

Int32

Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

  • false or 0 - the user (driver) is not late
  • true or 1 - the user (driver) is late

The default value is false.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

priority

Int32

The priority of this order.

ready_to_execute

Int32

Indicates whether this order is in planning and not visible to users (drivers). The values are:

  • false or 0 - is not in planning and is visible to users (drivers)
  • true or 1 - is in planning and is not visible to users (drivers)

status

Int32

This order's status. The values are:

  • 0 - created
  • 1 - assigned
  • 2 - on_the_way
  • 3 - checked_in
  • 4 - done
  • 5 - this status is not in use
  • 6 - accepted
  • 8 - rejected
  • 9 - unacknowledged

The Order Created callback returns the value 0 (created).

scheduled_at

datetime

The date and time this order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_inventories

Array of Objects

An array of objects containing this order's inventory, see Task Inventories.

task_notes

Array of Objects

An array of objects containing notes added to this order, see Task Notes.

team_ids

Array of Int32

An array of Int32 containing the Ids of all teams assigned to this order.

tip_driver_enabled

Int32

Indicates whether the user (driver) is allowed to be tipped. The values are:

  • false or 0 - the user (driver) cannot be tipped
  • true or 1 - the user (driver can be tipped.

title

string

This order's title. The maximum length is 255 characters.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user (driver). The default value is null, if no user (driver) is assigned.

uuid

Int32

The universal unique Id of this order.

way_points

Array of Objects

An array of objects containing way_point information, see Way Point.

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 (Task)

Use to update an order's (task's).

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
"id":8497619,
"automatically_assigned":true,
"customer_id":3185210,
"delivery_price":"250",
"discount":"25",
"external_id":"123456",
"fleet_id":"110",
"left_to_be_paid":"75.5",
"payment_method":"2",
"post_delivery_tip_cash":"15",
"ready_to_execute":"TRUE",
"title":"Daily Delivery",
"user_id":"81029",
"status": 4
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "task": {
        "title": "Daily Delivery",
        "user_id": 81029,
        "created_at": "2017-12-12T08:45:27.939Z",
        "scheduled_at": "2017-12-12T09:14:19.334Z",
        "lat": null,
        "lng": null,
        "status": 4,
        "id": 8497619,
        "address": "1 Martin Pl, Sydney NSW 2000, Australia",
        "active_way_point_id": null,
        "started_time": null,
        "cancelled_at": null,
        "late": true,
        "extras": null,
        "external_id": "123456",
        "customer_id": 3185210,
        "asap": false,
        "ended_time": "2018-01-09T17:37:02.239Z",
        "priority": 8497619,
        "distance_traveled": null,
        "total_price": null,
        "delivery_price": 250,
        "tip": 15,
        "pre_delivery_tip": null,
        "post_delivery_tip_cash": 15,
        "post_delivery_tip_credit": null,
        "left_to_be_paid": 75.5,
        "task_cancellation_reason": null,
        "dispatcher_id": null,
        "uuid": "59fb60d5-c23c-459f-b557-e44de7af2e94",
        "ready_to_execute": true,
        "discount": 25,
        "tip_driver_enabled": false,
        "tax_price": null,
        "price_before_tax": null,
        "tag_id": 8613,
        "group_uuid": null,
        "group_leader_id": null,
        "automatically_cancelled": 0,
        "parent_task_id": null,
        "payment_method": 2,
        "payment_type_name": null,
        "linked_task_id": null,
        "task_notes": [
            {
                "title": "12 Dec, 2017 08:45 AM, Avi Eliav",
                "note": "Drop at dock 3",
                "created_at": "2017-12-12T08:45:27.915Z",
                "author_name": "John Smith",
                "id": 9487200,
                "way_point_id": 10633064,
                "url": null,
                "type": "TaskNote",
                "user_id": 59172,
                "lat": 32.1068165,
                "lng": 34.8348318
            }
        ],
        "way_points": [
            {
                "id": 10633064,
                "scheduled_at": "2017-12-12T09:14:19.334Z",
                "has_to_leave_by": null,
                "task_id": 8497619,
                "customer_id": 4652688,
                "done": false,
                "lat": 40.442228,
                "lng": -80.003107,
                "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "address_second_line": "Annex B",
                "zipcode": null,
                "position": 1,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": true,
                "etl": "2017-12-12T09:19:19.334Z",
                "eta": null,
                "silent": false,
                "city": null,
                "borough": null,
                "full_address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "automatic_checkin": false,
                "automatic_checkout": false,
                "phone": "+9724121234567",
                "email": "mike@beveragebrothers.cm",
                "no_later_than": null,
                "no_earlier_than": null,
                "rating": null,
                "checkin_lat": null,
                "checkin_lng": null,
                "checkout_lat": null,
                "checkout_lng": null,
                "district": null,
                "house_number": null,
                "company_name": null,
                "customer": {
                    "id": 4652688,
                    "name": "Beverage Brothers",
                    "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                    "address_second_line": "Annex B",
                    "zipcode": null,
                    "lat": 40.442228,
                    "lng": -80.003107,
                    "phone": "+9724121234567",
                    "image": "/images/avatar.png",
                    "email": "mike@beveragebrothers.cm",
                    "merchant_id": 11271,
                    "external_id": "4652688",
                    "confirmation_code": "7454",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "customer_notes": []
                }
            }
        ],
        "shared_locations": [],
        "team_ids": [
            7990
        ],
        "task_inventories": [],
        "scans": []
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

id
int32
required

The Id of the order (task) to update.

customer
int32

The Id of an existing customer to associate with this order. NOTE: Use either the customer object attribute (create a new customer) or the customer_id attribute (an existing customer).

delivery_price
float

The delivery price for this order.

external_id

The order's external Id (in your own system).

external_user_id

The external user's (driver's) Id associated with this order (the user or driver's Id in your system).

left_to_be_paid
float

The unpaid balance of this total order.

discount
float

The discount amount of this order.

merchant_id
int32
required

The Id of the company. The merchant_id may be null, if the developer works with only one company.

note

The text of a note associated with this order (task). If a value is input, this creates a task_note object.

payment_method
int32

The payment method for this order. The values are: 0: unknown, 1: cash, 2: credit, 3: check.

post_delivery_tip_cash
float

The tip (gratuity) paid to the user (driver) in cash after this order delivery.

post_delivery_tip_credit
float

The tip (gratuity) paid to the user (driver) by credit after this order delivery.

pre_delivery_tip
float

The tip (gratuity) paid to the user (driver) before this order delivery.

price_before_tax
float

The net price of this order not including taxes.

priority
int32

The priority of this order.

ready_to_execute

Indicates whether this order is in planning and not visible to users (drivers). The values are: false or 0 - is not in planning and is visible to users (drivers), true or 1 - is in planning and is not visible to users (drivers)

status
int32

This order's status. The values are: 0 - created, 1 - assigned, 2 - on_the_way, 3 - checked_in, 4 - done, 5 - this status is not in use, 6 - accepted, 8 - rejected, 9 - unacknowledged.

share_location

Indicates whether to create a shared location context and return its Id for use in the tracking SDK. The values are: false or 0 - do not create a shared location, true or 1 - create a shared location.

tag_id
int32

The Id of the tag, if tags are enabled.

tax_price
float

The gross price of this order including taxes.

teams

An array of integers containing the Ids of all teams assigned to this order.

tip
float

The tip (gratuity) paid to the user (driver) by the customer for this order.

tip_driver_enabled

Indicates whether the user (driver) is allowed to be tipped. The values are: false or 0 - the user (driver) cannot be tipped, true or 1 - the user (driver can be tipped.

title

This order's title. The maximum length is 255 characters.

total_price
float

The total price of this order.

user_id
int32

The Id of the user (driver) associated with this order. If user_id is input, the order is assigned to the user. If user_id is not input, the order is unassigned.

way_points

An array of objects containing way_point information. NOTE: The way point object includes inventory, task note, and other way point attributes not attributes. For more information about way point object attributes, see Way Point Object.

 

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The unique Id of this order.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

automatically_assigned

boolean

Indicates whether this order was automatically assigned. The values are:

  • false or 0 - this order was not automatically assigned
  • true or 1 - this order was automatically assigned.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

An object containing detailed information about the customer associated with this order, see Customer.

customer_id

Int32

The Id of the customer associated with this order.

external_id

string

The order's external Id.

fleet_id

Int32

If this order is assigned to an external fleet, this is the Id of that external fleet.

late

Int32

Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

  • false or 0 - the user (driver) is not late
  • true or 1 - the user (driver) is late

The default value is false.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

priority

Int32

The priority of this order.

ready_to_execute

Int32

Indicates whether this order is in planning and not visible to users (drivers). The values are:

  • false or 0 - is not in planning and is visible to users (drivers)
  • true or 1 - is in planning and is not visible to users (drivers)

status

Int32

This order's status. The values are:

  • 0 - created
  • 1 - assigned
  • 2 - on_the_way
  • 3 - checked_in
  • 4 - done
  • 5 - this status is not in use
  • 6 - accepted
  • 8 - rejected
  • 9 - unacknowledged

scheduled_at

datetime

The date and time this order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_inventories

Array of Objects

An array of objects containing this order's inventory, see Task Inventories.

task_notes

Array of Objects

An array of objects containing notes added to this order, see Task Notes.

team_ids

Array of Int32

An array of Int32 containing the Ids of all teams assigned to this order.

tip_driver_enabled

Int32

Indicates whether the user (driver) is allowed to be tipped. The values are:

  • false or 0 - the user (driver) cannot be tipped
  • true or 1 - the user (driver can be tipped.

title

string

This order's title. The maximum length is 255 characters.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user (driver). The default value is null, if no user (driver) is assigned.

uuid

Int32

The universal unique Id of this order.

way_points

Array of Objects

An array of objects containing way_point information, see Way Point.

Suggest Edits

Start Order (Task)

Use to start an order (task).

 
posthttps://developer-api.bringg.com/services
{
	"id": 9707185
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "task": {
        "title": "Rush Delivery 45 cases of soda",
        "user_id": null,
        "created_at": "2018-01-17T11:59:07.083Z",
        "scheduled_at": "2018-01-17T12:27:56.704Z",
        "lat": 40.442228,
        "lng": -80.003107,
        "status": 9,
        "id": 9707185,
        "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
        "active_way_point_id": 11997420,
        "started_time": null,
        "asap": null,
        "late": false,
        "late_reason": null,
        "extras": null,
        "merchant_name": null,
        "external_id": "9707185",
        "uuid": "42dc2690-f7df-4d2b-a6c7-2ed6831b1176",
        "priority": 9707185,
        "total_price": 200,
        "delivery_price": 22.5,
        "left_to_be_paid": 50,
        "distance_traveled": null,
        "dispatcher_id": null,
        "tag_id": 8613,
        "cancelled_at": null,
        "discount": null,
        "tip_driver_enabled": true,
        "run_uuid": null,
        "scheduled_to_be_ready": null,
        "run_start_time": null,
        "run_end_time": null,
        "payment_type_name": null,
        "linked_task_id": null,
        "fleet_id": null,
        "fleet_delivery_external_id": null,
        "first_way_point_has_to_leave_by": null,
        "customer": {
            "id": 4652688,
            "name": "Beverage Brothers",
            "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
            "address_second_line": "Annex B",
            "zipcode": null,
            "lat": 40.442228,
            "lng": -80.003107,
            "phone": "+9724121234567",
            "image": "/images/avatar.png",
            "email": "mike@beveragebrothers.cm",
            "merchant_id": 11271,
            "external_id": "4652688",
            "confirmation_code": "7454",
            "client_version": null,
            "client_name": null,
            "mobile_type": 0,
            "allow_login": false,
            "extras": null,
            "city": null,
            "borough": null,
            "state": null,
            "street": null,
            "business_code": null,
            "language": null,
            "customer_notes": []
        },
        "user": null,
        "task_notes": [],
        "way_points": [
            {
                "id": 11997420,
                "scheduled_at": "2018-01-17T12:27:56.704Z",
                "has_to_leave_by": null,
                "task_id": 9707185,
                "customer_id": 4652688,
                "done": false,
                "lat": 40.442228,
                "lng": -80.003107,
                "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "address_second_line": "Annex B",
                "zipcode": null,
                "position": 1,
                "city": null,
                "borough": null,
                "street": null,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": "2018-01-17T12:32:56.704Z",
                "eta": null,
                "silent": false,
                "allow_editing_inventory": true,
                "allow_editing_payment": null,
                "allow_scanning_inventory": null,
                "automatic_checkin": null,
                "automatic_checkout": null,
                "phone": "+9724121234567",
                "distance_traveled_server": null,
                "must_approve_inventory": false,
                "contacts": [
                    {
                        "customer_id": 4652688,
                        "contact_type": "phone",
                        "contact_value": "+9724121234567",
                        "sharing_allowed": true
                    },
                    {
                        "customer_id": 4652688,
                        "contact_type": "email",
                        "contact_value": "mike@beveragebrothers.cm",
                        "sharing_allowed": false
                    }
                ],
                "no_later_than": null,
                "no_earlier_than": null,
                "extra_customers": [],
                "pending_geocode": false,
                "customer": {
                    "id": 4652688,
                    "name": "Beverage Brothers",
                    "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                    "address_second_line": "Annex B",
                    "zipcode": null,
                    "lat": 40.442228,
                    "lng": -80.003107,
                    "phone": "+9724121234567",
                    "image": "/images/avatar.png",
                    "email": "mike@beveragebrothers.cm",
                    "merchant_id": 11271,
                    "external_id": "4652688",
                    "confirmation_code": "7454",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "customer_notes": []
                },
                "rating": null,
                "inventory_changes": []
            }
        ],
        "shared_locations": [
            {
                "id": 10754606,
                "url": "https://app.bringg.com/she.html?919793fd&e=2",
                "expired": false,
                "way_point_id": 11997420,
                "customer_id": 4652688,
                "first_seen_on": null,
                "failure_reason": "Unroutable message - rejected",
                "shared_successfully": false,
                "shared_on": null,
                "view_counter": 0,
                "uuid": "919793fd",
                "sharing_method": 0,
                "was_forwarded": false
            }
        ],
        "team_ids": [
            15132
        ],
        "task_inventories": [],
        "scans": []
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

Id
int32
required

The Id of the order (task) to start.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The unique Id of this order.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

automatically_assigned

boolean

Indicates whether this order was automatically assigned. The values are:

  • false or 0 - this order was not automatically assigned
  • true or 1 - this order was automatically assigned.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

An object containing detailed information about the customer associated with this order, see Customer.

customer_id

Int32

The Id of the customer associated with this order.

external_id

string

The order's external Id.

fleet_id

Int32

If this order is assigned to an external fleet, this is the Id of that external fleet.

late

Int32

Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

  • false or 0 - the user (driver) is not late
  • true or 1 - the user (driver) is late

The default value is false.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

priority

Int32

The priority of this order.

ready_to_execute

Int32

Indicates whether this order is in planning and not visible to users (drivers). The values are:

  • false or 0 - is not in planning and is visible to users (drivers)
  • true or 1 - is in planning and is not visible to users (drivers)

status

Int32

This order's status. The values are:

  • 0 - created
  • 1 - assigned
  • 2 - on_the_way
  • 3 - checked_in
  • 4 - done
  • 5 - this status is not in use
  • 6 - accepted
  • 8 - rejected
  • 9 - unacknowledged

scheduled_at

datetime

The date and time this order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_inventories

Array of Objects

An array of objects containing this order's inventory, see Task Inventories.

task_notes

Array of Objects

An array of objects containing notes added to this order, see Task Notes.

team_ids

Array of Int32

An array of Int32 containing the Ids of all teams assigned to this order.

tip_driver_enabled

Int32

Indicates whether the user (driver) is allowed to be tipped. The values are:

  • false or 0 - the user (driver) cannot be tipped
  • true or 1 - the user (driver can be tipped.

title

string

This order's title. The maximum length is 255 characters.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user (driver). The default value is null, if no user (driver) is assigned.

uuid

Int32

The universal unique Id of this order.

way_points

Array of Objects

An array of objects containing way_point information, see Way Point.

Suggest Edits

Arrived to Location (Check-in)

Use to update an order (task) that the driver arrived at the next location (way point) in the order.

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

You couldn't be authenticated

{
    "success": true,
    "task": {
        "title": "Daily Morning Delivery Route A",
        "user_id": 77552,
        "created_at": "2018-01-11T15:58:01.026Z",
        "scheduled_at": "2018-01-11T16:27:16.604Z",
        "lat": 40.442228,
        "lng": -80.003107,
        "status": 3,
        "id": 9497399,
        "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
        "active_way_point_id": 11760055,
        "started_time": null,
        "cancelled_at": null,
        "late": false,
        "extras": null,
        "external_id": "9497399",
        "customer_id": 4652688,
        "asap": null,
        "ended_time": null,
        "priority": 9497399,
        "distance_traveled": null,
        "total_price": 250,
        "delivery_price": 5,
        "tip": 10,
        "pre_delivery_tip": null,
        "post_delivery_tip_cash": null,
        "post_delivery_tip_credit": null,
        "left_to_be_paid": 25,
        "task_cancellation_reason": null,
        "dispatcher_id": null,
        "uuid": "e8acf73d-40ce-4940-a79e-2523b7d3e9f3",
        "ready_to_execute": true,
        "discount": null,
        "tip_driver_enabled": true,
        "tax_price": null,
        "price_before_tax": null,
        "tag_id": 8613,
        "group_uuid": null,
        "group_leader_id": null,
        "automatically_cancelled": 0,
        "parent_task_id": null,
        "payment_method": null,
        "payment_type_name": null,
        "linked_task_id": null,
        "task_notes": [],
        "way_points": [
            {
                "id": 11760055,
                "scheduled_at": "2018-01-11T16:27:16.604Z",
                "has_to_leave_by": null,
                "task_id": 9497399,
                "customer_id": 4652688,
                "done": false,
                "lat": 40.442228,
                "lng": -80.003107,
                "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "address_second_line": "Annex B",
                "zipcode": null,
                "position": 1,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": "2018-01-11T16:32:16.604Z",
                "eta": null,
                "silent": false,
                "city": null,
                "borough": null,
                "full_address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "automatic_checkin": false,
                "automatic_checkout": false,
                "phone": "+9724121234567",
                "email": "mike@beveragebrothers.cm",
                "no_later_than": null,
                "no_earlier_than": null,
                "rating": null,
                "checkin_lat": null,
                "checkin_lng": null,
                "checkout_lat": null,
                "checkout_lng": null,
                "district": null,
                "house_number": null,
                "company_name": null,
                "customer": {
                    "id": 4652688,
                    "name": "Beverage Brothers",
                    "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                    "address_second_line": "Annex B",
                    "zipcode": null,
                    "lat": 40.442228,
                    "lng": -80.003107,
                    "phone": "+9724121234567",
                    "image": "/images/avatar.png",
                    "email": "mike@beveragebrothers.cm",
                    "merchant_id": 11271,
                    "external_id": "4652688",
                    "confirmation_code": "7454",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "customer_notes": []
                }
            },
            ...
        ],
        "shared_locations": [
            {
                "id": 10518339,
                "url": "https://app.bringg.com/she.html?160ab94f&e=2",
                "expired": false,
                "way_point_id": 11760055,
                "customer_id": 4652688,
                "first_seen_on": null,
                "failure_reason": "Unroutable message - rejected",
                "shared_successfully": false,
                "shared_on": null,
                "view_counter": 0,
                "uuid": "160ab94f",
                "sharing_method": 0,
                "was_forwarded": false
            }
        ],
        "team_ids": [
            15130
        ],
        "task_inventories": [],
        "scans": []
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

id
int32
required

The Id of the order (task) for which the driver arrived to a location.

 

OUTPUT PARAM

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The unique Id of this order.

message

string

If an error occurred, a message indicating the error.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

automatically_assigned

boolean

Indicates whether this order was automatically assigned. The values are:

  • false or 0 - this order was not automatically assigned
  • true or 1 - this order was automatically assigned.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

A object containing detailed information about the customer associated with this order, see Customer Object.

customer_id

Int32

The Id of the customer associated with this order.

delivery_price

double

The price of this delivery.

discount

double

The discount amount of this order.

dispatcher_id

Int32

If the dispatcher locked this order, the Id of the dispatcher.

distance_traveled

double

The actual distance traveled (in km).

external_id

string

The order's external Id.

extras

Object

Internal Use.

fleet_delivery_external_id

string

If this order is assigned to an external fleet, this is the Id used by that external fleet.

fleet_id

Int32

If this order is assigned to an external fleet, this is the Id of that external fleet.

group_leader_id

Int32

If this order is a group of orders, this is the Id of the order representing the entire collection of orders in the group (the parent order containing all child orders in the group). This is the Id that Bringg operators (for example, dispatchers and users/drivers) view. NOTE: Bringg internally maintains each order and each order contains the same group leader Id.

group_uuid

uuid

If this order is a group of orders, this is the UUID of the group (see group_leader_id above).

last_assigned_time

datetime

The last date and time an order was assigned to the user (driver). This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

late

Int32

Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

  • false or 0 - the user (driver) is not late
  • true or 1 - the user (driver) is late

The default value is false.

left_to_be_paid

double

The unpaid balance of this total order.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

parent_task_id

Int32

If this order was created from another order (for example, a failed order), this is the Id of that original order.

payment_type_name

string

The name of the payment type. For example, Visa, Mastercard, or Amex.

post_delivery_tip_cash

double

The tip (gratuity) paid to the user (driver) in cash after this order delivery.

post_delivery_tip_credit

double

The tip (gratuity) paid to the user (driver) by credit after this order delivery.

pre_delivery_tip

The tip (gratuity) paid to the user (driver) before this order delivery.

price_before_tax

double

The net price of this order not including taxes.

priority

Int32

The priority of this order.

ready_to_execute

boolean

Indicates whether this order is in planning and not visible to users (drivers). The values are:

  • false or 0 - is not in planning and is visible to users (drivers)
  • true or 1 - is in planning and is not visible to users (drivers

run_start_time

datetime

If the order is part of a "run", this is the start date and time of the "run". A "run" is a group of user (driver) tasks beginning at the time a user (driver) leaves a "base" and ending when the user (driver) returns to that "base". This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

run_uuid

uuid

If the order is part of a "run", this is the UUID of the "run". A "run" is a group of user (driver) tasks beginning at the time a user (driver) leaves a "base" and ending when the user (driver) returns to that "base".

scheduled_at

datetime

The date and time this order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

start_lat

double

The geoposition latitude of the user (driver) when this order started.

start_lng

double

The geoposition longitude of the user (driver) when this order started.

started_time

datetime

The date and time this order was started. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

status

Int32

This order's status. The values are:

  • 0 - created
  • 1 - assigned
  • 2 - on_the_way
  • 3 - checked_in
  • 4 - done
  • 5 - this status is not in use
  • 6 - accepted
  • 8 - rejected
  • 9 - unacknowledged

This Order Created callback returns the value 3 (checked_in).

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_inventories

Array of Objects

An array of objects containing this order's inventory, see Task Inventories Object.

task_notes

Array of Objects

An array of objects containing notes added to this order, see Task Notes Object.

tax_price

double

The gross price of this order including taxes.

tip

double

The tip (gratuity) paid to the user (driver) by the customer for this order.

tip_driver_enabled

Indicates whether the user (driver) is allowed to be tipped. The values are:

  • false or 0 - the user (driver) cannot be tipped
  • true or 1 - the user (driver can be tipped

title

string

This order's title. The maximum length is 255 characters.

total_price

double

The total price of this order.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user (driver).

uuid

Int32

The universal unique Id of this order.

way_points

Array of Objects

An array of objects containing way_point information, see Way Point Object.

webhooks

boolean

Indicates whether webhooks can be set for this order. The values are:

  • false or 0 - webhooks cannot be set for this task
  • true or 1 - webhooks can be set for this task.
Suggest Edits

Left Location (Check-out)

This service is pending a documentation update.

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

You couldn't be authenticated

{
    "success": false,
    "message": "Can't update a done order"
}

Body Params

id
int32
required

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

 
Suggest Edits

Create Note

Use to create a note for a way point.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"task_id": 12345,
	"way_point_id": 56789,
	"note": "Google",
	"type" : "HtmlTaskNote",
	"url" : "https://www.google.com",
	"user_id": "44444"
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "task": {
        "id": 10416492,
        "note": "Google",
        "user_id": 44444,
        "task_id": 12345,
        "created_at": "2018-01-08T13:51:36.955Z",
        "updated_at": "2018-01-08T13:51:36.955Z",
        "url": "https://www.google.com",
        "way_point_id": 56789,
        "customer_id": null,
        "pending_upload": false,
        "lat": null,
        "lng": null,
        "type": "HtmlTaskNote"
    }
}
{
    "success": false,
    "rc": 1,
    "message": "Can't create eempty message"
}

Body Params

note
required

The text of this note.

task_id
int32
required

The Id of the order (task) to which this note belongs.

type

The type of note. The values include: FormattedTaskNote, Form, HtmlTaskNote, Signature, TaskNote (text), TaskPhoto. Leave blank to create a text note. Use value "HtmlTaskNote" to create notes with a hyperlink.

url

The URL (hyperlink) added in this note for notes of type HTMLTaskNotes.

user_id
int32

The Id of the user creating this note.

way_point_id
int32

The Id of the way point to which this note was added.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

created_at

datetime

The date and time this note was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer_id

Int32

The Id of the customer with which this note is associated.

lat

double

The geoposition latitude of the user (driver) when the task note was added.

lng

double

The geoposition longitutde of the user (driver) when the task note was added.

pending_upload

boolean

Indicates whether the note is pending upload (or was already uploaded). A note may be pending upload due to the size of the note or system latency.

  • false or 0 - the note is not pending upload
  • true or 1 - the note is pending upload

task_id

Int32

Bringg order Id.

type

string

The type of task note. The values include:

  • FormattedTaskNote
  • Form
  • HtmlTaskNote
  • Signature
  • TaskNote (text)
  • TaskPhoto

updated_at

datetime

The date and time of the last update for this note. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

url

text

URL added to this note.

user_id

Int32

The Id of the user (driver).

way_point_id

Int32

The Id of the way point with which this note is associated.

Suggest Edits

Opened Orders (Tasks)

Use to get a list of open orders.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
**Requires no parameters**
A binary file was returned

You couldn't be authenticated

[
    {
        "title": "Pickup returns",
        "user_id": null,
        "created_at": "2017-12-12T14:15:53.441Z",
        "scheduled_at": "2017-12-12T14:45:12.900Z",
        "lat": 40.442228,
        "lng": -80.003107,
        "status": 0,
        "id": 8500047,
        "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
        "active_way_point_id": 10636415,
        "started_time": null,
        "cancelled_at": null,
        "late": true,
        "extras": null,
        "external_id": "8500047",
        "customer_id": 4652688,
        "asap": null,
        "ended_time": null,
        "priority": 8500047,
        "distance_traveled": null,
        "total_price": null,
        "delivery_price": null,
        "tip": null,
        "pre_delivery_tip": null,
        "post_delivery_tip_cash": null,
        "post_delivery_tip_credit": null,
        "left_to_be_paid": null,
        "task_cancellation_reason": null,
        "dispatcher_id": null,
        "uuid": "f5a87f3d-b774-4578-9674-d912b9ee8ac4",
        "ready_to_execute": true,
        "discount": null,
        "tip_driver_enabled": false,
        "tax_price": null,
        "price_before_tax": null,
        "tag_id": 8613,
        "group_uuid": null,
        "group_leader_id": null,
        "automatically_cancelled": 0,
        "parent_task_id": null,
        "payment_method": null,
        "payment_type_name": null,
        "linked_task_id": null,
        "task_notes": [
            {
                "title": "12 Dec, 2017 02:16 PM, John Smith",
                "note": "Ask foreman about 5 additional cases for return.",
                "created_at": "2017-12-12T14:16:59.942Z",
                "author_name": "John Smith",
                "id": 9492388,
                "way_point_id": 10636415,
                "url": null,
                "type": "TaskNote",
                "user_id": 59172,
                "lat": 32.1068165,
                "lng": 34.8348318
            },
            ...
        ],
        "way_points": [
            {
                "id": 10636415,
                "scheduled_at": "2017-12-12T14:45:12.900Z",
                "has_to_leave_by": null,
                "task_id": 8500047,
                "customer_id": 4652688,
                "done": false,
                "lat": 40.442228,
                "lng": -80.003107,
                "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "address_second_line": "Annex B",
                "zipcode": null,
                "position": 1,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": true,
                "etl": "2017-12-12T14:50:12.900Z",
                "eta": null,
                "silent": false,
                "city": null,
                "borough": null,
                "full_address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "automatic_checkin": false,
                "automatic_checkout": false,
                "phone": "2125551234",
                "email": "mike@beveragebrothers.cm",
                "no_later_than": null,
                "no_earlier_than": null,
                "rating": null,
                "checkin_lat": null,
                "checkin_lng": null,
                "checkout_lat": null,
                "checkout_lng": null,
                "district": null,
                "house_number": null,
                "company_name": null,
                "customer": {
                    "id": 4652688,
                    "name": "Beverage Brothers",
                    "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                    "address_second_line": "Annex B",
                    "zipcode": null,
                    "lat": 40.442228,
                    "lng": -80.003107,
                    "phone": "2125551234",
                    "image": "/images/avatar.png",
                    "email": "mike@beveragebrothers.cm",
                    "merchant_id": 11271,
                    "external_id": "4652688",
                    "confirmation_code": "7454",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "customer_notes": []
                }
            }
        ],
        "shared_locations": [],
        "team_ids": [],
        "task_inventories": [],
        "scans": []
    },
  ...
]
 

OUTPUT PARAM

The output is an array of order (task) objects.

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

id

Int32

The unique Id of this order.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

automatically_assigned

boolean

Indicates whether this order was automatically assigned. The values are:

  • false or 0 - this order was not automatically assigned
  • true or 1 - this order was automatically assigned.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

A object containing detailed information about the customer associated with this order, see Customer Object.

customer_id

Int32

The Id of the customer associated with this order.

external_id

string

The order's external Id.

fleet_id

Int32

If this order is assigned to an external fleet, this is the Id of that external fleet.

late

Int32

Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

  • false or 0 - the user (driver) is not late
  • true or 1 - the user (driver) is late

The default value is false.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

priority

Int32

The priority of this order.

ready_to_execute

Int32

Indicates whether this order is in planning and not visible to users (drivers). The values are:

  • false or 0 - is not in planning and is visible to users (drivers)
  • true or 1 - is in planning and is not visible to users (drivers)

status

Int32

This order's status. The values are:

  • 0 - created
  • 1 - assigned
  • 2 - on_the_way
  • 3 - checked_in
  • 4 - done
  • 5 - this status is not in use
  • 6 - accepted
  • 8 - rejected
  • 9 - unacknowledged

scheduled_at

datetime

The date and time this order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_inventories

Array of objects

An array of objects containing this order's inventory, see Task Inventories Object.

task_notes

Array of objects

An array of objects containing notes added to this order, see Task Notes Object.

team_ids

Array of Int32

An array of Int32 containing the Ids of all teams assigned to this order.

tip_driver_enabled

Int32

Indicates whether the user (driver) is allowed to be tipped. The values are:

  • false or 0 - the user (driver) cannot be tipped
  • true or 1 - the user (driver can be tipped.

title

string

This order's title. The maximum length is 255 characters.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user (driver). The default value is null, if no user (driver) is assigned.

uuid

Int32

The universal unique Id of this order.

way_points

Array of objects

An array of objects containing way_point information, see Way Point Object.

Suggest Edits

Post Optimization Orders (Tasks)

Use to list post optimization orders

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
**Requires no parameters**
A binary file was returned

You couldn't be authenticated

[
    {
        "id": 9626561,
        "external_id": "EXT12345678",
        "priority": 5,
        "user_id": 77552,
        "driver_external_id": "77552",
        "first_way_point_has_to_leave_by": null,
        "last_way_point_schedule": "2017-10-31T17:00:00.000Z"
    },
    {
        "id": 9626618,
        "external_id": "EXT12345678",
        "priority": 5,
        "user_id": 77552,
        "driver_external_id": "77552",
        "first_way_point_has_to_leave_by": null,
        "last_way_point_schedule": "2017-10-31T17:00:00.000Z"
    },
    ...
]
 

OUTPUT PARAMS

The output is an array of objects.

Id

Int32

The Id of this order (task).

driver_external_id

Int32

The external Id of the driver associated with this order (task).

external_id

string

The order's (task's) external Id.

first_way_point_has_to_leave_by

datetime

The date and time the user (driver) must leave the first way point. This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z"

last_way_point_schedule

datetime

The date and time scheduled for the last way point. This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z"

Suggest Edits

End Order (Task)

Use to end an order (task).

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

You couldn't be authenticated

{
    "success": true,
    "task": {
        "title": "Daily Morning Delivery Route A",
        "user_id": 77552,
        "created_at": "2018-01-11T15:58:01.026Z",
        "scheduled_at": "2018-01-11T16:27:16.604Z",
        "lat": null,
        "lng": null,
        "status": 4,
        "id": 9497399,
        "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
        "active_way_point_id": null,
        "started_time": "2018-01-15T18:36:28.023Z",
        "asap": false,
        "late": false,
        "late_reason": null,
        "extras": null,
        "merchant_name": null,
        "external_id": "9497399",
        "uuid": "e8acf73d-40ce-4940-a79e-2523b7d3e9f3",
        "priority": 9497399,
        "total_price": 250,
        "delivery_price": 5,
        "left_to_be_paid": 25,
        "distance_traveled": null,
        "dispatcher_id": null,
        "tag_id": 8613,
        "cancelled_at": null,
        "discount": null,
        "tip_driver_enabled": true,
        "run_uuid": null,
        "scheduled_to_be_ready": null,
        "run_start_time": null,
        "run_end_time": null,
        "payment_type_name": null,
        "linked_task_id": null,
        "fleet_id": null,
        "fleet_delivery_external_id": null,
        "first_way_point_has_to_leave_by": null,
        "customer": {
            "id": 4652688,
            "name": "Beverage Brothers",
            "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
            "address_second_line": "Annex B",
            "zipcode": null,
            "lat": null,
            "lng": null,
            "phone": "+9724121234567",
            "image": "/images/avatar.png",
            "email": "mike@beveragebrothers.cm",
            "merchant_id": 11271,
            "external_id": "4652688",
            "confirmation_code": "7454",
            "client_version": null,
            "client_name": null,
            "mobile_type": 0,
            "allow_login": false,
            "extras": null,
            "city": null,
            "borough": null,
            "state": null,
            "street": null,
            "business_code": null,
            "language": null,
            "customer_notes": []
        },
        "user": {
            "id": 77552,
            "name": "Billy Morrison",
            "status": "offline",
            "sub": "Free",
            "lat": null,
            "lng": null,
            "profile_image": "/images/avatar.png",
            "authentication_token": null,
            "phone": null,
            "admin": false,
            "driver": true,
            "dispatcher": false,
            "current_task": null,
            "beta": false,
            "debug": false,
            "email": "bmorrison@anyemail.com",
            "job_description": "Employee Driver Fulltime",
            "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": 1781729,
            "created_at": "2017-12-11T17:28:23.225Z",
            "partner_user": false,
            "feature_flags": null,
            "authorization_flags": {},
            "confirmed_at": null,
            "confirmation_sent_at": null,
            "battery": null,
            "uuid": "561ef47c-f659-4297-9341-740a1e149481",
            "mobile_type": null,
            "mobile_version": null,
            "device_model": null,
            "default_user_activity": 5,
            "language": null,
            "merchant_id": 11271,
            "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,
            "original_user_id": null,
            "default_welcome_url_id": null,
            "enable_logs": null,
            "in_beacon_range": false,
            "home_address": null,
            "home_lat": null,
            "home_lng": null,
            "team_ids": [
                15130
            ],
            "allowed_user_types": []
        },
        "task_notes": [],
        "way_points": [
            {
                "id": 11760055,
                "scheduled_at": "2018-01-11T16:27:16.604Z",
                "has_to_leave_by": null,
                "task_id": 9497399,
                "customer_id": 4652688,
                "done": true,
                "lat": 40.442228,
                "lng": -80.003107,
                "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "address_second_line": "Annex B",
                "zipcode": null,
                "position": 1,
                "city": null,
                "borough": null,
                "street": null,
                "checkin_time": "2018-01-15T18:36:28.023Z",
                "checkout_time": "2018-01-15T18:36:28.023Z",
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": "2018-01-15T18:36:28.023Z",
                "eta": null,
                "silent": false,
                "allow_editing_inventory": true,
                "allow_editing_payment": null,
                "allow_scanning_inventory": null,
                "automatic_checkin": null,
                "automatic_checkout": null,
                "phone": "+9724121234567",
                "distance_traveled_server": null,
                "must_approve_inventory": false,
                "contacts": [
                    {
                        "customer_id": 4652688,
                        "contact_type": "phone",
                        "contact_value": "+9724121234567",
                        "sharing_allowed": true
                    },
                    {
                        "customer_id": 4652688,
                        "contact_type": "email",
                        "contact_value": "mike@beveragebrothers.cm",
                        "sharing_allowed": false
                    }
                ],
                "no_later_than": null,
                "no_earlier_than": null,
                "extra_customers": [],
                "pending_geocode": false,
                "customer": {
                    "id": 4652688,
                    "name": "Beverage Brothers",
                    "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                    "address_second_line": "Annex B",
                    "zipcode": null,
                    "lat": null,
                    "lng": null,
                    "phone": "+9724121234567",
                    "image": "/images/avatar.png",
                    "email": "mike@beveragebrothers.cm",
                    "merchant_id": 11271,
                    "external_id": "4652688",
                    "confirmation_code": "7454",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "customer_notes": []
                },
                "rating": null,
                "inventory_changes": []
            },
            ...
        ],
        "shared_locations": [
            {
                "id": 10686601,
                "url": "https://app.bringg.com/she.html?a4314956&e=2",
                "expired": true,
                "way_point_id": 11760056,
                "customer_id": 4647476,
                "first_seen_on": null,
                "failure_reason": "",
                "shared_successfully": true,
                "shared_on": "2018-01-15T18:36:28.654Z",
                "view_counter": 0,
                "uuid": "a4314956",
                "sharing_method": 1,
                "was_forwarded": false
            },
            ...
        ],
        "team_ids": [
            15130
        ],
        "task_inventories": [],
        "scans": []
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

Id
int32
required

The Id of the order (task) to end.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

id

Int32

The unique Id of this order.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

automatically_assigned

boolean

Indicates whether this order was automatically assigned. The values are:

  • false or 0 - this order was not automatically assigned
  • true or 1 - this order was automatically assigned.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

A object containing detailed information about the customer associated with this order, see Customer.

customer_id

Int32

The Id of the customer associated with this order.

external_id

string

The order's external Id.

fleet_id

Int32

If this order is assigned to an external fleet, this is the Id of that external fleet.

late

Int32

Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

  • false or 0 - the user (driver) is not late
  • true or 1 - the user (driver) is late

The default value is false.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

priority

Int32

The priority of this order.

ready_to_execute

Int32

Indicates whether this order is in planning and not visible to users (drivers). The values are:

  • false or 0 - is not in planning and is visible to users (drivers)
  • true or 1 - is in planning and is not visible to users (drivers)

status

Int32

This order's status. The values are:

  • 0 - created
  • 1 - assigned
  • 2 - on_the_way
  • 3 - checked_in
  • 4 - done
  • 5 - this status is not in use
  • 6 - accepted
  • 8 - rejected
  • 9 - unacknowledged

The Order Created callback returns the value 4 (done).

scheduled_at

datetime

The date and time this order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_inventories

Array of Object

An array of object containing this order's inventory, see Task Inventories.

task_notes

Array of Object

An array of objects containing notes added to this order, see Task Notes.

team_ids

Array of Int32

An array of Int32 containing the Ids of all teams assigned to this order.

tip_driver_enabled

Int32

Indicates whether the user (driver) is allowed to be tipped. The values are:

  • false or 0 - the user (driver) cannot be tipped
  • true or 1 - the user (driver can be tipped.

title

string

This order's title. The maximum length is 255 characters.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user (driver). The default value is null, if no user (driver) is assigned.

uuid

Int32

The universal unique Id of this order.

way_points

Array of Objects

An array of objects containing way_point information, see Way Point.

Suggest Edits

Cancel Order (Task)

Use to cancel an active order (task).

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

You couldn't be authenticated

{
    "success": true,
    "task": {
        "title": "Daily Delivery",
        "user_id": 77484,
        "created_at": "2018-01-08T14:59:16.922Z",
        "scheduled_at": "2018-01-08T15:28:47.147Z",
        "lat": 40.442228,
        "lng": -80.003107,
        "status": 7,
        "id": 9372386,
        "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
        "active_way_point_id": null,
        "started_time": null,
        "cancelled_at": null,
        "late": false,
        "extras": null,
        "external_id": "9372386",
        "customer_id": 4652688,
        "asap": null,
        "ended_time": "2018-01-08T15:00:34.606Z",
        "priority": 9372386,
        "distance_traveled": null,
        "total_price": null,
        "delivery_price": null,
        "tip": null,
        "pre_delivery_tip": null,
        "post_delivery_tip_cash": null,
        "post_delivery_tip_credit": null,
        "left_to_be_paid": null,
        "task_cancellation_reason": null,
        "dispatcher_id": null,
        "uuid": "fd7a49e4-c5ec-432e-b8df-09a62893475e",
        "ready_to_execute": true,
        "discount": null,
        "tip_driver_enabled": true,
        "tax_price": null,
        "price_before_tax": null,
        "tag_id": 8613,
        "group_uuid": null,
        "group_leader_id": null,
        "automatically_cancelled": 0,
        "parent_task_id": null,
        "payment_method": null,
        "payment_type_name": null,
        "linked_task_id": null,
        "task_notes": [],
        "way_points": [
            {
                "id": 11622435,
                "scheduled_at": "2018-01-08T15:28:47.147Z",
                "has_to_leave_by": null,
                "task_id": 9372386,
                "customer_id": 4652688,
                "done": true,
                "lat": 40.442228,
                "lng": -80.003107,
                "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "address_second_line": "Annex B",
                "zipcode": null,
                "position": 1,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": "2018-01-08T15:33:47.147Z",
                "eta": null,
                "silent": false,
                "city": null,
                "borough": null,
                "full_address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                "automatic_checkin": false,
                "automatic_checkout": false,
                "phone": "+9724121234567",
                "email": "mike@beveragebrothers.cm",
                "no_later_than": null,
                "no_earlier_than": null,
                "rating": null,
                "checkin_lat": null,
                "checkin_lng": null,
                "checkout_lat": null,
                "checkout_lng": null,
                "district": null,
                "house_number": null,
                "company_name": null,
                "customer": {
                    "id": 4652688,
                    "name": "Beverage Brothers",
                    "address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
                    "address_second_line": "Annex B",
                    "zipcode": null,
                    "lat": 40.442228,
                    "lng": -80.003107,
                    "phone": "+9724121234567",
                    "image": "/images/avatar.png",
                    "email": "mike@beveragebrothers.cm",
                    "merchant_id": 11271,
                    "external_id": "4652688",
                    "confirmation_code": "7454",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "customer_notes": []
                }
            }
        ],
        "shared_locations": [
            {
                "id": 10372844,
                "url": "https://app.bringg.com/she.html?b23c2eba&e=2",
                "expired": true,
                "way_point_id": 11622435,
                "customer_id": 4652688,
                "first_seen_on": null,
                "failure_reason": "Unroutable message - rejected",
                "shared_successfully": false,
                "shared_on": null,
                "view_counter": 0,
                "uuid": "b23c2eba",
                "sharing_method": 0,
                "was_forwarded": false
            }
        ],
        "team_ids": [
            15132
        ],
        "task_inventories": [],
        "scans": []
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

id
int32
required

The Id of the active order (task) to cancel.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The unique Id of this order.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

automatically_assigned

boolean

Indicates whether this order was automatically assigned. The values are:

  • false or 0 - this order was not automatically assigned
  • true or 1 - this order was automatically assigned.

cancel_reason

Object

A object containing detailed information about the cancel reason, see Cancel Reasons Object.

cancel_reason_id

Int32

The cancel reason Id.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

A object containing detailed information about the customer associated with this order, Customer Object.

customer_id

Int32

The Id of the customer associated with this order.

delivery_price

double

The price of this delivery.

discount

double

The discount amount of this order.

dispatcher_id

Int32

If the dispatcher locked this order, the Id of the dispatcher.

distance_traveled

double

The actual distance traveled (in km).

ended_time

datetime

The date and time this order was ended. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

extras

Object

Internal Use.

external_id

string

The order's external Id.

fleet_delivery_external_id

string

If this order is assigned to an external fleet, this is the Id used by that external fleet.

fleet_id

Int32

If this order is assigned to an external fleet, this is the Id of that external fleet.

group_leader_id

Int32

If this order is a group of orders, this is the Id of the order representing the entire collection of orders in the group (the parent order containing all child orders in the group). This is the Id that Bringg operators (for example, dispatchers and users/drivers) view. NOTE: Bringg internally maintains each order and each order contains the same group leader Id.

group_uuid

uuid

If this order is a group of orders, this is the UUID of the group (see group_leader_id above).

last_assigned_time

datetime

The last date and time an order was assigned to the user (driver). This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

late

Int32

Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

  • false or 0 - the user (driver) is not late
  • true or 1 - the user (driver) is late

The default value is false.

left_to_be_paid

double

The unpaid balance of this total order.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

parent_task_id

Int32

If this order was created from another order (for example, a failed order), this is the Id of that original order.

payment_type_name

string

The name of the payment type. For example, Visa, Mastercard, or Amex.

pre_delivery_tip

double

The tip (gratuity) paid to the user (driver) before this order delivery.

post_delivery_tip_cash

double

The tip (gratuity) paid to the user (driver) in cash after this order delivery.

post_delivery_tip_credit

double

The tip (gratuity) paid to the user (driver) by credit after this order delivery.

price_before_tax

double

The net price of this order not including taxes.

priority

Int32

The priority of this order.

ready_to_execute

boolean

Indicates whether this order is in planning and not visible to users (drivers). The values are:

  • false or 0 - is not in planning and is visible to users (drivers)
  • true or 1 - is in planning and is not visible to users (drivers

reason

string

The reason the order was cancelled.

run_uuid

UUID

If the order is part of a "run", this is the UUID of the "run". A "run" is a group of user (driver) tasks beginning at the time a user (driver) leaves a "base" and ending when the user (driver) returns to that "base".

scheduled_at

datetime

The date and time this order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

start_lat

double

The geoposition latitude of the user (driver) when this order started.

start_lng

double

The geoposition longitude of the user (driver) when this order started.

status

Int32

This order's status. The values are:

  • 0 - created
  • 1 - assigned
  • 2 - on_the_way
  • 3 - checked_in
  • 4 - done
  • 5 - this status is not in use
  • 6 - accepted
  • 7 - cancelled
  • 8 - rejected
  • 9 - unacknowledged

This Order Created callback returns the value 7 (cancelled).

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_inventories

Array of Objects

An array of objects containing this order inventory.

task_notes

array of objects

An array of objects containing notes added to this order.

tax_price

double

The gross price of this order including taxes.

tip

double

The tip (gratuity) paid to the user (driver) by the customer for this order.

tip_driver_enabled

Indicates whether the user (driver) is allowed to be tipped. The values are:

  • false or 0 - the user (driver) cannot be tipped
  • true or 1 - the user (driver can be tipped

title

string

This order's title. The maximum length is 255 characters.

total_price

double

The total price of this order.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user (driver).

uuid

Int32

The universal unique Id of thise order.

webhooks

boolean

Indicates whether webhooks can be set for this order. The values are:

  • false or 0 - webhooks cannot be set for this task
  • true or 1 - webhooks can be set for this task.
Suggest Edits

Create Customer

Use to create a new customer.

NOTE: Use a customer object for the body parameter, see JSON examples below.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
  "customer": {
   "external_id": "EXT123",
    "name": "John Smith",
    "address": "1405 Lexington Ave, New York",
		"address_second_line": "Apt 2",
    "phone": "555-555-5555",
    "email": "john@company.com",
    "zipcode": "10128",
    "lat": "40.7833404",
    "lng" : "-73.9527781",
    "merchant_id" : 11271,
    "confirmation_code" : "5320",
    "allow_login" : true,
    "allow_sending_email" : true,
    "allow_sending_sms" : true,
    "language": "en"
    }
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "message": "Customer created",
    "customer": {
        "id": 5014158,
        "name": "John Smith",
        "address": "1405 Lexington Ave, New York",
        "address_second_line": null,
        "zipcode": null,
        "lat": 40.7833404,
        "lng": -73.9527782,
        "phone": "+9725555555555",
        "image": "/images/avatar.png",
        "email": "john@company.com",
        "merchant_id": 11271,
        "external_id": "EXT123",
        "confirmation_code": "4895",
        "client_version": null,
        "client_name": null,
        "mobile_type": 0,
        "allow_login": false,
        "extras": null,
        "city": null,
        "borough": null,
        "state": null,
        "street": null,
        "business_code": null,
        "language": null,
        "customer_notes": []
    }
}
{
    "success": false,
    "rc": 0,
    "message": "param is missing or the value is empty: name"
}

Body Params

address

The address of the new customer. Must be geolocated in Google Maps. The maximum length is 255 characters.

address_second_line

The address second line of the new customer, if needed. For example, "First floor" or "Apartment 1".

allow_login

Indicates whether the new customer can login. The values are: false or 0 - customer cannot login, true or 1 - customer can login.

allow_sending_email

Indicates whether the new customer allows email sharing. The values are: false or 0 - customer does not allow email sharing, true or 1 - customer allows email sharing.

allow_sending_sms

Indicates whether the new customer allows SMS sharing.The values are: false or 0 - customer does not allow SMS sharing, true or 1 - customer allows SMS sharing.

borough

The new customer's borough. This can also be used for any neighborhood or zone.

city

The new customer's city.

confirmation_code

The confirmation code sent to the new customer's phone for login verification.

district

The new customer's district.

email

The email address of the new customer. The default value is an empty string.

external_id

The new customer's external Id (in your own system).

house_number
int32

The house number of this customer.

image

The URL of an image associated with the new customer.

language

The language setting from the new customer's app. This is a 2-letter code, for example "en" for English or "fr" for French. Note: This may be different than the company's default language.

lat
float

The latitude of the new customer's address.

lng
float

The longitude of the new customer's address.

merchant_id
int32
required

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name

The name of the new customer. The maximum length is 255 letters.

phone

The phone number of the new customer.

state

The new customer's state.

street

The new customer's street.

zipcode

The new customer's ZIP Code. The default value is null.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The unique Id of this customer.

address

string

This customer's address. The maximum length is 255 characters.

address_second_line

text

This customer's address second line, if needed.

allow_login

boolean

Indicates whether this customer can login. The values are:

  • false or 0 - customer cannot login
  • true or 1 - customer can login

The default value is false.

allow_sending_email

boolean

Indicates whether this customer allows email sharing. The values are:

  • false or 0 - customer does not allow email sharing
  • true or 1 - customer allows email sharing

The default value is true.

allow_sending_sms

boolean

Indicates whether this customer allows SMS sharing.The values are:

  • false or 0 - customer does not allow SMS sharing
  • true or 1 - customer allows SMS sharing

The default value is true.

borough

string

This customer's borough. This can also be used for any neighborhood or zone.

business_code

string

This customer's business code.

city

string

This customer's city.

client_name

string

The client name.

client_version

string

The client version.

confirmation_code

string

The confirmation code sent to this customer's phone for login verification.

customer_notes

Array of Note Objects

An arry of note objects.

email

string

The email address of this customer. The default value is an empty string.

external_id

string

The customer's external Id.

extras

Object

Internal Use.

image

string

The URL of an image associated with this customer.

language

string

The language setting from this customer's app. This is a 2-letter code, for example "en" for English or "fr" for French. Note: This may be different than the company's default language.

lat

double

The latitude of this customer's address.

lng

double

The longitude of this customer's address.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

mobile_type

Int32

The type of mobile. The values are:

  • 0 - unknown
  • 1 - android
  • 2 - ios
  • 3 - windows

The default value is 0.

mobile_version

string

The mobile version of the app. The default value is null.

name

string

The name of this customer. The maximum length is 255 letters.

phone

string

The phone number of this customer.

state

string

This customer's state.

street

string

This customer's street.

zipcode

string

This customer's ZIP Code. The default value is null.

Suggest Edits

Update Customer

Use to update a customer's details.

NOTE: Use a customer object for the body parameter, see JSON examples below.

 
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
    }
}
{
    "success": false,
    "rc": 1,
    "message": "customer not found"
}

Body Params

id
int32
required

The Id of the customer.

address

The address of this customer. Must be geolocated in Google Maps. The maximum length is 255 characters.

address_second_line

The address second line of this customer, if needed. For example, "First floor" or "Apartment 1".

allow_login

Indicates whether this customer can login. The values are: false or 0 - customer cannot login, true or 1 - customer can login.

allow_sending_email

Indicates whether this customer allows email sharing. The values are: false or 0 - customer does not allow email sharing, true or 1 - customer allows email sharing.

allow_sending_sms

Indicates whether this customer allows SMS sharing.The values are: false or 0 - customer does not allow SMS sharing, true or 1 - customer allows SMS sharing.

borough

This customer's borough. This can also be used for any neighborhood or zone.

city

This customer's city.

confirmation_code

The confirmation code sent to this customer's phone for login verification.

district

This customer's district.

email

The email address of this customer. The default value is an empty string.

external_id

This customer's external Id (in your own system).

house_number

The house number of this customer.

image

The URL of an image associated with this customer.

language

The language setting from this customer's app. This is a 2-letter code, for example "en" for English or "fr" for French. Note: This may be different than the company's default language.

lat
float

The latitude of this customer's address.

lng
float

The longitude of this customer's address.

merchant_id
int32
required

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name

The name of this customer. The maximum length is 255 letters.

phone

The phone number of this customer.

state

This customer's state.

street

This customer's street.

zipcode

This customer's ZIP Code. The default value is null.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The unique Id of this customer.

address

string

This customer's address. The maximum length is 255 characters.

address_second_line

text

This customer's address second line, if needed.

allow_login

boolean

Indicates whether this customer can login. The values are:

  • false or 0 - customer cannot login
  • true or 1 - customer can login

The default value is false.

allow_sending_email

boolean

Indicates whether this customer allows email sharing. The values are:

  • false or 0 - customer does not allow email sharing
  • true or 1 - customer allows email sharing

The default value is true.

allow_sending_sms

boolean

Indicates whether this customer allows SMS sharing.The values are:

  • false or 0 - customer does not allow SMS sharing
  • true or 1 - customer allows SMS sharing

The default value is true.

borough

string

This customer's borough. This can also be used for any neighborhood or zone.

business_code

string

This customer's business code.

city

string

This customer's city.

client_name

string

The client name.

client_version

string

The client version.

confirmation_code

string

The confirmation code sent to this customer's phone for login verification.

customer_notes

Array of Note Objects

An arry of note objects.

email

string

The email address of this customer. The default value is an empty string.

external_id

string

The customer's external Id.

extras

Object

Internal Use.

image

string

The URL of an image associated with this customer.

language

string

The language setting from this customer's app. This is a 2-letter code, for example "en" for English or "fr" for French. Note: This may be different than the company's default language.

lat

double

The latitude of this customer's address.

lng

double

The longitude of this customer's address.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

mobile_type

Int32

The type of mobile. The values are:

  • 0 - unknown
  • 1 - android
  • 2 - ios
  • 3 - windows

The default value is 0.

mobile_version

string

The mobile version of the app. The default value is null.

name

string

The name of this customer. The maximum length is 255 letters.

phone

string

The phone number of this customer.

state

string

This customer's state.

street

string

This customer's street.

zipcode

string

This customer's ZIP Code. The default value is null.

Suggest Edits

Create User

Use to create a new user (driver, dispatcher, or admin).

 
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
  }
}
{
    "success": false,
    "rc": 0,
    "message": "param is missing or the value is empty: name"
}

Body Params

admin

Indicates whether the new user is an administrator. The values are: false or 0 - the user is not an administrator, true or 1 - the user is an administrator.

company

The company with which the new user is associated.

dispatcher

Indicates whether the new user is an dispatcher. The values are: false or 0 - the user is not a dispatcher, true or 1 - the user is a dispatcher.

driver

Indicates whether the new user is a driver. The values are: false or 0 - the user is not a driver, true or 1 - the user is a driver.

email

The email address of the new user. The default value is an empty string.

job_description

The new user's job description. The maximum length is 255 characters.

name

The new user's name. The maximum length is 255 characters.

password

The new user's password.

merchant_id
int32
required

The Id of the company. The merchant_id may be null, if the developer works with only one company.

phone

The new user's phone number.

team_ids

An array of the team Id's for the teams of which the new user is a member.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The Id of this new user.

access_token

string

The new user's access token for login.

active_shift_id

Int32

The Id of the user's current shift.

admin

boolean

Indicates whether this user is a Bringg administrator. The values are:

  • false or 0 - the user is not an administrator
  • true or 1 - the user is an administrator

at_home

boolean

Indicates whether the user is at home.

  • false or 0 - the user is not at home
  • true or 1 - the user is at home

authentication_token

string

The new user's authentication token.

authorization_flags

Object

A object containing user privileges.

average_rating

Int32

The user's average rating.

battery

Int32

The user's current battery.

belongs_to_partner

boolean

The parameter description is pending a documentation update.

beta

boolean

Indicates whether the user is a beta.

  • false or 0 - the user is not a beta
  • true or 1 - the user is a beta

blocked_email

boolean

Indicates whether this user's email is blocked. The values are:

  • false or 0 - user's email is not blocked
  • true or 1 - user's email is blocked

The default value is false.

company

string

The name of the company.

confirmation_code

string

The confirmation code sent to this user's phone for login verification.

confirmation_code_sent_at

datetime

The date and time this user's confirmation code was sent. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

created_at

datetime

The date and time this user was created. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

current_task_id

Int32

The Id of this user's current order.

debug

boolean

The parameter description is pending a documentation update.

default_user_activity

Int32

The user's default activity. The values are:

  • 0 - unknown
  • 1 - stationary
  • 2 - walking
  • 3 - running
  • 4 - bicycle
  • 5 - driving

The default values is 5.

default_welcome_url_id

string

The parameter description is pending a documentation update.

delete_at

datetime

The date and time this user was deleted, if the user was deleted. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

device_model

string

dispatcher

boolean

Indicates whether this user is a Bringg dispatcher. The values are:

  • false or 0 - the user is not an dispatcher
  • true or 1 - the user is an dispatcher

The default value is false.

dispatcher_push_token

text

driver

boolean

Indicates whether this user is a Bringg driver. The values are:

  • false or 0 - the user is not an driver
  • true or 1 - the user is an driver

driver_current_sign_in_at

datetime

The date and time the user signed into the current session. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

driver_last_sign_in_at

datetime

The date and time this user last signed. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

driver_sign_in_count

Int32

The number of times the user signed into the app.

email

string

The email address of this customer. The maximum length is 255 characters.

estimated_last_address

string

The last known address of the user using approximation based on last or next delivery.

estimated_last_etl

datetime

The estimated time of leaving the last known order location (ETA plus time on site). This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

estimated_last_lat

double

The last known latitude of the user using approximation based on last or next delivery.

estimated_last_lng

double

The last known longitude of the user using approximation based on last or next delivery.

estimated_last_waypoint_id

Int32

The Id of the last known way point for the user using approximation based on last or next delivery.

eta_to_home

datetime

The date and time of the expected time of arrival to home for this user. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

external_id

string

The customer's external Id.

feature_flags

Object

The parameter description is pending a documentation update.

fleet_id

Int32

If this user is assigned to an external fleet, this is the Id of that external fleet.

force_change_password_date

datetime

The date and time of this user will be required to change passwords. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

force_change_password_token

string

The token for this user's required change of passwords.

home_address

string

This user's (driver's) home address.

home_lat

float

The geolocation latitude of this user's (driver's) home address.

home_lng

float

The geolocation longitude of this user's (driver's) home address.

in_beacon_range

boolean

Indicates whether the user is in range of a known beacon.

  • false or 0 - the user is not in range of a beacon
  • true or 1 - the user is in range of a beacon

job_description

string

The user's job description. The maximum length is 255 characters.

language

string

The user's language.

lat

double

The geoposition latitude of the user when the customer tipped the user.

lng

double

The geoposition longitude of the user when the customer tipped the user.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

mobile_configuration

Object

mobile_type

Int32

The type of mobile. The default value is 0.

mobile_version

string

The mobile version of the app. The default value is null.

num_ratings

Int32

The parameter description is pending a documentation update.

name

string

The name of this customer. The maximum length is 255 characters.

original_phone_number

string

The original phone number of this user, if the phone number was changed.

original_user_id

Int32

The original Id of this user, if the Id was changed.

partner_user

boolean

The parameter description is pending a documentation update.

password_hash

string

The hash of this user's password.

phone

string

The phone number of this customer.

private_vehicle

boolean

Indicates whether the user uses a private vehicle

  • false or 0 - the user does use a private vehicle
  • true or 1 - the user does not use a private vehicle

privilege_id

Int32

The Id of the privileges for this user.

profile_image

text

The URL of a profile image associated with this customer. The default value is null.

push_token

string

This customer's push token.

running_diagnostics

boolean

The parameter description is pending a documentation update.

status

Int32

The user's status. The values are:

  • Free
  • Assigned
  • Started
  • Checked-In
  • Late

sub

string

The sub status of the user. The maximum length is 255 characters.

team_ids

Array of Int32

An array of Int32 containing the Ids of all teams to which this user belongs.

updated_at

datetime

The date and time this user was created. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

user_type_id

Int32

The Id of the user type.

uuid

UUID

The universal unique Id of this customer.

vehicle_type_id

Int32

The Id of the user's vehicle type.

Suggest Edits

Update User

Use to update a user's details.

 
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": 77509,
        "name": "Updated User Name",
        "status": "offline",
        "sub": "Free",
        "lat": null,
        "lng": null,
        "profile_image": "/images/avatar.png",
        "authentication_token": null,
        "phone": null,
        "admin": false,
        "driver": true,
        "dispatcher": true,
        "current_task": null,
        "beta": false,
        "debug": false,
        "email": "user123@test-company.com",
        "job_description": "Team Shift Manager",
        "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-12-11T09:44:53.515Z",
        "partner_user": false,
        "feature_flags": null,
        "authorization_flags": {},
        "confirmed_at": null,
        "confirmation_sent_at": null,
        "battery": null,
        "uuid": "27c06599-f10f-4171-b873-1128b3b4a365",
        "mobile_type": null,
        "mobile_version": null,
        "device_model": null,
        "default_user_activity": 5,
        "language": null,
        "merchant_id": 11271,
        "locked": false,
        "user_type_id": null,
        "privilege_id": null,
        "estimated_last_address": "95 Fifth Ave, Pittsburgh, PA , USA",
        "estimated_last_lat": 40.4417274,
        "estimated_last_lng": -80.0027365,
        "estimated_last_etl": "2017-12-11T18:47:38.586Z",
        "at_home": false,
        "company": null,
        "private_vehicle": true,
        "original_user_id": null,
        "default_welcome_url_id": null,
        "enable_logs": true,
        "in_beacon_range": false,
        "home_address": null,
        "home_lat": null,
        "home_lng": null,
        "team_ids": [],
        "allowed_user_types": []
    }
}
{
    "success": false,
    "message": {
        "email": [
            "has already been taken"
        ]
    }
}

Body Params

id
int32
required

The Id of the user to update.

admin

Indicates whether this user is an administrator. The values are: false or 0 - the user is not an administrator, true or 1 - the user is an administrator.

company

The company with which this user is associated.

dispatcher

Indicates whether this user is an dispatcher. The values are: false or 0 - the user is not a dispatcher, true or 1 - the user is a dispatcher.

driver

Indicates whether this user is a driver. The values are: false or 0 - the user is not a driver, true or 1 - the user is a driver.

email

The email address of this user. The default value is an empty string.

external_id

The external Id of this user (Id in your own system).

job_description

The email address of this user. The default value is an empty string.

language

The language setting from this user's app. This is a 2-letter code, for example "en" for English or "fr" for French. Note: This may be different than the company's default language.

merchant_id
required

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name

This user's name. The maximum length is 255 characters.

password

The password of this user.

phone

The phone number of this user.

team_ids

An array of the team Id's for the teams of which this user is a member.

 

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The Id of this new user.

access_token

string

The new user's access token for login.

active_shift_id

Int32

The Id of the user's current shift.

admin

boolean

Indicates whether this user is a Bringg administrator. The values are:

  • false or 0 - the user is not an administrator
  • true or 1 - the user is an administrator

at_home

boolean

Indicates whether the user is at home.

  • false or 0 - the user is not at home
  • true or 1 - the user is at home

authentication_token

string

The new user's authentication token.

authorization_flags

Object

A object containing user privileges.

average_rating

Int32

The user's average rating.

battery

Int32

The user's current battery.

belongs_to_partner

boolean

The parameter description is pending a documentation update.

beta

boolean

Indicates whether the user is a beta.

  • false or 0 - the user is not a beta
  • true or 1 - the user is a beta

blocked_email

boolean

Indicates whether this user's email is blocked. The values are:

  • false or 0 - user's email is not blocked
  • true or 1 - user's email is blocked

The default value is false.

company

string

The name of the company.

confirmation_code

string

The confirmation code sent to this user's phone for login verification.

confirmation_code_sent_at

datetime

The date and time this user's confirmation code was sent. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

created_at

datetime

The date and time this user was created. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

current_task_id

Int32

The Id of this user's current order.

debug

boolean

The parameter description is pending a documentation update.

default_user_activity

Int32

The user's default activity. The values are:

  • 0 - unknown
  • 1 - stationary
  • 2 - walking
  • 3 - running
  • 4 - bicycle
  • 5 - driving

The default values is 5.

default_welcome_url_id

string

The parameter description is pending a documentation update.

delete_at

datetime

The date and time this user was deleted, if the user was deleted. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

device_model

string

dispatcher

boolean

Indicates whether this user is a Bringg dispatcher. The values are:

  • false or 0 - the user is not an dispatcher
  • true or 1 - the user is an dispatcher

The default value is false.

dispatcher_push_token

text

driver

boolean

Indicates whether this user is a Bringg driver. The values are:

  • false or 0 - the user is not an driver
  • true or 1 - the user is an driver

driver_current_sign_in_at

datetime

The date and time the user signed into the current session. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

driver_last_sign_in_at

datetime

The date and time this user last signed. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

driver_sign_in_count

Int32

The number of times the user signed into the app.

email

string

The email address of this customer. The maximum length is 255 characters.

estimated_last_address

string

The last known address of the user using approximation based on last or next delivery.

estimated_last_etl

datetime

The estimated time of leaving the last known order location (ETA plus time on site). This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

estimated_last_lat

double

The last known latitude of the user using approximation based on last or next delivery.

estimated_last_lng

double

The last known longitude of the user using approximation based on last or next delivery.

estimated_last_waypoint_id

Int32

The Id of the last known way point for the user using approximation based on last or next delivery.

eta_to_home

datetime

The date and time of the expected time of arrival to home for this user. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

external_id

string

The customer's external Id.

feature_flags

Object

The parameter description is pending a documentation update.

fleet_id

Int32

If this user is assigned to an external fleet, this is the Id of that external fleet.

force_change_password_date

datetime

The date and time of this user will be required to change passwords. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

force_change_password_token

string

The token for this user's required change of passwords.

home_address

string

This user's (driver's) home address.

home_lat

float

The geolocation latitude of this user's (driver's) home address.

home_lng

float

The geolocation longitude of this user's (driver's) home address.

in_beacon_range

boolean

Indicates whether the user is in range of a known beacon.

  • false or 0 - the user is not in range of a beacon
  • true or 1 - the user is in range of a beacon

job_description

string

The user's job description. The maximum length is 255 characters.

language

string

The user's language.

lat

double

The geoposition latitude of the user when the customer tipped the user.

lng

double

The geoposition longitude of the user when the customer tipped the user.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

mobile_configuration

Object

mobile_type

Int32

The type of mobile. The default value is 0.

mobile_version

string

The mobile version of the app. The default value is null.

num_ratings

Int32

The parameter description is pending a documentation update.

name

string

The name of this customer. The maximum length is 255 characters.

original_phone_number

string

The original phone number of this user, if the phone number was changed.

original_user_id

Int32

The original Id of this user, if the Id was changed.

partner_user

boolean

The parameter description is pending a documentation update.

password_hash

string

The hash of this user's password.

phone

string

The phone number of this customer.

private_vehicle

boolean

Indicates whether the user uses a private vehicle

  • false or 0 - the user does use a private vehicle
  • true or 1 - the user does not use a private vehicle

privilege_id

Int32

The Id of the privileges for this user.

profile_image

text

The URL of a profile image associated with this customer. The default value is null.

push_token

string

This customer's push token.

running_diagnostics

boolean

The parameter description is pending a documentation update.

status

Int32

The user's status. The values are:

  • Free
  • Assigned
  • Started
  • Checked-In
  • Late

sub

string

The sub status of the user. The maximum length is 255 characters.

team_ids

Array of Int32

An array of Int32 containing the Ids of all teams to which this user belongs.

updated_at

datetime

The date and time this user was created. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

user_type_id

Int32

The Id of the user type.

uuid

UUID

The universal unique Id of this customer.

vehicle_type_id

Int32

The Id of the user's vehicle type.

Suggest Edits

Get User

Use to get the details of a user (driver, dispatcher, or admin).

 
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": "User Name",
    "status": "offline",
    "sub": "Free",
    "lat": null,
    "lng": null,
    "profile_image": "/images/avatar.png",
    "authentication_token": null,
    "phone": null,
    "admin": false,
    "driver": true,
    "dispatcher": false,
    "current_task": null,
    "beta": false,
    "debug": false,
    "email": "test@test-company.com",
    "job_description": "Site Manager",
    "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": "2018-01-09T14:41:56.837Z",
    "partner_user": false,
    "feature_flags": null,
    "authorization_flags": {},
    "confirmed_at": null,
    "confirmation_sent_at": null,
    "battery": null,
    "uuid": "67e81327-30a9-4f4b-ac70-5b76cb901a95",
    "mobile_type": null,
    "mobile_version": null,
    "device_model": null,
    "default_user_activity": 5,
    "language": null,
    "merchant_id": 11271,
    "locked": false,
    "user_type_id": null,
    "privilege_id": null,
    "estimated_last_address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
    "estimated_last_lat": 40.442228,
    "estimated_last_lng": -80.003107,
    "estimated_last_etl": "2017-12-12T09:19:19.334Z",
    "at_home": false,
    "company": null,
    "private_vehicle": true,
    "original_user_id": null,
    "default_welcome_url_id": null,
    "enable_logs": null,
    "in_beacon_range": false,
    "home_address": null,
    "home_lat": null,
    "home_lng": null,
    "team_ids": [
        7990
    ],
    "allowed_user_types": []
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

id
int32
required

The Id of the user whose details to get.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The Id of the user whose details to get.

access_token

string

The new user's access token for login.

active_shift_id

Int32

The Id of the user's current shift.

admin

boolean

Indicates whether this user is a Bringg administrator. The values are:

  • false or 0 - the user is not an administrator
  • true or 1 - the user is an administrator

at_home

boolean

Indicates whether the user is at home. The values are:

  • false or 0 - the user is not at home
  • true or 1 - the user is at home

authentication_token

string

The new user's authentication token.

authorization_flags

Object

A object containing user privileges.

average_rating

Int32

The user's average rating.

battery

Int32

The user's current battery.

belongs_to_partner

boolean

The parameter description is pending a documentation update.

beta

boolean

Indicates whether the user is a beta. The values are:

  • false or 0 - the user is not a beta
  • true or 1 - the user is a beta

blocked_email

boolean

Indicates whether this user's email is blocked. The values are:

  • false or 0 - user's email is not blocked
  • true or 1 - user's email is blocked

The default value is false.

company

string

The name of the company.

confirmation_code

string

The confirmation code sent to this user's phone for login verification.

confirmation_code_sent_at

datetime

The date and time this user's confirmation code was sent. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

created_at

datetime

The date and time this user was created. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

current_task_id

Int32

The Id of this user's current order.

debug

boolean

The parameter description is pending a documentation update.

default_user_activity

Int32

The user's default activity. The values are:

  • 0 - unknown
  • 1 - stationary
  • 2 - walking
  • 3 - running
  • 4 - bicycle
  • 5 - driving

The default values is 5.

default_welcome_url_id

string

The parameter description is pending a documentation update.

delete_at

datetime

The date and time this user was deleted, if the user was deleted. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

device_model

string

dispatcher

boolean

Indicates whether this user is a Bringg dispatcher. The values are:

  • false or 0 - the user is not an dispatcher
  • true or 1 - the user is an dispatcher

The default value is false.

dispatcher_push_token

text

driver

boolean

Indicates whether this user is a Bringg driver. The values are:

  • false or 0 - the user is not an driver
  • true or 1 - the user is an driver

driver_current_sign_in_at

datetime

The date and time the user signed into the current session. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

driver_last_sign_in_at

datetime

The date and time this user last signed. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

driver_sign_in_count

Int32

The number of times the user signed into the app.

email

string

The email address of this customer. The maximum length is 255 characters.

estimated_last_address

string

The last known address of the user using approximation based on last or next delivery.

estimated_last_etl

datetime

The estimated time of leaving the last known order location (ETA plus time on site). This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

estimated_last_lat

double

The last known latitude of the user using approximation based on last or next delivery.

estimated_last_lng

double

The last known longitude of the user using approximation based on last or next delivery.

estimated_last_waypoint_id

Int32

The Id of the last known way point for the user using approximation based on last or next delivery.

eta_to_home

datetime

The date and time of the expected time of arrival to home for this user. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

external_id

string

The customer's external Id.

feature_flags

Object

The parameter description is pending a documentation update.

fleet_id

Int32

If this user is assigned to an external fleet, this is the Id of that external fleet.

force_change_password_date

datetime

The date and time of this user will be required to change passwords. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

force_change_password_token

string

The token for this user's required change of passwords.

home_address

string

The address of this user's home.

home_lat

float

The geoposition latitude of this user's home address.

home_lng

float

The geoposition longitude of this user's home address.

in_beacon_range

boolean

Indicates whether the user is in range of a known beacon. The values are:

  • false or 0 - the user is not in range of a beacon
  • true or 1 - the user is in range of a beacon

job_description

string

The user's job description. The maximum length is 255 characters.

language

string

The user's language.

lat

double

The geoposition latitude of the user when the customer tipped the user.

lng

double

The geoposition longitude of the user when the customer tipped the user.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

mobile_configuration

Object

The configuration of this user's (driver's) mobile device.

mobile_type

Int32

The type of mobile. The default value is 0.

mobile_version

string

The mobile version of the app. The default value is null.

num_ratings

Int32

The parameter description is pending a documentation update.

name

string

The name of this customer. The maximum length is 255 characters.

original_phone_number

string

The original phone number of this user, if the phone number was changed.

original_user_id

Int32

The original Id of this user, if the Id was changed.

partner_user

boolean

The parameter description is pending a documentation update.

password_hash

string

The hash of this user's password.

phone

string

The phone number of this customer.

private_vehicle

boolean

Indicates whether the user uses a private vehicle

  • false or 0 - the user does use a private vehicle
  • true or 1 - the user does not use a private vehicle

privilege_id

Int32

The Id of the privileges for this user.

profile_image

text

The URL of a profile image associated with this customer. The default value is null.

push_token

string

This customer's push token.

running_diagnostics

boolean

The parameter description is pending a documentation update.

status

Int32

The user's status. The values are:

  • Free
  • Assigned
  • Started
  • Checked-In
  • Late

sub

string

The sub status of the user. The maximum length is 255 characters.

team_ids

Array of Int32

An array of Int32 containing the Ids of all teams to which this user belongs.

updated_at

datetime

The date and time this user was created. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

user_type_id

Int32

The Id of the user type.

uuid

UUID

The universal unique Id of this customer.

vehicle_type_id

Int32

The Id of the user's vehicle type.

Suggest Edits

Start Shift

Use to start the shift of a user.

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

You couldn't be authenticated

{
    "success": true,
    "shift": {
        "start_shift": "2018-01-15T17:23:13.688Z",
        "end_shift": null,
        "id": 1807547
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

user_id
int32
required

The user Id of the user whose shift to start.

 

OUTPUT PARAM

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The Id of the shift.

end_shift

datetime

The date and time this shift ended. The value is null if the shift has not ended. This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z".

delete_at

datetime

The date and time this team was deleted This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z".

Suggest Edits

End Shift

Use to end the shift of a user.

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

You couldn't be authenticated

{
    "success": true,
    "shift": {
        "start_shift": "2018-01-15T17:23:13.688Z",
        "end_shift": "2018-01-15T17:38:58.811Z",
        "id": 1807547
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

user_id
int32
required

The user Id of the user whose shift to end.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The Id of the shift.

end_shift

datetime

The date and time this shift ended. The value is null if the shift has not ended. This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z".

delete_at

datetime

The date and time this team was deleted This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z".

Suggest Edits

Driver Home Events

Use to determine whether a driver is at home or left home.

 
posthttps://developer-api.bringg.com/services
{
	"id": 81617,
	"at_home": true
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "message": "Driver Dave Smithson (ID: 81617) got home"
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

Id
int32
required

The Id of the driver. whose home status (left home or at home)

at_home
required

Indicates whether to determine if the driver is at home or left home. The values are: false or 0 - the driver not at home, true or 1 - the driver is at home.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If successful, a message indicating whether the driver is "got home" or "left home". For example, "Driver Dave Smithson (ID: 81617) got home". If an error occurred, a message indicating the error.

Suggest Edits

Delete User

Use to delete a user (driver, dispatcher, or admin).

 
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,
    "rc": 0
}
{
    "success": false,
    "rc": 2,
    "message": "ID not found"
}

Body Params

id
int32
required

The Id of the user (driver, dispatcher, or admin) to delete.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully. The values are:

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

A descriptive message indicating success or the reason for failure.

Suggest Edits

Create Team

Use to create a team.

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

You couldn't be authenticated

{
    "success": true,
    "team": {
        "id": 15531,
        "name": "New Team 123",
        "description": "Team description",
        "merchant_id": 11271,
        "parent_team_id": null,
        "created_at": "2018-01-15T16:19:09.443Z",
        "updated_at": "2018-01-15T16:19:09.443Z",
        "extra": null,
        "delete_at": null,
        "external_id": "12345",
        "extras": null,
        "contact_phone": "+15555555",
        "geohash": null,
        "lat": 40.7119677,
        "lng": -73.9830995,
        "zipcode": "12345",
        "address": "416 Water St. New York, NY 10002",
        "time_zone": "America/Los_Angeles",
        "distance_pay_per_km": null,
        "home_area": null,
        "service_zipcodes": [],
        "service_boroughs": [],
        "service_cities": [],
        "default_customer_id": 5293671,
        "default_user_id": null,
        "required_coc_type": 0,
        "beacon_ids": [],
        "feature_flags": null,
        "printer_type": null,
        "task_invoice_template_name": null,
        "country_code": null
    }
}
{
    "success": false,
    "rc": 0,
    "message": "param is missing or the value is empty: name"
}

Body Params

address

The address of the new team.

contact_phone

The contact phone number associated with this team.

description

The description of the new team.

external_id

The external Id of the new team.

lat
float

The geoposition latitude of the new team.

lng
float

The geoposition longitude of the new team.

merchant_id
int32
required

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name
required

The name of the new team.

time_zone

The time zone of the new team.

zipcode

The ZIP Code of the new team.

 

OUTPUT PARAM

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The Id of the new team.

address

string

The of this team.

beacon_ids

Array of strings

An array of Ids for the beacons associated with the team.

contact_phone

string

The contact phone number associated with this team.

country_code

string

The country code of this team. The maximum length is 255 characters.

created_at

datetime

"The date and time this team was created. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

default_customer_id

Int32

The default customer Id of this team.

default_user_id

Int32

The default user (driver) Id for this team.

delete_at

datetime

The date and time this team was deleted This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

description

string

The description of this team.

distance_pay_per_km

float

The distance pay per kilometer for this team.

external_id

string

The team's external Id.

extra

Object

Internal use.

extras

Object

Internal use.

feature_flags

Object

The parameter description is pending a documentation update.

geohash

string

The geohash (public domain geocoding system hash) of this team.

home_area

Object

An object containing the home areas for this team.

lat

float

The geoposition latitude of the team's address.

lng

float

The geoposition longitude of the team's address.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name

string

The name of this team.

parent_team_id

Int32

The Id of the parent team with which this team is associated.

printer_type

string

The parameter description is pending a documentation update.

required_coc_type

Int32

The required chain of custody type. The values include:

  • 0 - weak
  • 1 - strong
  • 2 - none
  • 3 - unload
"

service_boroughs

Array of text

An array of boroughs serviced by this team.

service_cities

Array of text

An array of cities serviced by this team.

service_zipcodes

Array of text

An array of ZIP Codes serviced by this team.

task_invoice_template_name

string

The parameter description is pending a documentation update.

time_zone

string

The time zone of the team.

updated_at

datetime

The last update date and time for this team. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

zipcode

string

The ZIP Code of this team.

Suggest Edits

Update Team

Use to update the details of a team.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"id":15549,
	  "team": {
	    "name": "Update Team 123",
	    "merchant_id": 11271,
	    "description": "Update Team description",
	    "address": "100 Water St. New York, NY 10002",
	    "external_id": "67890",
	    "zipcode": "10002",
	    "contact_phone":"+14444444",
	    "time_zone":"America/Los_Angeles"
	  }
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "team": {
        "id": 15549,
        "name": "Update Team 123",
        "description": "Update Team description",
        "merchant_id": 11271,
        "parent_team_id": null,
        "created_at": "2018-01-15T17:06:23.426Z",
        "updated_at": "2018-01-15T17:11:17.747Z",
        "extra": null,
        "delete_at": null,
        "external_id": "67890",
        "extras": null,
        "contact_phone": "+14444444",
        "geohash": null,
        "lat": 40.7108594,
        "lng": -73.9882368,
        "zipcode": "10002",
        "address": "100 Water St. New York, NY 10002",
        "time_zone": "America/Los_Angeles",
        "distance_pay_per_km": null,
        "home_area": null,
        "service_zipcodes": [],
        "service_boroughs": [],
        "service_cities": [],
        "default_customer_id": 5295940,
        "default_user_id": null,
        "required_coc_type": 0,
        "beacon_ids": [],
        "feature_flags": null,
        "printer_type": null,
        "task_invoice_template_name": null,
        "country_code": null
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

id
int32
required

The Id of the team to update.

address

The address of the team to update.

contact_phone
int32

The contact phone number associated with the team to update.

description

The description of the team to update.

external_id

The external Id of the team to update.

lat
int32

The geoposition latitude of the new team.

lng
int32

The geoposition longitude of the new team.

merchant_id
required

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name

The name of the team to update.

time_zone

The time zone of the team to update.

zipcode

The ZIP Code of the team to update.

 

Nest all input parameters inside the team object, except for Id.

{
"id":10000,
"team": {
...
}
}

OUTPUT PARAM

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The Id of the this team.

address

string

The of address this team.

beacon_ids

Array of strings

An array of Ids for the beacons associated with the team.

contact_phone

string

The contact phone number associated with this team.

country_code

string

The country code of this team. The maximum length is 255 characters.

created_at

datetime

"The date and time this team was created. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

default_customer_id

Int32

The default customer Id of this team.

default_user_id

Int32

The default user (driver) Id for this team.

delete_at

datetime

The date and time this team was deleted This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

description

string

The description of this team.

distance_pay_per_km

float

The distance pay per kilometer for this team.

external_id

string

The team's external Id.

extra

Object

Internal use.

extras

Object

Internal use.

feature_flags

Object

The parameter description is pending a documentation update.

geohash

string

The geohash (public domain geocoding system hash) of this team.

home_area

Object

An object containing the home areas for this team.

lat

float

The geoposition latitude of the team's address.

lng

float

The geoposition longitude of the team's address.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name

string

The name of this team.

parent_team_id

Int32

The Id of the parent team with which this team is associated.

printer_type

string

The parameter description is pending a documentation update.

required_coc_type

Int32

The required chain of custody type. The values include:

  • 0 - weak
  • 1 - strong
  • 2 - none
  • 3 - unload
"

service_boroughs

Array of text

An array of boroughs serviced by this team.

service_cities

Array of text

An array of cities serviced by this team.

service_zipcodes

Array of text

An array of ZIP Codes serviced by this team.

task_invoice_template_name

string

The parameter description is pending a documentation update.

time_zone

string

The time zone of the team.

updated_at

datetime

The last update date and time for this team. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

zipcode

string

The ZIP Code of this team.

Suggest Edits

Show All Teams

Use to list all teams for a merchant.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"merchant_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": "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

merchant_id
int32

The Id of the merchant whose teams to show. This value can be null if more than one merchant is defined.

 

OUTPUT PARAMS

The output is an array of team objects.

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

Id

Int32

The Id of this team.

team

string

If team is not found, the team output parameter is null.

address

string

The of this team.

beacon_ids

Array of strings

An array of Ids for the beacons associated with the team.

contact_phone

string

The contact phone number associated with this team.

country_code

string

The country code of this team. The maximum length is 255 characters.

created_at

datetime

"The date and time this team was created. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

default_customer_id

Int32

The default customer Id of this team.

default_user_id

Int32

The default user (driver) Id for this team.

delete_at

datetime

The date and time this team was deleted This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

description

string

The description of this team.

distance_pay_per_km

float

The distance pay per kilometer for this team.

external_id

string

The team's external Id.

extra

Object

Internal use.

extras

Object

Internal use.

feature_flags

Object

The parameter description is pending a documentation update.

geohash

string

The geohash (public domain geocoding system hash) of this team.

home_area

Object

An object containing the home areas for this team.

lat

float

The geoposition latitude of the team's address.

lng

float

The geoposition longitude of the team's address.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name

string

The name of this team.

parent_team_id

Int32

The Id of the parent team with which this team is associated.

printer_type

string

The parameter description is pending a documentation update.

required_coc_type

Int32

The required chain of custody type. The values include:

  • 0 - weak
  • 1 - strong
  • 2 - none
  • 3 - unload
"

service_boroughs

Array of text

An array of boroughs serviced by the team.

service_cities

Array of text

An array of cities serviced by the team.

service_zipcodes

Array of text

An array of ZIP codes serviced by the team.

task_invoice_template_name

string

The parameter description is pending a documentation update.

time_zone

string

The time zone of this team.

updated_at

datetime

The last update date and time for this team. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

zipcode

string

The ZIP Code of this team.

Suggest Edits

Get Team Details

Use to get the details of a team.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"id":15130
}
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": []
  }
}
{
    "success": true,
    "team": null
}

Body Params

id
int32
required

The Id of the team whose details to get.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

Id

Int32

The Id of this team.

team

string

If team is not found, the team output parameter is null.

address

string

The of this team.

beacon_ids

Array of strings

An array of Ids for the beacons associated with the team.

contact_phone

string

The contact phone number associated with this team.

country_code

string

The country code of this team. The maximum length is 255 characters.

created_at

datetime

"The date and time this team was created. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

default_customer_id

Int32

The default customer Id of this team.

default_user_id

Int32

The default user (driver) Id for this team.

delete_at

datetime

The date and time this team was deleted This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

description

string

The description of this team.

distance_pay_per_km

float

The distance pay per kilometer for this team.

external_id

string

The team's external Id.

extra

Object

Internal use.

extras

Object

Internal use.

feature_flags

Object

The parameter description is pending a documentation update.

geohash

string

The geohash (public domain geocoding system hash) of this team.

home_area

Object

An object containing the home areas for this team.

lat

float

The geoposition latitude of the team's address.

lng

float

The geoposition longitude of the team's address.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name

string

The name of this team.

parent_team_id

Int32

The Id of the parent team with which this team is associated.

printer_type

string

The parameter description is pending a documentation update.

required_coc_type

Int32

The required chain of custody type. The values include:

  • 0 - weak
  • 1 - strong
  • 2 - none
  • 3 - unload
"

service_boroughs

Array of text

An array of boroughs serviced by the team.

service_cities

Array of text

An array of cities serviced by the team.

service_zipcodes

Array of text

An array of ZIP codes serviced by the team.

task_invoice_template_name

string

The parameter description is pending a documentation update.

time_zone

string

The time zone of this team.

updated_at

datetime

The last update date and time for this team. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

zipcode

string

The ZIP Code of this team.

Suggest Edits

Delete Team

Use to delete a team.

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

You couldn't be authenticated

{
    "success": true,
    "message": "Team deleted"
}
{
    "success": false,
    "message": "Team not found"
}

Body Params

id
int32
required

The Id of the team to delete.

 

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully. The values are:

  • false - the service failed.
  • true - the service succeeded.

message

string

A descriptive message indicating success or the reason for failure.

Suggest Edits

Get Share

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

The service description is pending a documentation update.

 
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

Import Orders CSV

Online help is not yet available.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
** Online help is not yet available. **
A binary file was returned

You couldn't be authenticated

** Online help is not yet available. **
 
Suggest Edits

Import Orders CSV (async)

Online help is not yet available.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
** Online help is not yet available. **
A binary file was returned

You couldn't be authenticated

** Online help is not yet available. **
 
Suggest Edits

Import Orders CSV Progress

Online help is not yet available.

 
posthttps://developer-api.bringg.com/partner_api/serviceId/service_uuid1/service_uuid2
** Online help is not yet available. **
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Import Users CSV File

Online help is not yet available.

 
posthttps://developer-api.bringg.com/partner_api/serviceId/service_uuid1/service_uuid2
** Online help is not yet available. **
A binary file was returned

You couldn't be authenticated

** Online help is not yet available. **
 
Suggest Edits

Import Users CSV API

Online help is not yet available.

 
posthttps://developer-api.bringg.com/partner_api/serviceId/service_uuid1/service_uuid2
** Online help is not yet available. **
A binary file was returned

You couldn't be authenticated

** Online help is not yet available. **
 
Suggest Edits

JustEat Integration

Online help is not yet available.

 
posthttps://developer-api.bringg.com/partner_api/serviceId/service_uuid1/service_uuid2
** Online help is not yet available. **
A binary file was returned

You couldn't be authenticated

** Online help is not yet available. **
 
Suggest Edits

eCourier Integration

Online help is not yet available.

 
posthttps://developer-api.bringg.com/partner_api
** Online help is not yet available. **
A binary file was returned

You couldn't be authenticated

** Online help is not yet available. **
 

This service is pending a documentation update.

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
required

Name of customer

company_id
int32
required

Unique identifier representing a company (Merchant ID)

address

Address of customer

address_second_line

Extra information about the address e.g. floor #, apartment #

city
borough
state
zipcode
phone
required

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

email

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

lat
double

Latitude component of customer location

lng
double

Longitude component of customer location

external_id

Customer external ID

allow_login

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

confirmation_code

Confirmation code to approve login via phone number

allow_sending_email

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

allow_sending_sms

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

language

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
<?
$url = 'http://developer-api.bringg.com/partner_api/customers/12345';

$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, "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,
    "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

Name of customer

address

Address of customer

address_second_line

Extra information about the address e.g. floor #, apartment #

phone

Phone of customer

email

E-mail of customer

lat
double

Latitude component of customer location

lng
double

Longitude component of customer location

external_id

Customer external ID

confirmation_code

Confirmation code for the customer

customer_access_token

Access token of customer for a login process

allow_sending_email

Allows to opt out of email sharing for customer

allow_sending_phone

Allows to opt out of phone sharing for customer

language

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 details of a Customer using the Bringg Customer ID

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

$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": 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 details of a Customer using their phone number as a lookup

 
gethttps://developer-api.bringg.com/partner_api/customers/phone/phone
<?
$url = 'http://developer-api.bringg.com/partner_api/customers/phone/+15555555555';

$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": 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 a list of all customers in an account

 
gethttps://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'),
 '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,
        "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 the total count of all customers

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

$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: 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,
	'lng' => 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

Title of order

team_id
int32

Unique identifier representing a team

silent

Cancel notifications for customer

note

Note to the driver

formatted_note
scheduled_at

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

asap

Sets scheduled time for order to now

lat
double

Latitude component of way point location

lng
double

Longitude component of way point location

address

Address of way point

address_second_line

Extra information about the address e.g. floor #, apartment #

extras

Custom parameters

external_id

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

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

anonymous

Creates an anonymous customer instead of a real one

share_location

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' => '1 Lexington Avenue',
               'city' => 'New York',
               '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

Title of task

team_id
int32

Unique identifier representing a team

silent

Cancel notifications for customer

note

Note to the driver

extras

Custom parameters

way_points

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

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

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.

Updating Scheduled Time

To update the Scheduled At time for an order, you will need to update the field of the relevant Way Point. See http://developers.bringg.com/reference#update-way-point

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
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

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

address

Address of way point

address_second_line

Extra information about the address e.g. floor #, apartment #

city
borough

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

zipcode
lat
double

Latitude component of way point location

lng
double

Longitude component of way point location

note

Note to the driver

allow_scanning_inventory

Allow scanning inventory at this way point

must_approve_inventory

Driver can't leave way point before scanning inventory

allow_editing_inventory

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

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