Sous Chef API
Sous Chef Onboarding API
Documentation

List provisionable brands

POST/onboarding/fetchProvisionableBrands

List the brands this organization owns — the candidates for provisioning at a location, and the brandIds addBrandsToLocation needs.

NOT filtered to brands that can actually be provisioned today: a brand can be listed here and still come back BRAND_NOT_PROVISIONABLE or MASTER_MENU_AMBIGUOUS from addBrandsToLocation for that brand specifically — that write is the authoritative check, this read is not. Brands are excluded only once retired, never for being unready to provision.

Safe to retry: this operation is read-only and idempotent.

Request

application/json
required

Responses

200 — Every active brand your organization owns.
  • brandsProvisionableBrand[]

    Every active brand the organization owns, in no guaranteed order. NOT filtered to brands that can actually be provisioned today — see the operation's own doc comment.

About Onboarding

The Sous Chef Onboarding API — provisioning for operators whose own systems open new locations.

All endpoints are POST with a single JSON body. The base path carries NO version segment: evolution here is additive only (new fields, new endpoints), so there is no cutover a /v1 would ever mark.

AUTH: every request must carry BOTH x-api-key and x-mealco-org-id, and they must agree. The key alone determines the organization; the header must state the same one or the request is rejected. A partner therefore cannot act on an organization it did not name.

SCOPE: this API provisions to *menu-buildable*. Stores are created inert — not active, not integrated, not published. Putting a store live on a delivery platform remains a separate, deliberate step. This API also never creates organizations or brands.