Error

A valid request URL is required to generate request examples

{
  "preferences": {
    "auto-sync": true,
    "currency": "eur",
    "receipt-mode": "always"
  }
}

{
  "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
  }
}

Settings

Read the network settings

Returns the network-wide back-office preference document: a flat map of preference key → primitive value (boolean for a toggle, string for a choice) under preferences. These are NETWORK settings, not per-store ones — there is no store parameter, and the same document applies everywhere. Takes no parameters and always answers 200: before an operator has saved anything it returns { "preferences": {} } rather than a 404, so an empty map means ‘nothing configured yet’, never ‘not found’. ALWAYS call this before the update operation: the update replaces the document wholesale, so you must merge your change into the map you read here. The key vocabulary is owned by the back-office panel, not by the API — do not assume a key exists because you have seen it elsewhere; read what is actually there.

GET

settings

Error

A valid request URL is required to generate request examples

{
  "preferences": {
    "auto-sync": true,
    "currency": "eur",
    "receipt-mode": "always"
  }
}

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

Response

The current network settings (an empty preferences map if never saved).

preferences

object

required

Show child attributes

Get the POS permission manifest Replace the network settings

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

Read the network settings

Authorizations

Response