Skip to main content
GET
Inventory valuation aggregated by dimension

Authorizations

Authorization
string
header
required

User session token issued by NextAuth. For human users accessing Solya via the web application.

Query Parameters

page
integer
default:1

Page number, 1-indexed (default: 1)

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

Number of items per page, max 100 (default: 20)

Required range: 1 <= x <= 100
groupBy
enum<string>
default:brand

Aggregation dimension: shop, brand (default), or product

Available options:
shop,
brand,
product
shopIds
string

Comma-separated shop IDs to filter by

brandIds
string

Comma-separated brand IDs to filter by

sortBy
enum<string>
default:stockValue

Metric to sort by: stockValue (default), stockValueRetail, or units

Available options:
stockValue,
stockValueRetail,
units
sortDir
enum<string>
default:desc

Sort direction: desc (default) or asc

Available options:
asc,
desc

Response

Successful response

data
object[]
required

Page of items

meta
object
required

Pagination metadata

success
enum<boolean>
required
Available options:
true