How to recieve courier status updates

Introduction

Implement a courier status update webhook to receive real-time delivery updates from a dispatch partner and keep your customers informed.

Format

This webhook returns updates from dispatch partners. It does not return updates for channel partners, which are ordering platforms that may also deliver orders.

The courier status update webhook sends an update when the dispatch partner reports a change in the courier journey (the delivery process from dispatch through completion). These updates help you show customers the current state of their delivery.

The webhook sends updates for:

• Estimated delivery time changes when deliveryTimeETA changes by more than 60 seconds. Deliverect uses this threshold to reduce minor ETA fluctuations while still sending meaningful delivery time changes. The value uses UTC format.
• Changes to the courier's name.
• Dispatch partner actions that change the order status.
• Updated courier coordinates from the dispatch partner.

Required request details

Use the Courier Status Update API reference as the source of truth for request fields, field types, and supported status values.

At minimum, your webhook handler should:

1. Read the fields that identify the order and courier update.
2. Process status changes from the dispatch partner.
3. Process deliveryTimeETA changes when present.
4. Process courier name and coordinate updates when present.
5. Store or forward the update to the systems that notify customers.

Webhook configuration

Configure your webhook to respond with 200 OK after it receives and processes an update successfully.