ShopEazydevelopers
API referenceMerchant API BetaStorefront

The design as it stands in the draft

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

Look, colours, hero, home sections and announcement; whether the draft differs from live; a preview link (null when this deployment cannot sign one).

Access: OAuth scope store:read; 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>/storefront' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "look": "market",    "colours": {      "background": "#fffdf8",      "foreground": "#1d3557",      "accent": "#f4a261",      "primary": "#e63946"    },    "corners": "round",    "hero": {      "headline": "Made by hand, made to keep",      "line": "Small batches, made with care.",      "button": "Shop now",      "photo": null    },    "sections": [      {        "type": "block",        "label": "",        "shown": true,        "block": "products"      },      {        "type": "kit",        "label": "Shop",        "shown": true,        "kind": "physical"      },      {        "type": "kit",        "label": "Services",        "shown": true,        "kind": "service"      }    ],    "announcement": null,    "draftDiffersFromLive": false,    "previewUrl": "https://jabus-plant-shop.shopeazy.co/preview/home?t=w82oaN7OkGK7BykWs2Ag.home.1792931610852.4cagG-xHM1hghbY5t6K1wCCjmfuGDcnNlDtIKiCp-Zs",    "looks": [      {        "id": "bold",        "name": "Bold"      },      {        "id": "fresh",        "name": "Fresh"      },      {        "id": "warm",        "name": "Warm"      }    ]  }}

Tick a traveller on a tour as there (or not) PUT

Access: OAuth scope `bookings:write`; write-gated by the subscription.

The templates a design can start from GET

Each template is a whole starting design for a kind of business: a look, hero words and home sections around the shop's own listings. Send an `id` as `template` to applyStorefrontTemplate. `categories` are the store categories that start on it; a store can use any. Access: OAuth scope `store:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 50, at most 100) and an opaque `cursor`.