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 not issued publicly. To get one, contact support@yoursouschef.com. Credentials are issued per organization. You receive:
- an API key — send it as
x-api-key; - an organization id — send it as
x-mealco-org-id.
Both are required on every request. Neither is sufficient alone.
Examples call production, https://api.yoursouschef.com. The sandbox is https://api.dev.yoursouschef.com: same paths, same headers, its own keys.
2. See which brands you own
Call fetchProvisionableBrands to list the active brands your organization owns — the candidates for provisioning at a location. Presence on this list is not a guarantee: addBrandsToLocation is the authoritative check, and reports a brand that is not actually ready (for example BRAND_NOT_PROVISIONABLE) individually, 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 the store's own number and the state it operates in, e.g.:
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": "Libby's Restaurant" }
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 is what actually builds the brand out at the location: a brand location, a copy of its master menu, and an inert store per delivery platform.
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 are worth retrying, and which are a bug in the call.
- Concepts → Provisioning flow — the same three calls, with what each one actually creates.
- Concepts → What "provisioned" means — and what it deliberately does not mean.
- Concepts → Retries and idempotency — why sending the same call twice is always safe here.