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
   },
	 "teams" : [4248, 8419],
   "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",
         "address_type": 1,
         "location_name": "Public Library"
      },
      {
         "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",
           "weight" : 100
        }]
      }
   ]
}
{
	"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]
}
{
	"title" : "Delivery for Jane Smith",
	"external_id" : "EXT1234",
	"customer" : {
		"name" : "Jane Smith"
	},
	"teams" : [1234],
	"way_points" : [{
			"customer" : {
				"name" : "Jane Smith",
				"address" : "350 5th Ave, New York, NY 10118",
				"address_second_line" : "1st floor, 3rd door on the right"
			},
			"scheduled_at" : "2018-05-31T11:00:00-5",
			"note" : "Don't ring the bell. Knock",
			"inventory":[
				{
					"price":12.00,
					"name":"Super Meal",
					"original_quantity":1,
					"note":"Extra Mustard",
					"inventory":[
						{
							"price":2.75,
							"name":"Superfood Side",
							"original_quantity":1,
							"note":""
						},
						{
							"name":"Another Side",
							"original_quantity":1,
							"note":""
						}
					]
				},
				{
					"price":10.00,
					"name":"Chef's Meal",
					"original_quantity":1
				}
			]
		}
	]
}
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

create_linked_tasks
boolean

If there are two waypoints, create 2 orders, one for each waypoint. The orders are linked to each other.

customer
object

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
string

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

external_team_id
string

Specify your Team ID (instead of the Bringg Team ID)

external_user_id
string

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

fleet_id
int32

ID of the external fleet in Bringg

left_to_be_paid
float

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.

note
string

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

notes
array of strings

The text for multiple notes associated with the new order (task). If a value is input, this creates multiple task_note objects.

note_creator
string

Defines which name to use as the creator of the note. Values = "customer" or "admin"

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.

quote_id
string

The Id of a quote received from Get Quote.

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)

share_location
boolean

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.

task_configuration_id
int32
task_type_id
int32

Indicate whether an order is a Pickup (2), Return (3), Dropoff (4) or both Pickup and Dropoff (5)

tax_price
float

The gross price of this order including taxes.

teams
array of integers

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
string

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

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"}}' https://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) details.

 
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
}
{
   "id" : 9999999,
   "way_points" : [
      {
         "id" : 12345678,
         "inventory": [
           {
            "name": "Lg. Meaty Pizza",
            "price": "22.0",
            "original_quantity":1,
            "pending" : true
         }
        ]
      }
   ]
}
{
   "id" : 30145683,
   "way_points" : [
      {
         "id" : 35199009,
         "phone": "+1234567890"
      }
   ]
}
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
string

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

external_user_id
string

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

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

note
string

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

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
boolean

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.

task_configuration_id
int32
task_type_id
int32

Indicate whether an order is a Pickup (2), Return (3), Dropoff (4) or both Pickup and Dropoff (5)

tax_price
float

The gross price of this order including taxes.

