Skip to main content
Loads cached merchant preferences once, then resolves availability, analytics, prep time, order rules, and the channel release gate against the optional menu scope before returning. Clients should prefetch this payload at startup and reuse it for the unavailable screen, the minimum-version screen, and analytics session timeout.
Requires a Fire spark access token obtained through token exchange. This endpoint does not block other Storefront API calls.
Raw rules live on merchants.preferences. This endpoint never returns the rule trees — only the matched effect for the current scope.
  • availability — Any matching enabled rule makes the storefront UNAVAILABLE. Empty conditions match every scope. Scheduled rules use start_date (inclusive) and end_date (exclusive).
  • analytics — Session inactivity timeout as stored plus session_ms.
  • prep_time — First matching prep-time rule for the scope, or the fallback effect.
  • order_rules — First matching order and redeem limit effects for the scope, or the fallback effects.
  • release — Channel minimum version and store URLs for the current env + channel_id. min_version is null when no gate is configured.
availability.next_change_at is the soonest future start_date or end_date among enabled scheduled availability rules. Use it to refetch when a window opens or closes. Kiosk clients subscribe to availability.changed on the workspace realtime topic after issuing a token. The payload is { merchant_id }. This event also fires when preferences.releases changes. App clients refetch this endpoint on foreground instead of opening a realtime connection. Web clients ignore release.

​
Query parameters

​
Request

​
Response