API docs
Sous Chef Onboarding API
Request access

Quickstart

Your first call takes two headers and one JSON body, the same as every operation on this API.

1. Get credentials

API keys are issued to partners. To request access, send a partnership inquiry to support@yoursouschef.com. We review each request. Credentials are issued per organization. You receive:

  • an API key, which you send as x-api-key;
  • an organization id, which you send as x-mealco-org-id.

Both are required on every request. Neither is sufficient alone.

Before your first call, we set up your organization with you: your brands, a master menu for each brand, and the short prefix that starts each of your location codes.

Examples call production, https://api.yoursouschef.com.

2. See which brands you own

Call fetchProvisionableBrands to list the active brands your organization owns. These are the candidates for provisioning at a location. addBrandsToLocation confirms each brand individually: it reports a brand that is not ready (for example MASTER_MENU_NOT_FOUND) without failing the brands that are. An empty body is a complete request; nothing is required.

POST /onboarding/fetchProvisionableBrands HTTP/1.1
Host: api.yoursouschef.com
Content-Type: application/json
x-api-key: <your-api-key>
x-mealco-org-id: <your-organization-id>

{}

Keep each brand's id from the response. You pass it back in step 4.

3. Create the location

Call createLocation with your own number for the location, the state it operates in, its name and its timezone, for example:

POST /onboarding/createLocation HTTP/1.1
Host: api.yoursouschef.com
Content-Type: application/json
x-api-key: <your-api-key>
x-mealco-org-id: <your-organization-id>

{
  "storeNumber": 347,
  "state": "DE",
  "displayName": "Example Kitchen",
  "timezone": "America/New_York"
}

The reply carries the new location's id and created: true. Send the exact same body again and you get the same location back with created: false instead of a duplicate. See Errors and retries and Concepts → Retries and idempotency.

4. Add brands to the location

Call addBrandsToLocation with the location id from step 3 and the brand ids you kept from step 2:

POST /onboarding/addBrandsToLocation HTTP/1.1
Host: api.yoursouschef.com
Content-Type: application/json
x-api-key: <your-api-key>
x-mealco-org-id: <your-organization-id>

{ "locationId": "<id from step 3>", "brandIds": ["<id from step 2>"] }

This call builds the brand out at the location: a brand location, a copy of its master menu, and one store for each of DoorDash, Uber Eats and Grubhub. Going live is a separate step.

You can call this again later with more brand ids to grow the same location. A brand that is already provisioned there is reported back rather than provisioned twice.

Where to go next

  • Authentication: what the two headers mean and how they fail.
  • Errors and retries: which status codes to retry, and which mean the call needs fixing.
  • Concepts → Provisioning flow: the same three calls, with what each one creates.
  • Concepts → What "provisioned" means: what it means, and what it does not.
  • Concepts → Retries and idempotency: why sending the same call twice is safe here.