API docs
Sous Chef Ordering API
Request access

Errors and retries

Status codes

CodeMeaningRetry?
200Success. On a write, the call was queued. The restaurant has not acted on it yet.n/a
400The request body failed validation.No. Correct the request.
401The key is missing, unknown or revoked (see Authentication).No. Correct the credentials.
404The storeCode is unknown, retired or not on your channel, or the order does not exist.No, except fetchOrder right after createOrder.
422The store does not take orders through this API.No. Use another store.
429Over the rate limit. Limits apply per channel key.Yes, after backing off.
5xxA fault on our side.Yes, with backoff.

An order that was just queued can take a moment to appear, so fetchOrder may answer 404 for a short time after createOrder. See Concepts → Order intake.

Error body

A failure body carries statusCode, timestamp, path, method, a human-readable message and txId, the identifier of that call. Every operation in the reference uses the same OrderingApiError schema. Validate a request against the reference before you send it: it lists every required field and accepted value.

{
  "statusCode": 404,
  "timestamp": "2026-11-18T14:07:22.113Z",
  "path": "/ordering/orders/createOrder",
  "method": "POST",
  "message": "Not Found",
  "txId": "4f0a9c2e-6b31-4d77-9d0e-2a7f5c8b1e44"
}

The same value is returned in the x-mealco-tx-id response header. Log it with every call and quote it when you contact us. A request whose body is not valid JSON is rejected before an id is assigned, so that one 400 carries neither.

Retry policy

Every write on this API is idempotent. platformOrderId identifies an order, so sending a call again after a timeout or a 5xx never creates a second order. Keep platformOrderId unique across every order you send.

Retry 429 and 5xx with exponential backoff and jitter: start at about one second, cap at one minute, and stop after a few attempts. Honour Retry-After on a 429. When it is absent, wait 60 seconds. A 429 may arrive with no JSON body and no x-mealco-tx-id header. Treat it as a rate limit all the same.

Do not retry 400, 401, 404 or 422 without changing the request.

Do not parse messages

Branch on the status code and on documented fields. Messages are written for people and may change without notice.