ShopEazydevelopers
API referenceMerchant API BetaProducts

Create a customisation group

Beta
Credentials
  • OAuth access token
Scopes
listings:write
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
POST
/v1/merchant/stores/{storeId}/customisation-groups

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.

Authorization

merchantOAuth listings:write
headerAuthorizationBearer <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

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Header Parameters

Idempotency-Key*string

Required 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.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body
name*string
Lengthlength <= 60
description?string
Lengthlength <= 240
select?string
Default"one"
Value in"one""many"
required?boolean
max?|
Range1 <= value
choices*array<>
Items1 <= items <= 50

Response Body

Created

application/json
  1. response
data*

A group and the ids of the listings that offer it.

Example Request
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/customisation-groups' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "name": "Gift wrapping",  "description": "Choose how it arrives.",  "select": "one",  "required": false,  "choices": [    {      "name": "Plain brown paper",      "price": {        "amount": 0,        "currency": "ZAR"      }    },    {      "name": "Ribbon and card",      "price": {        "amount": 4500,        "currency": "ZAR"      },      "description": "A handwritten card in the box."    }  ]}'
Example Response
{  "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": []  }}

Customisation groups (option groups offered with a product) GET

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`.

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.