Stores
Update the authenticated store
Changes the Store details the merchant admin edits under Store Configuration and returns the Store. The body is a JSON merge patch: send only the fields to change, and null to clear a nullable field.
Overview
As
in the merchant admin, a blank string clears a nullable field too, and
name is trimmed. Requires the store:write scope, which a legacy
full-access (*) key also holds.
Some changes have effects outside this resource. contact_email
changes where Sign Customiser sends the Store's notifications.
currency changes the currency every price is shown in and does not
convert the prices, and order and integration product writes must then
send the new code. Only a universal Store accepts currency and the
currency formats: Shopify sets them on a shopify Store, and sending
them there answers 422 prohibited.
Units are not Store details: send measurement_unit or weight_unit
here and the request answers 422, because units change only through the
reviewed unit switch (POST/api/v3/stores/me/unit-switch). The logo
changes through PUT/api/v3/stores/me/logo.
An Idempotency-Key is optional. With one, a retry of the same body
replays the recorded response, and the same key with a different body
answers 409.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: store:write
Request body
Request body example
{
"name": "Demo Signs",
"contact_email": "hello@demosigns.example",
"website_url": "https://demosigns.example",
"primary_colour": "#1A73E8",
"use_branding_for_emails": true,
"currency": "GBP",
"currency_format_with_code": "£{{amount}} GBP",
"currency_format_without_code": "£{{amount}}",
"prevent_zero_price_products": true
}curl https://web.signcustomiser.com/api/v3/stores/me \
--request PATCH \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"name": "Demo Signs",
"contact_email": "hello@demosigns.example",
"website_url": "https://demosigns.example",
"primary_colour": "#1A73E8",
"use_branding_for_emails": true,
"currency": "GBP",
"currency_format_with_code": "£{{amount}} GBP",
"currency_format_without_code": "£{{amount}}",
"prevent_zero_price_products": true
}'{
"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",
"documentation": "https://www.signcustomiser.com/help/api/"
},
"meta": {
"api_version": "v3",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
}{
"type": "https://www.signcustomiser.com/help/api/problems/malformed_json",
"title": "Malformed JSON",
"status": 400,
"code": "malformed_json",
"detail": "The request body is not valid JSON: Syntax error.",
"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/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": "The request payload failed validation. Correct the fields listed in errors and retry.",
"errors": [
{
"pointer": "/primary_colour",
"code": "regex",
"detail": "The primary colour field format is invalid."
}
],
"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": "prohibited",
"detail": "Change Store units with POST /api/v3/stores/me/unit-switch."
}
],
"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"
}