A valid request URL is required to generate request examples{
"preferences": {
"auto-sync": true,
"offline-mode": false,
"currency": "eur",
"receipt": "always",
"psp.enabled": true,
"psp.provider": "stripe",
"low-stock": true,
"digest": "weekly"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}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 — read what is actually there rather than assuming a key exists. The CANONICAL keys the panel writes are: auto-sync (bool), offline-mode (bool), currency (e.g. eur), receipt — the receipt/reçu policy, one of always | on-demand | never (the OLD receipt-mode key is DEAD, do not use it), psp.enabled (bool) + psp.provider (e.g. stripe / adyen) which together are the ONLY way to switch the card terminal (TPE), low-stock (bool) and digest (e.g. weekly).
A valid request URL is required to generate request examples{
"preferences": {
"auto-sync": true,
"offline-mode": false,
"currency": "eur",
"receipt": "always",
"psp.enabled": true,
"psp.provider": "stripe",
"low-stock": true,
"digest": "weekly"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Authorizations
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).
The current network settings (an empty preferences map if never saved).
Show child attributes
Show child attributes