get https://{accountName}.{environment}.com.br/api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/
Retrieves an SKU by its Alternate ID.
This endpoint only retrieves information about active SKUs.
Attribute | Type | Description |
---|---|---|
alternateId | integer | Product EAN and RefId |
Response object has the following properties:
Attribute | Type | Description |
---|---|---|
id | integer | SKU ID |
ProductId | integer | ID from the related Product |
ProductRefId | integer | Ref 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 |
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 |
isFilter | boolean | If the SKU is filter |
FreightCommissionPercentage | integer | Registered value for Seller Freight Commission |
ProductCommissionPercentage | integer | Registered value for Seller Product Commission |
SalesChannels | integer | 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 | string | 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 | object | Array with related Specification Values ID |
FieldValues | object | Array with related Specification Values |
ProductClustersIds | object | Array with related Products Clusters ID |
ProductCategoryIds | string | Category Hierarchy with Category IDs |
ProductGlobalCategoryId | string | Global Category IDs |
ProductCategories | string | Category Hierarchy with Category Name |
CommercialConditionId | integer | SKU Commercial Condition ID |
RewardValue | integer | Reward value related to SKU |
AlternateIds | object | Array with alternate SKU IDs, like EAN and RefId |
AlternateIdValues | object | 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 |
Response body example:
{
"Id": 7,
"ProductId": 1,
"NameComplete": "Ração Royal Canin Feline Urinary sku test",
"ComplementName": "Ração Royal",
"ProductName": "Ração Royal Canin Feline Urinary",
"ProductDescription": "",
"ProductRefId": "",
"TaxCode": "",
"SkuName": "sku test",
"IsActive": false,
"IsTransported": true,
"IsInventoried": true,
"IsGiftCardRecharge": false,
"ImageUrl": "",
"DetailUrl": "/racao-royal-canin-feline-urinary/p",
"CSCIdentification": null,
"BrandId": "2000000",
"BrandName": "Orma Carbono",
"Dimension": {
"cubicweight": 1.0000,
"height": 10.0000,
"length": 10.0000,
"weight": 10.0000,
"width": 10.0000
},
"RealDimension": {
"realCubicWeight": 0.0,
"realHeight": 0.0,
"realLength": 0.0,
"realWeight": 0.0,
"realWidth": 0.0
},
"ManufacturerCode": "123",
"IsKit": true,
"KitItems": [
{
"Id": 1,
"Name": "Ração Royal Canin Feline Urinary 500g",
"UnitPrice": 50.0000,
"Amount": 1,
"EstimatedDateArrival": null,
"Dimension": {
"cubicweight": 1.0000,
"height": 6.0000,
"length": 24.0000,
"weight": 550.0000,
"width": 14.0000
},
"RefId": "0001",
"EAN": "1234567890123",
"IsKitOptimized": false
},
{
"Id": 2,
"Name": "Ração Royal Canin Feline Urinary 1,5kg",
"UnitPrice": 100.0000,
"Amount": 1,
"EstimatedDateArrival": null,
"Dimension": {
"cubicweight": 1.0000,
"height": 25.0000,
"length": 19.0000,
"weight": 1550.0000,
"width": 9.0000
},
"RefId": "0002",
"EAN": "",
"IsKitOptimized": false
}
],
"Services": [],
"Categories": [],
"Attachments": [
{
"Id": 1,
"Name": "Nome",
"Keys": [],
"Fields": [],
"IsActive": true,
"IsRequired": false
}
],
"Collections": [],
"SkuSellers": [
{
"SellerId": "1",
"StockKeepingUnitId": 7,
"SellerStockKeepingUnitId": "7",
"IsActive": true,
"FreightCommissionPercentage": 0.0,
"ProductCommissionPercentage": 0.0
}
],
"SalesChannels": [
1,
2,
3
],
"Images": [
{
"ImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155455/Water-Bottle.jpg?v=637213074965370000",
"ImageName": "",
"FileId": 155455
}
],
"Videos": [
"google.com"
],
"SkuSpecifications": [
{
"FieldId": 40,
"FieldName": "SKUFieldA",
"FieldValueIds": [
133
],
"FieldValues": [
"A"
],
"IsFilter": false,
"FieldGroupId": 17,
"FieldGroupName": "NewGroupName 2"
},
{
"FieldId": 32,
"FieldName": "Peso",
"FieldValueIds": [
131
],
"FieldValues": [
"500g"
],
"IsFilter": false,
"FieldGroupId": 11,
"FieldGroupName": "Especificações"
}
],
"ProductSpecifications": [
{
"FieldId": 34,
"FieldName": "Field B",
"FieldValueIds": [],
"FieldValues": [
"Giant"
],
"IsFilter": false,
"FieldGroupId": 17,
"FieldGroupName": "NewGroupName 2"
}
],
"ProductClustersIds": "152",
"ProductCategoryIds": "/1/10/",
"ProductGlobalCategoryId": 3367,
"ProductCategories": {
"10": "Ração Seca",
"1": "Alimentação"
},
"CommercialConditionId": 1,
"RewardValue": 0.0,
"AlternateIds": {
"Ean": "12341234",
"RefId": "125478"
},
"AlternateIdValues": [
"1234123",
"12341234",
"125478"
],
"EstimatedDateArrival": null,
"MeasurementUnit": "un",
"UnitMultiplier": 1.0000,
"InformationSource": "Database",
"ModalType": null,
"KeyWords": "aaaaaaa",
"ReleaseDate": "2020-01-06T00:00:00",
"ProductIsVisible": true,
"ShowIfNotAvailable": true
}