Search
Search for products
Retrieves general information about the products related to the term searched. This is the main search used by the store. The user can type anything to be searched.
For example, if they search for a "decanter", this is the URL: https://{{accountName}}.{{environment}}.com.br/api/catalog_system/pub/products/search/decanter.
Note that maybe the response can be HTTP 200 or 206, 206 means that it's a partial content response.
If it is a 206 take a look at the Headers, will be an entry called resources. E.g.: resources → 0-9/19. This means that the response is showing items from 0 to 9, 10 items, but there were 19 items found. See more information at the paging route example.
get/api/catalog_system/pub/products/search/{search}
Path parameters
searchstring required
Example:jacket
Term used to search products
Headers
Acceptstring required
Example:application/json
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Content-Typestring required
Example:application/json
Describes the type of the content being sent.
Response
OK
Example response
[
{
"productId": "35",
"productName": "Kit de Hoegaarden",
"brand": "Hoegaarden",
"brandId": 2000004,
"brandImageUrl": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg",
"linkText": "kit-6-cerveja-hoegaarden",
"productReference": "000806",
"productReferenceCode": 1234,
"categoryId": "1",
"productTitle": "Kit 6 cerveja Hoegaarden",
"metaTagDescription": "Category for Beers",
"releaseDate": "2020-10-07T00:00:00",
"clusterHighlights": {
"138": "teste2"
},
"productClusters": {
"138": "teste2",
"143": "NaoPesquisavel",
"146": "colecaotestesubcategoria",
"161": "merch_import_test1"
},
"searchableClusters": {
"138": "teste2"
},
"categories": [
"/Beers Beers Mesmo/"
],
"categoriesIds": [
"/1/"
],
"link": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p",
"allSpecifications": [
"Percentuals",
"Percentual"
],
"allSpecificationsGroups": [
"Total",
"Teste da Api2"
],
"description": "Description example",
"items": [
{
"itemId": "310118469",
"name": "Kit com 6",
"nameComplete": "Kit de Hoegaarden Kit com 6",
"complementName": "",
"ean": "",
"referenceId": [
{
"Key": "RefId",
"Value": "000806"
}
],
"measurementUnit": "un",
"unitMultiplier": 1,
"modalType": null,
"isKit": true,
"kitItems": [
{
"itemId": "310118466",
"amount": 6
}
],
"images": [
{
"imageId": "155489",
"imageLabel": "",
"imageTag": "<img src=\"~/arquivos/ids/155489-#width#-#height#/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000\" width=\"#width#\" height=\"#height#\" alt=\"hoegaarden-kit\" id=\"\" />",
"imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
"imageText": "hoegaarden-kit",
"imageLastModified": "2020-10-07T12:49:27.5800000Z"
}
],
"sellers": [
{
"sellerId": "1",
"sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
"addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
"sellerDefault": true,
"commertialOffer": {
"DeliverySlaSamplesPerRegion": {
"0": {
"DeliverySlaPerTypes": [],
"Region": null
}
},
"Installments": [
{
"Value": 42,
"InterestRate": 0,
"TotalValuePlusInterestRate": 42,
"NumberOfInstallments": 1,
"PaymentSystemName": "Visa",
"PaymentSystemGroupName": "creditCardPaymentGroup",
"Name": "Visa à vista"
},
{
"Value": 21,
"InterestRate": 0,
"TotalValuePlusInterestRate": 42,
"NumberOfInstallments": 2,
"PaymentSystemName": "Visa",
"PaymentSystemGroupName": "creditCardPaymentGroup",
"Name": "Visa 2 vezes sem juros"
},
{
"Value": 14,
"InterestRate": 0,
"TotalValuePlusInterestRate": 42,
"NumberOfInstallments": 3,
"PaymentSystemName": "Visa",
"PaymentSystemGroupName": "creditCardPaymentGroup",
"Name": "Visa 3 vezes sem juros"
},
{
"Value": 10.5,
"InterestRate": 0,
"TotalValuePlusInterestRate": 42,
"NumberOfInstallments": 4,
"PaymentSystemName": "Visa",
"PaymentSystemGroupName": "creditCardPaymentGroup",
"Name": "Visa 4 vezes sem juros"
},
{
"Value": 42,
"InterestRate": 0,
"TotalValuePlusInterestRate": 42,
"NumberOfInstallments": 1,
"PaymentSystemName": "Promissory",
"PaymentSystemGroupName": "promissoryPaymentGroup",
"Name": "Promissory à vista"
}
],
"DiscountHighLight": [],
"GiftSkuIds": [],
"Teasers": [
{
"<Name>k__BackingField": "TesteInfoAdicional",
"<GeneralValues>k__BackingField": {
"Time": "Flamengo",
"Nome": "Pedro",
"Camisa": "9"
},
"<Conditions>k__BackingField": {
"<MinimumQuantity>k__BackingField": 0,
"<Parameters>k__BackingField": [
{
"<Name>k__BackingField": "PaymentMethodId",
"<Value>k__BackingField": "4"
}
]
},
"<Effects>k__BackingField": {
"<Parameters>k__BackingField": [
{
"<Name>k__BackingField": "PercentualDiscount",
"<Value>k__BackingField": "1"
}
]
}
}
],
"PromotionTeasers": [
{
"Name": "TesteInfoAdicional",
"GeneralValues": {
"Time": "Flamengo",
"Nome": "Pedro",
"Camisa": "9"
},
"Conditions": {
"MinimumQuantity": 0,
"Parameters": [
{
"Name": "PaymentMethodId",
"Value": "4"
}
]
},
"Effects": {
"Parameters": [
{
"Name": "PercentualDiscount",
"Value": "1"
}
]
}
}
],
"BuyTogether": [],
"ItemMetadataAttachment": [],
"Price": 42,
"ListPrice": 42,
"PriceWithoutDiscount": 42,
"RewardValue": 0,
"PriceValidUntil": "4000-01-01T03:00:00Z",
"AvailableQuantity": 16,
"IsAvailable": true,
"Tax": 0,
"SaleChannel": 0,
"DeliverySlaSamples": [
{
"DeliverySlaPerTypes": [],
"Region": null
}
],
"GetInfoErrorMessage": null,
"CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_",
"PaymentOptions": {
"installmentOptions": [
{
"paymentSystem": "2",
"bin": null,
"paymentName": "Visa",
"paymentGroupName": "creditCardPaymentGroup",
"value": 4200,
"installments": [
{
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 4200,
"total": 4200,
"sellerMerchantInstallments": [
{
"id": "MERCH",
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 4200,
"total": 4200
}
]
},
{
"count": 2,
"hasInterestRate": false,
"interestRate": 0,
"value": 2100,
"total": 4200,
"sellerMerchantInstallments": [
{
"id": "MERCH",
"count": 2,
"hasInterestRate": false,
"interestRate": 0,
"value": 2100,
"total": 4200
}
]
},
{
"count": 3,
"hasInterestRate": false,
"interestRate": 0,
"value": 1400,
"total": 4200,
"sellerMerchantInstallments": [
{
"id": "MERCH",
"count": 3,
"hasInterestRate": false,
"interestRate": 0,
"value": 1400,
"total": 4200
}
]
},
{
"count": 4,
"hasInterestRate": false,
"interestRate": 0,
"value": 1050,
"total": 4200,
"sellerMerchantInstallments": [
{
"id": "MERCH",
"count": 4,
"hasInterestRate": false,
"interestRate": 0,
"value": 1050,
"total": 4200
}
]
}
]
},
{
"paymentSystem": "17",
"bin": null,
"paymentName": "Promissory",
"paymentGroupName": "promissoryPaymentGroup",
"value": 4200,
"installments": [
{
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 4200,
"total": 4200,
"sellerMerchantInstallments": [
{
"id": "MERCH",
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 4200,
"total": 4200
}
]
}
]
}
],
"paymentSystems": [
{
"id": 17,
"name": "Promissory",
"groupName": "promissoryPaymentGroup",
"validator": null,
"stringId": "17",
"template": "promissoryPaymentGroup-template",
"requiresDocument": false,
"isCustom": false,
"description": null,
"requiresAuthentication": false,
"dueDate": "2021-07-01T18:43:00.0264384Z",
"availablePayments": null
},
{
"id": 2,
"name": "Visa",
"groupName": "creditCardPaymentGroup",
"validator": null,
"stringId": "2",
"template": "creditCardPaymentGroup-template",
"requiresDocument": false,
"isCustom": false,
"description": null,
"requiresAuthentication": false,
"dueDate": "2021-07-01T18:43:00.0264384Z",
"availablePayments": null
}
],
"payments": [],
"giftCards": [],
"giftCardMessages": [],
"availableAccounts": [],
"availableTokens": []
}
}
}
],
"Videos": [],
"estimatedDateArrival": null
}
]
}
]