Currently the webhook system for Orders handles two types of events. The Order and the Rider types events:
Order type events:
order-acceptedorder-in-kitchenorder-ready-to-pick-uporder-picked-uporder-servedorder-canceled
Rider type events:
rider-createdrider-pickingrider-deliveringrider-completedrider-errorrider-proof-deliveryrider-refund
Sent to know that an order has been created.
Channel Pos Riders Loyalty ✖️ ✔️ ✖️ ✖️
JSON
{
"eventType": "order-accepted",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that an order has been received by the POS and will be prepared.
Channel Pos Riders Loyalty ✔️ ✖️ ✔️ ✔️
JSON
{
"eventType": "order-in-kitchen",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that an order which the fulfillment.type is delivery-by-location is ready to be picked up.
Channel Pos Rider Loyalty ✔️ ✖️ ✔️ ✖️
JSON
{
"eventType": "order-ready-to-pick-up",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that an order which the fulfillment.type is takeaway has been picked up by the customer.
Channel Pos Rider Loyalty ✔️ ✖️ ✖️ ✖️
JSON
{
"eventType": "order-picked-up",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that an order which the fulfillment.type is order-at-table has been served to the customer.
Channel Pos Rider Loyalty ✔️ ✖️ ✖️ ✖️
JSON
{
"eventType": "order-served",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that an order has been canceled.
Channel Pos Rider Loyalty ✖️ ✔️ ✔️ ✔️
JSON
{
"eventType": "order-canceled",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that an order has been take in charge for the delivery by a rider.
Channel Pos Rider Loyalty ✔️ ✔️ ✖️ ✖️
JSON
{
"eventType": "rider-created",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that a rider is on his way to the restaurant in order to pick the order.
Channel Pos Rider Loyalty ✔️ ✔️ ✖️ ✖️
JSON
{
"eventType": "rider-picking",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that a rider is on his way to the customer in order to deliver the order.
Channel Pos Rider Loyalty ✔️ ✔️ ✖️ ✖️
JSON
{
"eventType": "rider-delivering",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that the delivery process of an order has been completed correctly.
Channel Pos Rider Loyalty ✔️ ✔️ ✖️ ✖️
JSON
{
"eventType": "rider-completed",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent to know that an error occurred during the process of delivery of an order.
Channel Pos Rider Loyalty ✔️ ✔️ ✖️ ✖️
JSON
{
"eventType": "rider-error",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated
Sent by some riders as proof that the order has been delivered.
Channel Pos Rider Loyalty ✔️ ✖️ ✖️ ✖️
JSON
{
"eventType": "rider-proof-delivery",
"storeId": "string",
"data": {
"orderId": "string",
"proofDelivery": "string"
}
}
Field Description eventTypeThe type of event storeIdThe storeId where the event occurred data.orderIdThe orderId in which the status was updated data.proofDeliveryThe proofDeliverystring.UberDirect case: Long Base64 string that can be converted to a PNG image (Web Converter (External))
Sent by some riders, when for some reason the order is not delivered.
Channel Pos Rider Loyalty ✔️ ✖️ ✖️ ✖️
JSON
{
"eventType": "rider-refund",
"storeId": "string",
"data": {
"orderId": "string",
"refund": {
id: "string",
date: "string",
totalRiderRefund: "number",
totalPartnerRefund: "number",
reason: "string",
refundItems:[
{
reason: "string",
riderAmount: "number",
partnerAmount: "number",
partyAtFault: "string",
items: [
{
name: "string",
qty: "number"
},
]
},
],
refundFees: [
{
name: "string",
amount: "value",
code: "string"
},
]
}
}
}
Field Description eventTypeThe type of event. storeIdThe storeId where the event occurred. data.orderIdThe orderId in which the status was updated. data.refundThe refund Data Object data.refund.idThe refund identifier. data.refund.dateRefund creation date. data.refund.totalRiderRefundTotal monetary amount that Rider will adjust on the billing details report and invoice in cents. data.refund.totalPartnerRefundTotal monetary amount that the partner is liable to their customers in cents. data.refund.reasonRefund reason. data.refund.refundItemsArray of refund items data Object data.refund.refundItems.reasonRefund item reason. data.refund.refundItems.riderAmountThe monetary value of items that Rider will adjust on the invoice in cents. data.refund.refundItems.partnerAmountThe monetary value of items that the partner is liable towards their customers in cents. data.refund.refundItems.partyAtFaultParty at fault. data.refund.refundItems.itemsArray of items Object data.refund.refundItems.items.nameRefund Item name. data.refund.refundItems.items.qtyQuantity of the item. data.refund.refundFeesArray of refund Fees data Object data.refund.refundFees.nameRefund fee name. data.refund.refundFees.amountRefund fee amount. data.refund.refundFees.codeRefund fee Code.
