The provisioning flow
Every integration with this API makes the same three calls in the same order, because each call returns something a later call needs.
1. fetchProvisionableBrands: the brands you own and might provision
Returns the brands your organization owns that are not retired, up to 200. A brand is absent from this list only if you do not own it or it has been retired. Presence on the list does not guarantee that provisioning will succeed. addBrandsToLocation checks whether a brand has a master menu configured, and it reports a brand that fails that check with a typed code (for example MASTER_MENU_NOT_FOUND) for that brand specifically, without failing the others in the same call.
Call this whenever you need a fresh list. It reflects your organization's current configuration, not a snapshot taken once.
2. createLocation: the physical place, with nothing in it yet
Creates the location itself: a name, your number for it, a state and a timezone. On its own this location sells nothing. It carries no brand, no menu and no store. Creating the place and adding brands to it fail in different ways (a bad timezone is a different problem from a bad menu copy), so they are separate calls that you retry independently.
3. addBrandsToLocation: what actually makes it sellable
Takes the location id from step 2 and one or more brand ids from step 1. For each brand it creates a brand location, a copy of that brand's master menu, and one store, not yet live, for each of DoorDash, Uber Eats and Grubhub. It is the only one of the three calls that can succeed for some brands and fail for others. See Each brand in addBrandsToLocation is independent below.
Why three calls and not one
Creating a location and provisioning brands at it are separate writes, and each call reports the outcome of its own write.
- A failure in a later call leaves earlier work in place. If
addBrandsToLocationfails, the location you created stays in place. You do not need to create it again. RetryaddBrandsToLocationwith the same location id. - Adding a brand to an existing location is a routine case. An operator opens a location with one brand and adds a second one later. To do that, call
addBrandsToLocationagain with the new brand id. - Both writes are safe to retry. Repeating
createLocationoraddBrandsToLocationwith the same input never creates a duplicate. See Retries and idempotency.
Each brand in addBrandsToLocation is independent
If you send three brand ids and the second one fails, the first and third are still provisioned. A failed brand does not affect the location, which already exists when this call runs. Inspect the per-brand result in the response rather than assuming a single pass or fail for the whole call.
Where this flow does not go
This flow ends with a location and stores that are ready for their menus. See What "provisioned" means. Going live on a delivery platform is a separate, deliberate step. The flow works with the organization and brands you already have on Sous Chef: both are set up with us before your first call.