Skip to main content

Get store availability

Report whether a store is open, paused, or otherwise unavailable when Otter asks on a schedule.

Before you begin​

Steps​

Get Store Availability Event Flow

  1. Otter sends a Get store availability (storefront.get_store_availability) webhook (default about every 5 minutes; configurable in Otter Developer Portal).
  2. Read current state from your storefront (preferred) or your internal source of truth.
  3. POST current state to POST /v1/storefront/availability.

Tip: If availability POST fails because hours are missing, set hours with POST /v1/storefront/hours and retry.

Verify​

After configuring hours, confirm periodic webhooks arrive and your availability POST succeeds.

Common failures​

SymptomLikely causeFix
Availability rejectedHours not configuredPOST hours first
Stale state in OtterNot reading live storefront statusQuery target system on each webhook

Next​