Write or hide the shop's policies
- Credentials
- OAuth access token
- Scopes
settings: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.
For each policy, the words (plain paragraphs or html), or fromTemplate to write it fresh from the shop's details, and whether it is shown. A policy not sent is left alone. Live at once.
Access: OAuth scope settings:write; owner/admin only; write-gated by the subscription.
merchantOAuth settings: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: settings: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
policies*array<>1 <= items <= 4OK
application/json- response
data*curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/policies' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "policies": [ { "type": "terms" } ]}'{ "data": { "changed": [ "string" ], "policies": [ { "type": "string", "title": "string", "shown": true, "url": "string" } ] }}Change the shop's top menu PUT
`auto` is the menu every shop starts with; `custom` is the merchant's own list, up to 7 links. Dropdowns and the mega style come with Growth (403 `plan_limit`). Live at once. Access: OAuth scope `design:write`; owner/admin only; write-gated by the subscription.
Is this shop web address free? GET
The same policy and availability provisioning uses. When it is not free, the closest address that is. Access: OAuth scope `store:read`; not write-gated.