Start the design from a template
- Credentials
- OAuth access token
- Scopes
design:write- Role
- Owners and admins only. Staff get
403 forbidden. - Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
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.
merchantOAuth design:writeAuthorizationBearer <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
storeId*stringA store the person can reach. Any other id answers 404, never 403.
Idempotency-Key*stringRequired on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.
^[A-Za-z0-9_-]{8,128}$application/json- body
template*stringuseTemplateColours?booleantrueOK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/storefront/template' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "template": "string"}'{ "data": { "template": "string", "saved": { "look": "string", "colours": {}, "corners": "string", "hero": { "headline": "string", "line": "string", "button": "string", "photo": "string" }, "sections": [ { "id": "string", "type": "string", "label": "string", "shown": true, "kind": "string", "block": {} } ], "announcement": {} }, "draftDiffersFromLive": true, "previewUrl": "string" }}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`.
A private link to the draft design GET
Valid for 2 hours. Null when this deployment cannot sign one. Access: OAuth scope `store:read`; not write-gated.