Get SKU by Alternate ID

v1.0.0

Retrieves an SKU by its Alternate ID.

Response body example

json

{
    "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.0000,
        "length": 10.0000,
        "weight": 10.0000,
        "width": 10.0000
    },
    "RealDimension": {
        "realCubicWeight": 0.000,
        "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ção halloween"
    },
    "ProductClusterHighlights": {
        "151": "asdfghj"
    },
    "ProductCategoryIds": "/3/15/",
    "IsDirectCategoryActive": true,
    "ProductGlobalCategoryId": 5000,
    "ProductCategories": {
        "15": "Caixa de Areia",
        "3": "Higiene",
        "1": "Alimentação"
    },
    "CommercialConditionId": 1,
    "RewardValue": 0.0,
    "AlternateIds": {
        "RefId": "1"
    },
    "AlternateIdValues": [
        "1"
    ],
    "EstimatedDateArrival": null,
    "MeasurementUnit": "un",
    "UnitMultiplier": 1.0000,
    "InformationSource": null,
    "ModalType": null,
    "KeyWords": "",
    "ReleaseDate": "2020-01-06T00:00:00Z",
    "ProductIsVisible": true,
    "ShowIfNotAvailable": true,
    "IsProductActive": true,
    "ProductFinalScore": 0
}

Input

{
  "type": "object",
  "properties": {
    "Accept": {
      "type": "string"
    },
    "Content-Type": {
      "type": "string"
    },
    "alternateId": {
      "type": "integer"
    }
  },
  "required": [
    "Accept",
    "Content-Type",
    "alternateId"
  ],
  "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",
        "description": "Alternative SKU ID."
      }
    },
    "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": "Brand ID."
    },
    "BrandName": {
      "type": "string",
      "description": "Brand Name."
    },
    "CSCIdentification": {
      "type": "string",
      "description": "SKU Seller Identification."
    },
    "Categories": {
      "type": "array",
      "description": "Categories of the related product.",
      "items": {
        "type": "string",
        "description": "Category ID."
      }
    },
    "CategoriesFullPath": {
      "type": "array",
      "description": "Path of Categories of the related product.",
      "items": {
        "type": "string",
        "description": "Path composed by Category IDs separated by `/`."
      }
    },
    "Collections": {
      "type": "array",
      "description": "Array with Collections IDs 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 slug."
    },
    "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": "SKU estimated arrival date in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format, when the product is on pre-sale. 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 of objects with SKU image details.",
      "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."
    },
    "IsDirectCategoryActive": {
      "type": "boolean",
      "description": "Indicates if the direct Product Category is active or not."
    },
    "IsGiftCardRecharge": {
      "type": "boolean",
      "description": "Defines if the purchase of the SKU will generate reward value for the customer."
    },
    "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 of each bundle component."
      }
    },
    "ManufacturerCode": {
      "type": "string",
      "description": "Product Supplier ID."
    },
    "MeasurementUnit": {
      "type": "string",
      "description": "Measurement unit."
    },
    "ModalType": {
      "type": "string",
      "description": "Links an unusual type of SKU 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)."
    },
    "NameComplete": {
      "type": "string",
      "description": "Product Name and SKU Name combined."
    },
    "PositionsInClusters": {
      "type": "object",
      "description": "Product Clusters position in each Cluster. Structure: \"{Product Cluster ID}\": {Position}.\n\n`{Product Cluster ID}` is a string, while `{Position}` is an integer."
    },
    "ProductCategories": {
      "type": "object",
      "description": "Object containing product categories. Structure: \"{CategoryID}\": \"{CategoryName}\". Both the key and the value are strings."
    },
    "ProductCategoryIds": {
      "type": "string",
      "description": "Category path composed by category IDs separated by `/`."
    },
    "ProductClusterHighlights": {
      "type": "object",
      "description": "Product Clusters Highlights. Structure: \"{Product Cluster ID}\": \"{Product Cluster Name}\". Both the key and the value are strings."
    },
    "ProductClusterNames": {
      "type": "object",
      "description": "Product Clusters Names. Structure: \"{Product Cluster ID}\": \"{Product Cluster Name}\". Both the key and the value are strings."
    },
    "ProductClustersIds": {
      "type": "string",
      "description": "Product Cluster IDs separated by comma (`,`)."
    },
    "ProductDescription": {
      "type": "string",
      "description": "Product Description. HTML is allowed."
    },
    "ProductFinalScore": {
      "type": "integer",
      "description": "Product Final Score."
    },
    "ProductGlobalCategoryId": {
      "type": "integer",
      "description": "Product Global Category ID."
    },
    "ProductId": {
      "type": "integer",
      "format": "int32",
      "description": "Product ID."
    },
    "ProductIsVisible": {
      "type": "boolean",
      "description": "Defines if the product is visible or not."
    },
    "ProductName": {
      "type": "string",
      "description": "Product Name."
    },
    "ProductRefId": {
      "type": "string",
      "description": "Product Reference ID."
    },
    "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 of trade policy IDs.",
      "items": {
        "type": "integer",
        "format": "int32",
        "description": "Trade policy ID."
      }
    },
    "Services": {
      "type": "array",
      "description": "Array with Service IDs that are related to the SKU.",
      "items": {
        "type": "string",
        "description": "Service IDs of each service related to the SKU."
      }
    },
    "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 related 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."
    }
  }
}