Sous Chef API
Sous Chef Onboarding API
Documentation

Add brands to a location

POST/onboarding/addBrandsToLocation

Provision brands at an existing location: brand location, a copy of each brand's master menu, and inert stores per delivery platform.

SAFE TO RETRY, and safe to call again later to add more brands — a brand already provisioned at the location is reported as status: "alreadyProvisioned" and nothing is written for it. Each brand is provisioned in its own transaction: one brand failing leaves the others, and the location, in place.

Safe to retry: this operation changes state but is idempotent.

Request

application/json
required
  • locationIdstring

    The locationId returned by createLocation. Required.

  • brandIdsstring[]

    Brand ids from fetchProvisionableBrands. Required, 1 to 20 per call. Ids already provisioned at this location are reported and skipped, not rejected.

Responses

200 — One outcome per requested brand, in request order.

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.