Customisers
Get a customiser's features
Returns the optional features of the Overview "Recommended setup" card
that fit this customiser, each with its state: on, off, or locked
when the store's plan does not include it. enabled_count of
applicable_count features are on. dismissed is true when a merchant
hid the suggestion in the admin. Read-only; requires customisers:read.
Overview
A 404 problem means the customiser is not one of this store's.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: customisers:read
Path parameters
customiser_idrequired
The customiser id.
Example: 1
Get a customiser's features
curl https://web.signcustomiser.com/api/v3/customisers/1/features \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'Response
{
"data": {
"object": "customiser_features",
"customiser_id": 42,
"enabled_count": 1,
"applicable_count": 2,
"features": [
{
"key": "ai_sign_designer",
"name": "AI Sign Designer",
"description": "Shoppers turn a logo into a sign.",
"kind": "feature",
"value": null,
"state": "on",
"dismissed": false
},
{
"key": "presets",
"name": "Presets",
"description": "Start shoppers from a ready-made design.",
"kind": "feature",
"value": null,
"state": "off",
"dismissed": false
}
]
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/customisers/42/features",
"documentation": "https://www.signcustomiser.com/help/api/"
},
"meta": {
"api_version": "v3",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
}{
"type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
"title": "Insufficient scope",
"status": 403,
"code": "insufficient_scope",
"detail": "This operation requires the customisers:read scope.",
"required_scopes": [
"customisers:read"
],
"granted_scopes": [
"store:read"
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}