Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "id": "reg-idf",
      "name": "Île-de-France",
      "code": "IDF",
      "storeCount": 3,
      "active": true
    }
  ],
  "total": 13,
  "page": 1,
  "pageSize": 20,
  "pageCount": 1
}

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

Network

List the network's regions

Returns one page of the regions the store network is grouped into — the coarsest level of the network hierarchy (region → store → register). Reach for it to answer ‘where does this network operate’ or to resolve a region a user named in prose before drilling into stores. JOINING TO STORES: a store does NOT carry a region id — it carries a free-text region LABEL, matched by exact string equality with no normalisation. That label is usually this region’s name (e.g. Île-de-France) but sometimes its code (the seeded Provence-Alpes-Côte d’Azur stores carry PACA). So pass name as the store listing’s region filter, and if that returns zero rows RETRY with code before concluding the region has no stores. storeCount is a stored counter on the region record, not a live count, so treat it as indicative — but a non-zero storeCount against an empty store listing is exactly the signal that you filtered on the wrong spelling. Filter with active ("true"/"false") and/or minStoreCount (inclusive lower bound); sort by name or code; page with page/pageSize (max 100) until page reaches pageCount.

GET

regions

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "id": "reg-idf",
      "name": "Île-de-France",
      "code": "IDF",
      "storeCount": 3,
      "active": true
    }
  ],
  "total": 13,
  "page": 1,
  "pageSize": 20,
  "pageCount": 1
}

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

Query Parameters

page

integer

Required range: 0 < x <= 9007199254740991

pageSize

integer

Required range: 0 < x <= 100

active

enum<string>

Available options:

true,

false

minStoreCount

integer

Required range: 0 <= x <= 9007199254740991

sortField

enum<string>

Available options:

name,

code

sortDirection

enum<string>

Available options:

asc,

desc

Response

A page of regions with the pagination totals.

items

object[]

required

Show child attributes

total

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

page

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

pageSize

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

pageCount

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

Update a paired device Create a region

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

List the network's regions

Authorizations

Query Parameters

Response