API docs
Sous Chef Management API
Request access

Pause stores

POST/management/store-status/pauseStores

Take one or more storefronts offline, with a typed reason and an optional automatic reopen time. Your note is stored with the pause and returned as desired.pauseNote.

Stores are processed independently: one unsupported storefront in the batch does not fail it. 422 is returned only when no store in the batch supports the action through the API (none of the requested ids has live platform credentials).

Scope: only storefronts your organization owns or operates a brand out of. A storeId that exists but belongs to another organization is treated the same as one that does not exist. Both are absent from the response and neither is changed. When none of the requested ids is yours, the answer is 404.

reason: 'other' requires note.

Safe to retry: this operation changes state but is idempotent.

Request

application/json
required
  • storeIdsstring[]

    Store.id values, 1-100.

  • reasonstring

    Typed reason. Required. 'other' requires note.

    Possible values: [closingEarly, problemInRestaurant, outOfItems, tooBusy, other]
  • notestring

    Required when reason is 'other'. Stored with the pause and returned as desired.pauseNote.

  • untilstring<date-time>

    Automatic reopen time. Omit for an indefinite pause.

Responses

200: The `desired` state just written, for each paused storefront.

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[]

    One entry per requested storefront your organization operates that supports pausing through the API, carrying only storeId and the desired state just written. Requested ids that are not yours, or not integrated, are omitted.

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.