v50

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

Update specification

Updates a product specification or SKU specification.

⚠️ It is not possible to edit FieldTypeId, CategoryId, FieldGroupId or IsStockKeepingUnit in this API call.

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

Path parameters

specificationIdinteger required
Example:88

Specification'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

FieldTypeId1 | 2 | 4 | 5 | 6 | 7 | 8 | 9 required

Field type can be 1 - Text, 2 - Multi-Line Text, 4 - Number, 5 - Combo, 6 - Radio, 7 - Checkbox, 8 - Indexed Text, 9 - Indexed Multi-Line Text. This information is not editable.

CategoryIdinteger required

Specification category ID. This information is not editable.

FieldGroupIdinteger required

Numerical ID of the specification group that contains the new specification. This information is not editable.

Namestring required

Specification name. Limited to 100 characters.

Descriptionstring required

Specification description.

Positioninteger required

The current specification's position in comparison to the other specifications.

IsFilterboolean required

Defines if the specification can be used as a filter.

IsRequiredboolean required

Defines if the specification is required or not.

IsOnProductDetailsboolean required

Defines if the specification will be shown on the product screen in the specification area.

IsStockKeepingUnitboolean required

Defines if the specification is applied to a specific SKU. This information is not editable.

IsWizardboolean required

Deprecated field.

IsActiveboolean required

Defines if the specification is active or not.

IsTopMenuLinkActiveboolean required

Defines if the specification is shown in the main menu of the site.

IsSideMenuLinkActiveboolean required

Defines if the specification is shown in the side menu.

DefaultValuestring required

Specification default value.

Example request

{
  "FieldTypeId": 1,
  "Name": "Material",
  "Description": "Composition of the product.",
  "Position": 1,
  "DefaultValue": "Leather"
}

Response

OK

Idinteger

Specification ID.

FieldTypeIdinteger

Field type ID can be 1 - Text, 2 - Multi-Line Text, 4 - Number, 5 - Combo, 6 - Radio, 7 - Checkbox, 8 - Indexed Text, 9 - Indexed Multi-Line Text.

CategoryIdinteger

Category ID associated with this specification.

FieldGroupIdinteger

ID of the group of specifications that contains the new specification.

Namestring

Specification name. Limited to 100 characters.

Descriptionstring nullable

Deprecated field.

Positioninteger

Store Framework - Deprecated. Legacy CMS Portal - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page.

IsFilterboolean

Store Framework - Deprecated. Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar.

IsRequiredboolean

Makes the specification mandatory (true) or optional (false).

IsOnProductDetailsboolean

Store Framework - Deprecated. Legacy CMS Portal -If specification is visible on the product page.

IsStockKeepingUnitboolean

If true, it will be added as a SKU specification. If false, it will be added as a product specification field.

IsWizardboolean nullable

Deprecated field.

IsActiveboolean

Enable (true) or disable (false) specification.

IsTopMenuLinkActiveboolean

Store Framework - Deprecated. Legacy CMS Portal - To make the specification visible in the store's upper menu.

IsSideMenuLinkActiveboolean

Store Framework - Deprecated. Legacy CMS Portal - To make the specification field clickable in the search navigation bar.

DefaultValuestring

Specification default value.