v1

latestOpenAPI 3.0.3Apache 2.02026-07-2478177179.1 KB

Cancel a delivery job

This endpoint is used to cancel a delivery job that is no longer required ensuring that unnecessary delivery jobs are promptly canceled.

post/{aplicationId}/delivery-jobs/{deliveryJobId}/cancellations

Path parameters

aplicationIdstring required

The unique identifier for the application initiating the cancellation request. This ID ensures that the cancellation is associated with the correct application registered in the system.

deliveryJobIdstring required

The unique identifier for the specific delivery job that needs to be canceled. This allows the system to locate and update the status of the delivery job accurately.

Request body

cancellationReasonstring

A descriptive reason for why the delivery job is being canceled. This information can be used for tracking and reporting purposes (e.g., "Customer request", "Driver unavailable", or "Invalid address").

cancelledAtstring

A timestamp indicating when the cancellation occurred. The format should follow ISO 8601 standards (e.g., 2025-01-29T10:30:00Z). If not provided, the system may use the current timestamp as the default value.

Response

Delivery job canceled successfully