Customiser jackets

Create a jacket

Copy page

Adds a jacket to the customiser, at the end of the current presentation order. name and jacket_type are required; every other field has a documented default (excluded_colour_ids empty, base_price 0, price_multiplier 1, price_multiplier_target base_letter_price).

POST/api/v3/customisers/{customiser_id}/jackets

Create a jacket

Adds a jacket to the customiser, at the end of the current presentation order. `name` and `jacket_type` are required; every other field has a documented default (`excluded_colour_ids` empty, `base_price` 0, `price_multiplier` 1, `price_multiplier_target` base_letter_price). A customiser offers each type at most once, so creating a second `white` or `coloured` jacket is refused with a 422 on `/jacket_type` naming the jacket that already holds it. `excluded_colour_ids` must name the customiser's own colours — an id from another customiser or another store is a 422 on the offending element — and `sort_order` moves only through the reorder operation. Requires `customisers:write` and an `Idempotency-Key`. The write clears the customiser's cached storefront configuration and runs the advisory language sync. It never regenerates Shopify products, product images, or the product cache, so live listings are untouched. Option writes also spend one unit of a separate per-key option-write budget; exhausting it returns a 429 with `retry_after`.

Create a jacket

Overview

A customiser offers each type at most once, so creating a second white or coloured jacket is refused with a 422 on /jacket_type naming the jacket that already holds it. excluded_colour_ids must name the customiser's own colours — an id from another customiser or another store is a 422 on the offending element — and sort_order moves only through the reorder operation. Requires customisers:write and an Idempotency-Key. The write clears the customiser's cached storefront configuration and runs the advisory language sync. It never regenerates Shopify products, product images, or the product cache, so live listings are untouched. Option writes also spend one unit of a separate per-key option-write budget; exhausting it returns a 429 with retry_after.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: customisers:write

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

Request body

jacket_typestringbody

price_multiplier_targetstringbody

namestringbody

descriptionstringbody

excluded_colour_idsarraybody

base_priceintegerbody

price_multipliernumberbody

Request body example

{
  "jacket_type": "white",
  "price_multiplier_target": "base_letter_price",
  "name": "Clear Jacket",
  "description": "A clear sleeve that keeps the tube colour",
  "excluded_colour_ids": [
    7
  ],
  "base_price": 500,
  "price_multiplier": 1.2
}

Create a jacket

curl https://web.signcustomiser.com/api/v3/customisers/1/jackets \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "jacket_type": "white",
  "price_multiplier_target": "base_letter_price",
  "name": "Clear Jacket",
  "description": "A clear sleeve that keeps the tube colour",
  "excluded_colour_ids": [
    7
  ],
  "base_price": 500,
  "price_multiplier": 1.2
}'

{
  "data": {
    "object": "jacket",
    "id": 9,
    "customiser_id": 42,
    "name": "Clear Jacket",
    "description": null,
    "jacket_type": "white",
    "excluded_colour_ids": [],
    "base_price": 0,
    "currency": "USD",
    "price_multiplier": 1,
    "price_multiplier_target": "base_letter_price",
    "sort_order": 1,
    "created_at": "2026-08-13T00:00:00Z",
    "updated_at": "2026-08-13T00:00:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/jackets/9",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_idempotency_key",
  "title": "Missing idempotency key",
  "status": 400,
  "code": "missing_idempotency_key",
  "detail": "Provide an Idempotency-Key header for this write.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token.",
  "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:write scope.",
  "required_scopes": [
    "customisers:write"
  ],
  "granted_scopes": [
    "customisers:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/resource_not_found",
  "title": "Resource not found",
  "status": 404,
  "code": "resource_not_found",
  "detail": "The requested resource does not exist or does not belong to the authenticated store.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/idempotency_key_conflict",
  "title": "Idempotency key conflict",
  "status": 409,
  "code": "idempotency_key_conflict",
  "detail": "This Idempotency-Key was already used for a different request body on this operation.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/request_too_large",
  "title": "Request too large",
  "status": 413,
  "code": "request_too_large",
  "detail": "The request body must not exceed 2 MiB.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "code": "validation_failed",
  "detail": "This customiser already offers a white jacket.",
  "errors": [
    {
      "pointer": "/jacket_type",
      "code": "jacket_type_taken",
      "detail": "Jacket 9 already offers the white jacket type."
    }
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "You have exceeded the request limit for this API key.",
  "retry_after": 37,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}