The Order Cancelled callback occurs when an order is cancelled. This callback returns detailed information describing the order, including the order status.
Register Your URL for this Webhook
To start receiving webhooks from Bringg, you must first register a URL. Detailed guidance on setting up and managing Bringg webhooks is available in the following resources:
- Send Bringg Webhooks: Subscribe to webhooks and customize the fields in your callbacks.
- Webhook Authentication Methods: Ensure that your other systems recognize and accept webhooks from Bringg.
Response
{
"id": 8498720,
"title": "75 cases of soda to Beverage Brothers",
"created_at": "2017-12-12T11:48:37.440Z",
"updated_at": "2017-12-12T11:57:39.798Z",
"customer_id": 4652688,
"user_id": null,
"status": 7,
"scheduled_at": "2017-12-13T08:30:00.000Z",
"merchant_id": 11271,
"active_way_point_id": null,
"extras": null,
"webhooks": null,
"way_points": [
{
"id": 10634616,
"lat": 40.442228,
"lng": -80.003107,
"task_id": 8498720,
"done": true,
"created_at": "2017-12-12T11:48:37.409Z",
"updated_at": "2017-12-12T11:57:39.904Z",
"customer_id": 4652688,
"address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
"position": 1,
"scheduled_at": "2017-12-13T08:30:00.000Z",
"checkin_time": null,
"checkout_time": null,
"note": null,
"find_me": null,
"asap": null,
"late": false,
"eta": null,
"etl": "2017-12-13T08:35:00.000Z",
"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-12T11:48:37.454Z",
"phone": "+9724121234567",
"merchant_id": 11271,
"image": "/images/avatar.png",
"access_token": "0f97d647-d1ed-4a85-b562-a730c35d6c4a",
"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"
}
],
"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-12T11:48:37.454Z",
"phone": "+9724121234567",
"merchant_id": 11271,
"image": "/images/avatar.png",
"access_token": "0f97d647-d1ed-4a85-b562-a730c35d6c4a",
"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": "8498720",
"uuid": "e20302ac-a9ac-40d6-be7b-e501863c6602",
"priority": 8498720,
"total_price": null,
"price_before_tax": null,
"delivery_price": null,
"tip": null,
"left_to_be_paid": null,
"dispatcher_id": null,
"ready_to_execute": true,
"ended_time": "2017-12-12T11:57:39.798Z",
"start_lat": null,
"start_lng": null,
"distance_traveled": null,
"tax_price": null,
"cancelled_at": "2017-12-12T11:57:39.794Z",
"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-12T11:52:34.922Z",
"task_inventories": [],
"group_uuid": null,
"parent_task_id": null,
"payment_type_name": null,
"task_notes": [
{
"id": 9489575,
"note": "drop off at dock 3",
"user_id": 59172,
"task_id": 8498720,
"created_at": "2017-12-12T11:48:37.421Z",
"updated_at": "2017-12-12T11:48:37.459Z",
"url": null,
"way_point_id": 10634616,
"customer_id": null,
"pending_upload": false,
"lat": 32.1068165,
"lng": 34.8348318,
"type": "TaskNote"
}
],
"fleet_id": null,
"fleet_delivery_external_id": null,
"cancel_reason_id": 5,
"cancel_reason": {
"task_id": 8498720,
"other_text": "5 cases damaged."
},
"reason": "Accident / technical difficulties"
}
{
"task": {
"id": 123,
"title": "Delivery Task",
"status": 7,
"external_id": "ABCD",
"cancelled_at": "2021-04-01T06:17:05.000Z",
"way_points": [
{
"id": null,
"address": null,
"position": null,
"scheduled_at": null,
"eta": null
}
],
"task_cancellation_reason": {
"other_text": "Custom Reason",
"reason_to_cancel_task_id": 184,
"reason_to_cancel_task": {
"reason": "Customer Not Home",
"order_type": 4
}
}
},
"webhook_type": "task_cancelled",
"merchant_id": 1
}
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:
|
|
cancel_reason JSON |
A JSON containing detailed information about the cancel reason, see Cancel Reasons. |
|
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 JSON |
A JSON containing the following fields from the customer object associated with this order: |
|
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 JSON |
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:
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:
|
|
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:
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 JSONs |
An array of JSONs containing this order inventory. |
|
task_notes array of JSONs |
An array of JSONs 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:
|
|
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). |
|
user_external_id string |
The external Id of this user (driver)in your own system. |
uuid Int32 |
The universal unique Id of thise order. |
|
webhooks boolean |
Indicates whether webhooks can be set for this order. The values are:
|