Overview

Become an integration partner

Sign up as an integration partner to gain access to the Deliverect APIs and begin developing your dispatch integration.

Prerequisites

Before you build your integration:

1. Sign up as an integration partner to get API access.
2. Review the endpoint reference pages linked in Available endpoints for required request fields and authentication details.

Build a dispatch integration

1. Configure your Dispatch webhooks in Deliverect by following the Dispatch webhooks configuration guide. A webhook is an HTTP callback that Deliverect sends to your integration when an event occurs.
2. Create a test order from Deliverect. This triggers a call to your configured Validate webhook.
3. Respond to the Validate webhook call. Return a response that includes "canDeliver": true only when your integration can deliver the order. Deliverect then calls your Create webhook.
4. Process the Create webhook payload from Deliverect and create the delivery job in your dispatch system.
5. Send delivery status updates to the Update Delivery endpoint. Use this endpoint to provide delivery status, pickup time, delivery time, and courier information.
6. If you need to cancel a delivery, send the cancellation to the Cancel Delivery endpoint with the cancellation reason documented in the endpoint reference.

Available endpoints

The following endpoints are available for the Dispatch API.

Error handling and testing

Handle each integration state explicitly during testing:

If your integration cannot deliver an order, do not return "canDeliver": true in the Validate webhook response.

If an update or cancellation request fails, compare the request against the linked endpoint reference, correct the required fields, and resend the request.

Test the full order flow with the Delivery Manager App before using the integration in production.