team_ids
array of integers

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
boolean

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

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.

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

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" : 30145621,
    "reason_id" : 163,
    "reason" : "Reason for choosing Other"
}
{
    "external_id" : "ABC123"
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "task": {
        "title": "Test Order #3",
        "user_id": null,
        "created_at": "2019-01-02T14:30:01.339Z",
        "scheduled_at": "2018-10-30T17:30:00.000Z",
        "lat": 39.495507,
        "lng": -119.8078739,
        "status": 7,
        "id": 123456,
        "address": "901 Brinkby Ave",
        "active_way_point_id": null,
        "started_time": null,
        "cancelled_at": "2019-03-24T11:48:51.365Z",
        "late": false,
        "extras": null,
        "external_id": "A123456",
        "customer_id": 123456,
        "asap": null,
        "ended_time": "2019-03-24T11:48:51.373Z",
        "priority": 30145621,
        "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": "Customer not home",
        "dispatcher_id": null,
        "uuid": "dbf3e633-dd03-4b1d-9029-860565ae7457",
        "ready_to_execute": true,
        "discount": null,
        "tip_driver_enabled": true,
        "tax_price": null,
        "price_before_tax": null,
        "tag_id": 7500,
        "group_uuid": null,
        "group_leader_id": null,
        "automatically_cancelled": 4,
        "parent_task_id": null,
        "payment_method": null,
        "payment_type_name": null,
        "linked_task_id": null,
        "preparation_status": 0,
        "preparation_start_time_planned": null,
        "preparation_end_time_planned": null,
        "preparation_ready_for_pickup_time_planned": null,
        "task_type_id": null,
        "origin_title": "Service",
        "task_configuration_id": null,
        "required_skills": [],
        "team_ids": [
            1234
        ],
        "virtual_task": false,
        "run_id": null,
        "task_notes": [
            {
                "title": "02 Jan, 2019 02:30 PM, by unknown",
                "note": "Note",
                "created_at": "2019-01-02T14:30:01.316Z",
                "author_name": "Jay Smith",
                "id": 28397287,
                "way_point_id": 35198933,
                "url": null,
                "type": "TaskNote",
                "user_id": null,
                "lat": null,
                "lng": null,
                "form_group_uuid": null,
                "action_id": null,
                "task_inventory_id": null
            }
        ],
        "way_points": [
            {
                "id": 35198933,
                "scheduled_at": "2018-10-30T17:30:00.000Z",
                "has_to_leave_by": null,
                "task_id": 30145621,
                "customer_id": 123456,
                "done": true,
                "lat": 39.495507,
                "lng": -119.8078739,
                "address": "901 Brinkby Ave",
                "address_second_line": null,
                "zipcode": "89509",
                "position": 1,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": "2018-10-30T17:35:00.000Z",
                "eta": null,
                "silent": false,
                "city": "Reno",
                "borough": null,
                "full_address": "901 Brinkby Ave, Reno, Nevada, 89509",
                "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,
                "pickup_dropoff_option": null,
                "customer": {
                    "id": 123456,
                    "name": "Jay Smith",
                    "address": null,
                    "address_second_line": null,
                    "zipcode": null,
                    "lat": null,
                    "lng": null,
                    "phone": null,
                    "image": "/images/avatar.png",
                    "email": null,
                    "merchant_id": 123456,
                    "external_id": "16686599",
                    "confirmation_code": "2757",
                    "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": [],
        "task_inventories": [],
        "scans": []
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

id
int32

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

external_id
string
reason_id
int32

Specify the ID number of an existing cancellation reason

reason
string

This is used to specify the cancellation reason if the reason ID chosen refers to "Other". This is because it's mandatory for a user to fill in a reason when they choose "Other" from the Cancellation Reason dropdown list.

 

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

Get Order (Task)

Use to return all details about a particular order (task)

 
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,
    "task": {
        "title": "Test Order",
        "user_id": 12345,
        "created_at": "2018-06-19T07:46:01.123Z",
        "scheduled_at": "2018-06-27T10:00:00.000Z",
        "lat": null,
        "lng": null,
        "status": 4,
        "id": 12345,
        "address": null,
        "active_way_point_id": null,
        "started_time": "2018-06-19T07:46:52.802Z",
        "cancelled_at": null,
        "late": false,
        "extras": null,
        "external_id": "5519198",
        "customer_id": 12345,
        "asap": false,
        "ended_time": "2018-06-19T07:46:52.802Z",
        "priority": 16716995,
        "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": "538495c0-ed95-43e2-xxxx-1857cb082bf9",
        "ready_to_execute": true,
        "discount": null,
        "tip_driver_enabled": true,
        "tax_price": null,
        "price_before_tax": null,
        "tag_id": 7500,
        "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,
        "preparation_status": null,
        "preparation_start_time_planned": null,
        "preparation_end_time_planned": null,
        "preparation_ready_for_pickup_time_planned": null,
        "task_type_id": 4,
        "origin_title": null,
        "task_configuration_id": null,
        "task_notes": [],
        "way_points": [
            {
                "id": 19998860,
                "scheduled_at": "2018-06-27T10:00:00.000Z",
                "has_to_leave_by": null,
                "task_id": 12345,
                "customer_id": 12345,
                "done": true,
                "lat": 51.399439,
                "lng": -0.015265,
                "address": "23 Hayes Lane, Beckenham, Kent, BR3 6QS, United Kingdom",
                "address_second_line": "Ground floor",
                "zipcode": null,
                "position": 2,
                "checkin_time": "2018-06-19T07:46:52.802Z",
                "checkout_time": "2018-06-19T07:46:52.802Z",
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": "2018-06-19T07:46:52.802Z",
                "eta": null,
                "silent": false,
                "city": null,
                "borough": null,
                "full_address": "23 Hayes Lane, Beckenham, Kent, BR3 6QS, United Kingdom",
                "automatic_checkin": false,
                "automatic_checkout": false,
                "phone": null,
                "email": null,
                "no_later_than": null,
                "no_earlier_than": null,
                "rating": null,
                "checkin_lat": 32.106595,
                "checkin_lng": 34.8349748,
                "checkout_lat": 32.106595,
                "checkout_lng": 34.8349748,
                "district": null,
                "house_number": null,
                "company_name": null,
                "pickup_dropoff_option": 1,
                "customer": {
                    "id": 8979779,
                    "name": "John Smith",
                    "address": null,
                    "address_second_line": null,
                    "zipcode": null,
                    "lat": null,
                    "lng": null,
                    "phone": null,
                    "image": "/images/avatar.png",
                    "email": null,
                    "merchant_id": 10570,
                    "external_id": "8979779",
                    "confirmation_code": "9366",
                    "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": []
                }
            },
            {
                "id": 19998859,
                "scheduled_at": "2018-06-26T07:00:00.000Z",
                "has_to_leave_by": null,
                "task_id": 12345,
                "customer_id": 12345,
                "done": true,
                "lat": 53.816102,
                "lng": -1.562958,
                "address": "35 Regent Park Terrace, Leeds, West Yorkshire, LS6 2AX, United Kingdom",
                "address_second_line": "Ground floor",
                "zipcode": null,
                "position": 2,
                "checkin_time": "2018-06-19T07:46:52.802Z",
                "checkout_time": "2018-06-19T07:46:52.802Z",
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": "2018-06-19T07:46:52.802Z",
                "eta": null,
                "silent": false,
                "city": null,
                "borough": null,
                "full_address": "35 Regent Park Terrace, Leeds, West Yorkshire, LS6 2AX, United Kingdom",
                "automatic_checkin": false,
                "automatic_checkout": false,
                "phone": null,
                "email": null,
                "no_later_than": null,
                "no_earlier_than": null,
                "rating": null,
                "checkin_lat": 32.106595,
                "checkin_lng": 34.8349748,
                "checkout_lat": 32.106595,
                "checkout_lng": 34.8349748,
                "district": null,
                "house_number": null,
                "company_name": null,
                "pickup_dropoff_option": 0,
                "customer": {
                    "id": 8979780,
                    "name": "Jane Smith",
                    "address": null,
                    "address_second_line": null,
                    "zipcode": null,
                    "lat": null,
                    "lng": null,
                    "phone": null,
                    "image": "/images/avatar.png",
                    "email": null,
                    "merchant_id": 12345,
                    "external_id": "8979780",
                    "confirmation_code": "9897",
                    "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": [
            8419
        ],
        "task_inventories": [
            {
                "id": 91482738,
                "task_id": 12345,
                "inventory_id": 1918616,
                "quantity": 0,
                "original_quantity": 1,
                "merchant_id": 12345,
                "name": "Suitcase",
                "price": null,
                "image": "/images/product-placeholder.png",
                "way_point_id": 19998860,
                "scan_string": null,
                "pending": false,
                "note": null,
                "parent_task_inventory_id": null,
                "coc_type": null,
                "external_id": "28424",
                "size": null,
                "source_task_id": null,
                "inventory": {
                    "id": 1918616,
                    "name": "Suitcase",
                    "price": null,
                    "image": "/images/product-placeholder.png",
                    "merchant_id": 12345,
                    "external_id": "28424",
                    "scan_string": null,
                    "commodity": null,
                    "notes": null,
                    "weight": null,
                    "size": null,
                    "extras": null,
                    "delivery_cost": null,
                    "completed": null,
                    "width": null,
                    "height": null,
                    "length": null
                }
            }
        ],
        "scans": []
    }
}

Body Params

id
int32
required

Unique identifier representing an order/task in Bringg

 

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

$.get('http://yoursite.com/test/' + id, function(data) {
    console.log(data);
});
Suggest Edits

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

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

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

The text of this note.

task_id
int32
required

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

type
string

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
string

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

Update Note

Make text updates to an existing note

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"id" : 12345678,
	"note" : "Changed note",
	"url" : "https://www.bringg.com"
}
A binary file was returned

You couldn't be authenticated

{
    "task_note": {
        "title": "25 Nov, 2018 11:39 AM, Admin Name",
        "note": "Changed note",
        "created_at": "2018-11-25T11:39:41.887Z",
        "author_name": "Admin Name",
        "id": 12345678,
        "way_point_id": 87654321,
        "url": "https://www.bringg.com",
        "type": "TaskNote",
        "user_id": 12345,
        "lat": 32.1067605,
        "lng": 34.8346377
    },
    "success": true
}

Body Params

id
int32
required

ID of the note to update

note
string

The new text of the note

url
string

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

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

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

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 Bringg ID of this order (task).

external_id

string

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

user_id

Int32

The Bringg ID of the driver associated with this order (task).

driver_external_id

Int32

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

priority

Int32

The sequence number of the order in the route.

first_way_point_has_to_leave_by

datetime

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

last_way_point_schedule

datetime

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

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
string

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

address_second_line
string

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

allow_login
boolean

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
boolean

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
boolean

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
string

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

city
string

The new customer's city.

confirmation_code
string

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

district
string

The new customer's district.

email
string

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

external_id
string

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

house_number
int32

The house number of this customer.

image
string

The URL of an image associated with the new customer.

language
string

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
string

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

phone
string

The phone number of the new customer.

state
string

The new customer's state.

street
string

The new customer's street.

zipcode
string

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
string

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

address_second_line
string

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

allow_login
boolean

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

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.

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.

borough
string

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

city
string

This customer's city.

confirmation_code
string

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

district
string

This customer's district.

email
string

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

external_id
string

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

house_number
string

The house number of this customer.

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

 

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
boolean

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
string

The company with which the new user is associated.

dispatcher
boolean

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
boolean

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
string

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

job_description
string

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

name
string

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

password
string

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
string

The new user's phone number.

team_ids
array of integers

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

home_address
string

Driver's home address

home_lat
int32

Driver's home address - latitude

home_lng
int32

Driver's home address - longitude

 

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.

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.

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.

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

The model of the user's mobile device.

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.

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

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.

name

string

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

num_ratings

Int32

The number of times the user (driver) was rated.

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.

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.

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" : 77484,
	"user": {
		"name": "New Driver Name",
		"driver" : true,
		"job_description" : "Job description goes here",
		"language" : "es",
		"phone" : "0555555555",
		"user_external_id" : "",
		"external_id" : "Your_Driver_Id_12345"

	},
	"team_ids" : [15132],
	"password" : "ABC123456"
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "user": {
        "id": 77484,
        "name": "New Driver Name",
        "status": "online",
        "sub": "Started",
        "lat": 32.0939896,
        "lng": 34.8282907,
        "profile_image": "/images/avatar.png",
        "authentication_token": null,
        "phone": "+972555555555",
        "admin": false,
        "driver": true,
        "dispatcher": true,
        "current_task": null,
        "beta": false,
        "debug": false,
        "email": "tom@company.com",
        "job_description": "Job description goes here",
        "driver_current_sign_in_at": "2018-03-13T08:28:47.665Z",
        "driver_sign_in_count": 6,
        "average_rating": 3,
        "num_ratings": 1,
        "last_sign_in_at": "2018-03-13T15:40:37.145Z",
        "active_shift_id": 2195049,
        "created_at": "2017-12-10T12:04:19.993Z",
        "partner_user": false,
        "feature_flags": null,
        "authorization_flags": {},
        "confirmed_at": null,
        "confirmation_sent_at": null,
        "battery": null,
        "uuid": "ae56748d-8f9a-4892-bb8e-67150382fb82",
        "mobile_type": 1,
        "mobile_version": "1.1.125",
        "device_model": "samsung GT-I9505",
        "default_user_activity": 5,
        "language": "es",
        "merchant_id": 11271,
        "locked": false,
        "user_type_id": 1055,
        "privilege_id": 0,
        "estimated_last_address": null,
        "estimated_last_lat": null,
        "estimated_last_lng": null,
        "estimated_last_etl": null,
        "at_home": true,
        "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": [
            15132
        ],
        "allowed_user_types": [
            {
                "id": 1055,
                "merchant_id": 11271,
                "title": "Driver Class A",
                "default_for_merchant": true,
                "maximum_tasks_per_shift": 100,
                "minimum_tasks_per_shift": 50,
                "cost_per_shift": 0,
                "cost_per_task": 0,
                "created_at": "2017-12-28T12:07:21.682Z",
                "updated_at": "2017-12-28T12:07:21.682Z",
                "external_id": "1055",
                "is_crowd": false,
                "max_total_weight": null,
                "max_weight_per_parcel": null,
                "height": null,
                "width": null,
                "length": null,
                "vehicle_height": null,
                "vehicle_width": null,
                "vehicle_length": null
            }
        ]
    }
}
{
    "success": false,
    "message": {
        "email": [
            "has already been taken"
        ]
    }
}

Body Params

id
int32
required

The Id of the user to update.

admin
boolean

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
string

The company with which this user is associated.

dispatcher
boolean

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
boolean

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
string

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

external_id
string

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

job_description
string

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

language
string

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

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

name
string

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

password
string

The password of this user.

phone
string

The phone number of this user.

team_ids
array of integers

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

user_type_id
int32

The User Role ID of a driver (used in Route Optimization)

 

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.

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.

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.

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

The model of the user's mobile device.

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.

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

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.

name

string

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

num_ratings

Int32

The number of times the user (driver) was rated.

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.

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.

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.

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.

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.

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

The model of the user's mobile device.

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.

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.

name

string

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

num_ratings

Int32

The number of times the user (driver) was rated.

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.

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.

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

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

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

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

Get Shifts Schedule

Use to list all shifts schedule.

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

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

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

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

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

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

request = Net::HTTP::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/services/serviceId/service_uuid1/service_uuid2");

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "shift_schedules": [
        {
            "id": 712761,
            "user_id": 58182,
            "team_id": null,
            "merchant_id": 11263,
            "start_hour": 7,
            "end_hour": 22
        },
        {
            "id": 712762,
            "user_id": 58182,
            "team_id": null,
            "merchant_id": 11263,
            "start_hour": 31,
            "end_hour": 46
        },
        {
            "id": 712763,
            "user_id": 58182,
            "team_id": null,
            "merchant_id": 11263,
            "start_hour": 55,
            "end_hour": 70
        },
        {
            "id": 711357,
            "user_id": 57495,
            "team_id": null,
            "merchant_id": 11263,
            "start_hour": 60,
            "end_hour": 67
        },
    ]
}
 

success

boolean

Indicates whether the service completed successfully.

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

id

Int32

The Id of the shift.

end_hour

Int32

The ending hour of this shift. The hour is represented as the number of hours since the beginning of the work week. For example, 39 is Tuesday at 3:00 PM.

merchant_id

Int32

The Id of the merchant.

start_hour

Int32

The starting hour of this shift. The hour is represented as the number of hours since the beginning of the work week. For example, 30 is Tuesday at 6:00 AM.

team_id

Int32

The Id of the user's team.

user_id

Int32

The Id of the user.

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

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

name
string
required

The name of the new team.

external_id
string

The external Id of the new team.

address
string

The address of the new team.

address_second_line
string
zipcode
string

The ZIP Code of the new team.

country_code
string
lat
float

The geoposition latitude of the new team.

lng
float

The geoposition longitude of the new team.

time_zone
string

The time zone of the new team.

contact_phone
string

The contact phone number associated with this team.

description
string

The description 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.

distance_pay_per_km
int32
service_boroughs
array of strings
service_zipcodes
array of strings
service_cities
array of strings
 

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

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 type of printer used to print receipts. The values are:

  • 3"
  • A4

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.

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": 19557,
  "beacon_ids":["1"],
  "name": "Update Team 123",
  "merchant_id": 11263,
  "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",
  "service_zipcodes": [
      "123",
      "456",
      "1234"
    ],
  "service_boroughs": [
      "bronx"
    ],
  "service_cities": [
      "new york"
    ],
  "team_configuration": {
    "allow_access_to_all_open_tasks": true,
    "automatic_checkin": true,
    "automatic_checkout": true
  }
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "team": {
        "id": 19557,
        "name": "Update Team 123",
        "description": "Update Team description",
        "merchant_id": 11263,
        "parent_team_id": null,
        "created_at": "2018-10-02T13:02:01.087Z",
        "updated_at": "2018-10-09T10:14:28.884Z",
        "extra": null,
        "delete_at": null,
        "external_id": "67890",
        "extras": null,
        "contact_phone": "+14444444",
        "geohash": null,
        "lat": 40.704669,
        "lng": -74.0082213,
        "zipcode": "10002",
        "address": "100 Water St. New York, NY 10002",
        "time_zone": "America/Los_Angeles",
        "distance_pay_per_km": null,
        "home_area": [],
        "service_zipcodes": [
            "123",
            "456",
            "1234"
        ],
        "service_boroughs": [
            "bronx"
        ],
        "service_cities": [
            "new york"
        ],
        "default_customer_id": 12479558,
        "default_user_id": null,
        "required_coc_type": 0,
        "beacon_ids": [
            "1"
        ],
        "feature_flags": null,
        "printer_type": null,
        "task_invoice_template_name": null,
        "country_code": null,
        "street": null,
        "city": null,
        "state": null,
        "default_task_configuration_id": null
    }
}
{
    "success": false,
    "rc": 0,
    "message": "ActiveRecord::RecordNotFound"
}

Body Params

id
int32
required

The Id of the team to update.

address
string

The address of the team to update.

beacon_ids
string

An array of beacon Ids.

contact_phone
int32

The contact phone number associated with the team to update.

description
string

The description of the team to update.

external_id
string

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

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

name
string

The name of the team to update.

team_configuration
object
 
team_configuration.allow_access_to_all_open_tasks
boolean

Indicates whether drivers receive unassigned tasks.

team_configuration.automatic_checkin
boolean

Indicates whether drivers can automatically check in.

team_configuration.automatic_checkout
boolean

Indicates whether drivers can automatically check out

time_zone
string

The time zone of the team to update.

zipcode
string

The ZIP Code of the team to update.

 

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

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

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

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 type of printer used to print receipts. The values are:

  • 3"
  • A4

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.

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": 11263
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "teams": [
        {
            "name": "Team 456",
            "description": "Team description",
            "parent_team_id": null,
            "merchant_id": 11263,
            "id": 19630,
            "external_id": "12345",
            "extras": null,
            "contact_phone": "+15555555",
            "lat": 40.7120094,
            "lng": -73.9831043,
            "address": "416 Water St. New York, NY 10002",
            "distance_pay_per_km": null,
            "allow_access_to_all_open_tasks": null,
            "time_zone": "America/Los_Angeles",
            "home_area": null,
            "service_zipcodes": [],
            "service_boroughs": [],
            "service_cities": [],
            "required_coc_type": 0,
            "beacon_ids": [],
            "feature_flags": null,
            "printer_type": null,
            "task_invoice_template_name": null,
            "country_code": null
        },
        {
            "name": "Team 123",
            "description": "Team description",
            "parent_team_id": null,
            "merchant_id": 11263,
            "id": 19556,
            "external_id": "12345",
            "extras": null,
            "contact_phone": "+15555555",
            "lat": 40.7120094,
            "lng": -73.9831043,
            "address": "416 Water St. New York, NY 10002",
            "distance_pay_per_km": null,
            "allow_access_to_all_open_tasks": null,
            "time_zone": "America/Los_Angeles",
            "home_area": null,
            "service_zipcodes": [],
            "service_boroughs": [],
            "service_cities": [],
            "required_coc_type": 0,
            "beacon_ids": [],
            "feature_flags": null,
            "printer_type": null,
            "task_invoice_template_name": null,
            "country_code": null
        },
        {
            "name": "Team 100",
            "description": "Update Team description",
            "parent_team_id": null,
            "merchant_id": 11263,
            "id": 19555,
            "external_id": "67890",
            "extras": null,
            "contact_phone": "+14444444",
            "lat": 40.704669,
            "lng": -74.0082213,
            "address": "100 Water St. New York, NY 10002",
            "distance_pay_per_km": null,
            "allow_access_to_all_open_tasks": true,
            "time_zone": "America/New_York",
            "home_area": [],
            "service_zipcodes": [
                "10451",
                "10454",
                "10456"
            ],
            "service_boroughs": [
                "bronx"
            ],
            "service_cities": [
                "new york"
            ],
            "required_coc_type": 0,
            "beacon_ids": [
                "1"
            ],
            "feature_flags": null,
            "printer_type": null,
            "task_invoice_template_name": null,
            "country_code": null
        }     
    ]
}

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.

allow_access_to_all_open_tasks

boolean

Indicates whether drivers receive unassigned tasks.

  • false - the drivers do not receive unassigned tasks.
  • true - the drivers do receive unassigned tasks.

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.

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 type of printer used to print receipts. The values are:

  • 3"
  • A4

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.

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": 19557
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "team": {
        "name": "Update Team 123",
        "description": "Update Team description",
        "parent_team_id": null,
        "merchant_id": 11263,
        "id": 19557,
        "external_id": "67890",
        "extras": null,
        "contact_phone": "+14444444",
        "lat": 40.704669,
        "lng": -74.0082213,
        "address": "100 Water St. New York, NY 10002",
        "distance_pay_per_km": null,
        "allow_access_to_all_open_tasks": true,
        "time_zone": "America/Los_Angeles",
        "home_area": [],
        "service_zipcodes": [
            "123",
            "456",
            "1234"
        ],
        "service_boroughs": [
            "bronx"
        ],
        "service_cities": [
            "new york"
        ],
        "required_coc_type": 0,
        "beacon_ids": [
            "1"
        ],
        "feature_flags": null,
        "printer_type": null,
        "task_invoice_template_name": null,
        "country_code": null
    }
}
{
    "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.

allow_access_to_all_open_tasks

boolean

Indicates whether drivers receive unassigned tasks.

  • false - the drivers do not receive unassigned tasks.
  • true - the drivers do receive unassigned tasks.

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.

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 type of printer used to print receipts. The values are:

  • 3"
  • A4

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.

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

Get Quote

Use to get availability and fee (cost) of deliveries given a specific requirement

 
gethttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"asap": true,
	"delivery_attributes": {
    "total_item_count": 5,
    "total_items_weight_kg": 45.0,
    "required_vehicle_types": 5,
		"perishable": false,
		"food": true
	},
  "quote_type": 4,
	"way_points": [{
			"customer": {
				"name": "restaurant",
				"phone": "0123456789",
			},
			"address": "4196 Water St. New York, NY 10002",
			"city": "New York"
		},
		{
			"customer": {
				"name": "Mr. Customer",
				"phone": "05456974815",
				"allow_sending_sms": true,
			},
			"address": "416 Water St. New York, NY 10002",
			"delivery_confirmation_signature": "2",
			"inventory": [{
				"price": 10.4,
				"external_id": "12321312",
				"description": "This is a cool setup",
				"original_quantity": 5,
				"scan_string": "34242342342323432432234"
			}]
		}
	]
}
A binary file was returned

You couldn't be authenticated

{
	quote_id: "5920d1a0-4c82-11e4-916c-0800200c9a66",
	available: true,
	availability_windows: [{
			window_start: "2017-03-02T13:30:00-0500",
			window_end: "2017-03-02T13:30:00-0500",
			window_id: 1,
			window_quote_id: "f4b3ade5-4997-418e-8f99-1813dd1e56df",
			fleet: {
				name: 'Internal',
				type: 1,
				id: 3
			},
			expiry_time: "2017-03-02T13:30:00-0500",
			fee: 5.0
		},
		{
			window_start: "2017-03-03T13:30:00-0500",
			window_end: "2017-03-03T13:30:00-0500",
			window_id: 2,
			window_quote_id: "f4b3ade5-4997-418e-8f99-1813dd1e56df",
			fleet: {
				name: 'Internal',
				type: 1,
				id: 3
			},
			expiry_time: "2017-03-02T13:30:00-0500",
			fee: 8.0
		},
		{
			window_start: "2017-03-02T13:30:00-0500",
			window_end: "2017-03-03T13:30:00-0500",
			window_id: 3,
			window_quote_id: "f4b3ade5-4997-418e-8f99-1813dd1e56df",
			fleet: {
				name: 'Uber Rush',
				type: 2,
				id: 3
			},
			fee: 7.0
		}
	]

}

Query Params

asap
boolean

Indicates whether this quote is required for immediate availability (as soon as possible). The values are false or 0 - not ASAP, true or 1 - ASAP.

delivery_attributes
object

An object containing the attributes (details) for this delivery quote.

 
delivery_attributes.total_item_count
integer

The total number of items to be picked up in this delivery.

delivery_attributes.total_items_weight_kg
float

The total weight of items in this delivery.

delivery_attributes.perishable
boolean

Indicates whether the delivery items are perishable. The values are: true, false.

delivery_attributes.food
boolean

Indicates whether the delivery items are food. The values are: true, false.

delivery_attributes.required_vehicle_types
array of integers

An array of integers indicating the types of required vehicle for the delivery. The values are: 1 - Walker, 2 - Bicycle, 3 - Car, 4 - Truck.

way_points
object

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

 
quote_type
int32

Indicates the type of quote. The values are: 2 - pickup, 4 - delivery, 5 - pickup and delivery.

teams
array of integers

Specify from which team (address) the delivery will leave

 

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.

available

boolean

Indicates whether a time window is available for this quote.

  • false - time windows are not available for this quote.
  • true - time windows are available for this quote.

availability_windows

Array of Objects

An array of window objects containing the details of time windows available for this quote.

expiry_time

datetime

The date and time this window's availability expires.

fee

Pending Update

Pending Update

fleet

Object

An object containing detailed information about the fleet for this time window, include name, type, and id.

window_start

datetime

The date and time the delivery, pickup, or delivery and pickup window starts.

window_end

datetime

The date and time the delivery, pickup, or delivery and pickup window ends.

window_id

Int32

The Id of this window.

window_quote_id

GUID

A globally unique identifier for this time window.

Scheduled At

One of the scheduled at of one of the way point has to be included in the call

Suggest Edits

Create Task Configuration

Use to create task configurations which are sets of operational capabilities you can apply to specific sets of tasks using other API operations. The task configuration Id returned by this service can be attached to tasks and those tasks will get the task configuration's operational capabilities.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"title": "New Task Configuration",
	"pre_schedule_buffer": 10,
    "post_schedule_buffer": 5,
    "time_on_site_buffer_seconds": 30
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "rc": 0,
    "task_configuration": {
        "id": 19,
        "title": "New Task Configuration",
        "pre_schedule_buffer": 10,
        "post_schedule_buffer": 5,
        "time_on_site_buffer_seconds": 30,
        "action_data": null
    }
}

