API docs
Sous Chef Onboarding API
Request access

List provisionable brands

POST/onboarding/fetchProvisionableBrands

List the brands this organization owns. These are the candidates for provisioning at a location, and the source of the brandIds addBrandsToLocation needs.

The list is not filtered to brands that can be provisioned: a brand can be listed here and still come back MASTER_MENU_NOT_FOUND or MASTER_MENU_AMBIGUOUS from addBrandsToLocation for that brand. 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: The active brands your organization owns, up to 200.
  • brandsProvisionableBrand[]

    The active brands the organization owns, up to 200. Not filtered to brands that can be provisioned. See the fetchProvisionableBrands operation.

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. Changes to this API are additive: new fields and new endpoints.

Authentication: 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: a provisioned location is ready to build on. A new store takes no orders yet, is not yet connected to its delivery platform, and its menu is not yet visible to guests. Putting a store live on a delivery platform is a separate step. Your organization and brands are set up with us before your first call.