Currently the webhook system for Orders handles two types of events. The Order and the Rider types events:
Order type events:
order-accepted
order-in-kitchen
order-ready-to-pick-up
order-picked-up
order-served
order-canceled
Rider type events:
rider-created
rider-picking
rider-delivering
rider-completed
rider-error
Sent to know that an order has been created.
Channel | Pos | Riders | Loyalty |
---|
✖️ | ✔️ | ✖️ | ✖️ |
{
"eventType": "order-accepted",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The 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 |
---|
✔️ | ✖️ | ✔️ | ✔️ |
{
"eventType": "order-in-kitchen",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The 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 |
---|
✔️ | ✖️ | ✔️ | ✖️ |
{
"eventType": "order-ready-to-pick-up",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The 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 |
---|
✔️ | ✖️ | ✖️ | ✖️ |
{
"eventType": "order-picked-up",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The 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 |
---|
✔️ | ✖️ | ✖️ | ✖️ |
{
"eventType": "order-served",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The orderId in which the status was updated |
Sent to know that an order has been canceled.
Channel | Pos | Rider | Loyalty |
---|
✖️ | ✔️ | ✔️ | ✔️ |
{
"eventType": "order-canceled",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The 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 |
---|
✔️ | ✔️ | ✖️ | ✖️ |
{
"eventType": "rider-created",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The 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 |
---|
✔️ | ✔️ | ✖️ | ✖️ |
{
"eventType": "rider-picking",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The 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 |
---|
✔️ | ✔️ | ✖️ | ✖️ |
{
"eventType": "rider-delivering",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The 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 |
---|
✔️ | ✔️ | ✖️ | ✖️ |
{
"eventType": "rider-completed",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The 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 |
---|
✔️ | ✔️ | ✖️ | ✖️ |
{
"eventType": "rider-error",
"storeId": "string",
"data": {
"orderId": "string"
}
}
Field | Description |
---|
eventType | The type of event |
storeId | The storeId where the event occurred |
data.orderId | The orderId in which the status was updated |