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
Configure Dispatch Webhooks — Dispatch Webhooks
Configure your Dispatch webhooks in Deliverect. A webhook is an HTTP callback that Deliverect sends to your integration when an event occurs.
Create a Test Order
Create a test order from Deliverect. This triggers a call to your configured Validate webhook.
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.
Process the Create Webhook — Create Delivery Job
Process the Create webhook payload from Deliverect and create the delivery job in your dispatch system.
Send Delivery Status Updates — Update Delivery Job
Use this endpoint to provide delivery status, pickup time, delivery time, and courier information.
Cancel Delivery (optional) — Cancel Delivery Job
If you need to cancel a delivery, send the cancellation with the reason documented in the endpoint reference.
Updated 3 days ago
