A landing page built around one listing
- 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.
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.
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
listingId*stringOK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/pages/listing' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "listingId": "string"}'{ "data": { "listing": "string", "page": { "id": "string", "title": "string", "slug": "string", "live": true, "unpublishedChanges": true, "inMenu": true, "inFooter": true, "catalogPage": "physical" }, "previewUrl": "string" }}Make a page, or save a new draft of one POST
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.
Publish, unpublish or delete several pages POST
Up to 200 pages, one at a time (each change rewrites the store's pages index in a transaction, so running them side by side would only make them retry). Each page is re-read and decided again: one that is gone, already in that state, or that the plan does not allow is left alone with the reason. `delete` is permanent. The answer is one `{ id, ok, error? }` per id (`BulkResult`), always 200. A retry is safe: a page already published, unpublished or deleted is left alone (`ok: false`, for example `already live` or `not_found`) and nothing happens twice; the same `Idempotency-Key` replays the first answer. Access: OAuth scope `design:write`; owner/admin only; write-gated by the subscription.