Change the home hero in the design draft
- 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.
The big banner at the top of the home page: headline, the line under it, button words and photo (one the business stored itself). Only what is sent changes. Lands in the draft.
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
headline?string1 <= length <= 80line?stringlength <= 200button?stringlength <= 30photo?stringOK
application/json- response
data*curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/storefront/hero' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "saved": { "headline": "string", "line": "string", "button": "string", "photo": "string" }, "draftDiffersFromLive": true, "previewUrl": "string" }}Change the look and colours in the design draft PUT
The look (fonts, corners, style) and/or colours: `button`, `accent`, `background`, `text`, as hex like #ff5275. Text and buttons must stay readable: a pair failing contrast is refused, said so in `problems`, and the colours are left as they were. Lands in the draft. Access: OAuth scope `design:write`; owner/admin only; write-gated by the subscription.
The calling station GET
What the calling station is: its kind, store, name and (for a door) its event. A station reads this when it starts, to open straight into its job. Access: a station's token only.