v50

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

Specification value

Create specification value

Creates a new specification value for a category.

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

post/api/catalog/pvt/specificationvalue

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

FieldIdinteger required

Specification field ID associated with this specification value.

Namestring required

Specification value name.

Textstring nullable

Specification value text.

IsActiveboolean

Enable (true) or disable (false) specification value.

Positioninteger

The position of the value to be shown on product registration page (/admin/Site/Produto.aspx).

Example request

{
  "FieldId": 193,
  "Name": "Metal",
  "IsActive": true,
  "Position": 1
}

Response

FieldValueIdinteger

Specification value ID.

FieldIdinteger