Sous Chef API
Sous Chef Ordering API
Documentation

Cancel an order

POST/ordering/orders/cancelOrder

Cancel an order you created.

Idempotent: cancelling an order that is already cancelled, finished or rejected does nothing. A cancellation that arrives before its order is retried until the order exists, not lost.

Statuses beyond the common ones: 404 and 422 as on createOrder.

Safe to retry: this operation changes state but is idempotent.

Request

application/json
required
  • storeCodestring

    Required. The store's code. Required so you can never cancel another channel's order.

  • platformOrderIdstring

    Required. The platformOrderId you sent on createOrder.

  • reasonstring

    Why. Defaults to other.

    Possible values: [itemOutOfStock, storeClosed, kitchenBusy, other]
  • detailsstring

    Free-text detail. Personal data.

Responses

200 — The cancellation as received. The result follows as an `order.cancelled` webhook.

Headers

  • x-mealco-tx-idstringoptional

    The correlation id for this call, echoed on every response. Quote it when reporting a problem and we can find every log line for the request. You may also send your own x-mealco-tx-id on the request and we adopt it. Not marked required because a request whose JSON body is malformed is rejected before an id exists.

  • platformOrderIdstring

    Your platformOrderId, echoed.

  • storeCodestring

    Your storeCode, echoed.

  • receivedAtstring<date-time>

    When we received the cancellation.

  • statusstring

    What happened to the cancellation: queued or created.

    Possible values: [created, queued]

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: together with storeCode it is the idempotency key. 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 restaurant accepted the order: that arrives as an order.created or order.rejected webhook (order.created is not sent yet, coming before sandbox access). Every write is idempotent, so retry on 500 / 503 freely.