API docs
Sous Chef Management API
Request access

Overview

Read your orders, stores, menus and reports, and manage store status, hours, item availability, menu publishing, promotions and webhooks.

The Sous Chef Management API gives restaurant groups, and the systems they run on, one interface to the delivery platforms their stores sell on. Read orders, stores and menus in one normalised shape, whichever platform they come from. Manage store status, hours, item availability and menu publishing, request platform reports, and receive signed webhooks, without a separate integration for each platform.

Access is by partnership. To request it, send a partnership inquiry to support@yoursouschef.com.

Where to start

  • Getting Started: make your first authenticated call, then learn what a failure looks like and when to retry it.
  • Concepts: the rules that hold across every operation. They cover the call shape, the identity map, cursor paging, the webhook stream, how fresh each family of data is, and what each delivery platform supports.
  • API Reference: the operations themselves, grouped by domain.
  • Changelog: what became available, newest first.

What this API is for

  • Your own stores only. Every credential is scoped to one organization. organizationId is never a field in a request body. It is derived from the credential.
  • Fast reads that do not touch platform rate limits. Store, status, menu and order reads are answered from Sous Chef's own refreshed state, not proxied per request to the platforms, so your polling cannot exhaust a platform's rate limits. Each observation of a platform carries its own timestamp, lastPolledAt, so that you can check its age before you act on it. See Concepts → Data freshness.
  • The order feed is read-only. Order lifecycle actions (accept, mark ready, cancel) happen in the kitchen, on the Sous Chef tablet. You observe every transition; you do not drive them. To send orders to a restaurant, an ordering channel uses the separate Ordering API.
  • Additive evolution. New optional fields and new operations may be added at any time. Write your client to ignore fields it does not recognise and it keeps working across releases.