The order pages appear in the menu and footer
- 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.
Page ids, first to last. Pages left out keep their place after these.
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
pageIds*array<string>1 <= items <= 100OK
application/json- response
data*curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/pages/order' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "pageIds": [ "string" ]}'{ "data": { "pages": [ { "id": "string", "title": "string", "slug": "string", "live": true, "unpublishedChanges": true, "inMenu": true, "inFooter": true, "catalogPage": "physical" } ] }}Switch a catalogue page to a designed page, or back PUT
Design, Page headers, "Design this page": the page that lists everything of one kind (`physical` is the shop, `service`, `ticketing`, `tour`) becomes a page you design, or goes back to the built-in one. Every plan. Switching on creates the designed page (a draft built around the listings) and answers its id; switching to the state it is in answers the same page again, so a retry is safe. Access: OAuth scope `design:write`; owner/admin only; write-gated by the subscription.
One page: its draft, what is live, its settings and a preview link GET
`previewUrl` is a private link valid for 2 hours, or null when this deployment cannot sign one. Access: OAuth scope `store:read`; not write-gated.