ShopEazydevelopers
API referenceMerchant API BetaPages

Make a page, or save a new draft of one

Beta
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-Key header. A retry with the same key does the work once.
POST
/v1/merchant/stores/{storeId}/pages

New: startFrom "about", "contact", "faq", "team" and more (see listPages), or "blank" with your own blocks. Edit: pageId plus title and/or blocks (blocks replace the page's blocks). Saves a draft; shoppers see it after publishPage.

Access: OAuth scope design:write; owner/admin only; write-gated by the subscription.

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.

Header Parameters

Idempotency-Key*string

Required 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.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body
pageId?string
startFrom?string
title?string
Length1 <= length
blocks?array<>
inMenu?boolean

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/pages' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "created": true,    "page": {      "id": "string",      "title": "string",      "slug": "string",      "live": true,      "unpublishedChanges": true,      "inMenu": true,      "inFooter": true,      "catalogPage": "physical"    },    "blocks": [      {        "id": "string",        "type": "string",        "heading": "string"      }    ],    "problems": [      "string"    ],    "previewUrl": "string",    "nothingToPublish": true  }}

The shop's own pages and what new pages can start from GET

Every shop also has a built-in Contact page at /contact. Access: OAuth scope `store:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 50, at most 200) and an opaque `cursor`.

A landing page built around one listing POST

A draft page with the listing's photos, details and a buy button, for ads and social links. Growth and Scale. Access: OAuth scope `design:write`; owner/admin only; write-gated by the subscription.