ShopEazydevelopers
API referenceMerchant API BetaMembers

Members-only selling

Beta
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-Key header. A retry with the same key does the work once.
PUT
/v1/merchant/stores/{storeId}/membership

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.

Authorization

merchantOAuth settings: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: settings: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
enabled*boolean
gate?string

checkout stops non-members at checkout; browse makes the whole shop members-only.

Value in"checkout""browse"
requireVerification?boolean

Ask applicants for a selfie and ID.

autoApprove?boolean

Approve applications at once. Never with requireVerification.

applicationNote?string

Shown on the apply form. Empty removes it.

Lengthlength <= 500

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/membership' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "enabled": false}'
Example Response
{  "data": {    "enabled": true,    "gate": "checkout",    "requireVerification": true,    "autoApprove": true,    "applicationNote": "string"  }}

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.

Membership requests, or members by status GET

For members-only shops. At most 100 are returned; `total` counts them all. ID documents are never shown. Access: OAuth scope `settings:write`; owner/admin only; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 50, at most 100) and an opaque `cursor`.