API docs
Sous Chef Onboarding API
Request access

What "provisioned" means

This API provisions to one specific point: menu-buildable. A location and its stores exist, have a menu copied onto them, and can be built on. Provisioning stops there. Read every response with that in mind: "provisioned" does not mean "open for business" here.

What a provisioned store is

After addBrandsToLocation, each brand has three stores at the location: one for DoorDash, one for Uber Eats and one for Grubhub. Each store:

  • takes no orders yet;
  • is not yet connected to its delivery platform;
  • has a menu that is not yet visible to guests.

Its menu is in place and ready to build on. Nothing that would take the store live has run.

Why going live is a separate step

Going live on a delivery platform is a business decision as well as a technical action. It has its own checks: menu review, merchant setup on the platform side, and timing that the operator chooses. If provisioning also took a store live, a single API request could put a new, unreviewed menu in front of customers. This API stops before that step, so going live is always a separate action and never a side effect of provisioning.

On a provisioned store, the Management API's wentLiveAt is its setup time. Once a store is connected to its delivery platform, the Management API's fetchStoreStatuses reports whether it is open and taking orders.

What is set up before your first call

This API works with what you already have on Sous Chef:

  • Your organization. It is set up with us once, before your first call.
  • Your brands. fetchProvisionableBrands lists the brands you already have that are not retired. This API adds an existing brand to a location. A new brand, and its master menu, are set up with us first.

Where to look for the technical side of "provisioned"

The mechanics (what is created for each brand, and why the write is safe to repeat) are in Concepts → The provisioning flow and Concepts → Retries and idempotency. This page is the one to share with a non-technical stakeholder who asks what this API does to a restaurant.