v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-18160240.4 KB

Product

Get product by ID

📘 This API is part of the Seller Portal Catalog. This functionality is in the beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Center.

Retrieves general information about a product by its ID. The response also has information about the product's SKUs.

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
CatalogV2	Management	Product Read

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-seller-portal/products/{productId}

Path parameters

productIdstring required

Example:189371

Product unique identifier number.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

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

Response

idstring

Product's unique identifier number.

externalIdstring

Product reference unique identifier number in the store.

statusstring required

Status of the product. Its values can be active or inactive.

namestring required

Product name. Use simple words and avoid other languages or complex writing. This field is essential for SEO and must respect the 150 character limit.

brandIdstring required

Product's brand unique identifier number.

descriptionstring

Description data for product.

brandNamestring required

Name of the brand associated with the product.

categoryIdsstring[] required

Product's categories unique identifier numbers. It can have multiples IDs for each category and subcategories.

categoryNamesstring[] required

Names of the product's categories, displayed in a path format.

slugstring required

Reference of the product in the URL of the store.

transportModalstring nullable

Transport modal of the product.

taxCodestring nullable

Product tax code.

originstring required

Origin account of the product. It is not possible to alter products where the origin is marketplace.

createdAtstring required

Date when the product was created.

updatedAtstring required

Last date when the product was updated.

All 16 operations