1min

Search Products

POST
Search the complete product catalog by using the available filters in the request body.
QUERY PARAMETERS
pageinteger
sizeinteger
exclude_publicboolean
Excludes all publicly available products that are not part of your curated catalog. In sandbox this should be left as false as there are no merchant <-> developer relationships and all products are publically available to all developers.
HEADER PARAMETERS
X-Violet-Tokenstring
X-Violet-App-Secretstring
X-Violet-App-Idinteger
BODY PARAMETERS
body
SearchRequest
Search Request
querystring
Query
merchant_idinteger<int32>
Merchant ID
category_idstring
Category ID
category_slugstring
Category Slug
min_commissionnumber<double>
Minimum Commission
max_commissionnumber<double>
Maximum Commission
min_priceinteger<int32>
Minimum Price
max_priceinteger<int32>
Maximum Price
include_offersboolean
Include offers with products
RESPONSES
200
successful operation
PageProduct
total_pagesinteger<int32>
total_elementsinteger<int64>
sizeinteger<int32>
content
Product[]
Products
numberinteger<int32>
sortSort
firstboolean
lastboolean
number_of_elementsinteger<int32>
Updated 21 Apr 2022
Did this page help you?
Yes
No