v50

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

Get product specifications by product ID

Retrieves all specifications of a product by the product's ID.

📘 Onboarding guide

Check the new Catalog onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey.

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

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

Valuestring[] required

Array with specification values.

Idinteger

Specification field ID, which is the same as FieldId in other specification endpoints.

Namestring

Name of the specification.