v1
latestOpenAPI 3.0.0MIT2026-07-147825.1 KBProduct List Page
Get list of products for a query
Lists the products for a given query.
get/product_search/{facets}
Path parameters
facetsstring nullable required
Format
The facets parameter follows the format : /${facetKey1}/${facetValue1}/${facetKey2}/${facetValue2}/.../${facetKeyN}/${facetValueN}.
The order in which the terms appear is not relevant to the search.
You can also repeat the same facetKey several times for different values. For example: category-1/shoes/color/blue/color/red/color/yellow
General filters
The facets parameter also allows the following general filters.
| facetKey | Description | Example |
|---|---|---|
| price | Filter the search by a price range. The facet value follows the format ${minPrice}:${maxPrice} | /color/blue/price/100:500?query=shirt |
| category-${n} | Filter the search by category, where n represents the category tree level (1 = department, 2 = category, 3 = subcategory, and so on) | category-1/clothing/category-2/shirts |
| region-id | Filter the search by a region id (aka regionalization). The value is the region id | /color/blue/region-id/v2.26219C7C3DE42BAAD11CFB92CD0BFE91?query=shirt. |
Query parameters
querystring
Search term. It can contain any character.
simulationBehavior'default' | 'skip' | 'only1P' nullable
Defines the simulation behavior.
- default - Calls the simulation for every single seller.
- skip - Never calls the simulation.
- only1P - Only calls the simulation for first party sellers.
countnumber nullable
Number of products per page.
pagenumber nullable
Current search page.
sort'price:desc' | 'price:asc' | 'orders:desc' | 'name:desc' | 'name:asc' | 'release:desc' | 'discount:desc' nullable
Defines the sort type. If null, the products will be sorted by relevance.
localestring nullable
Indicates the target language as a BCP 47 language code. The Intelligent Search must have indexed the account in the target language.
hideUnavailableItemsboolean
Whether the result should hide unavailable items (true), or not (false)
Response
List of products for the given query.
Example response
{
"correction": {
"misspelled": false
},
"fuzzy": "0",
"operator": "and",
"products": [
{
"brand": "Sony",
"brandId": 2000005,
"cacheId": "sp-2000003",
"categories": [
"/Home & Decor/"
],
"categoriesIds": [
"/40/"
],
"categoryId": "40",
"clusterHighlights": [
{
"id": "1970",
"name": "Summer"
}
],
"description": "With this beautiful design piece you will never miss an appointment anymore. Yay.",
"items": [
{
"attachments": [],
"complementName": "",
"ean": "16001",
"images": [
{
"cacheId": "155484",
"imageId": "155484",
"imageLabel": "",
"imageTag": "",
"imageText": "",
"imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155484/Frame.jpg?v=636793817478300000"
},
{
"cacheId": "155485",
"imageId": "155485",
"imageLabel": "",
"imageTag": "",
"imageText": "",
"imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155485/Frame-1.jpg?v=636793817642000000"
},
{
"cacheId": "155486",
"imageId": "155486",
"imageLabel": "",
"imageTag": "",
"imageText": "",
"imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155486/Frame-2.jpg?v=636793817785530000"
}
],
"isKit": false,
"itemId": "2000534",
"measurementUnit": "un",
"modalType": "",
"name": "1",
"nameComplete": "Top Wood Clock 1",
"referenceId": [
{
"Key": "RefId",
"Value": "16001"
}
],
"sellers": [
{
"addToCartLink": "",
"commertialOffer": {
"AvailableQuantity": 10000,
"BuyTogether": [],
"CacheVersionUsedToCallCheckout": "",
"DeliverySlaSamples": [],
"DeliverySlaSamplesPerRegion": {},
"GetInfoErrorMessage": null,
"GiftSkuIds": [],
"Installments": [
{
"InterestRate": 0,
"Name": "American Express à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "American Express",
"TotalValuePlusInterestRate": 197.99,
"Value": 197.99
},
{
"InterestRate": 0,
"Name": "Visa à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Visa",
"TotalValuePlusInterestRate": 197.99,
"Value": 197.99
},
{
"InterestRate": 0,
"Name": "Visa 2 vezes sem juros",
"NumberOfInstallments": 2,
"PaymentSystemName": "Visa",
"TotalValuePlusInterestRate": 197.99,
"Value": 98.99
},
{
"InterestRate": 0,
"Name": "Visa 3 vezes sem juros",
"NumberOfInstallments": 3,
"PaymentSystemName": "Visa",
"TotalValuePlusInterestRate": 197.99,
"Value": 65.99
},
{
"InterestRate": 0,
"Name": "Visa 4 vezes sem juros",
"NumberOfInstallments": 4,
"PaymentSystemName": "Visa",
"TotalValuePlusInterestRate": 197.99,
"Value": 49.49
},
{
"InterestRate": 0,
"Name": "Visa 5 vezes sem juros",
"NumberOfInstallments": 5,
"PaymentSystemName": "Visa",
"TotalValuePlusInterestRate": 197.99,
"Value": 39.59
},
{
"InterestRate": 0,
"Name": "Visa 6 vezes sem juros",
"NumberOfInstallments": 6,
"PaymentSystemName": "Visa",
"TotalValuePlusInterestRate": 197.99,
"Value": 32.99
},
{
"InterestRate": 0,
"Name": "Diners à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Diners",
"TotalValuePlusInterestRate": 197.99,
"Value": 197.99
},
{
"InterestRate": 100,
"Name": "Diners 2 vezes com juros",
"NumberOfInstallments": 2,
"PaymentSystemName": "Diners",
"TotalValuePlusInterestRate": 200.96,
"Value": 100.48
},
{
"InterestRate": 0,
"Name": "Mastercard à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Mastercard",
"TotalValuePlusInterestRate": 197.99,
"Value": 197.99
},
{
"InterestRate": 0,
"Name": "Boleto Bancário à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Boleto Bancário",
"TotalValuePlusInterestRate": 197.99,
"Value": 197.99
},
{
"InterestRate": 0,
"Name": "Vale à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Vale",
"TotalValuePlusInterestRate": 197.99,
"Value": 197.99
},
{
"InterestRate": 0,
"Name": "Promissory à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Promissory",
"TotalValuePlusInterestRate": 197.99,
"Value": 197.99
},
{
"InterestRate": 0,
"Name": "Customer Credit à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Customer Credit",
"TotalValuePlusInterestRate": 197.99,
"Value": 197.99
},
{
"InterestRate": 0,
"Name": "Customer Credit 2 vezes sem juros",
"NumberOfInstallments": 2,
"PaymentSystemName": "Customer Credit",
"TotalValuePlusInterestRate": 197.99,
"Value": 98.99
},
{
"InterestRate": 100,
"Name": "Customer Credit 3 vezes com juros",
"NumberOfInstallments": 3,
"PaymentSystemName": "Customer Credit",
"TotalValuePlusInterestRate": 203.91,
"Value": 67.97
},
{
"InterestRate": 0,
"Name": "Free à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Free",
"TotalValuePlusInterestRate": 197.99,
"Value": 197.99
}
],
"ItemMetadataAttachment": [],
"ListPrice": 197.99,
"Price": 197.99,
"PriceValidUntil": "2023-04-01T13:13:20Z",
"PriceWithoutDiscount": 197.99,
"RewardValue": 0,
"Tax": 0,
"discountHighlights": [],
"spotPrice": 197.99,
"taxPercentage": 0,
"teasers": [
{
"conditions": {
"minimumQuantity": 0,
"parameters": [
{
"name": "PaymentMethodId",
"value": "6"
}
]
},
"effects": {
"parameters": [
{
"name": "PercentualDiscount",
"value": "8.0"
}
]
},
"name": "8% Boleto"
}
]
},
"sellerDefault": true,
"sellerId": "1",
"sellerName": "VTEX"
}
],
"unitMultiplier": 1,
"variations": [],
"videos": []
}
],
"link": "/wood-clock/p",
"linkText": "wood-clock",
"origin": "intelligent-search",
"priceRange": {
"listPrice": {
"highPrice": 197.99,
"lowPrice": 197.99
},
"sellingPrice": {
"highPrice": 197.99,
"lowPrice": 197.99
}
},
"productClusters": [
{
"id": "1970",
"name": "Summer"
}
],
"productId": "2000003",
"productName": "Top Wood Clock",
"productReference": "clock120",
"properties": [
{
"name": "sellerId",
"originalName": "sellerId",
"values": [
"1"
]
}
],
"skuSpecifications": [],
"specificationGroups": [
{
"name": "allSpecifications",
"originalName": "allSpecifications",
"specifications": [
{
"name": "sellerId",
"originalName": "sellerId",
"values": [
"1"
]
}
]
}
]
},
{
"brand": "Sony",
"brandId": 2000005,
"cacheId": "sp-2000214",
"categories": [
"/Home & Decor/"
],
"categoriesIds": [
"/40/"
],
"categoryId": "40",
"clusterHighlights": [],
"description": "",
"items": [
{
"attachments": [],
"complementName": "",
"ean": "2398428937489",
"images": [
{
"cacheId": "155675",
"imageId": "155675",
"imageLabel": "vtex",
"imageTag": "",
"imageText": "vtex",
"imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155675/vtex.jpg?v=637655270451200000"
}
],
"isKit": false,
"itemId": "310124211",
"measurementUnit": "un",
"modalType": "",
"name": "kevin1sku",
"nameComplete": "kevin1sku",
"referenceId": [
{
"Key": "RefId",
"Value": "2983678w63478"
}
],
"sellers": [
{
"addToCartLink": "",
"commertialOffer": {
"AvailableQuantity": 10000,
"BuyTogether": [],
"CacheVersionUsedToCallCheckout": "",
"DeliverySlaSamples": [],
"DeliverySlaSamplesPerRegion": {},
"GetInfoErrorMessage": null,
"GiftSkuIds": [],
"Installments": [
{
"InterestRate": 0,
"Name": "American Express à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "American Express",
"TotalValuePlusInterestRate": 10,
"Value": 10
},
{
"InterestRate": 0,
"Name": "Visa à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Visa",
"TotalValuePlusInterestRate": 10,
"Value": 10
},
{
"InterestRate": 0,
"Name": "Diners à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Diners",
"TotalValuePlusInterestRate": 10,
"Value": 10
},
{
"InterestRate": 0,
"Name": "Mastercard à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Mastercard",
"TotalValuePlusInterestRate": 10,
"Value": 10
},
{
"InterestRate": 0,
"Name": "Boleto Bancário à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Boleto Bancário",
"TotalValuePlusInterestRate": 10,
"Value": 10
},
{
"InterestRate": 0,
"Name": "Vale à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Vale",
"TotalValuePlusInterestRate": 10,
"Value": 10
},
{
"InterestRate": 0,
"Name": "Promissory à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Promissory",
"TotalValuePlusInterestRate": 10,
"Value": 10
},
{
"InterestRate": 0,
"Name": "Customer Credit à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Customer Credit",
"TotalValuePlusInterestRate": 10,
"Value": 10
},
{
"InterestRate": 0,
"Name": "Customer Credit 2 vezes sem juros",
"NumberOfInstallments": 2,
"PaymentSystemName": "Customer Credit",
"TotalValuePlusInterestRate": 10,
"Value": 5
},
{
"InterestRate": 100,
"Name": "Customer Credit 3 vezes com juros",
"NumberOfInstallments": 3,
"PaymentSystemName": "Customer Credit",
"TotalValuePlusInterestRate": 10.29,
"Value": 3.43
},
{
"InterestRate": 0,
"Name": "Free à vista",
"NumberOfInstallments": 1,
"PaymentSystemName": "Free",
"TotalValuePlusInterestRate": 10,
"Value": 10
}
],
"ItemMetadataAttachment": [],
"ListPrice": 10,
"Price": 10,
"PriceValidUntil": "2023-04-01T13:13:20Z",
"PriceWithoutDiscount": 10,
"RewardValue": 0,
"Tax": 0,
"discountHighlights": [],
"spotPrice": 10,
"taxPercentage": 0,
"teasers": [
{
"conditions": {
"minimumQuantity": 0,
"parameters": [
{
"name": "PaymentMethodId",
"value": "6"
}
]
},
"effects": {
"parameters": [
{
"name": "PercentualDiscount",
"value": "8.0"
}
]
},
"name": "8% Boleto"
}
]
},
"sellerDefault": true,
"sellerId": "1",
"sellerName": "VTEX"
}
],
"unitMultiplier": 1,
"variations": [],
"videos": []
}
],
"link": "/kevin1-lkn/p",
"linkText": "kevin1-lkn",
"origin": "intelligent-search",
"priceRange": {
"listPrice": {
"highPrice": 10,
"lowPrice": 10
},
"sellingPrice": {
"highPrice": 10,
"lowPrice": 10
}
},
"productClusters": [],
"productId": "2000214",
"productName": "kevin1",
"properties": [
{
"name": "sellerId",
"originalName": "sellerId",
"values": [
"1"
]
}
],
"skuSpecifications": [],
"specificationGroups": [
{
"name": "allSpecifications",
"originalName": "allSpecifications",
"specifications": [
{
"name": "sellerId",
"originalName": "sellerId",
"values": [
"1"
]
}
]
}
]
}
],
"recordsFiltered": 5,
"translated": false
}