Body Params

is_top_level
boolean

Indicates whether tasks for this new task configuration appear on the driver's default action list. The values are: false or 0 - tasks do not appear, true or 1 - tasks do appear.

title
string

The title of this new task configuration.

pre_schedule_buffer
int32

Time window start before the task schedule at

post_schedule_buffer
int32

The time window after the task is scheduled.

time_on_site_buffer_seconds
int32

The default time on site (seconds) for this task.

action_data
object

This description is pending a documentation update.

 
 

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 task configuration.

is_top_level

boolean

Indicates whether this task configuration appears on the driver's default action list.

  • false - does not appear on a driver's default action list
  • true - does appear on a driver's default action list

pre_schedule_buffer

Int32

The time window before the task is scheduled.

post_schedule_buffer

Int32

The time window after the task is scheduled.

time_on_site_buffer_seconds

Int32

The default time on site (seconds) for this task.

action_data

Object

This description is pending a documentation update.

Suggest Edits

Get Real-time Driver Availability

Use to get the real-time driver availability details of drivers in the teams you specify. The driver details for each driver in the teams you specify include driver Id, name, geoposition, and a list of all teams to which each driver belongs. "Availability" refers to drivers who are both online and on-shift.

 
gethttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"team_ids" : [12345, 67890]
}
A binary file was returned

