Brand
A brand (menu concept): what a customer sees on a delivery app. Top of the three-level identity map: brand -> location -> store.
Fields
- idstring
Sous Chef's identifier for the brand, and what the brand-scoped operations accept.
- codestring
Short reference code for the brand, where one has been configured.
Often absent: the value is optional and many brands have none. Do not key on it. It exists so that a partner who supplied us a code can recognise its own record.
- namestring
URL-friendly unique name, lowercase and hyphenated, e.g. "example-kitchen". Unique across all of Sous Chef, so it works as a human-readable join key where there is nowhere to keep an id.
- displayNamestring
Public-facing brand name as shown in the portal and printed on tickets. The one to display;
nameis the slug. - organizationIdstring
The organization that owns the brand. On
fetchBrandsrows it is always the one your API key resolves to. Echoed so a partner holding keys for several organizations can attribute a merged result set. - deactivatedAtstring<date-time>
When the brand was retired, as an ISO-8601 UTC instant. Absent means active.
Retired brands are returned by
fetchBrands, so that a partner reconciling last year's orders can still resolve the id it recorded then.