Product Search
GET /products/search
Returns a list of ProductMetadata objects. API Referece: Search Products
Use the query property to search products by their names, descriptions, variants, etc.
use the merchant_id property to limit your search results to products of a single merchant.
use the category_id property to limit your search results to products of a single category.
use the category_slug property to limit your search results to products of a single category.
use the min_commission property to limit your search results to products that offer a commission rate equal to or greater than this value.
use the max_commission property to limit your search results to products that offer a commission rate equal to or less than this value.
use the min_price property to limit your search results to products that have a price equal to or greater than this price.
use the max_price property to limit your search results to products that have a price equal to or less than this price.
extends the results to include available offers for each product. Pass a value of true if you wish to include product offers in the search results.
Optional Query Parameters:
the current page, used in pagination.
the number of products each page should contain, used in pagination.
excludes products that are publicly available by default to all applications. Pass a value of true if you wish to limit the product collection to only the merchants you have directly connected to.
excludes products that are not visible. Pass a value of true if you wish to limit the product collection to only visible products.
curl -X POST https://sandbox-api.violet.io/v1/catalog/products/search \
-H "X-Violet-App-Id: your-app-id-here" \
-H "X-Violet-App-Secret: your-app-secret-here" \
-H "X-Violet-Token: your-token-here" \
-H "Content-type: application/json" \
-d '{"query": "shirt", "min_commission": 15}'
Response
{
"content": [
{
"id": "3e622ea338294552be7309faeb185af2",
"name": "'Albion' Petite Ring with Semiprecious Stone & Diamonds",
"description": "Sterling silver. Faceted amethyst, black onyx, Black Orchid (lavender amethyst backed with hematine), prasiolite, morganite, blue topaz, white topaz or citrine, 7mm x 7mm. Pavé diamonds, 0.17 total carat weight. Split-shank. By David Yurman; imported.",
"brand": "DAVID YURMAN",
"available": true,
"visible": true,
"total_sales": 0,
"type": "PHYSICAL",
"currency": "USD",
"min_price": 67500,
"max_price": 72500,
"variants": [
{
"id": "f81794055a424b74b5ffff5937a31900",
"product_id": "3e622ea338294552be7309faeb185af2",
"name": "Size",
"visual": false,
"values": [
{
"id": "7c555d4a77a0490b84468ddea61b0f4a",
"variant_id": "f81794055a424b74b5ffff5937a31900",
"name": "7",
"display_order": 2
},
{
"id": "f95e7d35aab449a7b7e38f4d34bd3fb4",
"variant_id": "f81794055a424b74b5ffff5937a31900",
"name": "6",
"display_order": 1
},
{
"id": "300b74d15d5d40ce829c3e035c00ae3a",
"variant_id": "f81794055a424b74b5ffff5937a31900",
"name": "8",
"display_order": 3
}
],
"display_order": 1
},
{
"id": "8aaa5fda5cf54773ac5833df4998586a",
"product_id": "3e622ea338294552be7309faeb185af2",
"name": "Color",
"visual": true,
"values": [
{
"id": "15ec0bd4820c4c39bae02ee355562afd",
"variant_id": "8aaa5fda5cf54773ac5833df4998586a",
"name": "Amethyst",
"display_order": 1
},
{
"id": "492979aa9cba4792b4b1d7b3f10024ec",
"variant_id": "8aaa5fda5cf54773ac5833df4998586a",
"name": "Blue Topaz",
"display_order": 4
},
{
"id": "b28c338e0e2c442e9064634865cc23c4",
"variant_id": "8aaa5fda5cf54773ac5833df4998586a",
"name": "White Topaz",
"display_order": 6
},
{
"id": "983ee95fb46542c0ac52e756ce7f9495",
"variant_id": "8aaa5fda5cf54773ac5833df4998586a",
"name": "Black Onyx",
"display_order": 2
},
{
"id": "29db3d0183ed4f489ea1f670c48f6a0f",
"variant_id": "8aaa5fda5cf54773ac5833df4998586a",
"name": "Prasiolite",
"display_order": 5
},
{
"id": "4aed2fee362b483ebf6232cff5cd2c82",
"variant_id": "8aaa5fda5cf54773ac5833df4998586a",
"name": "Black Orchid",
"display_order": 3
}
],
"display_order": 2
}
],
"categories": [
{
"id": "200",
"name": "Rings",
"slug": "rings",
"parent_id": "188",
"depth": 3
},
{
"id": "188",
"name": "Jewelry",
"slug": "jewelry",
"parent_id": "166",
"depth": 2
},
{
"id": "166",
"name": "Apparel & Accessories",
"slug": "apparel_accessories",
"parent_id": "",
"depth": 1
}
],
"meta": [],
"tags": [],
"related_product_ids": [],
"cross_sale_product_ids": [],
"gtins": [],
"default_image_url": "https://dqzrr9k4bjpzk.cloudfront.net/images/13101742/956631377.jpg",
"qty_available": 149972,
"max_commission_rate": 10.0,
"merchant_ids": [
10003
],
"date_created": "2018-12-11T19:45:24+0000",
"date_last_modified": "2018-12-19T20:01:09+0000"
}
],
"pageable": {
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
},
"page_number": 0,
"page_size": 1,
"offset": 0,
"paged": true,
"unpaged": false
},
"total_elements": 133,
"last": false,
"total_pages": 133,
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
},
"number_of_elements": 1,
"first": true,
"size": 1,
"number": 0,
"empty": false
}