You couldn't be authenticated

{success: true, 
 rc: 0, 
 drivers: [{
   id: 1,
   name: "Michael",
   lat: 32.2222323,
   lng: 34.232322,
   team_ids: [1,2]
 }, {
   id: 1,
   name: "Eli",
   lat: 32.426453,
   lng: 34.235656,
   team_ids: [1,3]
 }]

Query Params

team_ids
array of integers

A list of team Ids whose drivers (team members) availability is required.

 

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.

id

Int32

The Id of this driver.

lat

Int32

The geoposition latitude of the driver.

lng

Int32

The geoposition longitude of the driver.

name

string

The name of this driver.

team_ids

Array of Integers

The team Ids of the teams in which this driver is member.

Suggest Edits

Create Quote For External Fleet

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

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

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

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

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

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

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

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

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

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

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

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{quote_uuid: quote_uuid}

Query Params

team_id
int32

Bringg Team Id the quote is for

way_points
string

description of the pickup (if different from team) and delivery

 

OUTPUT

quote_uuid

quote_uuid

The universal unique identifier of the new quote.

Suggest Edits

Get Quote Status For External Fleet

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

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

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

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

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

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

request = Net::HTTP::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/services/serviceId/service_uuid1/service_uuid2");

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  success: true,
 	rc: 0,
	pending: true,
	results: []
}

