Write a new page with AI, as a draft
- Credentials
- OAuth access token
- Scopes
ai:spend- Role
- Owners and admins only. Staff get
403 forbidden. - Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Daily limit
- AI generations, 300 a day per store. Over the limit is
429 rate_limited. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
A recipe or a line about what the page is for (and up to 6 listings it is about); one model call writes the words and the blocks come from the shop's own data. The page is a DRAFT, never published. Growth and Scale (403 plan_limit). Credits are checked first and charged only once the page exists (403 insufficient_credits).
Access: OAuth scope ai:spend; owner/admin only; write-gated by the subscription.
merchantOAuth ai:spendAuthorizationBearer <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: ai:spend
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
recipe?stringA page recipe id. Without one, about is needed.
about?stringWhat the page is for, in the merchant's words.
length <= 300listingIds?array<string>Listings the page is about.
items <= 6OK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/pages/ai' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "pageId": "string", "status": "draft", "previewUrl": "string", "creditsSpent": 0, "creditsLeft": 0 }}List or unlist the shop in the store directory PUT
Advertising only. Unlisting takes the shop off shopeazy.co/stores and out of the store sitemap index; it does not close the shop, which keeps serving every page to anyone with the address. Switching the storefront channel off is how a shop goes dark. Access: OAuth scope `settings:write`; owner/admin only; write-gated by the subscription.
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`.