Cancel an order
Cancel an order you created.
Idempotent: cancelling an order that is already cancelled, finished or rejected does nothing and sends no webhook. A cancellation that arrives just before its order is held and applied once the order exists, for up to five minutes.
Statuses beyond the common ones: 404 and 422 as on createOrder.
Safe to retry: this operation changes state but is idempotent.
Request
- storeCodestring
Required. The store's
code. Required so you can never cancel another channel's order. - platformOrderIdstring
Required. The
platformOrderIdyou sent oncreateOrder. - reasonstring
Why. Defaults to
other.Possible values: [itemOutOfStock, storeClosed, kitchenBusy, other] - detailsstring
Free-text detail. Personal data.
{
"storeCode": "<storeCode>",
"platformOrderId": "00000000-0000-0000-0000-000000000000",
"reason": "itemOutOfStock",
"details": "<details>"
}Responses
Headers
- x-mealco-tx-idstringoptional
The correlation id for this call, returned on a response from an operation. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned.
- platformOrderIdstring
Your
platformOrderId, echoed. - storeCodestring
Your
storeCode, echoed. - receivedAtstring<date-time>
When we received the cancellation.
- statusstring
What happened to the cancellation:
queued.Possible values: [created, queued]
{
"platformOrderId": "00000000-0000-0000-0000-000000000000",
"storeCode": "<storeCode>",
"receivedAt": "2026-01-01T00:00:00Z",
"status": "created"
}About Orders
Send orders to the restaurants on your channel, move them along, and read them back.
Stores are addressed by their code from fetchStores. A code that is unknown, retired or not on your channel answers 404, indistinguishably. Orders are addressed by YOUR id, platformOrderId: it is the idempotency key, and it must be unique across every order you send. Sous Chef's own id for the order arrives as id on every order.* webhook and on fetchOrder.
200 on a write means we accepted the call for processing, not that the order has reached the kitchen. An order for a store that is paused or outside its hours comes back as an order.rejected webhook. Every other order goes to the kitchen: fetchOrder returns it, and its progress arrives as order.status.updated when it becomes ready and then finished. Every write is idempotent, so retry on 500 / 503 freely.