> ## 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 catalog products

> Returns one page of the catalog read model, optionally filtered by status and sorted. Use `page`/`pageSize` (max 100) to walk the result; `total`/`pageCount` let you know when to stop. This is the read model — for a sellable price use the units operation.



## OpenAPI

````yaml /openapi.json get /v1/products
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/products:
    get:
      tags:
        - Catalog
      summary: List catalog products
      description: >-
        Returns one page of the catalog read model, optionally filtered by
        status and sorted. Use `page`/`pageSize` (max 100) to walk the result;
        `total`/`pageCount` let you know when to stop. This is the read model —
        for a sellable price use the units operation.
      operationId: listProducts
      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
            enum:
              - active
              - inactive
              - all
          in: query
          name: status
          required: false
        - schema:
            type: string
            enum:
              - name
              - brand
              - category
          in: query
          name: sortField
          required: false
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: sortDirection
          required: false
      responses:
        '200':
          description: A page of product views with the pagination totals.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        brandId:
                          type: string
                        category:
                          type: string
                        active:
                          type: boolean
                        serialTracked:
                          type: boolean
                        ageRestricted:
                          type: boolean
                        warrantyMonths:
                          type: number
                        rentable:
                          type: boolean
                        serviceable:
                          type: boolean
                        taxonomy:
                          type: object
                          additionalProperties:
                            type: string
                        imageUrl:
                          type: string
                        skus:
                          type: array
                          items:
                            type: object
                            properties:
                              skuId:
                                type: string
                              skuGroupId:
                                type: string
                              uom:
                                type: string
                              active:
                                type: boolean
                              axes:
                                type: object
                                additionalProperties:
                                  type: string
                              barcodes:
                                type: array
                                items:
                                  type: string
                              references:
                                type: array
                                items:
                                  type: string
                            required:
                              - skuId
                              - skuGroupId
                              - uom
                              - active
                              - axes
                              - barcodes
                              - references
                            additionalProperties: false
                        price:
                          nullable: true
                          type: object
                          properties:
                            currency:
                              type: string
                            minNetAmount:
                              type: number
                            maxNetAmount:
                              type: number
                          required:
                            - currency
                            - minNetAmount
                            - maxNetAmount
                          additionalProperties: false
                      required:
                        - id
                        - name
                        - brandId
                        - category
                        - active
                        - serialTracked
                        - ageRestricted
                        - warrantyMonths
                        - rentable
                        - serviceable
                        - taxonomy
                        - skus
                        - price
                      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 product views with the pagination totals.
                example:
                  items:
                    - id: prod-espresso
                      name: Espresso Blend 1kg
                      brandId: solya
                      category: cafe
                      active: true
                      serialTracked: false
                      ageRestricted: false
                      warrantyMonths: 0
                      rentable: false
                      serviceable: false
                      taxonomy:
                        Famille: Épicerie
                      skus:
                        - skuId: sku-espresso-1kg
                          skuGroupId: espresso
                          uom: piece
                          active: true
                          axes:
                            Format: 1kg
                          barcodes:
                            - '3401579800005'
                          references: []
                      price:
                        currency: EUR
                        minNetAmount: 15
                        maxNetAmount: 15
                  total: 21
                  page: 1
                  pageSize: 20
                  pageCount: 2
        '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.

````