Sign in

v50

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

Get product by reference ID

Retrieves a specific product by its Reference 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:

ProductCategoryResource
CatalogContentProduct management

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/products/productgetbyrefid/{refId}

Path parameters

refIdstring required
Example:12345

Product reference code.

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

OK

Idinteger

ID of the product.

Namestring

Name of the product.

DepartmentIdinteger

ID of product department.

CategoryIdinteger

ID of product category.

BrandIdinteger

ID of the product brand.

LinkIdstring

Category URL.

RefIdstring

Product Reference ID. The limit for the product RefId is 100 characters.

IsVisibleboolean

If the product are visible in search and list pages.

Descriptionstring

Product Description, HTML is allowed.

DescriptionShortstring

Product Short Description.

ReleaseDatestring

Product Release Date, for list ordering and product cluster highlight.

KeyWordsstring

Alternatives Keywords to improve the product findability.

Titlestring

Product's Title tag. Limited to 150 characters. It is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO.

IsActiveboolean

If the product is Active.

TaxCodestring

SKU Tax Code.

MetaTagDescriptionstring

Meta Description for the product page.

SupplierIdinteger

Product Supplier ID.

ShowWithoutStockboolean

If the product can be visible without stock.

ListStoreIdinteger[]

Array with the ID of all the sales channels that are related to the product.

AdWordsRemarketingCodestring

This is a legacy field. Do not take this information into consideration.

LomadeeCampaignCodestring

This is a legacy field. Do not take this information into consideration.