One customisation group and the listings that offer it
- Credentials
- OAuth access token
- Scopes
listings:read
Access: OAuth scope listings:read; not write-gated.
merchantOAuth listings:readAuthorizationBearer <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:read
storeId*stringA store the person can reach. Any other id answers 404, never 403.
groupId*stringA customisation group id, from GET /customisation-groups.
OK
application/json- response
data*A group and the ids of the listings that offer it.
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/customisation-groups/<groupId>' \ -H 'Authorization: Bearer <access_token>'{ "data": { "id": "QdChQIpRuzJvj6uu3Huc", "name": "Gift wrapping", "description": "Choose how it arrives.", "select": "one", "required": false, "max": null, "status": "active", "sortOrder": 0, "choices": [ { "id": "f0e14318", "name": "Plain brown paper", "price": { "amount": 0, "currency": "ZAR" }, "available": true, "description": null, "imageUrl": null }, { "id": "a26f9c74", "name": "Ribbon and card", "price": { "amount": 4500, "currency": "ZAR" }, "available": true, "description": "A handwritten card in the box.", "imageUrl": null } ], "updatedAt": 1792924388125, "listingIds": [] }}Put the customisation groups in order PUT
`ids` lists groups in the order to show; any left out follow in their present order. Answers with the whole list. Access: OAuth scope `listings:write`; write-gated by the subscription.
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.