API docs
Sous Chef Onboarding API
Request access

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 one store, not yet live, for each of DoorDash, Uber Eats and Grubhub.

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 succeeds or fails independently: 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. 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.