Query Params

quote_uuid
string

The UUID (universal unique Id) of the quote whose status is required.

 
Suggest Edits

Generate Driver QR Code

Use to generate an access token and secret key for the Driver App QR Code login of a specified driver.

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

You couldn't be authenticated

{
    "success": true,
    "rc": 0,
    "access_token": "af8e4179-1f9e-4045-87dd-xxxxxxxxxxxx",
    "secret": "90d6623d-5882-473a-9430-xxxxxxxxxxxx"
}

Body Params

user_id
int32
required

The Id of the driver requiring a Driver App QR code login.

 

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.

rc

Int32

The return code of the service.

access_token

GUID

The access token this driver can use for logging into the driver app by QR code.

secret

GUID

The secret key this driver can use for logging into the driver app by QR code.

Suggest Edits

Create a Delivery Block

Create a new delivery block. A delivery block is a work time slot for drivers in a team.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"team_id": 15130,
	"name": "Morning Shift 005",
	"description": "Daily Morning Shift",
	"start_time": "2018-07-23 08:00:00",
	"end_time": "2018-07-23 13:00:00",
	"original_capacity": 10
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "delivery_block": {
        "id": 1282,
        "name": "Morning Shift 005",
        "description": "Daily Morning Shift",
        "start_time": "2018-07-23T08:00:00.000Z",
        "end_time": "2018-07-23T13:00:00.000Z",
        "capacity": 0,
        "original_capacity": 10,
        "user_ids": [],
        "users": []
    }
}
{
    "success": false,
    "rc": 0,
    "message": "param is missing or the value is empty: original_capacity"
}

