Create a location
Create a location.
Safe to retry. The location code is made of a short prefix that we set up for your organization before your first call, your storeNumber and state, so a repeated call with the same storeNumber and state returns the existing location with created: false. A retry never creates a second location and never modifies the first. This operation does not correct a field on an existing location.
Safe to retry: this operation changes state but is idempotent.
Request
- storeNumbernumber
Your own number for this location, a whole number from 1 to 99999. Required. It is not a label: it forms part of our location code, which is a short prefix that we set up for your organization before your first call, then your
storeNumber, thenstate, e.g.AB347DEfor an organization whose prefix isAB. Sending the same number again (with the samestate) returns the existing location, which makes a retry safe. Sending a different number creates a different location. - statestring
Two-letter US state code, e.g.
NC. Required. It forms part of the location code. Case-insensitive in the request; always uppercase in the code. - displayNamestring
Restaurant name as it should read for staff, e.g. "Example Kitchen". 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. Required. Your opening hours are interpreted in this timezone. It is not derived fromstate. A missing value, or an abbreviation such asPST, is rejected with400. - phonestring
Contact phone in E.164, e.g.
+12035550147. - notesstring
Free-text notes stored with the location. Not shown to guests.
- hoursBusinessHoursWindow[]
Opening hours. Omit to leave hours unset and configure them later in the portal. Each window needs its
day,startTimeandendTime: a window that lacks one is not stored.
{
"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: newly 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.
{
"location": {
"locationId": "00000000-0000-0000-0000-000000000000",
"code": "<code>",
"displayName": "<displayName>",
"timezone": "<timezone>"
},
"created": true
}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.