> ## 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 stock items (stock / inventaire) > Returns one page of the stock read model (inventaire: on-hand / reserved / reorder point/seuil de réappro, valued in cents), optionally filtered by derived `status`, `category`, `storeId` and/or `supplier`, and sorted. Status is DERIVED from the levels: `out-of-stock` (rupture) is onHand = 0; `low-stock` is onHand ≤ reorderPoint (seuil atteint, à réapprovisionner); `in-stock` is onHand > reorderPoint. `available` = onHand − reserved. Because a stock line is a `sku × shop` position, pass `storeId` to scope the listing to one store (magasin) SERVER-SIDE. Use `page`/`pageSize` (max 100) to walk the result; `total`/`pageCount` tell you when to stop. ## OpenAPI ````yaml /openapi.json get /v1/inventory 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/inventory: get: tags: - Inventory summary: List stock items (stock / inventaire) description: >- Returns one page of the stock read model (inventaire: on-hand / reserved / reorder point/seuil de réappro, valued in cents), optionally filtered by derived `status`, `category`, `storeId` and/or `supplier`, and sorted. Status is DERIVED from the levels: `out-of-stock` (rupture) is onHand = 0; `low-stock` is onHand ≤ reorderPoint (seuil atteint, à réapprovisionner); `in-stock` is onHand > reorderPoint. `available` = onHand − reserved. Because a stock line is a `sku × shop` position, pass `storeId` to scope the listing to one store (magasin) SERVER-SIDE. Use `page`/`pageSize` (max 100) to walk the result; `total`/`pageCount` tell you when to stop. operationId: listInventory parameters: - schema: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 in: query name: page required: false description: 1-based page number (default 1). - schema: type: integer minimum: 0 exclusiveMinimum: true maximum: 100 in: query name: pageSize required: false description: Rows per page, max 100 (default 20). - schema: type: string enum: - in-stock - low-stock - out-of-stock in: query name: status required: false description: >- Filter by DERIVED availability: `out-of-stock` (rupture, onHand = 0), `low-stock` (seuil de réappro atteint, onHand ≤ reorderPoint), `in-stock` (onHand > reorderPoint). - schema: type: string minLength: 1 in: query name: category required: false description: Filter to one merchandising category (exact match). - schema: type: string minLength: 1 in: query name: storeId required: false description: >- Filter to one store (magasin) — matches the item's `shopId`. Since stock is a `sku × shop` position, pass this to scope the listing to a single store server-side. - schema: type: string minLength: 1 in: query name: supplier required: false description: >- Filter to lines replenished from one supplier (fournisseur; exact match). - schema: type: string enum: - name - onHand - available in: query name: sortField required: false description: >- Sort key: name, onHand, or available (onHand − reserved). Default name. - schema: type: string enum: - asc - desc in: query name: sortDirection required: false description: Sort direction (default asc). responses: '200': description: A page of stock items with the pagination totals. content: application/json: schema: type: object properties: items: type: array items: type: object properties: id: type: string minLength: 1 skuId: type: string pattern: ^[0-9a-f]{64}$ name: type: string minLength: 1 shopId: type: string minLength: 1 category: type: string minLength: 1 supplier: type: string minLength: 1 onHand: type: integer minimum: 0 maximum: 9007199254740991 reserved: type: integer minimum: 0 maximum: 9007199254740991 reorderPoint: type: integer minimum: 0 maximum: 9007199254740991 unitCostCents: type: integer minimum: 0 maximum: 9007199254740991 required: - id - skuId - name - shopId - category - supplier - onHand - reserved - reorderPoint - unitCostCents additionalProperties: false description: This page's stock lines. total: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Total stock lines matching the filter, across all pages. page: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: This page's 1-based number. pageSize: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Rows requested per page. pageCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Total number of pages. required: - items - total - page - pageSize - pageCount additionalProperties: false description: A page of stock items with the pagination totals. example: items: - id: stk-chemise-blanc-42 skuId: >- e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 name: Chemise sur-mesure Blanc 42 shopId: shop-paris-01 category: Mesure supplier: Atelier Solya onHand: 8 reserved: 2 reorderPoint: 5 unitCostCents: 1500 total: 1 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 `. 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. ````