Sign Customiser

Navigation

Dark mode

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.

PATCH/api/v3/stores/me
PATCHUpdate the authenticated store
PATCH/api/v3/stores/me

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. 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

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

Body
Update the authenticated store

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

namestringbody
contact_emailstringbody
website_urlstringbody
primary_colourstringbody
use_branding_for_emailsbooleanbody
currencystringbody
currency_format_with_codestringbody
currency_format_without_codestringbody
prevent_zero_price_productsbooleanbody

Request body example

application/json
{
  "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
}
Update the authenticated store
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
}'
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",
    "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.