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
Required range: 0 < x <= 9007199254740991
pageSize
integer
Required range: 0 < x <= 100
status
enum<string>
Available options:
in-stock,
low-stock,
out-of-stock
category
string
Minimum string length: 1
sortField
enum<string>
Available options:
name,
onHand,
available
sortDirection
enum<string>
Available options:
asc,
desc

Response

A page of stock items with the pagination totals.

A page of stock items with the pagination totals.

items
object[]
required
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
page
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
pageSize
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
pageCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991