ShopEazydevelopers
API referenceMerchant API BetaStore

The shop's top menu as it is

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

mode: auto is the menu every shop starts with.

It shows the menu when sent nothing.

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

Authorization

merchantOAuth design: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: design:write

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>/menu' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "menu": {      "mode": "auto",      "style": null,      "items": [],      "says": "Automatic: one link per kind you sell, pages ticked for the menu, then Contact."    },    "liveUrl": "https://jabus-plant-shop.shopeazy.co"  }}