DesiredStoreStatus
The state configured in Sous Chef for one storefront.
updatedAt is when the current pause began, and is absent while the store is open. It is not the time this record last changed.
Fields
- statestring
What Sous Chef is configured to do.
open: the storefront should be taking orders.paused: it has been paused (by an operator, this API, or the system).closedSpecialHours: closed by a special-hours date. Sous Chef does not produceclosedSpecialHours.Possible values: [open, paused, closedSpecialHours] - pauseReasonstring
Typed pause reason. Pauses recorded outside this API, or whose free-text reason does not match a typed value, read as
'other', with the operator's original wording carried inpauseNote. Absent for a system-initiated pause with no operator-entered reason.Possible values: [closingEarly, problemInRestaurant, outOfItems, tooBusy, other] - pauseNotestring
Free-text note accompanying the pause, in the operator's own wording. When
pauseReasonis'other'because the recorded reason matched no typed value, that original reason text is included here. Absent when no note was recorded, and always absent whileopen. - pausedUntilstring<date-time>
When the pause automatically ends, as an ISO-8601 UTC instant. Absent means the pause is indefinite.
- updatedAtstring<date-time>
When the current pause began, as an ISO-8601 UTC instant. It is not the time this record last changed. Absent while the store is open on a read; on a
pauseStores/unpauseStoresresponse it is the time the write was applied.