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 is for ordering channels: the platforms and storefronts that take orders from guests and send them to restaurants that cook on Sous Chef. It is a separate product from the Management API, which is for operators working on their own business. The two share a host, the call shape, the error body and the webhook signing scheme, but not keys: a channel key works only here, and a Management API key never works here.
This site is generated from the contract itself. Every operation, field, enum value and description on an API Reference page is read out of the OpenAPI document emitted from the source of the API.
Where to start
- Getting Started — make your first authenticated call, then learn what a failure looks like and when to retry it.
- Concepts — order intake end to end, the webhooks your channel receives, and the conventions every operation shares.
- API Reference — the operations and webhook events, grouped into Orders, Stores and Menus.
What this API is for
- The stores on your channel. A channel key reaches every store that sells through your channel, whichever restaurant organization runs it, and nothing else.
fetchStoreslists them. - Orders in, status out. You create, cancel and update the delivery status of orders; the restaurant decides on them in the kitchen, and you hear each decision as a webhook.
- Additive evolution. New optional fields and new operations may arrive at any time. Nothing is removed or narrowed.