What this person is alerted about
- Credentials
- OAuth access token
- Scopes
store:read
Push choices are per person; the new-order email is the store's.
Access: OAuth scope store:read; 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>/alerts' \ -H 'Authorization: Bearer <access_token>'{ "data": { "push": { "order": true, "payment": true, "member": true, "stock": true, "message": true }, "labels": { "order": "Order", "payment": "Payment", "member": "Membership", "stock": "Stock", "message": "Message", "security": "Security" }, "muted": false, "newOrderEmails": true }}Collect a setup-checklist credit reward POST
Grants the credits for one finished step of the dashboard's getting-started checklist (`stepKey`). Whether the step is done and the business is eligible is decided again from fresh reads, never from what the caller says. Owner only. Refusals: `not_owner` is 403 `forbidden`; `not_done` (the step is not finished), `already_claimed` and `not_eligible` are 422 `validation_error`, with the reason in `error.details.reason`. Credits are granted once per step per business: the grant is guarded by an entry id inside the credit transaction, so a double tap, a second tab or a retry with a new `Idempotency-Key` answers `already_claimed` and grants nothing. The same key replays the first answer. Access: OAuth scope `settings:write`; owner only (an admin is 403 `forbidden`); write-gated by the subscription.
Change this person's alerts PUT
Turn app alerts on or off per kind, mute them all, or switch the new-order email. The new-order email is the store's: owner or admin only (staff get 403 `forbidden`). Everything else is the person's own. Access: OAuth scope `orders:write`; write-gated by the subscription.