Body Params

name
string

The name of this new delivery block.

description
string

The description of this new delivery block.

original_capacity
int32
required

The number of drivers that should work this delivery block.

start_time
date
required

The starting date and time of this new delivery block.

end_time
date
required

The ending date and time of this new delivery block.

team_id
int32
required

The Id of the team for which this new delivery block is created.

users
object

An array of objects containing the Id, name, and email of the drivers assigned to this new delivery block.

 
users.id
integer

The Id of a driver assigned to this delivery block.

users.email
string

The email address of a driver assigned to this delivery block.

users.name
string

The name of a driver assigned to this delivery block.

user_ids
array of integers

The Ids of the drivers assigned to this delivery block.

break_start_time
date

The starting date and time of the break

break_end_time
date

The ending date and time of the break

 

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 new delivery block.

capacity

Int32

The number of drivers assigned to this new delivery block.

description

string

The description of this new delivery block.

end_time

datetime

The ending date and time of this new delivery block.

name

string

The name of this new delivery block.

original_capacity

Int32

The number of drivers that should work to this new delivery block.

start_time

datetime

The starting date and time of this new delivery block.

user_ids

array of integers

An array containing the Ids of the drivers assigned to this delivery block.

users

array of objects

An array of objects where each object contains the following:

  • id - the Id a driver assigned to this delivery block.
  • name - the name of a driver assigned to this delivery block.
  • email - the email address of a driver assigned to this delivery block.
Suggest Edits

Get Delivery Block

Get the details of a delivery block by delivery block Id.

 
gethttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2?id=id
No input body is required. 
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "delivery_block": {
        "id": 1285,
        "name": "Morning Shift 005",
        "description": "Daily Morning Shift",
        "start_time": "2018-07-23T08:00:00.000Z",
        "end_time": "2018-07-23T13:00:00.000Z",
        "capacity": 2,
        "original_capacity": 10,
        "user_ids": [
            81617,
            77509
        ],
        "users": [
            {
                "id": 81617,
                "name": "Dave Smithson",
                "email": "ben.techwriter@gmail.com"
            },
            {
                "id": 77509,
                "name": "Tom Parkman",
                "email": "tomp@beveragebarn.com"
            }
        ]
    }
}
{
    "success": false,
    "message": "Couldn't find delivery block with id 1289, merchant_id 11271"
}

Path Params

id
int32
required

The Id of the delivery block whose details are required.

 

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 delivery block.

capacity

Int32

The number of drivers assigned to this delivery block.

description

string

The description of this delivery block.

end_time

datetime

The ending date and time of this delivery block.

name

string

The name of this delivery block.

original_capacity

Int32

The number of drivers that should work to this delivery block.

start_time

datetime

The starting date and time of this delivery block.

user_ids

array of integers

An array containing the Ids of the drivers assigned to delivery block.

