> ## Documentation Index
> Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi.json get /v1/fleet
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/fleet:
    get:
      tags:
        - Network
      summary: List the paired register peripherals
      description: >-
        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.
      operationId: listFleetDevices
      parameters:
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 9007199254740991
          in: query
          name: page
          required: false
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 100
          in: query
          name: pageSize
          required: false
        - schema:
            type: string
            minLength: 1
          in: query
          name: kind
          required: false
        - schema:
            type: string
            minLength: 1
          in: query
          name: status
          required: false
        - schema:
            type: string
            enum:
              - label
              - lastSeen
          in: query
          name: sortField
          required: false
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: sortDirection
          required: false
      responses:
        '200':
          description: A page of fleet devices with the pagination totals.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        label:
                          type: string
                          minLength: 1
                        kind:
                          type: string
                          minLength: 1
                        store:
                          type: string
                          minLength: 1
                        register:
                          type: string
                          minLength: 1
                        status:
                          type: string
                          minLength: 1
                        lastSeen:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      required:
                        - id
                        - label
                        - kind
                        - store
                        - register
                        - status
                        - lastSeen
                      additionalProperties: false
                  total:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  page:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  pageSize:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  pageCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                required:
                  - items
                  - total
                  - page
                  - pageSize
                  - pageCount
                additionalProperties: false
                description: A page of fleet devices with the pagination totals.
                example:
                  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
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `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.

````