VTEX · Example Payload
Vtex Get Product Searchfacets Example
CommerceE-CommerceRetailMarketplacePayments
Vtex Get Product Searchfacets Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "get-product-searchfacets",
"method": "GET",
"path": "/product_search/{facets}",
"summary": "VTex Get list of products for a query",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"products": [
{
"cacheId": "sp-2000003",
"productId": "2000003",
"description": "Introducing our exquisite Top Wood Clock, a timeless blend of elegance and craftsmanship. Crafted from premium-quality wood, this clock seamlessly combines functionality with aesthetic appeal. Its sleek design and rich wood finish make it a sophisticated addition to any space, from classic to contemporary interiors.",
"productName": "Top Wood Clock",
"productReference": "clock120",
"linkText": "wood-clock",
"brand": "Sony",
"brandId": 2000005,
"link": "/wood-clock/p",
"categories": [
"/Home & Decor/"
],
"categoryId": "40",
"categoriesIds": [
"/40/"
],
"priceRange": {
"sellingPrice": {
"highPrice": 197.99,
"lowPrice": 197.99
},
"listPrice": {
"highPrice": 197.99,
"lowPrice": 197.99
}
},
"specificationGroups": [
{
"originalName": "allSpecifications",
"name": "allSpecifications",
"specifications": [
{
"originalName": "sellerId",
"name": "sellerId",
"values": [
"1"
]
}
]
}
],
"skuSpecifications": [],
"productClusters": [
{
"id": "1970",
"name": "Summer"
}
],
"clusterHighlights": [
{
"id": "1970",
"name": "Summer"
}
],
"properties": [
{
"name": "sellerId",
"originalName": "sellerId",
"values": [
"1"
]
}
],
"items": [
{
"sellers": [
{
"sellerId": "1",
"sellerName": "VTEX",
"addToCartLink": "",
"sellerDefault": true,
"commertialOffer": {
"DeliverySlaSamplesPerRegion": {},
"DeliverySlaSamples": [],
"AvailableQuantity": 10000,
"discountHighlights": [],
"Installments": [
{
"Value": 197.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 1,
"Name": "American Express \u00e0 vista",
"PaymentSystemName": "American Express"
},
{
"Value": 197.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 1,
"Name": "Visa \u00e0 vista",
"PaymentSystemName": "Visa"
},
{
"Value": 98.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 2,
"Name": "Visa 2 vezes sem juros",
"PaymentSystemName": "Visa"
},
{
"Value": 65.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 3,
"Name": "Visa 3 vezes sem juros",
"PaymentSystemName": "Visa"
},
{
"Value": 49.49,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 4,
"Name": "Visa 4 vezes sem juros",
"PaymentSystemName": "Visa"
},
{
"Value": 39.59,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 5,
"Name": "Visa 5 vezes sem juros",
"PaymentSystemName": "Visa"
},
{
"Value": 32.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 6,
"Name": "Visa 6 vezes sem juros",
"PaymentSystemName": "Visa"
},
{
"Value": 197.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 1,
"Name": "Diners \u00e0 vista",
"PaymentSystemName": "Diners"
},
{
"Value": 100.48,
"InterestRate": 100,
"TotalValuePlusInterestRate": 200.96,
"NumberOfInstallments": 2,
"Name": "Diners 2 vezes com juros",
"PaymentSystemName": "Diners"
},
{
"Value": 197.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 1,
"Name": "Mastercard \u00e0 vista",
"PaymentSystemName": "Mastercard"
},
{
"Value": 197.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 1,
"Name": "Boleto Banc\u00e1rio \u00e0 vista",
"PaymentSystemName": "Boleto Banc\u00e1rio"
},
{
"Value": 197.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 1,
"Name": "Vale \u00e0 vista",
"PaymentSystemName": "Vale"
},
{
"Value": 197.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 1,
"Name": "Promissory \u00e0 vista",
"PaymentSystemName": "Promissory"
},
{
"Value": 197.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 1,
"Name": "Customer Credit \u00e0 vista",
"PaymentSystemName": "Customer Credit"
},
{
"Value": 98.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 2,
"Name": "Customer Credit 2 vezes sem juros",
"PaymentSystemName": "Customer Credit"
},
{
"Value": 67.97,
"InterestRate": 100,
"TotalValuePlusInterestRate": 203.91,
"NumberOfInstallments": 3,
"Name": "Customer Credit 3 vezes com juros",
"PaymentSystemName": "Customer Credit"
},
{
"Value": 197.99,
"InterestRate": 0,
"TotalValuePlusInterestRate": 197.99,
"NumberOfInstallments": 1,
"Name": "Free \u00e0 vista",
"PaymentSystemName": "Free"
}
],
"Price": 197.99,
"ListPrice": 197.99,
"spotPrice": 197.99,
"taxPercentage": 0,
"PriceWithoutDiscount": 197.99,
"Tax": 0,
"GiftSkuIds": [],
"BuyTogether": [],
"ItemMetadataAttachment": [],
"RewardValue": 0,
"PriceValidUntil": "2023-04-01T13:13:20Z",
"GetInfoErrorMessage": null,
"CacheVersionUsedToCallCheckout": "",
"teasers": [
{
"name": "8% Boleto",
"conditions": {
"minimumQuantity": 0,
"parameters": [
{
"name": "PaymentMethodId",
"value": "6"
}
]
},
"effects": {
"parameters": [
{
"name": "PercentualDiscount",
"value": "8.0"
}
]
}
}
]
}
}
],
"images": [
{
"imageId": "155484",
"cacheId": "155484",
"imageTag": "",
"imageLabel": "",
"imageText": "",
"imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155484/Frame.jpg?v=636793817478300000"
},
{
"imageId": "155485",
"cacheId": "155485",
"imageTag": "",
"imageLabel": "",
"imageText": "",
"imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155485/Frame-1.jpg?v=636793817642000000"
},
{
"imageId": "155486",
"cacheId": "155486",
"imageTag": "",
"imageLabel": "",
"imageText": "",
"imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155486/Frame-2.jpg?v=636793817785530000"
}
],
"itemId": "2000534",
"name": "1",
"nameComplete": "Top Wood Clock 1",
"complementName": "",
"referenceId": [
{
"Key": "RefId",
"Value": "16001"
}
],
"measurementUnit": "un",
"unitMultiplier": 1,
"variations": [],
"ean": "16001",
"modalType": "",
"videos": [],
"attachments": [],
"isKit": false
}
],
"origin": "intelligent-search"
},
{
"cacheId": "sp-2000214",
"productId": "2000214",
"description": "",
"productName": "kevin1",
"linkText": "kevin1-lkn",
"brand": "Sony",
"brandId": 2000005,
"link": "/kevin1-lkn/p",
"categories": [
"/Home & Decor/"
],
"categoryId": "40",
"categoriesIds": [
"/40/"
],
"priceRange": {
"sellingPrice": {
"highPrice": 10,
"lowPrice": 10
},
"listPrice": {
"highPrice": 10,
"lowPrice": 10
}
},
"specificationGroups": [
{
"originalName": "allSpecifications",
"name": "allSpecifications",
"specifications": [
{
"originalName": "sellerId",
"name": "sellerId",
"values": [
"1"
]
}
]
}
],
"skuSpecifications": [],
"productClusters": [],
"clusterHighlights": [],
"properties": [
{
"name": "sellerId",
"originalName": "sellerId",
"values": [
"1"
]
}
],
"items": [
{
"sellers": [
{
"sellerId": "1",
"sellerName": "VTEX",
"addToCartLink": "",
"sellerDefault": true,
"commertialOffer": {
"DeliverySlaSamplesPerRegion": {},
"DeliverySlaSamples": [],
"AvailableQuantity": 10000,
"discountHighlights": [],
"Installments": [
{
"Value": 10,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 1,
"Name": "American Express \u00e0 vista",
"PaymentSystemName": "American Express"
},
{
"Value": 10,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 1,
"Name": "Visa \u00e0 vista",
"PaymentSystemName": "Visa"
},
{
"Value": 10,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 1,
"Name": "Diners \u00e0 vista",
"PaymentSystemName": "Diners"
},
{
"Value": 10,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 1,
"Name": "Mastercard \u00e0 vista",
"PaymentSystemName": "Mastercard"
},
{
"Value": 10,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 1,
"Name": "Boleto Banc\u00e1rio \u00e0 vista",
"PaymentSystemName": "Boleto Banc\u00e1rio"
},
{
"Value": 10,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 1,
"Name": "Vale \u00e0 vista",
"PaymentSystemName": "Vale"
},
{
"Value": 10,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 1,
"Name": "Promissory \u00e0 vista",
"PaymentSystemName": "Promissory"
},
{
"Value": 10,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 1,
"Name": "Customer Credit \u00e0 vista",
"PaymentSystemName": "Customer Credit"
},
{
"Value": 5,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 2,
"Name": "Customer Credit 2 vezes sem juros",
"PaymentSystemName": "Customer Credit"
},
{
"Value": 3.43,
"InterestRate": 100,
"TotalValuePlusInterestRate": 10.29,
"NumberOfInstallments": 3,
"Name": "Customer Credit 3 vezes com juros",
"PaymentSystemName": "Customer Credit"
},
{
"Value": 10,
"InterestRate": 0,
"TotalValuePlusInterestRate": 10,
"NumberOfInstallments": 1,
"Name": "Free \u00e0 vista",
"PaymentSystemName": "Free"
}
],
"Price": 10,
"ListPrice": 10,
"spotPrice": 10,
"taxPercentage": 0,
"PriceWithoutDiscount": 10,
"Tax": 0,
"GiftSkuIds": [],
"BuyTogether": [],
"ItemMetadataAttachment": [],
"RewardValue": 0,
"PriceValidUntil": "2023-04-01T13:13:20Z",
"GetInfoErrorMessage": null,
"CacheVersionUsedToCallCheckout": "",
"teasers": [
{
"name": "8% Boleto",
"conditions": {
"minimumQuantity": 0,
"parameters": [
{
"name": "PaymentMethodId",
"value": "6"
}
]
},
"effects": {
"parameters": [
{
"name": "PercentualDiscount",
"value": "8.0"
}
]
}
}
]
}
}
],
"images": [
{
"imageId": "155675",
"cacheId": "155675",
"imageTag": "",
"imageLabel": "vtex",
"imageText": "vtex",
"imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155675/vtex.jpg?v=637655270451200000"
}
],
"itemId": "310124211",
"name": "kevin1sku",
"nameComplete": "kevin1sku",
"complementName": "",
"referenceId": [
{
"Key": "RefId",
"Value": "2983678w63478"
}
],
"measurementUnit": "un",
"unitMultiplier": 1,
"variations": [],
"ean": "2398428937489",
"modalType": "",
"videos": [],
"attachments": [],
"isKit": false
}
],
"origin": "intelligent-search"
}
],
"recordsFiltered": 5,
"correction": {
"misspelled": false
},
"fuzzy": "0",
"operator": "and",
"translated": false
}
}
]
}