v1

latestOpenAPI 3.0.3Apache 2.02026-07-2478177179.1 KB
Order Status Update API Grubtech Endpoints

Cancel Order

The Cancel Order endpoint is used to mark an order as canceled within the Order Status Update API. It signifies that the order is no longer active and should not proceed further in the workflow. Typically, this action is initiated when the customer, merchant, or platform cancels the order for various reasons such as stock unavailability, customer request, or other issues. Upon a successful request to this endpoint, the order status is updated to reflect the cancellation, and any further actions related to the order (e.g., preparation, delivery) are stopped.

post/{service-id}/orders/{id}/cancel

Path parameters

service-idstring required

Integration service id. This will be provided by Grubtech.

idstring required

Order id provided by GrubTech

Request body

reason'OUT_OF_ITEMS' | 'RESTAURANT_TOO_BUSY' | 'OTHER' required

Order cancellation reasons

notestring

Reason or note for cancellation

Response

Successful response OK