get https://{accountName}.{environment}.com.br/api/catalog_system/pvt/sku/stockkeepingunitbyid/
Retrieves context of an SKU
Response body has the following properties:
| Attribute | Type | Description |
|---|---|---|
id | integer | SKU ID |
ProductId | integer | ID from the related Product |
NameComplete | string | Product Name and SKU Name concatenated |
ComplementName | string | Product Complement Name |
ProductName | string | Product Name |
ProductDescription | string | Product Description, HTML is allowed |
ProductRefId | integer | Ref ID from the related Product |
TaxCode | string | SKU Tax Code |
SkuName | string | SKU Name |
IsActive | boolean | If the SKU is Active |
IsTransported | boolean | Obsolete Field |
IsInventoried | boolean | Obsolete Field |
IsGiftCardRecharge | boolean | If the buy will generate Reward |
ImageUrl | string | SKU image URL |
DetailUrl | string | Product URL |
CSCIdentification | string | SKU Seller Identification |
BrandId | integer | Product Brand ID |
BrandName | string | Product Brand Name |
Dimension | object | Object of the SKU dimensions that used on shipping calculation |
cubicweight | integer | SKU Cubic Weight |
height | integer | SKU Height |
length | integer | SKU Length |
weight | integer | SKU Weight |
width | integer | SKU Width |
RealDimension | object | Object of the Real SKU dimensions, that appears in product page |
realCubicWeight | integer | Real SKU Cubic Weight |
realHeight | integer | Real SKU Height |
realLength | integer | Real SKU Length |
realWeight | integer | Real SKU Weight |
realWidth | integer | Real SKU Width |
ManufacturerCode | string | Product Supplier ID |
IsKit | boolean | If the SKU is budle |
KitItems | array of objects | Array with SKU ID from bundle components |
Services | array of objects | Array with Service ID that are related to the SKU |
Categories | array of objects | Categories from the related Product |
Attachments | array of objects | Array with Attachments ID that are related to the SKU |
Collections | array of objects | Array with Collections ID that are related to the Product |
SkuSellers | array of objects | Array with related Sellers data |
SellerId | integer | SKU Seller ID |
StockKeepingUnitId | integer | SKU ID |
SellerStockKeepingUnitId | integer | SKU ID in SKU Seller |
IsActive | boolean | If the SKU is Active |
FreightCommissionPercentage | integer | Registered value for Seller Freight Commission |
ProductCommissionPercentage | integer | Registered value for Seller Product Commission |
SalesChannels | array | Array with the ID of all the Sales Channel that are related to the product |
Images | object | Object with SKU image details |
ImageUrl | string | Image URL |
ImageName | string | Image Name |
Videos | array of strings | Videos URL |
FileId | integer | SKU image ID |
SkuSpecifications | object | Array with related SKU Specifications |
ProductSpecifications | object | Array with related Product Specifications |
FieldId | integer | Specification ID |
FieldName | string | Specification Name |
FieldValueIds | array of objects | Array with related Specification Values ID |
FieldValues | array of objects | Array with related Specification Values |
isFilter | boolean | If the SKU is filter |
ProductClustersIds | string | Products Clusters ID |
PositionsInClusters | object | Product Clusters position in each Cluster |
ProductClusterNames | object | Products Clusters Names |
ProductCategoryIds | string | Category Hierarchy with Category IDs |
ProductGlobalCategoryId | integer | Global Category IDs |
ProductCategories | object | Category Hierarchy with Category's ID and Name |
CommercialConditionId | integer | SKU Commercial Condition ID |
RewardValue | float | Reward value related to SKU |
AlternateIds | object | Array with alternate SKU IDs, like EAN and RefId |
AlternateIdValues | array | Array with values of alternative SKU IDs |
EstimatedDateArrival | string | Estimated Arrival Date |
MeasurementUnit | integer | SKU Unit Measurement |
UnitMultiplier | integer | SKU Unit Multiplier |
InformationSource | string | Information Source |
ModalType | string | Modal Type |
KeyWords | string | KeyWords related to the product |
ReleaseDate | string | Release date of the product |
ProductIsVisible | boolean | If the Product is visible or not |
ShowIfNotAvailable | boolean | If the Product will be shown if it is not available |
Response body example:
{
"Id": 2001773,
"ProductId": 2001426,
"NameComplete": "Tabela de Basquete",
"ProductName": "Tabela de Basquete",
"ProductDescription": "Tabela de Basquete",
"SkuName": "Tabela de Basquete",
"IsActive": true,
"IsTransported": true,
"IsInventoried": true,
"IsGiftCardRecharge": false,
"ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952-55-55/7508800GG.jpg",
"DetailUrl": "/tabela-de-basquete/p",
"CSCIdentification": null,
"BrandId": "2000018",
"BrandName": "MARCA ARGOLO TESTE",
"Dimension": {
"cubicweight": 81.6833,
"height": 65,
"length": 58,
"weight": 10000,
"width": 130
},
"RealDimension": {
"realCubicWeight": 274.1375,
"realHeight": 241,
"realLength": 65,
"realWeight": 9800,
"realWidth": 105
},
"ManufacturerCode": "",
"IsKit": false,
"KitItems": [],
"Services": [],
"Categories": [],
"Attachments": [
{
"Id": 3,
"Name": "Mensagem",
"Keys": [
"nome;20",
"foto;40"
],
"Fields": [
{
"FieldName": "nome",
"MaxCaracters": "20",
"DomainValues": "Adalberto,Pedro,João"
},
{
"FieldName": "foto",
"MaxCaracters": "40",
"DomainValues": null
}
],
"IsActive": true,
"IsRequired": false
}
],
"Collections": [],
"SkuSellers": [
{
"SellerId": "1",
"StockKeepingUnitId": 2001773,
"SellerStockKeepingUnitId": "2001773",
"IsActive": true,
"FreightCommissionPercentage": 0,
"ProductCommissionPercentage": 0
}
],
"SalesChannels": [
1,
2,
3,
10
],
"Images": [
{
"ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg",
"ImageName": "",
"FileId": 168952
},
{
"ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168953/7508800_1GG.jpg",
"ImageName": "",
"FileId": 168953
},
{
"ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168954/7508800_2GG.jpg",
"ImageName": "",
"FileId": 168954
}
],
"SkuSpecifications": [
{
"FieldId": 102,
"FieldName": "Cor",
"FieldValueIds": [
266
],
"FieldValues": [
"Padrão"
]
}
],
"ProductSpecifications": [
{
"FieldId": 7,
"FieldName": "Faixa Etária",
"FieldValueIds": [
58,
56,
55,
52
],
"FieldValues": [
"5 a 6 anos",
"7 a 8 anos",
"9 a 10 anos",
"Acima de 10 anos"
]
},
{
"FieldId": 23,
"FieldName": "Fabricante",
"FieldValueIds": [],
"FieldValues": [
"Xalingo"
]
}
],
"ProductClustersIds": "176,187,192,194,211,217,235,242",
"ProductCategoryIds": "/59/",
"ProductGlobalCategoryId": null,
"ProductCategories": {
"59": "Brinquedos"
},
"CommercialConditionId": 1,
"RewardValue": 100,
"AlternateIds": {
"Ean": "8781",
"RefId": "878181"
},
"AlternateIdValues": [
"8781",
"878181"
],
"EstimatedDateArrival": null,
"MeasurementUnit": "un",
"UnitMultiplier": 1,
"InformationSource": "Indexer",
"ModalType": ""
}