v50

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

Product specification

Update product specification by product ID

Updates the value of a product specification by the product's ID. The specification's ID or name can be used to identify what product specification will be updated. specification fields must be previously created in your Catalog.

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

post/api/catalog_system/pvt/products/{productId}/specification

Path parameters

productIdinteger required

Example:1

Product's unique 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.

Request body

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.

Example request

[
  {
    "Value": [
      "Cotton"
    ],
    "Id": 7,
    "Name": "Fabric"
  }
]

v50