Operations

Currently, Delivery integration supports the following operations:

Request Quote: Requests a delivery quote from the partner. This operation is performed by sending a webhook POST request to the configured partner’s endpoint. To provide results, partners are expected to make a POST request to v1/delivery/{deliveryReferenceId}/quotes.

Create Delivery: Requests to create a delivery job from the partner. This operation is performed by sending a webhook POST request to the configured partner’s endpoint. To provide results, partners are expected to make a POST request to v1/delivery/{deliveryReferenceId}/accept.

Cancel Delivery: Requests to cancel an ongoing delivery job from the partner. This operation is performed by sending a webhook POST request to the configured partner’s endpoint. To provide results, partners are expected to make a POST request to v1/delivery/{deliveryReferenceId}/cancel.

Update delivery information: Updates delivery information for an ongoing delivery job, such as destination address, pick-up address, courier, vehicle type, and customer notes. Partners are expected to make PUT requests to v1/delivery/{deliveryReferenceId}/status.

Errors: For any errors found while processing various delivery operations, partners are expected to send a POST request to v1/delivery/callback/error.