Sign in

v50

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

Get product and its general context

Retrieves a specific product's general information as name, description and the sales channels where it is included.

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 Form

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/productget/{productId}

Path parameters

productIdinteger required
Example:1

Product's unique numerical identifier.

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

Product ID.

Namestring

Product's name. Limited to 150 characters.

DepartmentIdinteger

Product department ID.

CategoryIdinteger

Product category ID.

BrandIdinteger

Product brand ID.

LinkIdstring

Product text link.

RefIdstring

Product reference code.

IsVisibleboolean

If the product is visible on the store.

Descriptionstring

Product description.

DescriptionShortstring

Product complement name.

ReleaseDatestring

Product release date.

KeyWordsstring

Substitutes words for the product.

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 (true) or not (false) at the store.

TaxCodestring

Product fiscal code.

MetaTagDescriptionstring

Product meta tag description.

SupplierIdinteger

Product supplier ID.

ShowWithoutStockboolean

Defines if the product will be shown in the store even if it's out of stock (true) or not (false).

ListStoreIdinteger[]

List with the IDs of sales channels where the product is included.

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.