Sign Customiser

Navigation

Dark mode

Reads what switching the Store to another pair of units would change, and returns a review_token that POST/api/v3/stores/me/unit-switch needs to apply exactly that switch. Nothing is written.

POST/api/v3/stores/me/unit-switch/review
POSTReview a store unit switch
POST/api/v3/stores/me/unit-switch/review

Review a store unit switch

Reads what switching the Store to another pair of units would change, and returns a `review_token` that `POST /api/v3/stores/me/unit-switch` needs to apply exactly that switch. Nothing is written. Requires the `store:write` scope. A unit switch changes the units the merchant admin and the storefront show lengths and weights in. It never changes a stored value: `converted_rows` and `converted_quantities` count the quantities that will show converted, and `examples` shows some of them before and after. The token is valid for 15 minutes, and only for this Store, this API key (or MCP connection), these units and this `unit_revision`. Review again after any of them changes.

Authorisation

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

Body
Review a store unit switch

Overview

Requires the store:write scope. A unit switch changes the units the merchant admin and the storefront show lengths and weights in. It never changes a stored value: converted_rows and converted_quantities count the quantities that will show converted, and examples shows some of them before and after. The token is valid for 15 minutes, and only for this Store, this API key (or MCP connection), these units and this unit_revision. Review again after any of them changes.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: store:write

Request body

measurement_unitstringbody
weight_unitstringbody

Request body example

application/json
{
  "measurement_unit": "cm",
  "weight_unit": "kg"
}
Review a store unit switch
curl https://web.signcustomiser.com/api/v3/stores/me/unit-switch/review \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "measurement_unit": "cm",
  "weight_unit": "kg"
}'
Response
{
  "data": {
    "object": "store_unit_switch_review",
    "from_measurement_unit": "in",
    "from_weight_unit": "lb",
    "to_measurement_unit": "cm",
    "to_weight_unit": "kg",
    "unit_revision": 7,
    "converted_rows": 12,
    "converted_quantities": 31,
    "examples": [
      {
        "section": "Sizes",
        "field": "Width",
        "current_display": "24 in",
        "target_display": "61 cm"
      }
    ],
    "review_token": "eyJpdiI6Ik1hY2hpbmVSZXZpZXdUb2tlbiJ9",
    "expires_at": "2026-11-16T00:15:00Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/unit-switch/review",
    "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.