Overview

The Standalone Dispatch API is for ordering platforms and brands whose have already integrated orders into a POS e.g. first-party channel with a direct POS integration and want to integrate only a Dispatch flow as a standalone integrattion.

It enables integrators to pre-validate courier availability before capturing payment and then creating an order that is then assigned to a courier, after which, delivery progress updates are sent as webhook events.

1

Pre-validate Dispatch Availability — Dispatch Availability

Check that a dispatch service is available before checkout.

2

Create Order for Dispatch — Create Order

Send the order with a valid delivery address, courier set to "restaurant" and, optionally, the validationId from step 1. The job is then assigned to the integrated dispatch service.

3

Receive Courier Updates — Courier Update Webhook

Receive a webhook event when:

The order status changes

Courier coordinates update

deliveryTimeETA changes by more than 60 seconds

The courier name changes