Cancel Delivery Job

Purpose

This endpoint allows a way of receiving notification from our partners that a job they have previously accepted is no longer possible to be dispatched by their system.

Reason Tags

Cancelations shoud be tagged accordingly using one of the below;

reasonTagMeaning
COURIER_NO_LONGER_AVAILABLEThere is no longer an available courier for the delivery
COURIER_TRANSPORT_FAILURECourier attempted to deliver but could not because of a transport failure (e.g., a flat tire)
FOOD_ITEMS_ARE_NOT_READYThe order was not ready within the agreed time after pick up (between the dispatch partner and merchant)
DROP_OFF_LOCATION_NOT_FOUNDThe courier could not find the delivery location
CUSTOMER_UNRESPONSIVEThe customer did not pick up the phone nor open the door.
PACKAGE_SIZE_TOO_LARGEThe package size is too large to be delivered

ℹ️ Cancellation Cut-off Time

You can cancel a delivery job with a valid reasonTag at any point before its status changes to Delivered.


Body Params
string
string
enum
Allowed:
integer
string
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json