Sous Chef API
Sous Chef Ordering API
Documentation

Fetch an order

POST/ordering/orders/fetchOrder

Read one of your orders back by your own id.

Statuses beyond the common ones: 404 the store is not on your channel, or no order with that platformOrderId exists there yet (it may still be queued).

Safe to retry: this operation is read-only and idempotent.

Request

application/json
required
  • storeCodestring

    Required. The store's code from fetchStores.

  • platformOrderIdstring

    Required. The platformOrderId you sent on createOrder.

Responses

200 — The order, with Sous Chef's `id` beside your `platformOrderId`.

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.

  • orderOrder

    The order. id is Sous Chef's id for it; platformOrderId is yours. An object wrapper so later versions can add sibling fields additively.

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.