Sous Chef API
Sous Chef Ordering API
Documentation

Introduction

The API Reference is generated from the Ordering API contract. Each section corresponds to one domain of the API; each page inside it to one operation or one webhook event.

How to read a reference page

  • The page title is the operation name — createOrder, not a sentence. That name is also the operationId in the OpenAPI document, so a generated client's method has the same name.
  • Under the title is the path. Every operation is a POST with one JSON body and one JSON reply.
  • 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.

Sections

  • Orders — create, cancel and update the delivery status of orders, read one back, and the order.* webhooks.
  • Stores — the stores on your channel, and the store.status.changed webhook (not sent yet, coming before sandbox access).
  • Menus — what each store sells, and the item.availability.changed webhook.

A webhook event page describes a delivery we make to the ONE url registered for your channel — it is documentation of a payload, not a separate endpoint for you to stand up.