{ "openapi": "3.0.0", "info": { "version": "0.1.12", "title": "VTEX Ad Network API", "description": "VTEX Ad Network connects VTEX stores with brands interested in advertising their products. This connection allows advertisers and merchants to boost their business:\r\n\r\n* **Advertisers:** Brands that can create ad campaigns to promote products in VTEX stores offering the same products in their catalogs, thus increasing sales. \r\n\r\n* **Merchants:** Can offer ad space in their stores for advertisers to promote products. In return, these merchants will receive a fee for each click on an ad in their stores.\r\n\r\n> Learn more about [VTEX Ad Network](https://help.vtex.com/en/tutorial/vtex-ad-network-beta--2cgqXcBuJmXN2livQvClur).\r\n\r\n## Index\r\n### Sponsored products\r\n `GET` [Get sponsored products for a query](https://developers.vtex.com/docs/api-reference/vtex-ad-network-api#get-/sponsored_products/-facets-)\r\n## Common parameters \r\n\r\n| **Parameter name** | **Description** |\r\n| --------------- | ----------------- | \r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | \r\n| ` {{environment}}` | Environment to use. Used as part of the URL. |", "license": { "name": "MIT" } }, "servers": [ { "url": "https://{accountName}.{environment}.com.br/api/io/_v/api/intelligent-search", "description": "VTEX IO Intelligent Search server URL.", "variables": { "accountName": { "default": "apiexamples", "description": "Name of the VTEX account. Used as part of the URL." }, "environment": { "description": "Environment to use. Used as part of the URL.", "enum": [ "vtexcommercestable" ], "default": "vtexcommercestable" } } } ], "paths": { "/sponsored_products/{facets}": { "get": { "summary": "Get sponsored products for a query", "description": "Lists sponsored products for a given search query.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [authentication](https:\/\/developers.vtex.com\/docs\/guides\/authentication) or [permissions](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "tags": [ "Sponsored products" ], "parameters": [ { "$ref": "#/components/parameters/facetsPath" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/simulationBehavior" }, { "$ref": "#/components/parameters/locale" }, { "$ref": "#/components/parameters/hideUnavailableItems" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsoredProducts" }, "example": [ { "advertisement": { "adId": "88346159-1ec4-4c4b-a33c-fdd1a1080fdb", "campaignId": "7ecd769b-0572-444f-9719-0072887d1046", "actionCost": 0.25, "adRequestId": "522eccfe-83d6-4b26-aa4d-773d00986532", "adResponseId": "f4711939-ba78-4d46-899c-d38538a8c299" }, "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 à vista", "PaymentSystemName": "American Express" }, { "Value": 197.99, "InterestRate": 0, "TotalValuePlusInterestRate": 197.99, "NumberOfInstallments": 1, "Name": "Visa à 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 à 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 à vista", "PaymentSystemName": "Mastercard" }, { "Value": 197.99, "InterestRate": 0, "TotalValuePlusInterestRate": 197.99, "NumberOfInstallments": 1, "Name": "Boleto Bancário à vista", "PaymentSystemName": "Boleto Bancário" }, { "Value": 197.99, "InterestRate": 0, "TotalValuePlusInterestRate": 197.99, "NumberOfInstallments": 1, "Name": "Vale à vista", "PaymentSystemName": "Vale" }, { "Value": 197.99, "InterestRate": 0, "TotalValuePlusInterestRate": 197.99, "NumberOfInstallments": 1, "Name": "Promissory à vista", "PaymentSystemName": "Promissory" }, { "Value": 197.99, "InterestRate": 0, "TotalValuePlusInterestRate": 197.99, "NumberOfInstallments": 1, "Name": "Customer Credit à 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 à 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" }, { "advertisement": { "adId": "15f57fc4-06fb-4d31-8508-39db1826b366", "campaignId": "46ee9c36-52f5-4c80-9d1a-eb826cc15b47", "actionCost": 0.25, "adRequestId": "00003e4a-3623-4e55-aa8a-c9a73176fb9d", "adResponseId": "7e70c643-7f9a-4e5a-af2b-1d3cec658bef" }, "cacheId": "sp-2000214", "productId": "2000214", "description": "Introducing our stunning Metal Clock, a perfect blend of sophistication and durability. Crafted from high-quality metal, this clock seamlessly combines functionality with aesthetic appeal. Its sleek design and polished metal finish make it a stylish addition to any space, from modern to industrial interiors.", "productName": "Metal Clock", "linkText": "metal-clock-lkn", "brand": "Sony", "brandId": 2000005, "link": "/metal-clock-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 à vista", "PaymentSystemName": "American Express" }, { "Value": 10, "InterestRate": 0, "TotalValuePlusInterestRate": 10, "NumberOfInstallments": 1, "Name": "Visa à vista", "PaymentSystemName": "Visa" }, { "Value": 10, "InterestRate": 0, "TotalValuePlusInterestRate": 10, "NumberOfInstallments": 1, "Name": "Diners à vista", "PaymentSystemName": "Diners" }, { "Value": 10, "InterestRate": 0, "TotalValuePlusInterestRate": 10, "NumberOfInstallments": 1, "Name": "Mastercard à vista", "PaymentSystemName": "Mastercard" }, { "Value": 10, "InterestRate": 0, "TotalValuePlusInterestRate": 10, "NumberOfInstallments": 1, "Name": "Boleto Bancário à vista", "PaymentSystemName": "Boleto Bancário" }, { "Value": 10, "InterestRate": 0, "TotalValuePlusInterestRate": 10, "NumberOfInstallments": 1, "Name": "Vale à vista", "PaymentSystemName": "Vale" }, { "Value": 10, "InterestRate": 0, "TotalValuePlusInterestRate": 10, "NumberOfInstallments": 1, "Name": "Promissory à vista", "PaymentSystemName": "Promissory" }, { "Value": 10, "InterestRate": 0, "TotalValuePlusInterestRate": 10, "NumberOfInstallments": 1, "Name": "Customer Credit à 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 à 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": "Metal Clock 1", "nameComplete": "Metal Clock 1", "complementName": "", "referenceId": [ { "Key": "RefId", "Value": "2983678w63478" } ], "measurementUnit": "un", "unitMultiplier": 1, "variations": [], "ean": "2398428937489", "modalType": "", "videos": [], "attachments": [], "isKit": false } ], "origin": "intelligent-search" } ] } } } } } } }, "components": { "parameters": { "query": { "in": "query", "name": "query", "description": "Search term. It can contain any character.", "schema": { "type": "string", "example": "shirt" } }, "facetsPath": { "in": "path", "name": "facets", "required": true, "description": "## Format\r\n\r\nThe `facets` parameter follows the format: `/${facetKey1}/${facetValue1}/${facetKey2}/${facetValue2}/.../${facetKeyN}/${facetValueN}`.\r\n\r\nThe order in which the terms appear is not relevant to the search.\r\n\r\nYou can also repeat the same `facetKey` several times for different values. For example: `category-1/shoes/color/blue/color/red/color/yellow`.\r\n\r\n## General filters\r\n\r\nThe `facets` parameter also allows the following general filters:\r\n\r\n| `facetKey` | Description | Example |\r\n| - | - | - |\r\n| `price` | Filter the search by a price range, following the format `${minPrice}:${maxPrice}`. | `/color/blue/price/100:500?query=shirt` |\r\n| `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` |\r\n| `productClusterIds` | Filter the search by collection, following the format `productClusterIds/{collectionId}`. | `productClusterIds/262` |\r\n| `trade-policy` | Filter the search by trade policy (also known as sales channel), following the format `trade-policy/{tradePolicyId}`. | `trade-policy/2`|\n", "example": "category-1/clothing/category-2/shirt/category-3/man", "schema": { "nullable": true, "type": "string", "default": "/", "example": "color/blue" } }, "locale": { "in": "query", "name": "locale", "description": "Indicates the target language as a BCP 47 language code. The Intelligent Search must have indexed the account in the target language.", "example": "en-US", "schema": { "type": "string", "nullable": true } }, "simulationBehavior": { "in": "query", "name": "simulationBehavior", "schema": { "type": "string", "enum": [ "default", "skip", "only1P" ], "nullable": true, "default": "default" }, "description": "Defines the simulation behavior.\n\n * `default` - Calls the simulation for every single seller.\n * `skip` - Never calls the simulation.\n * `only1P` - Only calls the simulation for first party sellers." }, "hideUnavailableItems": { "in": "query", "name": "hideUnavailableItems", "description": "Defines whether the result should hide unavailable items (`true`), or not (`false`).", "schema": { "type": "boolean", "default": false } }, "fuzzy": { "in": "query", "name": "fuzzy", "description": "Indicates how the search engine will correct misspelled words 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.", "schema": { "type": "string" } }, "operator": { "in": "query", "name": "operator", "description": "Indicates how the search-engine will deal with the fullText if there is more than one word. Set `and` if the returned products must have all the words in its metadata or `or` otherwise.", "schema": { "type": "string", "enum": [ "and", "or" ] } } }, "schemas": { "SponsoredProducts": { "type": "array", "description": "List of sponsored products.", "items": { "type": "object", "description": "Sponsored product information.", "allOf": [ { "properties": { "advertisement": { "description": "Data related to sponsored information.", "type": "object", "properties": { "adId": { "description": "The unique Ad ID for this product.", "type": "string" }, "campaignId": { "description": "The campaign ID associated with this ad.", "type": "string" }, "actionCost": { "description": "The cost charged to the advertiser for the specific action (e.g.: cost per click).", "type": "number" }, "adRequestId": { "description": "ID for the ad request. Unique for each request.", "type": "string" }, "adResponseId": { "description": "ID for the ad response. Unique for each request.", "type": "string" } } } } }, { "$ref": "#/components/schemas/Product" } ] } }, "Product": { "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.", "items": { "type": "object", "description": "Delivery SLA information.", "properties": { "Price": { "type": "integer", "description": "Price of the delivery SLA type in cents." }, "TypeName": { "type": "string", "description": "SLA type name." }, "EstimatedTimeSpanToDelivery": { "type": "integer", "description": "Estimated delivery time span." } } } }, "Region": { "type": "string", "description": "Region ID.", "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.", "type": "object", "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²). 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" } } } } }, "tags": [ { "name": "Sponsored products" } ] }