Skip to main content

Storefront

Keep store hours, availability, and pause state aligned between Otter and your online storefront.

Overview​

Use storefront APIs when you operate the customer-facing store status (open, paused, hours). Otter may poll availability on a schedule or ask you to pause/unpause via webhooks.

How it fits​

Storefront hours, availability webhooks, and availability updates

Integration overview​

  1. Send store hours with POST /v1/storefront/hours (required before availability calls).
  2. Respond to Get store availability (storefront.get_store_availability) webhooks (default ~every 5 minutes) — see Get store availability.
  3. Handle Pause store (storefront.pause_store) / Unpause store (storefront.unpause_store) when operators change state in Otter — see Pause or unpause.
  4. Optionally push proactive updates with POST /v1/storefront/availability.

Test​

  • Configure hours, then post availability; confirm Otter accepts the payload.
  • Pause a test store and complete the availability follow-up webhook.

Next​

Implement hours + Get store availability before pause/unpause.