Skip to main content
GET
List inventory stock-out risks (what to reorder / restock / replenish)

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
shopIds
string

Comma-separated shop IDs to filter by

brandIds
string

Comma-separated brand IDs to filter by

status
enum<string>

Filter by risk status tier: critical (< 7 days supply), warning (7–13 days), healthy (≥ 14 days)

Available options:
critical,
warning,
healthy
period
integer
default:30

Period in days for sales velocity calculation (default: 30). Mapped to nearest pre-aggregated window.

Required range: 7 <= x <= 365

Response

Successful response

data
object[]
required

Page of items

meta
object
required

Pagination metadata

success
enum<boolean>
required
Available options:
true