API docs
Sous Chef Ordering API
Request access

Quickstart

API keys are issued to partners. To request access, send a partnership inquiry to support@yoursouschef.com. We review each request. The same address registers the webhook url that deliveries are sent to. A key is shown once, so store it as a secret.

The examples call production, https://api.yoursouschef.com.

1. List your stores

POST https://api.yoursouschef.com/ordering/stores/fetchStores
x-api-key: otk_…
content-type: application/json

{ "limit": 100 }

Each store carries a code. Every other operation takes that code as storeCode.

2. Read a store's menu

POST https://api.yoursouschef.com/ordering/menus/fetchMenu
x-api-key: otk_…
content-type: application/json

{ "storeCode": "<code>" }

The item and modifier ids in the reply are the ids that createOrder takes.

3. Send an order

POST https://api.yoursouschef.com/ordering/orders/createOrder
x-api-key: otk_…
content-type: application/json

{
  "storeCode": "<code>",
  "platformOrderId": "your-order-123",
  "fulfillment": "pickup",
  "items": [
    { "itemId": "<MenuItem.id>", "name": "Margherita", "quantity": 1, "unitPrice": 1250, "totalPrice": 1250 }
  ],
  "subtotal": 1250,
  "total": 1250
}

200 means the order was queued. A rejection arrives as an order.rejected webhook at your registered url, and later changes arrive as further order.* webhooks. fetchOrder returns the order's current status at any time. See Concepts → Order intake.

4. Verify the webhooks you receive

Every delivery is signed. Verify the signature before you act on a delivery. See Concepts → Verifying webhook signatures.