Skip to main content
GET
List stock per voucher set

Authorizations

Authorization
string
header
required

Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.

Query Parameters

page
integer
default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000
perPage
integer
default:25

Page size 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100
sort
string
default:-stock.usagePercent

One sort field; prefix - for descending (sort=field or sort=-field); id is appended as tie-breaker. Another value is a 400 data-failed-validation with the constraint invalid-sort. Default -stock.usagePercent.

Example:

"-stock.usagePercent"

Free-text search over the documented search fields, 1-255 characters.

Maximum string length: 255
filter[status]
string

Filter on status (equals).

filter[status][in]
string

Filter on status (one of, comma-separated). Comma-separated values.

filter[stock.stockStatus]
string

Filter on stock.stockStatus (equals).

filter[stock.stockStatus][in]
string

Filter on stock.stockStatus (one of, comma-separated). Comma-separated values.

filter[stock.usagePercent][gte]
number

Filter on stock.usagePercent (greater than or equal).

filter[stock.usagePercent][lte]
number

Filter on stock.usagePercent (less than or equal).

Response

A page of results.

Page envelope of VoucherSetStockRow.

data
object
required

Page body.