tenant.settings.update

Update the tenant-wide admin settings. tenant_name is what the admin calls this business on screen — the shell’s tenant row shows the tenant id until it is set, which is unreadable for anyone who works across two tenants; send an empty string to clear it back to unnamed. default_locale is the language operators see when they have not picked one of their own (‘en’ | ‘pt-BR’ | ‘es’); an operator’s own choice always wins over it. default_timezone is the clock every screen renders instants in — an IANA name such as ‘America/Sao_Paulo’, never an offset like ‘-03:00’. default_currency is the ISO-4217 currency the instance sells in (one per instance; only currencies with 2 decimal places). Changing it CONVERTS NOTHING — every stored price keeps its number and changes meaning — so it is refused once priced skus exist unless acknowledge_no_conversion is true. cart_ttl_days is how long an untouched cart survives before the maintenance sweeper deletes it (default 90); a cart whose order still has a live payment attempt is never swept, whatever this says. require_shipping_document makes the kernel refuse order.shipment.mark_shipped on a parcel that has no document attached to it — a NEUTRAL gate: the kernel never learns what the document is (an invoice, a declaration, a label), only that this instance requires one before a parcel may leave. Default false.

• Scope: tenant.settings.write
• System: no
• Reachable from: POST /v1/commands/tenant.settings.update (tenant credential) · MCP tool tenant.settings.update · SDK client.call('tenant.settings.update', …)
• Events: tenant.settings.updated

Input (JSON Schema)

{
  "properties": {
    "acknowledge_no_conversion": {
      "type": "boolean"
    },
    "cart_ttl_days": {
      "maximum": 3650,
      "minimum": 1,
      "type": "integer"
    },
    "default_currency": {
      "maxLength": 3,
      "minLength": 3,
      "type": "string"
    },
    "default_locale": {
      "maxLength": 10,
      "minLength": 2,
      "type": "string"
    },
    "default_timezone": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "require_shipping_document": {
      "type": "boolean"
    },
    "tenant_name": {
      "maxLength": 120,
      "type": "string"
    }
  },
  "type": "object"
}

Result (200)

{
  "additionalProperties": false,
  "properties": {
    "cart_ttl_days": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "default_currency": {
      "type": "string"
    },
    "default_locale": {
      "type": "string"
    },
    "default_timezone": {
      "type": "string"
    },
    "require_shipping_document": {
      "type": "boolean"
    },
    "tenant_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "tenant_name",
    "default_locale",
    "default_timezone",
    "default_currency",
    "cart_ttl_days",
    "require_shipping_document"
  ],
  "type": "object"
}

Errors

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)