Skip to main content
GET
Error

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
default:1

1-based page index to return. Defaults to 1.

Required range: 1 <= x <= 9007199254740991
pageSize
integer
default:20

Rows per page, 1..100. Defaults to 20.

Required range: 1 <= x <= 100
status
enum<string>

Status filter: active (sellable only), inactive (archived only), all (both). Default all.

Available options:
active,
inactive,
all
q
string

Free-text term (recherche): matched case-insensitively over product name, SKU references and barcodes (EAN/code-barres).

Minimum string length: 1
brand
string

Exact brand (marque) id match, e.g. br-sly — the id served by the brands directory. Filtered server-side, so a brand's catalogue is a total-accurate page rather than a client-side refine of one window.

Minimum string length: 1
category
string

Exact category (catégorie) match, e.g. sneakers — the merchandising category slug.

Minimum string length: 1
taxonomy
string

Taxonomy facet as a JSON object of axis -> value (every pair must match), e.g. {"Famille":"Sneakers"}. Malformed JSON 400s.

Minimum string length: 1
rentable
enum<string>

Location capability gate (true / false): keep only the products the merchant has flagged as rentable (true), or only those it has not (false). Filtered server-side over the whole catalogue before the page window, so total counts the rentable articles rather than the whole book. Unconstrained when omitted. A product that predates the flag carries false and is therefore NOT offered for rental — renting an article out is opt-in per product.

Available options:
true,
false
serviceable
enum<string>

After-sales (SAV) capability gate (true / false): the same facet as rentable, for the repair flow. Combines with rentable as AND.

Available options:
true,
false
sortField
enum<string>

Field to order by: name, brand, or category. Unsorted when omitted.

Available options:
name,
brand,
category
sortDirection
enum<string>

Sort direction; defaults to asc when sortField is set.

Available options:
asc,
desc
store
string

Store id to re-price every unit through its overrides; omit for the base price.

Response

A page of products with their priced sellable units and the pagination totals.

A page of products with their priced sellable units and the pagination totals.

items
object[]
required

The rows on this page, in the query's sort order.

total
integer
required

Total rows matching the filter across ALL pages, not just this one.

Required range: 0 <= x <= 9007199254740991
page
integer
required

The 1-based page number served.

Required range: 0 < x <= 9007199254740991
pageSize
integer
required

Rows requested per page.

Required range: 0 < x <= 9007199254740991
pageCount
integer
required

Total number of pages; stop walking when page reaches it.

Required range: 0 <= x <= 9007199254740991