users

array of objects

An array of objects where each object contains the following:

  • id - the Id a driver assigned to this delivery block.
  • name - the name of a driver assigned to this delivery block.
  • email - the email address of a driver assigned to this delivery block.
Suggest Edits

Assign a Driver to a Delivery Block

Assign a driver or drivers to a delivery block by driver Id(s) and delivery block Id.

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

You couldn't be authenticated

{
    "success": true
}
{
    "success": false,
    "message": "Driver already assigned to block",
    "rc": 2
}
{
    "success": false,
    "message": "Couldn't find user with id 81617, merchant_id 11271"
}
{
    "success": false,
    "message": "Couldn't find delivery block with id 1285, merchant_id 11271"
}

Body Params

delivery_block_id
int32
required

The Id of the delivery block to which the driver is assigned.

user_id
int32
required

The Id of the driver to assign to the specified delivery block.

 

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.

Suggest Edits

Unassign a Driver from a Delivery Block

Unassign a driver or drivers from a delivery block by driver Id(s) and delivery block Id.

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

You couldn't be authenticated

{
    "success": true
}
{
    "success": false,
    "message": "Not allowed, unassign time has passed",
    "rc": 1
}
{
    "success": false,
    "message": "Driver is not assigned to block",
    "rc": 2
}
{
    "success": false,
    "message": "Couldn't find user with id 81617, merchant_id 11271"
}
{
    "success": false,
    "message": "Couldn't find delivery block with id 1285, merchant_id 11271"
}

Body Params

delivery_block_id
int32
required

The Id of the delivery block from which the driver is unassigned.

user_id
int32
required

The Id of the driver to unassign from the specified delivery block.

 
Suggest Edits

Update a Delivery Block

Make changes to an existing delivery block e.g. change capacity

 
posthttps://developer-api.bringg.com/partner_api
{
	"id" : 12345,
	"original_capacity": 10,
	"name": "Morning Shift 005",
	"description": "Daily Morning Shift",
	"team_id": 54321,
	"start_time" : "2018-10-31T19:00:00.000Z",
	"end_time": "2018-10-31T20:00:00.000Z"
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "delivery_block": {
        "id": 12345,
        "name": "",
        "description": null,
        "start_time": "2018-10-31T17:00:00.000Z",
        "end_time": "2018-10-31T18:00:00.000Z",
        "break_start_time": null,
        "break_end_time": null,
        "capacity": 0,
        "original_capacity": 10,
        "delivery_block_schedule_id": null,
        "user_ids": [],
        "team_id": 54321,
        "ical": null,
        "users": []
    }
}

Body Params

id
int32
required

Delivery Block ID

break_end_time
date

For a delivery block that includes a break, this is the ending time of the break.

break_start_time
date

For a delivery block that includes a break, this is the starting time of the break.

description
string

The description of the delivery block

end_time
date

The ending time of the delivery block

name
string

The name of the delivery block

original_capacity
int32

The number of drivers that should work this delivery block.

recurring
string

Indicates whether the delivery block is a recurring delivery block. The values are: all - All delivery blocks in that series from the current time stamp forward, future - All delivery blocks in that series from that delivery block forward.

start_time
date

The starting time of the delivery block

team_id
int32

The ID of the team that this delivery block should belong to

 
recurring

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 delivery block.

break_end_time

datetime

For a delivery block that includes a break, this is the ending time of the break.

break_start_time

datetime

For a delivery block that includes a break, this is the starting time of the break.

capacity

Int32

The number of drivers assigned to this new delivery block.

description

string

The description of this new delivery block.

end_time

datetime

The ending date and time of this new delivery block.

name

string

The name of this new delivery block.

ical

string

A string representing the iCal object for this delivery block. iCal is used for Internet Calendaring and Scheduling. For example, an iCal value is: FREQ=DAILY;INTERVAL=1;UNTIL=20181115T210000Z. For information about iCal, see the RFC for the Internet Calendaring and Scheduling Core Object Specification (iCalendar).

original_capacity

Int32

The number of drivers that should work to this new delivery block.

recurring

string

Indicates whether the delivery block is a recurring delivery block. The values are:

  • all - All delivery blocks in that series from the current time stamp forward.
  • future - All delivery blocks in that series from that delivery block forward.

Note: If future is specified for the recurring parameter, an iCal object is returned as a string in the iCal parameter.

start_time

datetime

The starting date and time of this new delivery block.

user_ids

array of integers

An array containing the Ids of the drivers assigned to this delivery block.

users

array of objects

An array of objects where each object contains the following:

  • id - the Id a driver assigned to this delivery block.
  • name - the name of a driver assigned to this delivery block.
  • email - the email address of a driver assigned to this delivery block.
Suggest Edits

Delete a Delivery Block

Delete a delivery block.

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

You couldn't be authenticated

{
    "success": true
}
{
    "success": false,
    "message": "cannot delete delivery block, driver assigned\""
}
{
    "success": false,
    "message": "Couldn't find delivery block with id 1246, merchant_id 11271"
}

Body Params

id
int32
required

The Id of the delivery block to delete.

recurring
string

Indicates whether the delivery block is a recurring delivery block. The values are: all - All delivery blocks in that series from the current time stamp forward, future - All delivery blocks in that series from that delivery block forward.

 
Suggest Edits

Drivers Delivery Blocks

