Whether the shop is listed in the public ShopEazy store directory
- Credentials
- OAuth access token
- Scopes
store:read- Role
- Owners and admins only. Staff get
403 forbidden.
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.
merchantOAuth store:readAuthorizationBearer <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: store:read
storeId*stringA store the person can reach. Any other id answers 404, never 403.
OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/directory-listing' \ -H 'Authorization: Bearer <access_token>'{ "data": { "listed": false }}Switch the storefront or WhatsApp channel on or off PUT
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.
List or unlist the shop in the store directory PUT
Advertising only. Unlisting takes the shop off shopeazy.co/stores and out of the store sitemap index; it does not close the shop, which keeps serving every page to anyone with the address. Switching the storefront channel off is how a shop goes dark. Access: OAuth scope `settings:write`; owner/admin only; write-gated by the subscription.