Sign Customiser

Navigation

Dark mode

Returns the setup steps of the Overview page and whether each one is complete, in the order the merchant admin shows them. dismissed is true when a merchant hid the guide in the admin. Read-only; requires customisers:read.

GET/api/v3/customisers/{customiser_id}/setup-guide
GETGet a customiser setup guide
GET/api/v3/customisers/{customiser_id}/setup-guide

Get a customiser setup guide

Returns the setup steps of the Overview page and whether each one is complete, in the order the merchant admin shows them. `dismissed` is true when a merchant hid the guide in the admin. Read-only; requires `customisers:read`. A 404 problem means the customiser is not one of this store's.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Path

The customiser id.

Get a customiser setup guide

Click Send to see the live response.

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_idstringpathrequired

The customiser id.

Example: 1

Get a customiser setup guide
curl https://web.signcustomiser.com/api/v3/customisers/1/setup-guide \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "customiser_setup_guide",
    "customiser_id": 42,
    "dismissed": false,
    "all_complete": false,
    "complete_count": 1,
    "total_count": 2,
    "steps": [
      {
        "key": "sizes_pricing",
        "title": "Set your sizes and prices",
        "why": "Shoppers see a price for each size.",
        "complete": true
      },
      {
        "key": "install",
        "title": "Add the customiser to your store",
        "why": "Shoppers cannot find it yet.",
        "complete": false
      }
    ]
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/setup-guide",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.