ShopEazydevelopers
API referenceMerchant API BetaStore

Store details, channels and go-live blockers

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

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

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.

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/profile' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "id": "w82oaN7OkGK7BykWs2Ag",    "name": "Jabu's Plant Shop",    "subdomain": "jabus-plant-shop",    "description": null,    "supportEmail": null,    "supportPhone": null,    "location": null,    "branding": {      "logoUrl": null,      "primaryColor": "#e63946"    },    "channels": {      "storefront": true,      "whatsapp": false    },    "directoryListed": true,    "categoryCode": "home_garden",    "blockers": []  }}