Sign Customiser

Navigation

Dark mode

Applies a reviewed unit switch and returns the Store with its new units and unit_revision. Review first with POST/api/v3/stores/me/unit-switch/review, then send the same units, the review's unit_revision and its review_token.

POST/api/v3/stores/me/unit-switch
POSTSwitch the store units
POST/api/v3/stores/me/unit-switch

Switch the store units

Applies a reviewed unit switch and returns the Store with its new units and `unit_revision`. Review first with `POST /api/v3/stores/me/unit-switch/review`, then send the same units, the review's `unit_revision` and its `review_token`. Requires the `store:write` scope and an `Idempotency-Key`. Only the units the merchant admin and the storefront show change. No stored quantity changes. A unit-bearing write that sends the old `unit_revision` afterwards answers 409 `stale_revision`. Switching to the units the Store already has returns the Store unchanged. A token that expired, was issued to another API key, or names other units or another revision answers 409 `unit_switch_review_invalid`, and a Store whose units changed after the review answers 409 `stale_revision`. Review again in both cases.

Authorisation

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

Body
Switch the store units

Overview

Requires the store:write scope and an Idempotency-Key. Only the units the merchant admin and the storefront show change. No stored quantity changes. A unit-bearing write that sends the old unit_revision afterwards answers 409 stale_revision. Switching to the units the Store already has returns the Store unchanged. A token that expired, was issued to another API key, or names other units or another revision answers 409 unit_switch_review_invalid, and a Store whose units changed after the review answers 409 stale_revision. Review again in both cases.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: store:write

Request body

measurement_unitstringbody
weight_unitstringbody
unit_revisionintegerbody
review_tokenstringbody

Request body example

application/json
{
  "measurement_unit": "cm",
  "weight_unit": "kg",
  "unit_revision": 7,
  "review_token": "eyJpdiI6Ik1hY2hpbmVSZXZpZXdUb2tlbiJ9"
}
Switch the store units
curl https://web.signcustomiser.com/api/v3/stores/me/unit-switch \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "measurement_unit": "cm",
  "weight_unit": "kg",
  "unit_revision": 7,
  "review_token": "eyJpdiI6Ik1hY2hpbmVSZXZpZXdUb2tlbiJ9"
}'
Response
{
  "data": {
    "object": "store",
    "id": 1,
    "name": "Demo Signs",
    "platform": "universal",
    "plan": "starter",
    "currency": "GBP",
    "integrations": [
      {
        "object": "integration",
        "id": 17,
        "type": "custom",
        "name": "Warehouse bridge",
        "enabled": true,
        "accepts_writes": true
      },
      {
        "object": "integration",
        "id": 9,
        "type": "woocommerce",
        "name": "Old WooCommerce shop",
        "enabled": false,
        "accepts_writes": false
      }
    ],
    "scopes": [
      "store:read",
      "pricing:read",
      "pricing:write"
    ],
    "created_at": "2026-01-12T03:14:15Z",
    "measurement_unit": "in",
    "weight_unit": "lb",
    "unit_revision": 7,
    "contact_email": "hello@demosigns.example",
    "website_url": "https://demosigns.example",
    "primary_colour": "#1A73E8",
    "use_branding_for_emails": true,
    "logo_url": "https://cdn.signcustomiser.com/files/2f6c0b9e.png",
    "currency_format_with_code": "£{{amount}} GBP",
    "currency_format_without_code": "£{{amount}}",
    "prevent_zero_price_products": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/unit-switch",
    "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.