Overview
Become an integration partner
Become a partner to gain access to our APIs. You can then begin developing your dispatch integration.
Build a dispatch integration
Step 1. Follow the instructions in this guide on how to set up your webhooks in Deliverect.
Step 2. Create a test order from Deliverect, which will trigger a call to your configured Validate webhook.
Step 3. Respond to the validate call. A call to the Create webhook is triggered if the call is affirmative ("canDeliver": true
).
Step 4. Send order updates to the Update Delivery endpoint.
You can use the Delivery Manager App to test the order flow. Learn more.
Available endpoints
The following endpoints are available for the Dispatch API.
Endpoint | Method | Purpose |
---|---|---|
Update Delivery | POST | Provide updates to the delivery status, pickup time, delivery time, and courier information |
Cancel Delivery | POST | Cancel the delivery of an order and provide a reason |
Updated 9 months ago