v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB

SKU EAN

Get SKU by EAN

Retrieves an SKU by its EAN ID.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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 for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/catalog_system/pvt/sku/stockkeepingunitbyean/{ean}

Path parameters

eanstring required

Example:1234567890123

EAN of the SKU which you need to retrieve details from.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

Idinteger required

SKU ID.

ProductIdinteger required

Product ID.

NameCompletestring required

Product name and SKU name combined.

ComplementNamestring

Product complement name.

ProductNamestring required

Product name.

ProductDescriptionstring required

Product description. HTML is allowed.

ProductRefIdstring

Product reference ID.

TaxCodestring

SKU tax code.

SkuNamestring required

SKU name.

IsActiveboolean required

Defines if the SKU is active or not.

IsTransportedboolean required

Deprecated field.

IsInventoriedboolean required

Deprecated field.

IsGiftCardRechargeboolean required

Defines if the purchase of the SKU will generate reward value for the customer.

ImageUrlstring required

SKU image URL.

DetailUrlstring required

Product slug.

CSCIdentificationstring nullable required

SKU seller identification.

BrandIdstring required

Brand ID.

BrandNamestring required

Brand name.

ManufacturerCodestring 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.

IsKitboolean 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.

KitItemsstring[] required

Array with SKU IDs of bundle components.

Servicesstring[] required

Array with service IDs that are related to the SKU.

Categoriesstring[] required

Categories of the related product.

CategoriesFullPathstring[]

Path of categories of the related product.

Collectionsstring[] required

Array with collections IDs that are related to the product.

SalesChannelsinteger[] required

Array of sales channel IDs.

ProductClustersIdsstring required

Product cluster IDs separated by comma (,).

PositionsInClustersobject

Product clusters position in each cluster. Structure: "{Product cluster ID}": {Position}.

{Product cluster ID} is a string, while {Position} is an integer.

ProductClusterNamesobject

Product clusters names. Structure: "{Product cluster ID}": "{Product cluster name}". Both the key and the value are strings.

ProductClusterHighlightsobject

Product clusters highlights. Structure: "{Product cluster ID}": "{Product cluster name}". Both the key and the value are strings.

ProductCategoryIdsstring required

Category path composed by category IDs separated by /.

IsDirectCategoryActiveboolean

Indicates if the direct product category is active or not.

ProductGlobalCategoryIdinteger nullable required

Product global category ID.

ProductCategoriesobject required

Object containing product categories. Structure: "{CategoryID}": "{CategoryName}". Both the key and the value are strings.

CommercialConditionIdinteger 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.

RewardValuenumber 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.

AlternateIdValuesstring[] required

Array with values of alternative SKU IDs.

EstimatedDateArrivalstring nullable required

SKU estimated arrival date in 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.

MeasurementUnitstring 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".

UnitMultipliernumber 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.

InformationSourcestring nullable required

Information source.

ModalTypestring 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 and Setting up modal for carriers.

KeyWordsstring nullable

Keywords related to the product.

ReleaseDatestring nullable

Release date of the product.

ProductIsVisibleboolean

Defines if the product is visible or not.

ShowIfNotAvailableboolean

Defines if the product will be shown if it is not available.

IsProductActiveboolean

Defines if the product is active or not.

ProductFinalScoreinteger

Product final score.