{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/GetSKUandContext", "title": "GetSKUandContext", "required": [ "Id", "ProductId", "NameComplete", "ProductName", "ProductDescription", "SkuName", "IsActive", "IsTransported", "IsInventoried", "IsGiftCardRecharge", "ImageUrl", "DetailUrl", "CSCIdentification", "BrandId", "BrandName", "Dimension", "RealDimension", "ManufacturerCode", "IsKit", "KitItems", "Services", "Categories", "Attachments", "Collections", "SkuSellers", "SalesChannels", "Images", "SkuSpecifications", "ProductSpecifications", "ProductClustersIds", "ProductCategoryIds", "ProductGlobalCategoryId", "ProductCategories", "CommercialConditionId", "RewardValue", "AlternateIds", "AlternateIdValues", "EstimatedDateArrival", "MeasurementUnit", "UnitMultiplier", "InformationSource", "ModalType" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "SKU ID." }, "ProductId": { "type": "integer", "format": "int32", "description": "ID of the related product." }, "NameComplete": { "type": "string", "description": "Product Name and SKU Name concatenated." }, "ComplementName": { "type": "string", "description": "Product Complement Name." }, "ProductName": { "type": "string", "description": "Product Name." }, "ProductDescription": { "type": "string", "description": "Product Description. HTML is allowed." }, "ProductRefId": { "type": "string", "description": "Reference ID of the related product." }, "TaxCode": { "type": "string", "description": "SKU Tax Code." }, "SkuName": { "type": "string", "description": "SKU Name." }, "IsActive": { "type": "boolean", "description": "Defines if the SKU is active or not." }, "IsTransported": { "type": "boolean", "description": "Deprecated field.", "nullable": true, "deprecated": true }, "IsInventoried": { "type": "boolean", "description": "Deprecated field.", "nullable": true, "deprecated": true }, "IsGiftCardRecharge": { "type": "boolean", "description": "Defines if the purchase will generate a reward." }, "ImageUrl": { "type": "string", "description": "SKU image URL." }, "DetailUrl": { "type": "string", "description": "Product URL." }, "CSCIdentification": { "type": "string", "nullable": true, "description": "SKU seller identification." }, "BrandId": { "type": "string", "description": "Product brand ID." }, "BrandName": { "type": "string", "description": "Product brand Name." }, "Dimension": { "$ref": "#/components/schemas/Dimension" }, "RealDimension": { "$ref": "#/components/schemas/RealDimension" }, "ManufacturerCode": { "type": "string", "description": "Product Supplier ID." }, "IsKit": { "type": "boolean", "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." }, "KitItems": { "type": "array", "items": { "type": "string", "description": "SKU ID." }, "description": "Array with SKU IDs of bundle components." }, "Services": { "type": "array", "items": { "type": "string", "description": "Service ID." }, "description": "Array with Service IDs that are related to the SKU." }, "Categories": { "type": "array", "items": { "type": "string", "description": "Category ID." }, "description": "Array with Categories from the related product." }, "Attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "description": "Array with Attachments ID that are related to the SKU." }, "Collections": { "type": "array", "items": { "type": "string", "description": "Collection ID." }, "description": "Array with Collection IDs that are related to the product." }, "SkuSellers": { "type": "array", "items": { "$ref": "#/components/schemas/SkuSeller" }, "description": "Array with SKU sellers data." }, "SalesChannels": { "type": "array", "items": { "type": "integer", "format": "int32", "description": "Trade policy ID." }, "description": "Array with the ID of all the trade policies that are related to the product." }, "Images": { "type": "array", "items": { "$ref": "#/components/schemas/Image" }, "description": "Array with SKU images." }, "SkuSpecifications": { "type": "array", "items": { "$ref": "#/components/schemas/SkuSpecification" }, "description": "Array with related SKU specifications." }, "ProductSpecifications": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecification" }, "description": "Array with related product specifications." }, "ProductClustersIds": { "type": "string", "description": "Product clusters IDs." }, "ProductCategoryIds": { "type": "string", "description": "Category hierarchy with category IDs." }, "ProductGlobalCategoryId": { "type": "integer", "nullable": true, "description": "Global category ID." }, "ProductCategories": { "type": "object", "description": "Object containing product categories. Structure: \"{CategoryID}\": \"{CategoryName}\".", "additionalProperties": { "type": "string", "description": "Category ID.", "additionalProperties": { "type": "string", "description": "Category name." } } }, "CommercialConditionId": { "type": "integer", "format": "int32", "description": "Commercial condition ID, used to define SKU specific promotions or installment rules. In case of no specific condition, use `1` (default value). This field does not accept `0`. Learn more at [Registering a commercial condition](https://help.vtex.com/tutorial/registering-a-commercial-condition--tutorials_445).", "default": 1 }, "RewardValue": { "type": "number", "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." }, "AlternateIds": { "$ref": "#/components/schemas/AlternateIds" }, "AlternateIdValues": { "type": "array", "items": { "type": "string", "description": "Alternative SKU ID." }, "description": "Array with values of alternative SKU IDs." }, "EstimatedDateArrival": { "type": "string", "nullable": true, "description": "To add the product as pre-sale, enter the product estimated arrival date in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. You must take into consideration both the launch date and the freight calculation for the arrival date." }, "MeasurementUnit": { "type": "string", "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\"`." }, "UnitMultiplier": { "type": "number", "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." }, "InformationSource": { "type": "string", "description": "Information source.", "nullable": true }, "ModalType": { "type": "string", "nullable": true, "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)." }, "KeyWords": { "type": "string", "nullable": true, "description": "Keywords related to the product." }, "ReleaseDate": { "type": "string", "nullable": true, "description": "Release date of the product." }, "ProductIsVisible": { "type": "boolean", "description": "Defines if the product is visible or not." }, "ShowIfNotAvailable": { "type": "boolean", "description": "Defines if the product will be shown if it is not available." }, "IsProductActive": { "type": "boolean", "description": "Defines if the product is active or not." }, "ProductFinalScore": { "type": "integer", "description": "Product final score." } }, "example": { "Id": 310118450, "ProductId": 2, "NameComplete": "Caixa de Areia Azul Petmate sku test", "ComplementName": "", "ProductName": "Caixa de Areia Azul Petmate", "ProductDescription": "", "ProductRefId": "", "TaxCode": "", "SkuName": "sku test", "IsActive": true, "IsTransported": true, "IsInventoried": true, "IsGiftCardRecharge": false, "ImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155451-55-55/caixa-areia-azul-petmate.jpg?v=637139451191670000", "DetailUrl": "/caixa-de-areia-azul-petmate/p", "CSCIdentification": null, "BrandId": "2000005", "BrandName": "Petmate", "IsBrandActive": true, "Dimension": { "cubicweight": 0.2083, "height": 10.0, "length": 10.0, "weight": 10.0, "width": 10.0 }, "RealDimension": { "realCubicWeight": 0.0, "realHeight": 0.0, "realLength": 0.0, "realWeight": 0.0, "realWidth": 0.0 }, "ManufacturerCode": "123", "IsKit": false, "KitItems": [], "Services": [], "Categories": [], "CategoriesFullPath": [ "/3/15/", "/3/", "/1/" ], "Attachments": [], "Collections": [], "SkuSellers": [ { "SellerId": "1", "StockKeepingUnitId": 310118450, "SellerStockKeepingUnitId": "310118450", "IsActive": true, "FreightCommissionPercentage": 0.0, "ProductCommissionPercentage": 0.0 } ], "SalesChannels": [ 1, 3 ], "Images": [ { "ImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155451/caixa-areia-azul-petmate.jpg?v=637139451191670000", "ImageName": null, "FileId": 155451 } ], "Videos": [], "SkuSpecifications": [], "ProductSpecifications": [], "ProductClustersIds": "151,158", "PositionsInClusters": { "151": 1, "158": 2 }, "ProductClusterNames": { "151": "asdfghj", "158": "Cole\u00e7\u00e3o halloween" }, "ProductClusterHighlights": { "151": "asdfghj" }, "ProductCategoryIds": "/3/15/", "IsDirectCategoryActive": true, "ProductGlobalCategoryId": 5000, "ProductCategories": { "15": "Caixa de Areia", "3": "Higiene", "1": "Alimenta\u00e7\u00e3o" }, "CommercialConditionId": 1, "RewardValue": 0.0, "AlternateIds": { "RefId": "1" }, "AlternateIdValues": [ "1" ], "EstimatedDateArrival": null, "MeasurementUnit": "un", "UnitMultiplier": 1.0, "InformationSource": null, "ModalType": null, "KeyWords": "", "ReleaseDate": "2020-01-06T00:00:00Z", "ProductIsVisible": true, "ShowIfNotAvailable": true, "IsProductActive": true, "ProductFinalScore": 0 } }