Skip to main content
GET
List sales lines (sales transactions / sell-through)

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

brandId
string

Filter by brand UUID

productId
string

Filter by product UUID

variantId
string

Filter by variant UUID

lineType
enum<string>

Filter by line type. Enum (lowercase, matching stored values): 'sale' (regular sale), 'return' (returned item)

Available options:
sale,
return
dateFrom
string

Return lines where saleDate >= 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 saleDate column.

dateTo
string

Return lines where saleDate <= 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 saleDate column.

sortBy
string

Column to sort by. Allowed: 'saleDate', 'quantity', 'price'. Defaults to 'saleDate'.

sortOrder
enum<string>

Sort direction: 'asc' or 'desc'. Default order is saleDate 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