v50

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

Associate product specification using specification name and group name

Associates a specification to a product using specification name and group name. Automatically creates the informed group, specification and values if they had not been created before.

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 and SKU 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.

put/api/catalog/pvt/product/{productId}/specificationvalue

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.

Request body

FieldNamestring required

Specification name. Limited to 100 characters.

GroupNamestring required

Group name.

RootLevelSpecificationboolean required

Root level specification.

FieldValuesstring[] required

Array of specification values.

Example request

{
  "FieldName": "Material",
  "GroupName": "Composition",
  "RootLevelSpecification": true,
  "FieldValues": [
    "Cotton",
    "Polyester"
  ]
}

Response

OK

Idinteger

ID of the association of the product and the specification.

ProductIdinteger

Product ID.

FieldIdinteger

Specification field ID.

FieldValueIdinteger

Current specification value ID.

Textstring

Current specification value text.