Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "id": "reg-paris-1-printer",
      "label": "Imprimante ticket",
      "kind": "printer",
      "store": "Paris Rivoli",
      "register": "Caisse 1",
      "status": "ready",
      "lastSeen": "2026-07-13T08:15:00.000Z"
    }
  ],
  "total": 16,
  "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 paired register peripherals

Returns one page of the hardware paired onto the network’s POS registers — this is the answer to ‘is the till equipment working’ and ‘which registers exist’. Each row is ONE peripheral, not one register, so a single register appears several times (once per printer / scanner / terminal / drawer / display). Filter with kind (the peripheral family: printer, scanner, payment-terminal, cash-drawer, customer-display) and/or status (the hardware link state: ready means online; disconnected, connecting and error all mean it is not usable right now) — status=error is the query for a hardware-fault triage. Sort by label or lastSeen (sortField=lastSeen&sortDirection=desc surfaces the most recent state changes first) and page with page/pageSize (max 100). GOTCHA: store and register are human display LABELS (e.g. Paris Rivoli, Caisse 1), not ids — they do not match a store id from the store listing, so you cannot join the two surfaces programmatically; match on the label text or ask the operator.

GET

fleet

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "id": "reg-paris-1-printer",
      "label": "Imprimante ticket",
      "kind": "printer",
      "store": "Paris Rivoli",
      "register": "Caisse 1",
      "status": "ready",
      "lastSeen": "2026-07-13T08:15:00.000Z"
    }
  ],
  "total": 16,
  "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

kind

string

Minimum string length: 1

status

string

Minimum string length: 1

sortField

enum<string>

Available options:

label,

lastSeen

sortDirection

enum<string>

Available options:

asc,

desc

Response

A page of fleet devices 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 a supplier Pair a device onto a register

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

List the paired register peripherals

Authorizations

Query Parameters

Response