Location
A physical location (kitchen).
Returned when your organization either owns the kitchen or operates a brand out of it. A "host-located" operator, whose brand cooks inside somebody else's kitchen, owns no location of its own but still needs the location id, because setItemAvailability and the hours operations key on it.
Fields
- idstring
Sous Chef's identifier for the location.
- codestring
The location's short site code, as shown on kitchen tickets and platform dashboards.
- namestring
Operator-facing name.
- timezonestring
IANA timezone, e.g. "America/New_York". It is not an offset, which changes with DST.
- addressstring
Free-text street address as configured.
- brandsLocationBrand[]
The brands carried at this location.
- storeCountnumber
How many storefronts operate at this location.
- displayNamestring
Human-readable display name, e.g. "Harlem Store".
nameis the unique operator-facing name; this is the one to show a person where they differ. - organizationIdstring
The organization that owns the kitchen.
Not necessarily yours. For a host-located brand this is the host's id, which is how you tell the two cases apart.