Replace the network settings

Upserts the ENTIRE network preference document. This is a full replacement, not a patch: every key you omit is DELETED. Read the settings first, merge your change into the map you got back, and send the whole map — sending only the key you want to change silently wipes the rest of the network’s configuration. The document is network-wide and takes effect on every store and every till, so this operation can reconfigure live registers mid-trading; do not call it speculatively, and confirm the intended change with the operator first. Values must be primitives — a nested object or a number is rejected with a 400 whose error.fieldErrors names the offending key. Returns the document exactly as persisted. PERMISSIONS: unlike the store and fleet writes in this same domain, this operation asserts NO kernel permission, so pos.settings.manage genuinely suffices on its own (pos.settings.view alone is a 403). The domain’s two write stories differ — see solya-pos#950 for why the store/fleet writes additionally need config:manage.

PUT /v1/settings

Error

A valid request URL is required to generate request examples

200

{
  "preferences": {
    "auto-sync": false,
    "currency": "eur",
    "receipt-mode": "on-request"
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Authorizations

Authorization · string · header · required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Body

application/json

preferences · object · required

Show child attributes

Response

200

application/json

The settings document as it was persisted (identical to the request body).

The settings document as it was persisted (identical to the request body).

preferences · object · required

Show child attributes