v50

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

Specification

Get specification by specification ID

Retrieves information of a product or SKU specification.

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.

get/api/catalog/pvt/specification/{specificationId}

Path parameters

specificationIdinteger required

Example:1

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.

Response

Idinteger required

Created specification's ID.

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.

CategoryIdinteger required

Specification category ID.

FieldGroupIdinteger required

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

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.

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 nullable required

Specification default value.