Error

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": {
    "message": "<string>",
    "statusCode": 123
  }
}

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

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

Network

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.

GET

stores

Error

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

region

string

Minimum string length: 1

active

enum<string>

Available options:

true,

false

sortField

enum<string>

Available options:

name,

city

sortDirection

enum<string>

Available options:

asc,

desc

Response

A page of stores 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

Deactivate (archive) a region Provision a store

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

List the network's stores

Authorizations

Query Parameters

Response