Store
One storefront: a single brand, at a single location, on a single platform.
A location running two brands on three platforms has six stores, each with its own menu, hours and pause state. A store joins our identifiers to the platform's: our id, the merchant-supplied code that appears on order payloads, and the platform's own storefront id, all on one object.
Fields
- idstring
Sous Chef's identifier for the storefront, and what
pauseStores/unpauseStoresaccept. - codestring
Stable storefront identifier, human-readable where configured; also what the platform holds as the merchant-supplied store id, and the value order payloads carry as
store.externalId. - platformstring
Delivery platform slug, e.g. "doordash", "ubereats", "grubhub".
Treat as an open enum: responses may carry slugs beyond the documented three (smaller platforms connected for some organizations), and new platforms are added without a version bump. Key on
platformIdif you need something closed and stable. - platformStoreIdstring
The platform's own identifier for this storefront: the DoorDash store id, the Uber Eats store uuid, and so on.
Absent where the platform's id is the merchant-supplied id (Grubhub: use
codethere), or where we do not hold it. It is a stored value, recorded the first time Sous Chef reads the storefront on the platform and not fetched live, so it does not follow a later change made directly on the platform. - brandStoreBrandRef
The brand this storefront sells.
- locationStoreLocationRef
The kitchen this storefront cooks in.
- modestring
full: Sous Chef manages orders and menus for this storefront.reportingOnly: data ingestion only. We never receive its orders.Check this before acting on a storefront: a
reportingOnlystorefront never produces orders through this API. New values may be added. - wentLiveAtstring<date-time>
When Sous Chef set this storefront up, as an ISO-8601 UTC instant. A storefront provisioned through the Onboarding API's
addBrandsToLocationgets it when it is created. Older storefronts may instead carry the set-up time of their brand at that location, or the moment they were first switched on. It is present before a storefront takes its first order, so it is not a go-live signal: whether a storefront is open and taking orders isfetchStoreStatuses. - platformIdstring
Sous Chef's id for the delivery platform. Unlike
platformthis is a fixed identifier that never changes and never gains new spellings. Key your mapping on it. - platformStoreNamestring
The storefront's name as it appears on the platform, where we hold it.
- namestring
The storefront's name inside Sous Chef.
- storeUrlstring
Public URL of the storefront on the platform, where we hold one. A stored value, recorded at the same time as
platformStoreId, with the same caveat.