Courier Status Updates

Introduction

To stay updated on courier-related information and changes during a delivery, you can implement a webhook that listens for updates triggered by changes in the courier journey. This webhook provides real-time information about the courier's activities and status changes.

👍

You can use the information received to keep your customers informed about the progress of their deliveries.

Purpose of the webhook

The courier status update webhook provides immediate updates for any change in the courier's journey. These updates include the following:

• Changes in the estimated delivery time (deliveryTimeETA) that are greater or less than 60 seconds (in UTC format).
• Changes in the courier's name.
• Actions performed by the delivery partner that result in a status change for the order.
• Updated coordinates provided by the dispatch partner.

📘

Before implementing the webhook

Ensure that there is a registered dispatch partner who is integrated with our Dispatch API and also connected to the customer (restaurant or food business) account. This webhook does not return results for channel partners who may also deliver orders.

API reference

For a comprehensive list of request key definitions and available status updates, please refer to our Courier Status Update API reference..

Webhook configuration

Configure your webhook to listen to updates as specified in the documentation. The webhook should respond with a 200 OK status to acknowledge the receipt of updates.

👍

Keep in mind that the webhook provides real-time updates, so your system should be designed to handle these updates promptly.