Sign Customiser

Return the Store-local option ids captured for a modern product. Stable integer value fields are separate from merchant-editable display_name labels.

GET/api/v3/products/{product_id}/selections

Overview

Canonical axes include letter_type and support_finish; the latter may report finish_kind and colour_hex. Lookups are restricted to the product customiser, so stale or foreign option ids become null or are omitted. Requires products:read and has no side effects. Unknown and foreign product ids share one 404 response.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: products:read

Path parameters

product_idstringpathrequired

Product id returned by the list operation.

Example: 731

Show product selections
curl https://web.signcustomiser.com/api/v3/products/731/selections \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "product_selections",
    "product_id": 731,
    "letter_type": {
      "value": 18,
      "display_name": "Front and halo lit"
    },
    "size": {
      "value": 9,
      "display_name": "Medium",
      "width_cm": 80.5,
      "height_cm": 31.5,
      "length_cm": 2.5
    },
    "support": {
      "value": 4,
      "display_name": "Cut to shape"
    },
    "support_finish": {
      "value": 27,
      "display_name": "Gloss black",
      "finish_kind": "colour",
      "colour_hex": "#111111"
    },
    "jacket": {
      "value": 3,
      "display_name": "White jacket"
    },
    "mounting": {
      "value": 6,
      "display_name": "Wall mounted"
    },
    "mounting_colour": {
      "value": 7,
      "display_name": "Black"
    },
    "backlight": {
      "value": 8,
      "display_name": "Warm white"
    },
    "material": {
      "value": 9,
      "display_name": "Acrylic"
    },
    "colours": [
      {
        "value": 12,
        "display_name": "Warm white"
      }
    ],
    "fonts": [
      {
        "value": 5,
        "display_name": "Signature"
      }
    ]
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/products/731/selections",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}