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.
Authorizations
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
1-based page number (default 1).
0 < x <= 9007199254740991Rows per page, max 100 (default 20).
0 < x <= 100Filter by DERIVED availability: out-of-stock (rupture, onHand = 0), low-stock (seuil de réappro atteint, onHand ≤ reorderPoint), in-stock (onHand > reorderPoint).
in-stock, low-stock, out-of-stock Filter to one merchandising category (exact match).
1Filter 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.
1Filter to lines replenished from one supplier (fournisseur; exact match).
1Sort key: name, onHand, or available (onHand − reserved). Default name.
name, onHand, available Sort direction (default asc).
asc, desc Response
A page of stock items with the pagination totals.
A page of stock items with the pagination totals.
This page's stock lines.
Total stock lines matching the filter, across all pages.
-9007199254740991 <= x <= 9007199254740991This page's 1-based number.
-9007199254740991 <= x <= 9007199254740991Rows requested per page.
-9007199254740991 <= x <= 9007199254740991Total number of pages.
-9007199254740991 <= x <= 9007199254740991
