ShopEazydevelopers
API referenceMerchant API BetaStore

What a store can say it sells (the store category choices)

Beta
Credentials
  • OAuth access token
Scopes
store:read
GET
/v1/merchant/stores/{storeId}/profile/categories

Send a code as categoryCode to updateStoreProfile: the storefront cannot go live without one.

Access: OAuth scope store:read; not write-gated.

Paged: { items, nextCursor }, limit (default 100, at most 200) and an opaque cursor.

Authorization

merchantOAuth store:read
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: store:read

Path Parameters

storeId*string

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

Query Parameters

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 100, at most 200 (more is 200; a missing or unusable value is 100).

Range1 <= value <= 200
Default100

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/profile/categories' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "items": [      {        "code": "fashion_apparel",        "label": "Clothing & fashion",        "group": "Retail"      },      {        "code": "shoes_accessories",        "label": "Shoes & accessories",        "group": "Retail"      },      {        "code": "jewellery",        "label": "Jewellery & watches",        "group": "Retail"      }    ],    "nextCursor": "p1.eyJvIjo1LCJhIjoiZWxlY3Ryb25pY3MifQ"  }}

The business's referral link, credit banked and who signed up through it GET

The link is made on the first ask. A business that subscribes through it gets its next month free; when it pays again the referrer gets a month free too (up to 6 a year). Access: OAuth scope `store:read`; not write-gated.

Store details, channels and go-live blockers GET

Access: OAuth scope `store:read`; owner/admin only; not write-gated.