Switch the storefront or WhatsApp channel on or off
- Credentials
- OAuth access token
- Scopes
settings:write- Role
- Owners and admins only. Staff get
403 forbidden. - Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
Off is always allowed. On goes through the console's go-live gates: the storefront needs a category and the current agreement (422 needs_category, needs_terms) and WhatsApp a connected number (422 needs_whatsapp); nothing is changed when refused. Turning the storefront off is how a shop goes dark: it stops serving its pages.
api in the path is 422.
Access: OAuth scope settings:write; owner/admin only; write-gated by the subscription.
merchantOAuth settings:writeAuthorizationBearer <token>OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.
Scope: settings:write
storeId*stringA store the person can reach. Any other id answers 404, never 403.
channel*stringThe channel to switch.
"storefront""whatsapp"Idempotency-Key*stringRequired on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.
^[A-Za-z0-9_-]{8,128}$application/json- body
enabled*booleanOK
application/json- response
data*curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/channels/<channel>' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "enabled": false}'{ "data": { "channel": "storefront", "enabled": true }}Which sales channels are on, and why an off one cannot be switched on yet GET
The storefront, the API and WhatsApp. The same gates the console uses. Access: OAuth scope `store:read`; owner/admin only; not write-gated.
Whether the shop is listed in the public ShopEazy store directory GET
The merchant's choice, opt-out: a shop that never chose is listed. Whether it shows up also depends on the storefront being on and the plan being paid (see `getStoreProfile` blockers); this is only the switch. Access: OAuth scope `store:read`; owner/admin only; not write-gated.