Properties
| Name | Type | Description |
|---|---|---|
| products | array | List of active products. |
| recordsFiltered | number | Total number of filtered active products. |
| correction | object | Object with information of misspelled terms. |
| fuzzy | string | Indicates how the search engine corrected the misspelled word by using fuzzy logic. It can be a number representing the max number of misspelled letters, or the string `auto` suggesting that the searc |
| operator | string | Indicates how the search-engine dealt with the fullText when there is more than one word. * `and` - It means that the products contains all the words in the query. * `or` - It means that the results w |
| translated | boolean | Defines whether the list of products was translated by Intelligent Search (`true`) or not (`false`). |
| pagination | object | Pagination information. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ProductSearch",
"title": "ProductSearch",
"type": "object",
"description": "Response body object.",
"properties": {
"products": {
"type": "array",
"description": "List of active products.",
"items": {
"type": "object",
"description": "Product information.",
"properties": {
"cacheId": {
"description": "Cache ID.",
"type": "string"
},
"productId": {
"description": "Product unique identifier.",
"type": "string"
},
"description": {
"description": "Product description.",
"type": "string"
},
"productName": {
"description": "Product name.",
"type": "string"
},
"productReference": {
"description": "Product reference code.",
"type": "string"
},
"linkText": {
"description": "Product text link.",
"type": "string"
},
"brand": {
"description": "Brand name.",
"type": "string"
},
"brandId": {
"description": "Brand unique identifier.",
"type": "number"
},
"link": {
"description": "Product slug in the store.",
"type": "string"
},
"categories": {
"description": "Category path.",
"type": "array",
"items": {
"description": "Category name.",
"type": "string"
}
},
"categoryId": {
"description": "Category unique identifier.",
"type": "string"
},
"categoriesIds": {
"description": "List of category IDs in the corresponding category path.",
"type": "array",
"items": {
"description": "Category ID.",
"type": "string"
}
},
"priceRange": {
"description": "Price range information.",
"type": "object",
"properties": {
"sellingPrice": {
"description": "Selling price.",
"type": "object",
"properties": {
"highPrice": {
"description": "Highest selling price.",
"type": "number"
},
"lowPrice": {
"description": "Lowest selling price.",
"type": "number"
}
}
},
"listPrice": {
"description": "List price information.",
"type": "object",
"properties": {
"highPrice": {
"description": "Highest list price.",
"type": "number"
},
"lowPrice": {
"description": "Lowest list price.",
"type": "number"
}
}
}
}
},
"specificationGroups": {
"description": "Specification groups information.",
"type": "array",
"items": {
"description": "Specification group information.",
"type": "object",
"properties": {
"originalName": {
"description": "Speficiation group original name.",
"type": "string"
},
"name": {
"description": "Specification group name.",
"type": "string"
},
"specifications": {
"description": "List of specifications.",
"type": "array",
"items": {
"description": "Specification information.",
"type": "object",
"properties": {
"originalName": {
"description": "Specification original name.",
"type": "string"
},
"name": {
"description": "Specification name.",
"type": "string"
},
"values": {
"description": "Specification values.",
"type": "array",
"items": {
"description": "Specification value.",
"type": "string"
}
}
}
}
}
}
}
},
"skuSpecifications": {
"description": "SKU specifications.",
"type": "array",
"items": {
"description": "SKU specification information.",
"type": "object",
"properties": {
"field": {
"description": "SKU specification field information.",
"type": "object",
"properties": {
"name": {
"description": "SKU specification field name.",
"type": "string"
},
"originalName": {
"description": "SKU specification field original name.",
"type": "string"
}
}
},
"values": {
"description": "SKU specification field values.",
"type": "array",
"items": {
"description": "SKU specification value.",
"type": "object",
"properties": {
"name": {
"description": "SKU specification value name.",
"type": "string"
},
"originalName": {
"description": "SKU specification value original name.",
"type": "string"
}
}
}
}
}
}
},
"productClusters": {
"description": "Product clusters information.",
"type": "array",
"items": {
"description": "Product cluster information.",
"type": "object",
"properties": {
"id": {
"description": "Product cluster unique identifier.",
"type": "string"
},
"name": {
"description": "Product cluster name.",
"type": "string"
}
}
}
},
"clusterHighlights": {
"description": "Cluster highlights information.",
"type": "array",
"items": {
"description": "Cluster highlight information.",
"type": "object",
"properties": {
"id": {
"description": "Product cluster unique identifier.",
"type": "string"
},
"name": {
"description": "Product cluster name.",
"type": "string"
}
}
}
},
"properties": {
"description": "Product properties.",
"type": "array",
"items": {
"description": "Product property.",
"type": "object",
"properties": {
"name": {
"description": "Property name.",
"type": "string"
},
"originalName": {
"description": "Property original name.",
"type": "string"
},
"values": {
"description": "Property values.",
"type": "array",
"items": {
"description": "Property value.",
"type": "string"
}
}
}
}
},
"items": {
"description": "Information about the related SKUs.",
"type": "array",
"items": {
"description": "SKU information.",
"type": "object",
"additionalProperties": true,
"properties": {
"sellers": {
"description": "List of sellers.",
"type": "array",
"items": {
"description": "Seller information.",
"type": "object",
"properties": {
"sellerId": {
"description": "Seller unique identifier.",
"type": "string"
},
"sellerName": {
"description": "Seller name.",
"type": "string"
},
"addToCartLink": {
"description": "Add to cart link.",
"type": "string"
},
"sellerDefault": {
"description": "Default seller.",
"type": "boolean"
},
"commertialOffer": {
"description": "Commercial offer information.",
"type": "object",
"properties": {
"DeliverySlaSamplesPerRegion": {
"description": "Delivery SLA samples per region.",
"type": "object",
"additionalProperties": true
},
"DeliverySlaSamples": {
"description": "Delivery SLA samples.",
"type": "array",
"items": {
"type": "object",
"description": "Delivery SLA sample.",
"properties": {
"DeliverySlaPerTypes": {
"type": "array",
"description": "Delivery SLA per types."
},
"Region": {
"type": "string",
"description": "Region.",
"nullable": true
}
}
}
},
"AvailableQuantity": {
"description": "Available quantity of the item.",
"type": "number"
},
"discountHighlights": {
"description": "Discount highlights.",
"type": "array",
"items": {
"type": "object",
"description": "Discount highlight information.",
"properties": {
"name": {
"type": "string",
"description": "Discount highlight name."
}
}
}
},
"Installments": {
"description": "Installments information.",
"type": "array",
"items": {
"description": "Installment information.",
"type": "object",
"properties": {
"PaymentSystemName": {
"description": "Payment system name.",
"type": "string"
},
"Value": {
"description": "Total value.",
"type": "number"
},
"InterestRate": {
"description": "Interest rate.",
"type": "number"
},
"TotalValuePlusInterestRate": {
"description": "Total value plus interest rate.",
"type": "number"
},
"NumberOfInstallments": {
"description": "Number of installments.",
"type": "number"
},
"Name": {
"description": "Payment condition name.",
"type": "string"
},
"PaymentSystemGroupName": {
"description": "Payment system group.",
"type": "string"
}
}
}
},
"Price": {
"description": "Price of the item.",
"type": "number"
},
"ListPrice": {
"description": "List price of the item.",
"type": "number"
},
"spotPrice": {
"description": "Spot price.",
"type": "number"
},
"taxPercentage": {
"description": "Tax percentage.",
"type": "number"
},
"PriceWithoutDiscount": {
"description": "Price with discount.",
"type": "number"
},
"Tax": {
"description": "Tax value.",
"type": "number"
},
"GiftSkuIds": {
"description": "List of SKU gifts IDs.",
"type": "array",
"items": {
"type": "string",
"description": "SKU gift unique identifier."
}
},
"BuyTogether": {
"description": "Array of other items that can be bought together with the item in question.",
"type": "array",
"items": {
"type": "string",
"description": "Unique identifier of each SKU that can be bought together."
}
},
"ItemMetadataAttachment": {
"description": "Item metadata attachment.",
"type": "array",
"items": {
"description": "Item metadata attachment information.",
"type": "object",
"properties": {
"Name": {
"description": "SKU name.",
"type": "string"
},
"NameComplete": {
"description": "Complete name of the product combined with the SKU name.",
"type": "string"
},
"MainImage": {
"description": "Main image URL.",
"type": "string"
},
"BrandName": {
"description": "Brand name.",
"type": "string"
},
"CategoryId": {
"description": "Category unique identifier.",
"type": "number"
},
"ProductId": {
"description": "Product unique identifier.",
"type": "number"
},
"id": {
"description": "SKU unique identifier.",
"type": "string"
},
"seller": {
"description": "Seller unique identifier.",
"type": "string"
},
"assemblyOptions": {
"description": "Assembly options attachment.",
"type": "array",
"items": {
"description": "Assembly options attachment information.",
"properties": {
"id": {
"description": "Attachment unique identifier.",
"type": "string"
},
"name": {
"description": "Attachment name.",
"type": "string"
},
"required": {
"description": "Defines whether the attachment is required (`true`) or not (`false`).",
"type": "boolean"
},
"inputValues": {
"description": "Input values information.",
"type": "object",
"additionalProperties": true
}
}
}
}
}
}
},
"RewardValue": {
"description": "Credit that the customer receives when finalizing an order that includes the SKU. By filling this field out with `1`, the customer receives credit on the site in the selected currency, e.g. U$ 1.",
"type": "number"
},
"PriceValidUntil": {
"description": "Date until the price is valid, in ISO 8601 format.",
"type": "string"
},
"GetInfoErrorMessage": {
"description": "Get info error message.",
"type": "string",
"nullable": true
},
"CacheVersionUsedToCallCheckout": {
"description": "Cache version used to call Checkout.",
"type": "string"
},
"teasers": {
"description": "Teasers information.",
"type": "array",
"items": {
"description": "Teaser information.",
"type": "object",
"properties": {
"name": {
"description": "Promotion name.",
"type": "string"
},
"conditions": {
"description": "Conditions for the promotion the be valid.",
"type": "object",
"properties": {
"minimumQuantity": {
"description": "Minimum quantity of the item for the promotion to be valid.",
"type": "number"
},
"parameters": {
"description": "Condition parameters.",
"type": "array",
"items": {
"description": "Condition parameters.",
"type": "object",
"properties": {
"name": {
"description": "Condition name.",
"type": "string"
},
"value": {
"description": "Condition value.",
"type": "string"
}
}
}
}
}
},
"effects": {
"description": "Promotion effects.",
"type": "object",
"properties": {
"parameters": {
"description": "Effects parameters.",
"type": "array",
"items": {
"description": "Effect parameters.",
"type": "object",
"properties": {
"name": {
"description": "Effect name.",
"type": "string"
},
"value": {
"description": "Effect value.",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"images": {
"description": "SKU images information.",
"type": "array",
"items": {
"description": "SKU image information.",
"type": "object",
"properties": {
"imageId": {
"description": "Image unique identifier.",
"type": "string"
},
"cacheId": {
"description": "Cache ID.",
"type": "string"
},
"imageTag": {
"description": "HTML tag for the selected image.",
"type": "string"
},
"imageLabel": {
"description": "Image label.",
"type": "string"
},
"imageText": {
"description": "Image text.",
"type": "string"
},
"imageUrl": {
"description": "Image URL.",
"type": "string"
}
}
}
},
"itemId": {
"description": "SKU unique identifier.",
"type": "string"
},
"name": {
"description": "SKU name.",
"type": "string"
},
"nameComplete": {
"description": "Combination of the product name with the SKU name.",
"type": "string"
},
"complementName": {
"description": "Complement name.",
"type": "string"
},
"referenceId": {
"description": "SKU alternate IDs.",
"type": "array",
"items": {
"description": "Alternate ID information.",
"type": "object",
"properties": {
"Key": {
"description": "Alternate ID key.",
"type": "string"
},
"Value": {
"description": "Alternate ID value.",
"type": "string"
}
}
}
},
"measurementUnit": {
"description": "Measurement unit. This field should only be used when it is necessary to convert the unit of measure for sale. For example, if a product is sold in boxes, but customers want to buy per square meter (m\u00b2). In common cases, use `'un'`.",
"type": "string"
},
"unitMultiplier": {
"description": "Multiple number of SKU. If the multiplier is 5.0000, the product can be added in multiple quantities of 5, 10, 15, 20, onward.",
"type": "number"
},
"variations": {
"description": "Variations.",
"type": "array",
"items": {
"description": "Variation information.",
"type": "object",
"properties": {
"name": {
"description": "Variation name.",
"type": "string"
},
"values": {
"description": "Variation values.",
"type": "array",
"items": {
"description": "Variation value.",
"type": "string"
}
}
}
}
},
"ean": {
"description": "EAN value.",
"type": "string"
},
"modalType": {
"description": "Links an unusual type of SKU that needs special transportation, such as meat, glass, or a mattress, to a carrier specialized in delivering it. This field should be filled in with the name of the modal (e.g. \"Chemicals\" or \"Refrigerated products\"). To learn more about this feature, read our articles [How the modal works](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) and [Setting up modal for carriers](https://help.vtex.com/en/tutorial/configure-modal--3jhLqxuPhuiq24UoykCcqy).",
"type": "string"
},
"videos": {
"description": "SKU videos.",
"type": "array",
"items": {
"type": "string",
"description": "Video URL."
}
},
"attachments": {
"description": "Array with information about the attachments that are related to the SKU.",
"type": "array",
"items": {
"type": "object",
"description": "Attachment information.",
"properties": {
"id": {
"type": "string",
"description": "Attachment unique identifier."
},
"name": {
"type": "string",
"description": "Attachment name."
},
"required": {
"type": "boolean",
"description": "Defines if the attachment is required (`true`) or not (`false`)."
},
"domainValues": {
"type": "array",
"description": "Attachment domain values.",
"items": {
"type": "object",
"description": "Attachment information.",
"properties": {
"FieldName": {
"type": "string",
"description": "Attachment name."
},
"DomainValues": {
"type": "string",
"description": "Attachment value."
}
}
}
}
}
}
},
"isKit": {
"description": "Defines whether the SKU is made up of one or more SKUs (part of a kit) (`true`) or not (`false`). Must be enabled if you are adding a kit. Once activated, this definition cannot be reverted.",
"type": "boolean"
}
}
}
},
"releaseDate": {
"description": "Release date.",
"type": "number"
},
"origin": {
"description": "Origin of products in the trade policy.",
"type": "string"
}
}
}
},
"recordsFiltered": {
"type": "number",
"description": "Total number of filtered active products."
},
"correction": {
"type": "object",
"description": "Object with information of misspelled terms.",
"properties": {
"misspelled": {
"type": "boolean",
"description": "Defines whether the term is misspelled (`true`) or not (`false`)."
}
}
},
"fuzzy": {
"type": "string",
"description": "Indicates how the search engine corrected the misspelled word by using fuzzy logic. It can be a number representing the max number of misspelled letters, or the string `auto` suggesting that the search-engine should set this value by itself."
},
"operator": {
"type": "string",
"enum": [
"and",
"or"
],
"description": "Indicates how the search-engine dealt with the fullText when there is more than one word.\n * `and` - It means that the products contains all the words in the query.\n * `or` - It means that the results will contain at least one word from the original search query. If `and` was not possible, `or` will be the fallback."
},
"translated": {
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/json-schema/vtex-productsearch-schema.json