The business's referral link, credit banked and who signed up through it
- Credentials
- OAuth access token
- Scopes
store:read
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.
merchantOAuth store:readAuthorizationBearer <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
storeId*stringA store the person can reach. Any other id answers 404, never 403.
OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/referral' \ -H 'Authorization: Bearer <access_token>'{ "data": { "link": "https://shopeazy.co/r/jabus-plant-shop", "creditBanked": { "amount": 0, "currency": "ZAR" }, "referred": [] }}What the business paid ShopEazy, fee invoices and recent sales and refunds GET
Subscription and credit charges, platform fee invoices, and the recent ledger over the last `days` days. Access: OAuth scope `store:read`; owner/admin only; not write-gated.
What a store can say it sells (the store category choices) GET
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`.