API docs
Sous Chef Management API
Request access

Introduction

Each section of the API Reference covers one domain of the API, and each page in a section covers one operation or one webhook event.

How to read a reference page

  • The page title is a short description of the operation, for example List orders.
  • Under the title is the path. It ends with the operation name, for example fetchOrders. That name is also the operationId in the OpenAPI document, so a generated client's method has the same name. Every operation is a POST with one JSON body and one JSON reply. There are no path parameters and no query strings.
  • Request lists the body's fields: the field name, its type, its description, and, for an enumerated field, the complete set of accepted values under Possible values.
  • The right-hand column carries the authorization headers the operation requires and a ready-to-paste code sample in cURL, Go, raw HTTP, Java, JavaScript and Python.
  • A webhook event page shows the body we POST to your endpoint. It documents one event's payload. It is not an endpoint that you call. See Concepts → Webhooks.

OpenAPI document

The whole API is also published as one OpenAPI 3.1 document, for generating a client or importing into your own tools: openapi.json.

Sections

  • Orders: the normalized order feed across every connected delivery platform.
  • Stores: the store directory and identity map (locations, brands, and the storefronts that sit at their intersection).
  • Store status: whether each storefront is taking orders, whether Sous Chef and the delivery platform agree about it, and the pause and unpause operations.
  • Item availability: reading and setting item availability at a kitchen.
  • Reports: requesting, listing and downloading delivery-platform reports.
  • Menus: reading menus and publishing them to the delivery platforms.
  • Promotions: Uber Eats promotions.
  • Settings: your webhook settings.