Stores
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.
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
Request body example
{
"measurement_unit": "cm",
"weight_unit": "kg"
}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"
}'{
"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": "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 store:write scope.",
"required_scopes": [
"store:write"
],
"granted_scopes": [
"store:read"
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/validation_failed",
"title": "Validation failed",
"status": 422,
"code": "validation_failed",
"detail": "The request payload failed validation. Correct the fields listed in errors and retry.",
"errors": [
{
"pointer": "/measurement_unit",
"code": "in",
"detail": "The selected measurement unit is invalid.",
"allowed_values": [
"cm",
"in"
]
}
],
"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": 60,
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}