v50

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

Specification field

Get specification field

Retrieves details from a specification field by this field's ID.

⚠️ This is a legacy endpoint. We recommend using Get specification instead.

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_system/pub/specification/fieldGet/{fieldId}

Path parameters

fieldIdinteger required

Example:88

Specification field ID.

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

Namestring

Specification field name.

FieldIdinteger

Specification field ID.

IsActiveboolean

Enable (true) or disable (false) specification.

IsRequiredboolean

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

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.

FieldTypeNamestring

Field type name, which can be Text, Multi-Line Text, Number, Combo, Radio, Checkbox, Indexed Text or Indexed Multi-Line Text.

FieldValueIdinteger nullable

Specification value ID.

Descriptionstring nullable

Deprecated field.

IsStockKeepingUnitboolean

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

IsFilterboolean

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

IsOnProductDetailsboolean

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

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.

IsWizardboolean nullable

Deprecated field.

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 nullable

Specification default value.

FieldGroupIdinteger

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

FieldGroupNamestring

Specification field group name.