Gets a list of delivery blocks assigned to specified drivers by time range.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
 "user_ids" :[81617,82267],
 "start_time": 1531612800,
 "end_time": 1534291200
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "delivery_blocks": [
        {
            "id": 1287,
            "name": "Morning Shift 005",
            "description": "Daily Morning Shift",
            "start_time": "2018-07-23T08:00:00.000Z",
            "end_time": "2018-07-23T13:00:00.000Z",
            "capacity": 1,
            "original_capacity": 10,
            "user_ids": [
                81617
            ],
            "users": [
                {
                    "id": 81617,
                    "name": "Dave Smithson",
                    "email": "dsmithson@yourcompany.com"
                }
            ]
        },
        {
            "id": 1872,
            "name": "Evening Shift 400",
            "description": "Daily Evening Shift",
            "start_time": "2018-08-09T15:45:00.000Z",
            "end_time": "2018-08-09T18:00:00.000Z",
            "capacity": 1,
            "original_capacity": 10,
            "user_ids": [
                82267
            ],
            "users": [
                {
                    "id": 82267,
                    "name": "Steven Eng",
                    "email": "seng@yourcompany.com"
                }
            ]
        },
...
        {
            "id": 1870,
            "name": "Afternoon Shift 200",
            "description": "Afternoon Shift",
            "start_time": "2018-08-08T15:45:00.000Z",
            "end_time": "2018-08-08T18:00:00.000Z",
            "capacity": 1,
            "original_capacity": 10,
            "user_ids": [
                81617
            ],
            "users": [
                {
                    "id": 81617,
                    "name": "Dave Smithson",
                    "email": "dsmithson@yourcompany.com"
                }
            ]
        },
        {
            "id": 1871,
            "name": "Evening Shift 400",
            "description": "Evening Shift",
            "start_time": "2018-08-09T15:45:00.000Z",
            "end_time": "2018-08-09T18:00:00.000Z",
            "capacity": 2,
            "original_capacity": 10,
            "user_ids": [
                81617,
                82267
            ],
            "users": [
                {
                    "id": 81617,
                    "name": "Dave Smithson",
                    "email": "dsmithson@yourcompany.com"
                },
                {
                    "id": 82267,
                    "name": "Steven Eng",
                    "email": "seng@yourcompany.com"
                }
            ]
        }
    ]
}
{
    "success": false,
    "rc": 0,
    "message": "param is missing or the value is empty: start_time"
}
{
}

Body Params

user_ids
array of integers
required

The Ids of the drivers whose delivery blocks are required.

start_time
date
required

The starting date and time of the delivery blocks to list for the specified drivers. Use epoch time.

end_time
date
required

The ending date and time of the delivery blocks to list for the specified drivers. Use epoch time.

 

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 delivery block.

capacity

Int32

The number of drivers assigned to this delivery block.

description

string

The description of this delivery block.

end_time

datetime

The ending date and time of this delivery block. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

name

string

The name of this delivery block.

original_capacity

Int32

The number of drivers that should work to this delivery block.

start_time

datetime

The starting date and time of this delivery block. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_ids

array of integers

An array containing the Ids of the drivers assigned to delivery block.

users

array of objects

An array of objects where each object contains the following:

  • id - the Id a driver assigned to this delivery block.
  • name - the name of a driver assigned to this delivery block.
  • email - the email address of a driver assigned to this delivery block.
Suggest Edits

Team Delivery Blocks

Gets a list of delivery blocks assigned to a specific team by time range.

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"team_id" : 12345,
	"start_time": "1541513000",
	"end_time": "1542376985"
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "delivery_blocks": [
        {
            "id": 1287,
            "name": "Morning Shift 005",
            "description": "Daily Morning Shift",
            "start_time": "2018-07-23T08:00:00.000Z",
            "end_time": "2018-07-23T13:00:00.000Z",
            "break_start_time": null,
            "break_end_time": null,
            "capacity": 1,
            "original_capacity": 10,
            "delivery_block_schedule_id": null,
            "user_ids": [
                81617
            ],
            "team_id": 18667,
            "ical": null,
            "users": [
                {
                    "id": 81617,
                    "name": "Tom Jones",
                    "email": "jones.tom@bringg.com"
                }
            ]
        },
        {
            "id": 1872,
            "name": "Evening Shift 400",
            "description": "Daily Evening Shift",
            "start_time": "2018-08-09T15:45:00.000Z",
            "end_time": "2018-08-09T18:00:00.000Z",
            "break_start_time": null,
            "break_end_time": null,
            "capacity": 1,
            "original_capacity": 10,
            "delivery_block_schedule_id": null,
            "user_ids": [],
            "team_id": 18667,
            "ical": null,
            "ical": null,
            "users": []
        },
...
      

Body Params

team_id
int32
required
start_time
date
required

The starting date and time of the delivery blocks to list for the specified team. Use epoch time.

end_time
date
required

The ending date and time of the delivery blocks to list for the specified team. Use epoch time.

 
Suggest Edits

Create Blacklisted Customer Driver

Block drivers from delivering to specific customers

 
posthttps://developer-api.bringg.com/services/serviceId/service_uuid1/service_uuid2
{
	"user_id" : 12345,
	"customer_id" : 54321,
	"reason" : "Here is the reason for blocking"
}
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "rc": 0,
    "blacklisted_customer_user": {
        "id": 10,
        "user_id": 12345,
        "customer_id": 54321,
        "reason": "Here is the reason for blocking"
    }
}
{
    "success": false,
    "rc": 3,
    "message": "blacklisted customer user already exists"
}
{
    "success": false,
    "rc": 1,
    "message": "customer not found"
}

Body Params

user_id
int32
required

ID of the driver in Bringg

customer_id
int32
required

ID of the customer in Bringg

reason
string

Reason for blocking the driver from the customer

 
Suggest Edits

Delete Blacklisted Customer Driver

Remove the blacklisted association between driver and customer

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

You couldn't be authenticated

{
    "success": true,
    "rc": 0
}

Body Params

user_id
int32
required

ID of the driver in Bringg

customer_id
int32
required

ID of the customer in Bringg

 
Suggest Edits

Get List of Blacklisted Customer Drivers

Get a list of all blacklisted associations between customers and drivers

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

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

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

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

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

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

request = Net::HTTP::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/services/serviceId/service_uuid1/service_uuid2");

xhr.send(data);
import requests

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

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

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "success": true,
    "rc": 0,
    "blacklisted_customer_users": [
        {
            "id": 1,
            "user_id": 12345,
            "customer_id": 54321,
            "reason": "Here is the reason"
        },
        {
            "id": 2,
            "user_id": 3434343,
            "customer_id": 121212121,
            "reason": null
        }
    ]
}     
 
Suggest Edits

Generate Pickup QR Code

Use to generate QR Code for a task to be scanned by the driver

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

You couldn't be authenticated

{
  success: true, 
  rc: 0, 
  scan_string: "eWicoDcMH5aeWs2M"
}

Body Params

id
int64

Bringg ID of task to generate QR code for

 
Suggest Edits

Create Customer

Create a Customer

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

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

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

$data_string["signature"] = $signature;

$content = json_encode($data_string);

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

$json_response = curl_exec($ch);

$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

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

curl_close($ch);

$response = json_decode($json_response, true);

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

You couldn't be authenticated

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

Body Params

name
string
required

Name of customer

company_id
int32
required

Unique identifier representing a company (Merchant ID)

address
string

Address of customer

address_second_line
string

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

city
string
borough
string
state
string
zipcode
string
phone
string
required

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

email
string

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

lat
double

Latitude component of customer location

lng
double

Longitude component of customer location

external_id
string

Customer external ID