API Reference

Delivery Cancelled Webhook

This notifies you when Bringg has cancelled an order.

When you receive this webhook, you will need to cancel the delivery in your system.

📘

What we expect from you in response

We need a success:true response. Nothing else in the body of the payload is required.

{
	"success": true
}

EXAMPLE PAYLOAD SENT FROM BRINGG

{
   "id": 44185871,
   "delivery_id": "cb28bba8-6b99-4221-86bc-aaee3161b8bd",
   "request_id": "78ff4a4e-3ed3-4bdf-9de6-69cf360df520"
}
{
	"delivery_id": "Your Delivery ID",
	"id": 123456,
	"reason_id": 1,
	"reason": "Customer cancelled the order",
	"request_id": "c873bfb4-b8ca-4813-a530-c8039745f19e"
}
{
	"delivery_id": "Your Delivery ID",
	"id": 123456,
	"reason_id": 1,
	"reason": "Other: Here is the other reason",
	"request_id": "c873bfb4-b8ca-4813-a530-c8039745f19e"
}

BODY PARAMS

delivery_id

string

The delivery ID you gave for this order

id

Int32

Bringg's unique ID for this order

reason_id

Int32

Bringg's ID for this cancellation reason

reason

string

The cancellation reason provided by the merchant