Archive a customisation group
- Credentials
- OAuth access token
- Scopes
listings:write- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
Groups are archived, never deleted: orders hold what was picked by id. Listings keep the attachment, and the shop stops offering the group. Bring it back with updateCustomisationGroup (status: active). Archiving twice is fine.
Access: OAuth scope listings:write; write-gated by the subscription.
merchantOAuth listings: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: listings:write
storeId*stringA store the person can reach. Any other id answers 404, never 403.
groupId*stringA customisation group id, from GET /customisation-groups.
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}$OK
application/json- response
data*A group and the ids of the listings that offer it.
curl -X DELETE 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/customisation-groups/<groupId>' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>'{ "data": { "id": "G0aBOQaKiBzyCWBdxLuS", "name": "Drainage saucer", "description": null, "select": "one", "required": false, "max": null, "status": "archived", "sortOrder": 0, "choices": [ { "id": "744085ec", "name": "No saucer", "price": { "amount": 0, "currency": "ZAR" }, "available": true, "description": null, "imageUrl": null }, { "id": "cb4f1304", "name": "Add a saucer", "price": { "amount": 3500, "currency": "ZAR" }, "available": true, "description": null, "imageUrl": null } ], "updatedAt": 1792924390504, "listingIds": [] }}Change a customisation group PATCH
Send only what changes. A `choices` list replaces the whole list: keep a choice's `id` so listings keep their price overrides for it. `status: active` brings an archived group back. Access: OAuth scope `listings:write`; write-gated by the subscription.
Offer a group on exactly these listings PUT
The group is added where it is missing (at the end of that listing's groups) and taken off every other listing. A listing that keeps it keeps its price overrides. Any kind of listing, archived ones excepted. Access: OAuth scope `listings:write`; write-gated by the subscription.