Order Flow

Validate Webhook

Placing an order from your test account will call your webhook URL and attempt to validate it. This can be done by following this article.

Before placing an order, you will need to click on the Add Info button in the basket and provide a valid delivery address.

It is also necessary to ensure that the location has a valid address, which can be checked by going to the Locations page and clicking on the Edit button for the location you will place a test order for.

Once the order is placed, Deliverect will validate the request to your webhook. You will need to respond according to the samples in the public documentation.

Create Webhook

After your webhook has responded accordingly, you can see the order in the Deliverect Delivery Manager App on your tablet.

There you can either manually Assign the order to your dispatch channel, or you can wait around two minutes for the order to be automatically assigned.

This will post the event to your Create Webhook URL, which also needs to respond as per our public technical documentation.

Update Endpoint

You can call our Update endpoint to change the status of the delivery job, the courier information or the ETAs for pick up and delivery time.

The final status is Delivered. You will find the values and the relevant specification in the documentation for the endpoint.

You can track status updates in the Deliverect Delivery Manager App.

You will also see the status updates once you click on the order, in the Deliverect staging account, under the Status option.

Cancel Webhook

You can initiate the cancellation of a delivery job from the Deliverect app. Go to the Deliverect Delivery Manager app and click on the 3 dots on the bottom left of the screen next to "More Order Options". You can click on "Cancel Delivery" from the pop up window. This will call your Cancel Webhook URL.

The webhook needs to respond as per the documentation and you will see a note on the top of the screen of the app that the cancellation is successful.

📘

The creation of the job needs to be completed without errors for the Cancel webhook to be called.

Delivery Logs

You can track any errors that we receive from a delivery. To do so, find the order in the Orders page and click on the Delivery job tab.