Webhook Events
Stay Informed About Key Order and Delivery Milestones
Retm webhooks keep you abreast of crucial order and delivery events as they unfold. Here's a breakdown of the events you can subscribe to:
Order Events
order.created
Signals the creation of a new order within the Retm platform.order.updated
Indicates a change in an existing order's status, details, or other relevant information.
Delivery Events
order.delivery.created
Marks the initiation of a delivery process for an order.order.delivery.updated
Signifies a change in the delivery status of an order, such as assignment to a driver, completion, or cancellation.
Order Status Codes
ID | Status | Description |
---|---|---|
1 | Closed | The order has been completed and closed. |
2 | Pending | The order is awaiting processing or confirmation. |
3 | Active | The order is actively being prepared or delivered. |
4 | Refunded | The order has been refunded to the customer. |
5 | Void | The order has been invalidated and is no longer valid. |
6 | Declined | The order has been declined, typically due to payment issues. |
Delivery Status Codes
ID | Status | Description |
---|---|---|
1 | In process | The order is currently being prepared at the restaurant. |
2 | Pickup ready | The order is ready for pickup but has not yet been collected by the customer or driver. |
3 | Assigned | The order has been assigned to a delivery driver. |
4 | Out for delivery | The driver is en route to deliver the order to the customer. |
5 | Delivered | The order has been successfully delivered to the customer. |
6 | Canceled | The order has been canceled and will not be delivered. |
By subscribing to these webhook events, your application can seamlessly react to order and delivery updates in real-time, enabling enhanced customer experiences and operational efficiency.
Modified at 9 months ago