Get SKU by Alternate ID

Retrieves an SKU by its Alternate ID.


This endpoint only retrieves information about active SKUs.

alternateIdintegerProduct EAN and RefId

Response object has the following properties:

idintegerSKU ID
ProductIdintegerID from the related Product
ProductRefIdintegerRef ID from the related Product
NameCompletestringProduct Name and SKU Name concatenated
ComplementNamestringProduct Complement Name
ProductNamestringProduct Name
ProductDescriptionstringProduct Description, HTML is allowed
TaxCodestringSKU Tax Code
SkuNamestringSKU Name
IsActivebooleanIf the SKU is Active
IsTransportedbooleanObsolete Field
IsInventoriedbooleanObsolete Field
IsGiftCardRechargebooleanIf the buy will generate Reward
ImageUrlstringSKU image URL
DetailUrlstringProduct URL
CSCIdentificationstringSKU Seller Identification
BrandIdintegerProduct Brand ID
BrandNamestringProduct Brand Name
DimensionobjectObject of the SKU dimensions that used on shipping calculation
cubicweightintegerSKU Cubic Weight
heightintegerSKU Height
lengthintegerSKU Length
weightintegerSKU Weight
widthintegerSKU Width
RealDimensionobjectObject of the Real SKU dimensions, that appears in product page
realCubicWeightintegerReal SKU Cubic Weight
realHeightintegerReal SKU Height
realLengthintegerReal SKU Length
realWeightintegerReal SKU Weight
realWidthintegerReal SKU Width
ManufacturerCodestringProduct Supplier ID
IsKitbooleanIf the SKU is budle
KitItemsarray of objectsArray with SKU ID from bundle components
Servicesarray of objectsArray with Service ID that are related to the SKU
Categoriesarray of objectsCategories from the related Product
Attachmentsarray of objectsArray with Attachments ID that are related to the SKU
Collectionsarray of objectsArray with Collections ID that are related to the Product
SkuSellersarray of objectsArray with related Sellers data
SellerIdintegerSKU Seller ID
StockKeepingUnitIdintegerSKU ID
SellerStockKeepingUnitIdintegerSKU ID in SKU Seller
IsActivebooleanIf the SKU is Active
isFilterbooleanIf the SKU is filter
FreightCommissionPercentageintegerRegistered value for Seller Freight Commission
ProductCommissionPercentageintegerRegistered value for Seller Product Commission
SalesChannelsintegerArray with the ID of all the Sales Channel that are related to the product
ImagesobjectObject with SKU image details
ImageUrlstringImage URL
ImageNamestringImage Name
VideosstringVideos URL
FileIdintegerSKU image ID
SkuSpecificationsobjectArray with related SKU Specifications
ProductSpecificationsobjectArray with related Product Specifications
FieldIdintegerSpecification ID
FieldNamestringSpecification Name
FieldValueIdsobjectArray with related Specification Values ID
FieldValuesobjectArray with related Specification Values
ProductClustersIdsobjectArray with related Products Clusters ID
ProductCategoryIdsstringCategory Hierarchy with Category IDs
ProductGlobalCategoryIdstringGlobal Category IDs
ProductCategoriesstringCategory Hierarchy with Category Name
CommercialConditionIdintegerSKU Commercial Condition ID
RewardValueintegerReward value related to SKU
AlternateIdsobjectArray with alternate SKU IDs, like EAN and RefId
AlternateIdValuesobjectArray with values of alternative SKU IDs
EstimatedDateArrivalstringEstimated Arrival Date
MeasurementUnitintegerSKU Unit Measurement
UnitMultiplierintegerSKU Unit Multiplier
InformationSourcestringInformation Source
ModalTypestringModal Type
KeyWordsstringKeyWords related to the product
ReleaseDatestringRelease 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": [
    "Images": [
            "ImageUrl": "",
            "ImageName": "",
            "FileId": 155455
    "Videos": [
    "SkuSpecifications": [
            "FieldId": 40,
            "FieldName": "SKUFieldA",
            "FieldValueIds": [
            "FieldValues": [
            "IsFilter": false,
            "FieldGroupId": 17,
            "FieldGroupName": "NewGroupName 2"
            "FieldId": 32,
            "FieldName": "Peso",
            "FieldValueIds": [
            "FieldValues": [
            "IsFilter": false,
            "FieldGroupId": 11,
            "FieldGroupName": "Especificações"
    "ProductSpecifications": [
            "FieldId": 34,
            "FieldName": "Field B",
            "FieldValueIds": [],
            "FieldValues": [
            "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": [
    "EstimatedDateArrival": null,
    "MeasurementUnit": "un",
    "UnitMultiplier": 1.0000,
    "InformationSource": "Database",
    "ModalType": null,
    "KeyWords": "aaaaaaa",
    "ReleaseDate": "2020-01-06T00:00:00",
    "ProductIsVisible": true,
    "ShowIfNotAvailable": true
Click Try It! to start a request and see the response here!