Sous Chef API
Sous Chef Onboarding API
Documentation

Overview

Onboard a new location: create it, then provision your brands, their menus and their delivery-platform stores there.

The Sous Chef Onboarding API is the partner-facing interface for operators whose own systems open new restaurant locations. Where the Management API reads orders and store status for an already-operating estate, the Onboarding API is how a new part of that estate comes into being: create a location, then provision the brands that sell out of it.

This site is generated from the contract itself. Every operation, every field, every enum value and every description on an API Reference page is read out of the OpenAPI document that is emitted from the source of the API — so a page here cannot describe an API we do not serve.

Where to start

  • Getting Started — make your first authenticated call, then walk the full provisioning flow end to end.
  • Concepts — the four things that hold across every operation: the call shape, the provisioning flow, what "provisioned" means, and why retries are safe.
  • API Reference — the three operations themselves.

What this API is for

  • Your own organization only. Every credential is scoped to one organization. organizationId is never a request parameter — it is derived from the credential and enforced at the data layer, the same as the Management API.
  • Provisioning, not go-live. This API creates locations and stores that are menu-buildable — inert, not active, not integrated, not published anywhere. Putting a store live on a delivery platform is a separate, deliberate step that this API does not perform. See Concepts → What "provisioned" means.
  • No organizations, no brands. This API provisions locations and adds existing brands to them. It never creates an organization or a brand — those are set up by Sous Chef ahead of any call here.
  • Writes are idempotent, not one-shot. createLocation and addBrandsToLocation are both safe to retry, and addBrandsToLocation is also safe to call again later to add more brands to a location that already has some. See Concepts → Retries and idempotency.
  • Additive evolution. New optional fields and new operations may arrive at any time. Nothing is removed or narrowed. Write your client to ignore fields it does not recognise and it keeps working across releases.