Skip to main content
GET
List stock ledger entries (inventory transaction history)

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

Filter by shop UUID

variantId
string

Filter by variant UUID

movementCategory
string

Filter by movement category. Values are title case as stored in the gold layer (NOT uppercase). Known values: 'Stock Out', 'Stock In', 'Correction'. Example: 'Stock Out'.

movementType
string

Filter by movement type. Values are title case as stored in the gold layer (NOT uppercase). Known values: 'Sale', 'Receipt', 'Transfer', 'Return'. Example: 'Sale'.

dateFrom
string

Return entries where movementTime >= this value (inclusive). ISO 8601 date 'YYYY-MM-DD' (e.g. '2026-01-01') or datetime 'YYYY-MM-DDTHH:mm:ssZ' — both accepted. Filters on the movementTime ledger timestamp, NOT saleDate.

dateTo
string

Return entries where movementTime <= this value (inclusive). ISO 8601 date 'YYYY-MM-DD' (e.g. '2026-12-31') or datetime 'YYYY-MM-DDTHH:mm:ssZ' — both accepted. Filters on the movementTime ledger timestamp, NOT saleDate.

sortBy
string

Column to sort by. Allowed: 'movementTime', 'quantityChange', 'stockAfter'. Defaults to 'movementTime'.

sortOrder
enum<string>

Sort direction: 'asc' or 'desc'. Default order is movementTime descending (most recent first).

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