ShopEazydevelopers
API referenceMerchant API BetaAlerts

Change this person's alerts

Beta
Credentials
  • OAuth access token
Scopes
orders:write
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
PUT
/v1/merchant/stores/{storeId}/alerts

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.

Authorization

merchantOAuth orders:write
headerAuthorizationBearer <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: orders:write

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Header Parameters

Idempotency-Key*string

Required 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.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body
push?

Per kind of alert, e.g. { "stock": false }. Unknown kinds are ignored.

muted?boolean
newOrderEmails?boolean

Owner or admin only.

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/alerts' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "push": {      "property1": true,      "property2": true    },    "labels": {      "property1": "string",      "property2": "string"    },    "muted": true,    "newOrderEmails": true  }}

What this person is alerted about GET

Push choices are per person; the new-order email is the store's. Access: OAuth scope `store:read`; not write-gated.

Members-only selling PUT

Switch members-only selling on or off and how it works. Only what is sent changes; an empty `applicationNote` removes the note. Access: OAuth scope `settings:write`; owner/admin only; write-gated by the subscription.