Create a location
Create a location.
SAFE TO RETRY. The location code is derived from an organization-specific prefix, your storeNumber, and state, so a repeated call computes the same code, finds the location it already created, and returns it with created: false. A retry never creates a second location and never modifies the first — correcting a field is not something this operation does.
Safe to retry: this operation changes state but is idempotent.
Request
- storeNumbernumber
YOUR store number for this location. Required. It is not a label: our location code — a short prefix assigned to your organization, then your
storeNumber, thenstate, e.g.AB347DEfor an organization whose prefix isAB— is derived from it, so sending the same number twice (with the samestate) is exactly what makes a retry safe, and sending a different number creates a different location. - statestring
Two-letter US state code, e.g.
NC. Required — it forms part of the derived location code. Case-insensitive on the way in; always uppercase in the code. - displayNamestring
Restaurant name as it should read for staff, e.g. "Cody's Diner". Required.
- addressstring
Street address, one line.
- unitNumberstring
Unit or suite within the building, e.g. "Suite 200".
- timezonestring
IANA timezone, e.g.
America/New_York. Defaults toUS/Easternwhen omitted — NOT to anything derived fromstate. Send it explicitly for any location outside Eastern time: the timezone is what your opening hours are interpreted in, so leaving it off a Central or Pacific location shifts every window and nothing reports an error. - phonestring
Contact phone in E.164, e.g.
+12035550147. - notesstring
Free-text notes for our onboarding team. Not shown to guests.
- hoursBusinessHoursWindow[]
Opening hours. Omit to leave hours unset and configure them later in the portal.
{
"storeNumber": 50,
"state": "<state>",
"displayName": "<displayName>",
"address": "<address>",
"unitNumber": "<unitNumber>",
"timezone": "<timezone>",
"phone": "<phone>",
"notes": "<notes>",
"hours": [
{
"day": "monday",
"startTime": "<startTime>",
"endTime": "<endTime>"
}
]
}Responses
- locationLocationSummary
The location — freshly created when
createdistrue, or the existing one for thisstoreNumber/statepair whencreatedisfalseand this was a retry. - createdboolean
truewhen this call created the location,falsewhen it already existed and this was a retry. Either way the location inlocationis yours and ready foraddBrandsToLocation.
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.