A valid request URL is required to generate request examples{
"items": [
{
"id": "store-rivoli",
"name": "Boutique Rivoli",
"city": "Paris 1er",
"region": "Île-de-France",
"active": true
}
],
"total": 15,
"page": 1,
"pageSize": 20,
"pageCount": 1
}{
"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
}
}List the network's stores
Returns one page of the store directory. START HERE when a task mentions a shop, a branch or a location: the id of each row is the store slug every store-scoped operation takes downstream — store-price overrides, inventory and count sessions, stock transfers, cash sessions, fiscal reports and the register fleet all address a store by this id. Filter with region — the free-text region LABEL the store record carries (never a region id), matched by EXACT string equality with no normalisation. That label is usually the region’s name (e.g. Île-de-France) but sometimes its code (e.g. PACA), so if a region filter returns zero rows, retry with the other spelling from the regions listing before concluding the region is empty. Also filter by active ("true"/"false"; anything else is a 400). Sort by name or city. Walk the result with page/pageSize (max 100) and stop when page reaches pageCount. active:false means the store is closed and no longer trading — do not route sales or transfers to it.
A valid request URL is required to generate request examples{
"items": [
{
"id": "store-rivoli",
"name": "Boutique Rivoli",
"city": "Paris 1er",
"region": "Île-de-France",
"active": true
}
],
"total": 15,
"page": 1,
"pageSize": 20,
"pageCount": 1
}{
"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.
Query Parameters
1-based page index to return. Defaults to 1.
1 <= x <= 9007199254740991Rows per page, 1..100. Defaults to 20.
1 <= x <= 1001true, false name, city asc, desc Response
A page of stores with the pagination totals.
A page of stores with the pagination totals.
The rows on this page, in the query's sort order.
Show child attributes
Show child attributes
Total rows matching the filter across ALL pages, not just this one.
0 <= x <= 9007199254740991The 1-based page number served.
0 < x <= 9007199254740991Rows requested per page.
0 < x <= 9007199254740991Total number of pages; stop walking when page reaches it.
0 <= x <= 9007199254740991