Overview


Become an integration partner

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

Build a dispatch integration

1

Configure Dispatch Webhooks

Configure your Dispatch webhooks in Deliverect. A webhook is an HTTP callback that Deliverect sends to your integration when an event occurs.

2

Create a Test Order

Create a test order from Deliverect. This triggers a call to your configured Validate webhook.

3

Respond to the Validate Webhook

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

Process the Create webhook payload from Deliverect and create the delivery job in your dispatch system.

5

Send Delivery Status Updates

Use this endpoint to provide delivery status, pickup time, delivery time, and courier information.

6

Cancel DeliveryOptional

If you need to cancel a delivery, send the cancellation with the reason documented in the endpoint reference.

You can use the Delivery Manager App to test the order flow. Learn more.


Did this page help you?