ShopEazydevelopers
API referenceMerchant API BetaStorefront

A private link to the draft design

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

Valid for 2 hours. 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/preview' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "previewUrl": "string",    "expiresAt": 0  }}

Start the design from a template POST

Its look, hero words and home sections around the shop's own listings. Lands in the draft; nothing changes for shoppers until `publishStorefront`. Access: OAuth scope `design:write`; owner/admin only; write-gated by the subscription.

Make the draft design live POST

Publishing the design does not open the shop. Access: OAuth scope `design:write`; owner/admin only; write-gated by the subscription.