Customisation groups (option groups offered with a product)
- Credentials
- OAuth access token
- Scopes
listings:read
Groups like "Upgrades" or "Extras", set up once and attached to listings. Archived groups are included (status), in the merchant's order. status=active|archived narrows the list.
Access: OAuth scope listings:read; not write-gated.
Paged: { items, nextCursor }, limit (default 100, at most 200) and an opaque cursor.
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.
cursor?stringThe nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.
limit?integerPage size: default 100, at most 200 (more is 200; a missing or unusable value is 100).
1 <= value <= 200100status?string"active""archived"OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/customisation-groups' \ -H 'Authorization: Bearer <access_token>'{ "data": { "items": [ { "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 }, { "id": "G0aBOQaKiBzyCWBdxLuS", "name": "Drainage saucer", "description": null, "select": "one", "required": false, "max": null, "status": "active", "sortOrder": 1, "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": 1792924388445 } ], "nextCursor": null }}Put a Library photo on a product POST
Added after the product's other photos (primary only when it has none), shown as a Studio photo, and the Library notes it as in use (`usedIn`). A photo already on the product is left alone (`added: false`), so a retry is safe. 422 `validation_error` for a Library file or a product that is gone. Any listing, hidden and draft ones included: a product with no photo at all is the one that needs it most. Replacing one photo with another is `updateProduct`. Access: OAuth scope `listings:write`; write-gated by the subscription.
Create a customisation group POST
A choice a shopper can pick with a product, each with a price in minor units (0 for free). `select: one` lets the shopper pick one (`required` makes that compulsory); `select: many` lets them tick several, up to `max`. Returns the group; attach it to listings with setCustomisationGroupListings or setProductCustomisations. Access: OAuth scope `listings:write`; write-gated by the subscription.