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

1-based page number (default 1).

Required range: 0 < x <= 9007199254740991
pageSize
integer

Rows per page, max 100 (default 20).

Required range: 0 < x <= 100
category
string

Filter to one supplier category (exact match).

Minimum string length: 1
active
enum<string>

Filter by active flag: true for active suppliers, false for archived ones.

Available options:
true,
false
sortField
enum<string>

Sort key: supplier name or replenishment lead time in days (default name).

Available options:
name,
leadTimeDays
sortDirection
enum<string>

Sort direction (default asc).

Available options:
asc,
desc

Response

A page of suppliers with the pagination totals.

A page of suppliers with the pagination totals.

items
object[]
required

This page's suppliers.

total
integer
required

Total suppliers matching the filter, across all pages.

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

This page's 1-based number.

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

Rows requested per page.

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

Total number of pages.

Required range: -9007199254740991 <= x <= 9007199254740991