Sous Chef API
Sous Chef Onboarding API
Documentation

The provisioning flow

Every integration with this API is the same three calls, in the same order, because each one creates something the next one needs.

1. fetchProvisionableBrands — the brands you own and might provision

Returns every brand your organization owns that is not retired — a brand is absent from this list only because you do not own it or it has been retired, nothing else. Presence on the list is NOT a guarantee that provisioning will succeed: whether a brand actually has a master menu configured is addBrandsToLocation's check to make, not this one's, and it reports a brand that fails that check with a typed code (for example BRAND_NOT_PROVISIONABLE) for that brand specifically, without failing the others in the same call.

Call this whenever you need a fresh list; it reflects whatever your organization has configured right now, not a snapshot taken once.

2. createLocation — the physical place, with nothing in it yet

Creates the location itself: an address, a store number, a state. On its own this location sells nothing — it carries no brand, no menu, no storefront. That is deliberate: creating the place and stocking it are different failure modes (a bad address is not the same problem as a bad menu copy), so they are different calls with independent retry stories.

3. addBrandsToLocation — what actually makes it sellable

Takes the location id from step 2 and one or more brand ids from step 1, and for each brand creates: a brand location record, a copy of that brand's master menu, and one inert store per delivery platform your organization is connected to. This is the call that does the real work, and it is the only one of the three that can be partially wrong — see below.

Why three calls and not one

An earlier design combined location creation and brand provisioning into a single call. Two things argued against it:

  • The two writes are already separate transactions internally. A single call spanning both would either need a distributed transaction across them or accept that "succeeded" could mean "half succeeded" — and a partner cannot tell which from a single response shape.
  • Adding a brand to an existing location is a real, recurring case, not an edge case: an operator opens a location with one brand today and adds a second next quarter. A single combined call has no natural shape for that; two calls do, because "add brands to a location" is then just addBrandsToLocation called again.

Each brand in addBrandsToLocation is independent

If you send three brand ids and the second one fails, the first and third still provision. The location itself is never at risk from a brand failing — it already exists by the time this call runs. Inspect the per-brand result in the response rather than assuming a single pass/fail for the whole call.

Where this flow does not go

This flow ends with locations and stores that are menu-buildable — see What "provisioned" means. It never puts anything live on a delivery platform, and it never creates an organization or a brand; those exist before you make your first call here.