ShopEazydevelopers
API referenceMerchant API BetaMembers

Membership requests, or members by status

Beta
Credentials
  • OAuth access token
Scopes
settings:write
Role
Owners and admins only. Staff get 403 forbidden.
GET
/v1/merchant/stores/{storeId}/members

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.

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.

Query Parameters

status?string

Which members to list.

Default"pending"
Value in"pending""active""rejected""revoked""all"
cursor?string

The nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.

limit?integer

Page size: default 50, at most 100 (more is 100; a missing or unusable value is 50).

Range1 <= value <= 100
Default50

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/members' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "items": [      {        "id": "string",        "name": "string",        "email": "string",        "phone": "string",        "status": "pending",        "note": "string",        "hasIdCheck": true,        "appliedAt": 0,        "decidedAt": 0      }    ],    "total": 0,    "nextCursor": "string"  }}

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.

One application or member GET

The selfie and ID stay in the console: only whether they were sent is shown. Access: OAuth scope `settings:write`; owner/admin only; not write-gated.