API docs
Sous Chef Onboarding API
Request access

Overview

Open new locations from your own systems: create a location, then add your brands to it, each with its menu and its stores, ready to go live when you choose.

The Sous Chef Onboarding API lets multi-location operators open new locations on Sous Chef from their own systems. Create a location and add the brands that will sell from it. Each brand gets its own copy of its menu and its stores there, with no ticket, form or onboarding call. Every write is safe to retry.

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 walk the full provisioning flow end to end.
  • Concepts: 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 field in a request body. It is derived from the credential, and a call cannot reach another organization's data.
  • Provisioned locations are ready to build on. Each brand you add gets a copy of its master menu and one store for each of DoorDash, Uber Eats and Grubhub. Going live on a delivery platform is a separate, deliberate step, so nothing reaches guests before you choose. See Concepts → What "provisioned" means.
  • Works with the brands you already have on Sous Chef. Your organization and brands are set up with us once, before your first call.
  • Writes are safe to retry. createLocation and addBrandsToLocation both return the same result when you send the same call again, 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 changes. New optional fields and new operations may arrive at any time. Write your client to ignore fields it does not recognise and it keeps working across releases.

A store on this API is one brand at one location on one delivery platform. It is the same record that the Management API's fetchStores returns.

Questions about an integration go to support@yoursouschef.com.