Switch the daily automatic basket reminders on or off
- Credentials
- OAuth access token
- Scopes
marketing:write- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
On comes with a plan that has automatic reminders (Growth), else 403 plan_limit; off is always allowed. Setting the state it is already in changes nothing. Owner or admin.
Access: OAuth scope marketing:write; write-gated by the subscription.
merchantOAuth marketing: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: marketing:write
storeId*stringA store the person can reach. Any other id answers 404, never 403.
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
auto*booleanOK
application/json- response
data*curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/recovery' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "auto": false}'{ "data": { "auto": true }}Email shoppers a link back to their basket POST
Emails the baskets named in `basketIds`, or every basket that can be reminded now when it is left out. A basket that cannot be reminded (no email, reminded in the last day, reminded 3 times) is skipped, and one address that fails does not stop the rest. A reminder counts only once it was sent, so a retry never emails anyone twice. Access: OAuth scope `messages:send`; write-gated by the subscription.
The store's kits, in display order GET
Access: OAuth scope `listings:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 100, at most 200) and an opaque `cursor`.