The Driver On Way callback occurs when a user (driver) notifies Bringg that the user (driver) is on the way to an order location. This callback returns detailed information describing the order, including driver status
Response
{
"id": 8503585,
"title": "50 cases of Best Brand Soda",
"created_at": "2017-12-12T15:57:37.000Z",
"updated_at": "2017-12-12T16:14:35.000Z",
"customer_id": 4652688,
"user_id": 77484,
"status": 2,
"scheduled_at": "2017-12-12T16:26:03.000Z",
"merchant_id": 11271,
"additional_attributes": {
"planned_distance_from_prev_task": 4.594
},
"active_way_point_id": 10640287,
"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,
"dispatcher_id": null,
"team_ids": [],
"ready_to_execute": true,
"started_time": "2017-12-12T16:14:33.000Z",
"start_lat": 32.0939897,
"start_lng": 34.8282845,
"tip_driver_enabled": false,
"tag_id": 8613,
"automatically_assigned": false,
"run_uuid": "0f8ec3a8-d35c-4665-aa63-b5d703673f4f",
"run_start_time": "2017-12-12T16:14:33.000Z",
"last_assigned_time": "2017-12-12T16:05:31.000Z",
"task_inventories": 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
}{
"task": {
"id": 1234,
"title": "Delivery Task",
"status": 2,
"external_id": "h84j187",
"fleet_delivery_external_id": "ABC123",
"additional_attributes": {
"planned_distance_from_prev_task": 4.594
},
"way_points": [
{
"id": 9876,
"position": 1,
"scheduled_at": null,
"eta": null,
"address": "123 Main St. New York, NY 10001",
},
{
"id": 9877,
"position": 2,
"scheduled_at": "2023-01-01T12:47:00.000Z",
"eta": "2023-01-01T12:42:00.000Z",
"address": "123 1st Ave. New York, NY 10002"
}
],
"fleet": {
"name": "Carrier",
"id": 1234
}
},
"webhook_type": "driver_on_the_way",
"merchant_id": 1
}Output Params
|
id Int32 |
The Id of the 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:
|
|
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 detailed information about the customer associated with this order, see Customer. |
|
customer_id Int32 |
The Id of the customer associated with this order. |
|
dispatcher_id Int32 |
If the dispatcher locked this order, the Id of the dispatcher. |
|
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. |
|
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:
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 boolean |
Indicates whether this order is in planning and not visible to users (drivers). The values are:
|
|
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:
This Order Created callback returns the value 2 (on_the_way). |
|
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. |
|
team_ids Array of Int32 |
An array of Int32 containing the Ids of all teams assigned to this order. |
|
tip_driver_enabled boolean |
Indicates whether the user (driver) is allowed to be tipped. The values are:
|
|
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). |
|
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. |