Operation

The Storefront API supports the following operations:

Update store hours configuration: The partner sends the current store hours configuration through the endpoint /v1/storefront/hours. Sending a store hour configuration is a prerequisite to enable other available operations.

Get store availability: Public API sends a webhook event requesting the partner application to send the current store availability state through the endpoint /v1/storefront/availability. The default frequency of webhook events is 5 minutes.

Pause/Unpause store: Public API sends a webhook event requesting the partner application to pause/unpause a store, then it must send the event result through the endpoint /v1/storefront/{pause | unpause}, this will trigger the “store availability event” flow to confirm the current store state. Implementing the “get store availability” is a prerequisite for the pause/unpause event integration.

In addition to these events, the partner application can consume the endpoint /v1/storefront/availability to proactively send any updates on the availability for a given store.