A valid request URL is required to generate request examples{
"items": [
{
"id": "brand-solya",
"name": "Maison Solya",
"code": "SLY",
"country": "France",
"active": true
}
],
"total": 15,
"page": 1,
"pageSize": 20,
"pageCount": 1
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}List catalog brands (marques)
Returns one page of the merchandising brand directory (the ‘Marques’ list). Optionally narrow by country of origin and/or the active flag, and sort by name or code. Walk the result with page/pageSize (max 100); total/pageCount tell you when to stop. Use this to discover a brand’s id before a get/update, or to resolve a brand name to its id.
A valid request URL is required to generate request examples{
"items": [
{
"id": "brand-solya",
"name": "Maison Solya",
"code": "SLY",
"country": "France",
"active": true
}
],
"total": 15,
"page": 1,
"pageSize": 20,
"pageCount": 1
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}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 index to return. Defaults to 1.
1 <= x <= 9007199254740991Rows per page, 1..100. Defaults to 20.
1 <= x <= 100Filter to brands whose country of origin matches.
1Filter by the active flag: true (live only), false (archived only). Both when omitted.
true, false Field to order by: name or code. Unsorted when omitted.
name, code Sort direction; defaults to asc when sortField is set.
asc, desc Response
A page of brand directory rows with the pagination totals.
A page of brand directory rows with the pagination totals.
The rows on this page, in the query's sort order.
Show child attributes
Show child attributes
Total rows matching the filter across ALL pages, not just this one.
0 <= x <= 9007199254740991The 1-based page number served.
0 < x <= 9007199254740991Rows requested per page.
0 < x <= 9007199254740991Total number of pages; stop walking when page reaches it.
0 <= x <= 9007199254740991