Store

Schema

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. This is where OUR world joins the platforms': our id, the merchant-supplied code that appears on order payloads, and the platform's OWN storefront id, all on one row.

Fields

idstring
OneTablet's identifier for the storefront, and what pauseStores / unpauseStores accept.
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 platformId if you need something closed and stable.
platformStoreIdstring
The platform's own identifier for this storefront — the DoorDash store id, the UberEats store uuid, and so on. The field that makes the identity map useful.

Absent where the platform's id IS the merchant-supplied id (Grubhub — use code there), or where we have not learned it yet. STORED and refreshed by an hourly sweep, not fetched live, so it can lag a change made directly on the platform by up to an hour.
brandStoreBrandRef
The brand this storefront sells.
locationStoreLocationRef
The kitchen this storefront cooks in.
modestring
full — OneTablet manages orders and menus for this storefront. reportingOnly — data ingestion only; we never see its orders.

Worth reading before acting on a row: a reportingOnly storefront will never produce orders through this API, however healthy it otherwise looks. New values may be added.
wentLiveAtstring<date-time>
When OneTablet set this storefront up, as an ISO-8601 UTC instant. A storefront provisioned through the Onboarding API's addBrandsToLocation gets 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 is fetchStoreStatuses.
platformIdstring
OneTablet's id for the delivery platform. Unlike platform this is a fixed identifier that never changes and never gains new spellings — the right thing to key a mapping on.
platformStoreNamestring
The storefront's name as it appears on the platform, where we hold it.
namestring
The storefront's name inside OneTablet.
storeUrlstring
Public URL of the storefront on the platform, where we hold one. Stored and refreshed by the same hourly sweep as platformStoreId, with the same staleness caveat.