List store statuses
Status for any set of stores, from one storefront to the whole estate, in one operation.
Each status carries three things: desired (what Sous Chef is configured to do), observed (what the platform reports), and discrepancy (always present; its classification fields are populated only when the two disagree).
Served from Sous Chef's stored state, never proxied per request, so this never touches platform rate limits.
Freshness is not uniform. lastPolledAt shows the age of each observation. observed (and the discrepancy derived from it) comes from a sweep that runs hourly and covers DoorDash, Uber Eats and Grubhub only. Storefronts on other platforms are never swept, and a storefront on one of those three may also have no recent reading. A store that has never been polled is absent from this feed. It is not returned with an unknown state. Treat a stale lastPolledAt as "we do not currently know", not as "nothing has changed", and check its age before driving an automated decision off observed. desired carries no such caveat: it is Sous Chef's own intended state and is always current.
Pass storeIds for specific stores, filter by locationIds / brandIds / platforms, or filter hasDiscrepancy: true for just the stores needing attention. Omitting a filter means no filter, exactly as on fetchStores.
Paging: sorted by storeId ascending. Loop until nextCursor is absent.
Safe to retry: this operation is read-only and idempotent.
Request
- storeIdsstring[]
Narrow to specific storefronts.
- locationIdsstring[]
Narrow to storefronts at these kitchens.
- brandIdsstring[]
Narrow to storefronts selling these brands.
- platformsstring[]
Narrow to these platform slugs.
- statestring
Filter on the desired state.
closedSpecialHoursis accepted but never matches: Sous Chef does not produce that state.Possible values: [open, paused, closedSpecialHours] - hasDiscrepancyboolean
Filter to stores with (or without) a live discrepancy between desired and observed state.
- pagePageRequest
Cursor pagination.
{
"storeIds": [
"<storeIds>"
],
"locationIds": [
"<locationIds>"
],
"brandIds": [
"<brandIds>"
],
"platforms": [
"<platforms>"
],
"state": "open",
"hasDiscrepancy": true,
"page": {
"limit": 50,
"cursor": "<cursor>"
}
}Responses
Headers
- x-mealco-tx-idstringoptional
The correlation id for this call, returned on every response that an operation produces, successful or not. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned, so that one response carries neither this header nor the txId field of the error body.
- statusesStoreStatus[]
The page of statuses, sorted by
storeIdascending. - nextCursorstring
Opaque cursor for the next page. Absent means the last page.
{
"statuses": [
{
"storeId": "00000000-0000-0000-0000-000000000000",
"desired": {
"state": "open",
"pauseReason": "closingEarly",
"pauseNote": "<pauseNote>",
"pausedUntil": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
},
"observed": {
"state": "online",
"orderable": true,
"platformReason": "<platformReason>"
},
"discrepancy": {
"hasDiscrepancy": true,
"classification": "pauseNotPropagated",
"autoRemediable": true,
"requiresHumanIntervention": true,
"remediationChannel": "api"
},
"lastPolledAt": "2026-01-01T00:00:00Z"
}
],
"nextCursor": "<nextCursor>"
}About Store status
Whether each storefront is actually taking orders, and whether Sous Chef and the delivery platform agree about it.
Separate from Stores, which is the identity map: the brands, kitchens and storefronts you operate, which changes when your estate changes. This section is the operational layer on top of it: two reads (fetchStoreStatuses, fetchStoreStatus), two writes (pauseStores, unpauseStores) and the store.status.changed webhook, all addressed by the Store.id values fetchStores returns. It uses the same API key, organization scoping and ids, under a different route prefix (/management/store-status).
Three things are kept distinct throughout: desired is what Sous Chef is configured to do, observed is what the platform reports, and discrepancy is the classified disagreement between the two.
Scoped to the organization your API key resolves to, exactly as the directory reads are.