---
title: "Get SKU by alternate ID"
method: GET
path: "/api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/{alternateId}"
tags: ["SKU"]
---

# Get SKU by alternate ID

`GET /api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/{alternateId}`

Retrieves an SKU by its alternate ID, which can be the EAN or the reference ID.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Catalog | Content | **SKUs** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `alternateId` integer, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- GetSKUAltID — Object with the response.
  - `Id` integer, required — SKU ID.
  - `ProductId` integer, required — Product ID.
  - `NameComplete` string, required — Product name and SKU name combined.
  - `ComplementName` string — Product complement name.
  - `ProductName` string, required — Product name.
  - `ProductDescription` string, required — Product description. HTML is allowed.
  - `ProductRefId` string — Product reference ID.
  - `TaxCode` string — SKU tax code.
  - `SkuName` string, required — SKU name.
  - `IsActive` boolean, required — Defines if the SKU is active or not.
  - `IsTransported` boolean, required — Deprecated field.
  - `IsInventoried` boolean, required — Deprecated field.
  - `IsGiftCardRecharge` boolean, required — Defines if the purchase of the SKU will generate reward value for the customer.
  - `ImageUrl` string, required — SKU image URL.
  - `DetailUrl` string, required — Product slug.
  - `CSCIdentification` string, nullable, required — SKU seller identification.
  - `BrandId` string, required — Brand ID.
  - `BrandName` string, required — Brand name.
  - `Dimension` Dimension, required — Object containing the SKU dimensions to be used on the shipping calculation.
    - `cubicweight` number, required — SKU [cubic weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).
    - `height` number, required — SKU height.
    - `length` number, required — SKU length.
    - `weight` number, required — SKU weight.
    - `width` number, required — SKU width.
  - `RealDimension` RealDimension, required — Object containing the real SKU dimensions, which appear in the product page.
    - `realCubicWeight` number, required — Real SKU [cubic weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).
    - `realHeight` number, required — Real SKU height.
    - `realLength` number, required — Real SKU length.
    - `realWeight` number, required — Real SKU weight.
    - `realWidth` number, required — Real SKU width.
  - `ManufacturerCode` string, required — Identifier provided by the manufacturers to identify their product. This field should be filled in if the product has a specific manufacturer's code.
  - `IsKit` boolean, required — Defines whether the SKU is made up of one or more SKUs (part of a kit) (`true`) or not (`false`). Must be enabled if you are adding a kit. Once activated, this definition cannot be reverted.
  - `KitItems` string[], required — Array with SKU IDs of bundle components.
  - `Services` string[], required — Array with service IDs that are related to the SKU.
  - `Categories` string[], required — Categories of the related product.
  - `CategoriesFullPath` string[] — Path of categories of the related product.
  - `Attachments` Attachment[], required — Array with attachment IDs that are related to the product.
    - `Id` integer, required — Attachment ID.
    - `Name` string, required — Attachment name.
    - `Keys` string[], required — Attachment Keys.
    - `Fields` object[], required — Array containing attachment fields.
      - `FieldName` string, required — Attachment field name.
      - `MaxCaracters` string, required — Maximum number of characters accepted in the attachment field.
      - `DomainValues` string, nullable, required — Allowed key values.
    - `IsActive` boolean, required — Defines if the attachment is active or not.
    - `IsRequired` boolean, required — Defines if the attachment is required or not.
  - `Collections` string[], required — Array with collections IDs that are related to the product.
  - `SkuSellers` SkuSeller[], required — Array with related sellers data.
    - `SellerId` string, required — 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.
    - `StockKeepingUnitId` integer, required — SKU ID.
    - `SellerStockKeepingUnitId` string, required — SKU ID for the SKU seller.
    - `IsActive` boolean, required — Defines if the SKU is active.
    - `FreightCommissionPercentage` number, required — Registered value for Seller Freight Commission.
    - `ProductCommissionPercentage` number, required — Registered value for Seller product Commission.
  - `SalesChannels` integer[], required — Array of sales channel IDs.
  - `Images` Image[], required — Array of objects with SKU image details.
    - `ImageUrl` string, required — Image URL.
    - `ImageName` string, nullable, required — Image label.
    - `FileId` integer, required — SKU image ID.
  - `SkuSpecifications` SkuSpecification[], required — Array with related SKU specifications.
    - `FieldId` integer, required — Specification field ID.
    - `FieldName` string, required — Specification field Name.
    - `FieldValueIds` integer[], required — Array with related specification values IDs.
    - `FieldValues` string[], required — Array with related specification values.
  - `ProductSpecifications` ProductSpecification[], required — Array with related product specifications.
    - `FieldId` integer, required — Specification field ID.
    - `FieldName` string, required — Specification name. Limited to 100 characters.
    - `FieldValueIds` integer[], required — Array with related specification values IDs.
    - `FieldValues` string[], required — Array with related specification values.
  - `ProductClustersIds` string, required — Product cluster IDs separated by comma (`,`).
  - `PositionsInClusters` object — Product clusters position in each cluster. Structure: "{Product cluster ID}": {Position}. `{Product cluster ID}` is a string, while `{Position}` is an integer.
  - `ProductClusterNames` object — Product clusters names. Structure: "{Product cluster ID}": "{Product cluster name}". Both the key and the value are strings.
  - `ProductClusterHighlights` object — Product clusters highlights. Structure: "{Product cluster ID}": "{Product cluster name}". Both the key and the value are strings.
  - `ProductCategoryIds` string, required — Category path composed by category IDs separated by `/`.
  - `IsDirectCategoryActive` boolean — Indicates if the direct product category is active or not.
  - `ProductGlobalCategoryId` integer, nullable, required — Product global category ID.
  - `ProductCategories` object, required — Object containing product categories. Structure: "{CategoryID}": "{CategoryName}". Both the key and the value are strings.
  - `CommercialConditionId` integer, required — Commercial condition ID, used to define SKU specific promotions or installment rules. In case of no specific condition, use `1` (default value). This field does not accept `0`. Learn more at [Registering a commercial condition](https://help.vtex.com/tutorial/registering-a-commercial-condition--tutorials_445).
  - `RewardValue` number, required — Credit that the customer receives when finalizing an order that includes the SKU. By filling this field out with `1`, the customer receives credit on the site in the selected currency, e.g. U$ 1.
  - `AlternateIds` AlternateIds, required — Array with alternate SKU IDs, such as EAN and `RefId`.
    - `Ean` string — SKU EAN.
    - `RefId` string — SKU reference ID.
  - `AlternateIdValues` string[], required — Array with values of alternative SKU IDs.
  - `EstimatedDateArrival` string, nullable, required — 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.
  - `MeasurementUnit` string, required — Measurement unit. This field should only be used when it is necessary to convert the unit of measure for sale. For example, if a product is sold in boxes, but customers want to buy per square meter (m²). In common cases, use `"un"`.
  - `UnitMultiplier` number, required — Multiple number of SKU. If the multiplier is 5.0000, the product can be added in multiple quantities of 5, 10, 15, 20, onward.
  - `InformationSource` string, nullable, required — Information source.
  - `ModalType` string, nullable, required — Links an unusual type of SKU that needs special transportation, such as meat, glass, or a mattress, 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).
  - `KeyWords` string, nullable — Keywords related to the product.
  - `ReleaseDate` string, nullable — Release date of the product.
  - `ProductIsVisible` boolean — Defines if the product is visible or not.
  - `ShowIfNotAvailable` boolean — Defines if the product will be shown if it is not available.
  - `IsProductActive` boolean — Defines if the product is active or not.
  - `ProductFinalScore` integer — Product final score.

---

[API](https://skmtc.net/vtex/apis/catalog-api.md) · [All operations](https://skmtc.net/vtex/apis/catalog-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/catalog-api/versions/d58c38c07169/schema)