action vtex_sku_context { label: "Get SKU and context" description: "Retrieves context of an SKU. \n> šŸ“˜ Onboarding guide \n> \n> Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. \n \n ## Response body example \n \n```json \n{ \n \"Id\": 2001773, \n \"ProductId\": 2001426, \n \"NameComplete\": \"Tabela de Basquete\", \n \"ComplementName\": \"\", \n \"ProductName\": \"Tabela de Basquete\", \n \"ProductDescription\": \"Tabela de Basquete\", \n \"SkuName\": \"Tabela de Basquete\", \n \"ProductRefId\": \"0987\", \n \"TaxCode\": \"\", \n \"IsActive\": true, \n \"IsTransported\": true, \n \"IsInventoried\": true, \n \"IsGiftCardRecharge\": false, \n \"ImageUrl\": \"http://ambienteqa.vteximg.com.br/arquivos/ids/168952-55-55/7508800GG.jpg\", \n \"DetailUrl\": \"/tabela-de-basquete/p\", \n \"CSCIdentification\": null, \n \"BrandId\": \"2000018\", \n \"BrandName\": \"MARCA ARGOLO TESTE\", \n \"IsBrandActive\": true, \n \"Dimension\": { \n \"cubicweight\": 81.6833, \n \"height\": 65, \n \"length\": 58, \n \"weight\": 10000, \n \"width\": 130 \n }, \n \"RealDimension\": { \n \"realCubicWeight\": 274.1375, \n \"realHeight\": 241, \n \"realLength\": 65, \n \"realWeight\": 9800, \n \"realWidth\": 105 \n }, \n \"ManufacturerCode\": \"\", \n \"IsKit\": false, \n \"KitItems\": [], \n \"Services\": [], \n \"Categories\": [], \n \"CategoriesFullPath\": [ \n \"/1/10/\", \n \"/1/\", \n \"/20/\" \n ], \n \"Attachments\": [ \n { \n \"Id\": 3, \n \"Name\": \"Mensagem\", \n \"Keys\": [ \n \"nome;20\", \n \"foto;40\" \n ], \n \"Fields\": [ \n { \n \"FieldName\": \"nome\", \n \"MaxCaracters\": \"20\", \n \"DomainValues\": \"Adalberto,Pedro,JoĆ£o\" \n }, \n { \n \"FieldName\": \"foto\", \n \"MaxCaracters\": \"40\", \n \"DomainValues\": null \n } \n ], \n \"IsActive\": true, \n \"IsRequired\": false \n } \n ], \n \"Collections\": [], \n \"SkuSellers\": [ \n { \n \"SellerId\": \"1\", \n \"StockKeepingUnitId\": 2001773, \n \"SellerStockKeepingUnitId\": \"2001773\", \n \"IsActive\": true, \n \"FreightCommissionPercentage\": 0, \n \"ProductCommissionPercentage\": 0 \n } \n ], \n \"SalesChannels\": [ \n 1, \n 2, \n 3, \n 10 \n ], \n \"Images\": [ \n { \n \"ImageUrl\": \"http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg\", \n \"ImageName\": \"\", \n \"FileId\": 168952 \n }, \n { \n \"ImageUrl\": \"http://ambienteqa.vteximg.com.br/arquivos/ids/168953/7508800_1GG.jpg\", \n \"ImageName\": \"\", \n \"FileId\": 168953 \n }, \n { \n \"ImageUrl\": \"http://ambienteqa.vteximg.com.br/arquivos/ids/168954/7508800_2GG.jpg\", \n \"ImageName\": \"\", \n \"FileId\": 168954 \n } \n ], \n \"Videos\": [ \n \"www.google.com\" \n ], \n \"SkuSpecifications\": [ \n { \n \"FieldId\": 102, \n \"FieldName\": \"Cor\", \n \"FieldValueIds\": [ \n 266 \n ], \n \"FieldValues\": [ \n \"PadrĆ£o\" \n ], \n \"IsFilter\": false, \n \"FieldGroupId\": 11, \n \"FieldGroupName\": \"EspecificaƧƵes\" \n } \n ], \n \"ProductSpecifications\": [ \n { \n \"FieldId\": 7, \n \"FieldName\": \"Faixa EtĆ”ria\", \n \"FieldValueIds\": [ \n 58, \n 56, \n 55, \n 52 \n ], \n \"FieldValues\": [ \n \"5 a 6 anos\", \n \"7 a 8 anos\", \n \"9 a 10 anos\", \n \"Acima de 10 anos\" \n ], \n \"IsFilter\": true, \n \"FieldGroupId\": 17, \n \"FieldGroupName\": \"NewGroupName 2\" \n }, \n { \n \"FieldId\": 23, \n \"FieldName\": \"Fabricante\", \n \"FieldValueIds\": [], \n \"FieldValues\": [ \n \"Xalingo\" \n ], \n \"IsFilter\": false, \n \"FieldGroupId\": 17, \n \"FieldGroupName\": \"NewGroupName 2\" \n } \n ], \n \"ProductClustersIds\": \"176,187,192,194,211,217,235,242\", \n \"PositionsInClusters\": { \n \"151\": 3, \n \"152\": 0, \n \"158\": 1 \n }, \n \"ProductClusterNames\": { \n \"151\": \"asdfghj\", \n \"152\": \"George\", \n \"158\": \"Coleção halloween\" \n }, \n \"ProductClusterHighlights\": { \n \"151\": \"asdfghj\", \n \"152\": \"George\" \n }, \n \"ProductCategoryIds\": \"/59/\", \n \"IsDirectCategoryActive\": false, \n \"ProductGlobalCategoryId\": null, \n \"ProductCategories\": { \n \"59\": \"Brinquedos\" \n }, \n \"CommercialConditionId\": 1, \n \"RewardValue\": 100.0, \n \"AlternateIds\": { \n \"Ean\": \"8781\", \n \"RefId\": \"878181\" \n }, \n \"AlternateIdValues\": [ \n \"8781\", \n \"878181\" \n ], \n \"EstimatedDateArrival\": \"\", \n \"MeasurementUnit\": \"un\", \n \"UnitMultiplier\": 2.0000, \n \"InformationSource\": \"Indexer\", \n \"ModalType\": \"\", \n \"KeyWords\": \"basquete, tabela\", \n \"ReleaseDate\": \"2020-01-06T00:00:00\", \n \"ProductIsVisible\": true, \n \"ShowIfNotAvailable\": true, \n \"IsProductActive\": true, \n \"ProductFinalScore\": 0 \n} \n```" provider: vtex method: GET path: "/api/catalog_system/pvt/sku/stockkeepingunitbyid/{skuId}" encoding: json input: { type: "object" properties: { Accept: { type: "string" } "Content-Type": { type: "string" } sc: { type: "integer" } skuId: { type: "integer" } } required: ["Accept", "Content-Type", "skuId"] additionalProperties: false } output: { type: "object" required: ["AlternateIdValues", "AlternateIds", "Attachments", "BrandId", "BrandName", "CSCIdentification", "Categories", "Collections", "CommercialConditionId", "DetailUrl", "Dimension", "EstimatedDateArrival", "Id", "ImageUrl", "Images", "InformationSource", "IsActive", "IsGiftCardRecharge", "IsInventoried", "IsKit", "IsTransported", "KitItems", "ManufacturerCode", "MeasurementUnit", "ModalType", "NameComplete", "ProductCategories", "ProductCategoryIds", "ProductClustersIds", "ProductDescription", "ProductGlobalCategoryId", "ProductId", "ProductName", "ProductSpecifications", "RealDimension", "RewardValue", "SalesChannels", "Services", "SkuName", "SkuSellers", "SkuSpecifications", "UnitMultiplier"] properties: { AlternateIdValues: { type: "array" description: "Array with values of alternative SKU IDs." items: { type: "string" } } AlternateIds: { type: "object" description: "Array with alternate SKU IDs, such as EAN and RefId." properties: { Ean: { type: "string" description: "SKU EAN." } RefId: { type: "string" description: "SKU Reference ID." } } } Attachments: { type: "array" description: "Array with Attachments ID that are related to the SKU." items: { type: "object" description: "Object containing information about SKU attachments." required: ["Id", "Name", "Keys", "Fields", "IsActive", "IsRequired"] properties: { Fields: { type: "array" description: "Array containing Attachment fields." items: { type: "object" required: ["FieldName", "MaxCaracters", "DomainValues"] properties: { DomainValues: { type: "string" description: "Allowed key values." } FieldName: { type: "string" description: "Attachment field name." } MaxCaracters: { type: "string" description: "Maximum number of characters accepted in the attachment field." } } } } Id: { type: "integer" format: "int32" description: "Attachment ID." } IsActive: { type: "boolean" description: "Defines if the Attachment is active or not." } IsRequired: { type: "boolean" description: "Defines if the Attachment is required or not." } Keys: { type: "array" description: "Attachment Keys." items: { type: "string" } } Name: { type: "string" description: "Attachment Name." } } } } BrandId: { type: "string" description: "Product Brand ID." } BrandName: { type: "string" description: "Product Brand Name." } CSCIdentification: { type: "string" description: "SKU Seller identification." } Categories: { type: "array" description: "Array with Categories from the related Product." items: { type: "string" description: "Category ID." } } Collections: { type: "array" description: "Array with Collections ID that are related to the Product." items: { type: "string" description: "Collection ID." } } CommercialConditionId: { type: "integer" format: "int32" description: "SKU Commercial Condition ID." } ComplementName: { type: "string" description: "Product Complement Name." } DetailUrl: { type: "string" description: "Product URL." } Dimension: { type: "object" description: "Object containing the SKU dimensions to be used on the shipping calculation." required: ["cubicweight", "height", "length", "weight", "width"] properties: { cubicweight: { type: "number" description: "SKU Cubic Weight." } height: { type: "number" description: "SKU Height." } length: { type: "number" description: "SKU Length." } weight: { type: "number" description: "SKU Weight." } width: { type: "number" description: "SKU Width." } } } EstimatedDateArrival: { type: "string" 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." } Id: { type: "integer" format: "int32" description: "SKU ID." } ImageUrl: { type: "string" description: "SKU image URL." } Images: { type: "array" description: "Array with SKU images." items: { type: "object" description: "Object containing SKU images details." required: ["ImageUrl", "ImageName", "FileId"] properties: { FileId: { type: "integer" format: "int32" description: "SKU image ID." } ImageName: { type: "string" description: "Image label." } ImageUrl: { type: "string" description: "Image URL." } } } } InformationSource: { type: "string" description: "Information Source." } IsActive: { type: "boolean" description: "Defines if the SKU is active or not." } IsGiftCardRecharge: { type: "boolean" description: "Defines if the purchase will generate a reward." } IsInventoried: { type: "boolean" } IsKit: { type: "boolean" description: "Defines if the SKU is part of a bundle." } IsProductActive: { type: "boolean" description: "Defines if the product is active or not." } IsTransported: { type: "boolean" } KeyWords: { type: "string" description: "Keywords related to the product." } KitItems: { type: "array" description: "Array with SKU IDs of bundle components." items: { type: "string" description: "SKU ID." } } ManufacturerCode: { type: "string" description: "Product Supplier ID." } MeasurementUnit: { type: "string" description: "SKU Measurement Unit." } ModalType: { type: "string" description: "Modal Type." } NameComplete: { type: "string" description: "Product Name and SKU Name concatenated." } ProductCategories: { type: "object" description: "Object containing product categories. Structure: \"{CategoryID}\": \"{CategoryName}\"." } ProductCategoryIds: { type: "string" description: "Category Hierarchy with Category IDs." } ProductClustersIds: { type: "string" description: "Product Clusters IDs." } ProductDescription: { type: "string" description: "Product Description. HTML is allowed." } ProductFinalScore: { type: "integer" description: "Product Final Score." } ProductGlobalCategoryId: { type: "integer" description: "Global Category ID." } ProductId: { type: "integer" format: "int32" description: "ID of the related Product." } ProductIsVisible: { type: "boolean" description: "Defines if the product is visible or not." } ProductName: { type: "string" description: "Product Name." } ProductRefId: { type: "string" description: "Reference ID of the related Product." } ProductSpecifications: { type: "array" description: "Array with related Product Specifications." items: { type: "object" required: ["FieldId", "FieldName", "FieldValueIds", "FieldValues"] properties: { FieldId: { type: "integer" format: "int32" description: "Specification ID." } FieldName: { type: "string" description: "Specification Name." } FieldValueIds: { type: "array" description: "Array with related Specification Values IDs." items: { type: "integer" format: "int32" description: "Specification Value ID." } } FieldValues: { type: "array" description: "Array with related Specification Values." items: { type: "string" } } } } } RealDimension: { type: "object" description: "Object containing the real SKU dimensions, which appear in the product page." required: ["realCubicWeight", "realHeight", "realLength", "realWeight", "realWidth"] properties: { realCubicWeight: { type: "number" description: "Real SKU Cubic Weight." } realHeight: { type: "number" description: "Real SKU Height." } realLength: { type: "number" description: "Real SKU Length." } realWeight: { type: "number" description: "Real SKU Weight." } realWidth: { type: "number" description: "Real SKU Width." } } } ReleaseDate: { type: "string" description: "Release date of the product." } RewardValue: { type: "number" description: "Reward value related to the SKU." } SalesChannels: { type: "array" description: "Array with the ID of all the Sales Channels that are related to the product." items: { type: "integer" format: "int32" } } Services: { type: "array" description: "Array with Service IDs that are related to the SKU." items: { type: "string" description: "Service ID." } } ShowIfNotAvailable: { type: "boolean" description: "Defines if the product will be shown if it is not available." } SkuName: { type: "string" description: "SKU Name." } SkuSellers: { type: "array" description: "Array with SKU Sellers data." items: { type: "object" description: "Object containing related SKU Sellers data." required: ["SellerId", "StockKeepingUnitId", "SellerStockKeepingUnitId", "IsActive", "FreightCommissionPercentage", "ProductCommissionPercentage"] properties: { FreightCommissionPercentage: { type: "number" description: "Registered value for Seller Freight Commission." } IsActive: { type: "boolean" description: "Defines if the SKU is active." } ProductCommissionPercentage: { type: "number" description: "Registered value for Seller Product Commission." } SellerId: { type: "string" description: "SKU Seller ID. This is the ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." } SellerStockKeepingUnitId: { type: "string" description: "SKU ID for the SKU Seller." } StockKeepingUnitId: { type: "integer" format: "int32" description: "SKU ID." } } } } SkuSpecifications: { type: "array" description: "Array with related SKU Specifications." items: { type: "object" description: "Object containing related SKU Specifications." required: ["FieldId", "FieldName", "FieldValueIds", "FieldValues"] properties: { FieldId: { type: "integer" format: "int32" description: "Specification ID." } FieldName: { type: "string" description: "Specification Name." } FieldValueIds: { type: "array" description: "Array with related Specification Values IDs." items: { type: "integer" format: "int32" description: "Specification Value ID." } } FieldValues: { type: "array" description: "Array with related Specification Values." items: { type: "string" } } } } } TaxCode: { type: "string" description: "SKU Tax Code." } UnitMultiplier: { type: "number" description: "This is the multiple number of SKU. If the Multiplier is 5.0000, the product can be added in multiple quantities of 5, 10, 15, 20, onward." } } } }