API docs
Sous Chef Management API
Request access

Get one order

POST/management/orders/fetchOrder

Get one order by its Sous Chef id. Use it when a webhook arrives, to fetch the full record behind the event.

Scoped to the organization your api key resolves to. An orderId that belongs to another organization is indistinguishable from one that does not exist: both are 404. Every other unknown id on this API follows the same convention.

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

Request

application/json
required
  • orderIdstring

    Sous Chef's identifier for the order (uuid): the Order.id every order webhook carries.

Responses

200: The order.

Headers

  • x-mealco-tx-idstringoptional

    The correlation id for this call, returned on every response that an operation produces, successful or not. 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, so that one response carries neither this header nor the txId field of the error body.

  • orderOrder

    The order. It is wrapped in an object, like every other reply on this API, so that fields can be added without a breaking change.

About Orders

Read the orders placed with your restaurants.

Start an integration here. Poll fetchOrders for the orders Sous Chef has accepted on your behalf across every delivery platform you are connected to. Orders are normalized into one shape, whether they arrived from DoorDash, Uber Eats, Grubhub or a direct channel.

Two conventions hold everywhere on this API. Money is always an integer in the currency's minor unit: 1250 is $12.50. Times are always ISO-8601 in UTC. The API does not convert them to a store's local time.

All endpoints are POST with a single JSON body, and the path carries no version segment. Changes to this API are additive (new fields and new endpoints, never removals or narrowing), so there is no versioned cutover.