API docs
Sous Chef Ordering API
Request access

Overview

Send orders to the restaurants on your ordering channel, keep their delivery status current, and read your stores, their menus and your orders.

The Sous Chef Ordering API connects ordering channels to the restaurants that run on Sous Chef. A channel is a platform or storefront that takes orders from guests. With this API, a channel reads the stores it sells for, reads their menus, sends orders straight to the kitchen, and follows each order through signed webhooks. One key reaches every store that sells through your channel, whichever restaurant group operates it.

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 how errors are reported and when to retry.
  • Concepts: order intake from end to end, the webhooks your channel receives, how to verify them, and the conventions every operation shares.
  • API Reference: the operations and webhook events, grouped into Orders, Stores and Menus.

What the API covers

  • The stores on your channel. A channel key reaches every store that sells through your channel, whichever restaurant operates it, and nothing else. fetchStores lists them.
  • Menus. fetchMenu returns what a store sells, with the item and modifier ids that createOrder takes.
  • Orders. You create an order, cancel it, and report its delivery status. The restaurant works the order in the kitchen. A signed webhook tells you when it is ready, finished, rejected or cancelled, and fetchOrder reads its current state at any time.
  • Separate from the Management API. A channel key works on this API only. It does not reach the Management API, which is a separate product with its own keys.
  • Additive changes. 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.