Order Accepted by Driver

The Order Accepted By Driver callback occurs when an order is accepted by a driver. This returns detailed information describing the order, including the driver and status.

📘

Registering Your URL for the Order Accepted By Driver Webhook

For information describing how to register your URL for a webhook, see Bringg Webhooks.

Response

{
	"id": 8503585,
	"title": "50 cases of Best Brand Soda",
	"created_at": "2017-12-12T15:57:37.240Z",
	"updated_at": "2017-12-12T16:06:57.530Z",
	"customer_id": 4652688,
	"user_id": 77484,
	"status": 6,
	"scheduled_at": "2017-12-12T16:26:03.411Z",
	"merchant_id": 11271,
	"active_way_point_id": 10640287,
	"extras": null,
	"webhooks": null,
	"way_points": [
		{
			"id": 10640287,
			"lat": 40.442228,
			"lng": -80.003107,
			"task_id": 8503585,
			"done": false,
			"created_at": "2017-12-12T15:57:37.124Z",
			"updated_at": "2017-12-12T15:57:37.260Z",
			"customer_id": 4652688,
			"address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
			"position": 1,
			"scheduled_at": "2017-12-12T16:26:03.411Z",
			"checkin_time": null,
			"checkout_time": null,
			"note": null,
			"find_me": null,
			"asap": null,
			"late": false,
			"eta": null,
			"etl": "2017-12-12T16:31:03.411Z",
			"silent": false,
			"phone": "+9724121234567",
			"email": "[email protected]",
			"delete_at": null,
			"checkin_lat": null,
			"checkin_lng": null,
			"checkout_lat": null,
			"checkout_lng": null,
			"etos": 300,
			"distance_traveled_client": null,
			"distance_traveled_server": null,
			"automatically_checked_in": 0,
			"automatically_checked_out": 0,
			"merchant_id": 11271,
			"start_lat": null,
			"start_lng": null,
			"start_time": null,
			"estimated_distance": null,
			"estimated_time": null,
			"allow_editing_inventory": true,
			"must_approve_inventory": false,
			"address_second_line": "Annex B",
			"zipcode": null,
			"allow_scanning_inventory": null,
			"allow_editing_payment": null,
			"late_reason": null,
			"no_later_than": null,
			"no_earlier_than": null,
			"masked_phone_number": null,
			"twilio_number_id": null,
			"marked_late_at": null,
			"borough": null,
			"city": null,
			"distance_traveled": null,
			"state": null,
			"delivery_confirmation_scan": null,
			"delivery_confirmation_note": null,
			"delivery_confirmation_photo": null,
			"delivery_confirmation_signature": null,
			"delivery_confirmation_form": null,
			"delivery_confirmation_ocr": null,
			"company_name": null,
			"customer_contact_ids": [
				4652688
			],
			"contacts": [
				{
					"customer_id": 4652688,
					"contact_type": "phone",
					"contact_value": "+9724121234567",
					"sharing_allowed": true
				},
				{
					"customer_id": 4652688,
					"contact_type": "email",
					"contact_value": "[email protected]",
					"sharing_allowed": true
				}
			],
			"allow_editing_original_quantity": null,
			"pickup_dropoff_option": null,
			"delivery_confirmation_cash": null,
			"district": null,
			"house_number": null,
			"street": null,
			"pending_geocode": false,
			"original_eta": null,
			"allow_automatic_set_coordinates": true,
			"has_to_leave_by": null,
			"customer": {
				"id": 4652688,
				"name": "Beverage Brothers",
				"address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
				"lat": 40.442228,
				"lng": -80.003107,
				"created_at": "2017-12-11T17:19:06.856Z",
				"updated_at": "2017-12-12T16:01:48.607Z",
				"phone": "+9724121234567",
				"merchant_id": 11271,
				"image": "/images/avatar.png",
				"access_token": "4895077e-dc4b-4bc5-a3bc-705d31c83429",
				"confirmation_code": "7454",
				"salt": null,
				"approved": false,
				"push_token": null,
				"uuid": "0885ddb9-c943-4ef5-98f2-9db7f02e6d13",
				"email": "[email protected]",
				"external_id": "4652688",
				"delete_at": null,
				"facebook_id": null,
				"extras": null,
				"original_lat_lng_changed": "2017-12-12T11:47:49.499Z",
				"encrypted_password": "",
				"blocked_email": false,
				"address_second_line": "Annex B",
				"zipcode": null,
				"allow_login": false,
				"stripe_id": null,
				"original_phone_number": "412-123-4567",
				"last_open_at": null,
				"last_order_at": null,
				"uploaded_profile_image": {
					"url": "/images/avatar.png"
				},
				"original_lat": 40.442228,
				"original_lng": -80.003107,
				"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
			},
			"full_address": "120 Fifth Ave, Pittsburgh, PA 15222, USA"
		},
		{
			"id": 10640288,
			"lat": 40.4417274,
			"lng": -80.0027365,
			"task_id": 8503585,
			"done": false,
			"created_at": "2017-12-12T15:57:37.197Z",
			"updated_at": "2017-12-12T15:57:37.265Z",
			"customer_id": 4647476,
			"address": "95 Fifth Ave, Pittsburgh, PA , USA",
			"position": 2,
			"scheduled_at": "2017-12-12T16:56:03.411Z",
			"checkin_time": null,
			"checkout_time": null,
			"note": null,
			"find_me": null,
			"asap": null,
			"late": false,
			"eta": null,
			"etl": "2017-12-12T17:01:03.411Z",
			"silent": false,
			"phone": null,
			"email": "[email protected]",
			"delete_at": null,
			"checkin_lat": null,
			"checkin_lng": null,
			"checkout_lat": null,
			"checkout_lng": null,
			"etos": 300,
			"distance_traveled_client": null,
			"distance_traveled_server": null,
			"automatically_checked_in": 0,
			"automatically_checked_out": 0,
			"merchant_id": 11271,
			"start_lat": null,
			"start_lng": null,
			"start_time": null,
			"estimated_distance": null,
			"estimated_time": null,
			"allow_editing_inventory": true,
			"must_approve_inventory": false,
			"address_second_line": null,
			"zipcode": "15222",
			"allow_scanning_inventory": null,
			"allow_editing_payment": null,
			"late_reason": null,
			"no_later_than": null,
			"no_earlier_than": null,
			"masked_phone_number": null,
			"twilio_number_id": null,
			"marked_late_at": null,
			"borough": null,
			"city": null,
			"distance_traveled": null,
			"state": null,
			"delivery_confirmation_scan": null,
			"delivery_confirmation_note": null,
			"delivery_confirmation_photo": null,
			"delivery_confirmation_signature": null,
			"delivery_confirmation_form": null,
			"delivery_confirmation_ocr": null,
			"company_name": null,
			"customer_contact_ids": [
				4647476
			],
			"contacts": [
				{
					"customer_id": 4647476,
					"contact_type": "email",
					"contact_value": "[email protected]",
					"sharing_allowed": true
				}
			],
			"allow_editing_original_quantity": null,
			"pickup_dropoff_option": null,
			"delivery_confirmation_cash": null,
			"district": null,
			"house_number": null,
			"street": null,
			"pending_geocode": false,
			"original_eta": null,
			"allow_automatic_set_coordinates": true,
			"has_to_leave_by": null,
			"customer": {
				"id": 4647476,
				"name": "Mike's Quickstop",
				"address": "95 Fifth Ave, Pittsburgh, PA 15222, USA",
				"lat": 40.4417274,
				"lng": -80.0027365,
				"created_at": "2017-12-11T13:53:19.963Z",
				"updated_at": "2017-12-12T16:01:48.649Z",
				"phone": null,
				"merchant_id": 11271,
				"image": "/images/avatar.png",
				"access_token": "7e011add-f5db-47cb-897e-1bd1224db659",
				"confirmation_code": "3504",
				"salt": null,
				"approved": false,
				"push_token": null,
				"uuid": "4301c99c-904c-4c36-a2f2-6a7e96de68e8",
				"email": "[email protected]",
				"external_id": "4647476",
				"delete_at": null,
				"facebook_id": null,
				"extras": null,
				"original_lat_lng_changed": null,
				"encrypted_password": "",
				"blocked_email": false,
				"address_second_line": null,
				"zipcode": "15222",
				"allow_login": false,
				"stripe_id": null,
				"original_phone_number": null,
				"last_open_at": null,
				"last_order_at": null,
				"uploaded_profile_image": {
					"url": "/images/avatar.png"
				},
				"original_lat": null,
				"original_lng": null,
				"consecutive_checkins_out_of_geofence": 1,
				"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
			},
			"full_address": "95 Fifth Ave, Pittsburgh, PA , USA, 15222"
		}
	],
	"customer": {
		"id": 4652688,
		"name": "Beverage Brothers",
		"address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
		"lat": 40.442228,
		"lng": -80.003107,
		"created_at": "2017-12-11T17:19:06.856Z",
		"updated_at": "2017-12-12T16:01:48.607Z",
		"phone": "+9724121234567",
		"merchant_id": 11271,
		"image": "/images/avatar.png",
		"access_token": "4895077e-dc4b-4bc5-a3bc-705d31c83429",
		"confirmation_code": "7454",
		"salt": null,
		"approved": false,
		"push_token": null,
		"uuid": "0885ddb9-c943-4ef5-98f2-9db7f02e6d13",
		"email": "[email protected]",
		"external_id": "4652688",
		"delete_at": null,
		"facebook_id": null,
		"extras": null,
		"original_lat_lng_changed": "2017-12-12T11:47:49.499Z",
		"encrypted_password": "",
		"blocked_email": false,
		"address_second_line": "Annex B",
		"zipcode": null,
		"allow_login": false,
		"stripe_id": null,
		"original_phone_number": "412-123-4567",
		"last_open_at": null,
		"last_order_at": null,
		"uploaded_profile_image": {
			"url": "/images/avatar.png"
		},
		"original_lat": 40.442228,
		"original_lng": -80.003107,
		"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
	},
	"late": false,
	"external_id": "8503585",
	"uuid": "9dd753ff-9bf4-43ab-94d7-aa5f6f77af63",
	"priority": 8503585,
	"total_price": null,
	"price_before_tax": null,
	"delivery_price": null,
	"tip": null,
	"left_to_be_paid": null,
	"dispatcher_id": null,
	"ready_to_execute": true,
	"start_lat": null,
	"start_lng": null,
	"distance_traveled": null,
	"tax_price": null,
	"discount": null,
	"tip_driver_enabled": false,
	"tag_id": 8613,
	"pre_delivery_tip": null,
	"post_delivery_tip_cash": null,
	"post_delivery_tip_credit": null,
	"group_leader_id": null,
	"automatically_assigned": false,
	"run_uuid": null,
	"last_assigned_time": "2017-12-12T16:05:31.977Z",
	"task_inventories": [],
	"group_uuid": null,
	"parent_task_id": null,
	"payment_type_name": null,
	"task_notes": [
		{
			"id": 9495596,
			"note": "20 cases, ask for Tom or Mike.",
			"user_id": 59172,
			"task_id": 8503585,
			"created_at": "2017-12-12T15:57:37.213Z",
			"updated_at": "2017-12-12T15:57:37.270Z",
			"url": null,
			"way_point_id": 10640288,
			"customer_id": null,
			"pending_upload": false,
			"lat": 32.1068165,
			"lng": 34.8348318,
			"type": "TaskNote"
		},
		{
			"id": 9495595,
			"note": "30 cases, drop at dock #4",
			"user_id": 59172,
			"task_id": 8503585,
			"created_at": "2017-12-12T15:57:37.141Z",
			"updated_at": "2017-12-12T15:57:37.267Z",
			"url": null,
			"way_point_id": 10640287,
			"customer_id": null,
			"pending_upload": false,
			"lat": 32.1068165,
			"lng": 34.8348318,
			"type": "TaskNote"
		}
	],
	"fleet_id": null,
	"fleet_delivery_external_id": null
}

Output Params

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

JSON

A JSON containing the following fields from the customer object associated with this order:

  • id
  • name
  • address
  • address_second_line
  • zipcode
  • lat
  • lng
  • phone
  • address_type
  • merchant_id
  • image
  • email
  • facebook_id
  • extras
  • external_id
  • mobile_type
  • client_version
  • client_name
  • 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

    JSON

    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.

    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

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

    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 6 (accepted).

    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.

    tag_id

    Int32

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

    task_inventories

    Array of JSONs

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

    task_notes

    Array of JSONs

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

    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 JSONs

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

    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.