Create Specifications Field

Creates a specification field in a category.

📘

This is a legacy endpoint. We recommend using Create Specification instead.

Request object has the following properties:

AttributeTypeDescription
NamestringSpecification Field ID
CategoryIdintegerCategory ID
FieldIdintegerSpecification Field ID
IsActivebooleanIf the Specification Field is active, default value is true
IsRequiredbooleanIf the Specification Field is required
FieldTypeIdintegerSpecification Field Type ID
FieldValueIdintegerSpecification Field Value ID
DescriptionstringSpecification Field Description
IsStockKeepingUnitbooleanIf is a SKU Specification Field
IsFilterbooleanIf is a Filter Specification
IsOnProductDetailsbooleanIf is visible in Product Page, default value is false
PositionintegerSpecification Field Position
IsWizardbooleanObsolete Field
IsTopMenuLinkActivebooleanIf is visible in Top Menu, default value is false
IsSideMenuLinkActivebooleanIf is visible in Menu Link, default value is false
DefaultValuestringSpecification Field default Value
FieldGroupIdintegerSpecification Field Group ID
FieldGroupNamestringSpecification Field Group Name
FieldTypeIds:  
1 - Text  
2 - Multi-Line Text  
4 - Number  
5 - Combo  
6 - Radio  
7 - CheckBox  
8 - Indexed Text  
9 - Indexed Multi-Line Text

Read more about FieldTypeIds in our Help Center article.

Response object has the following properties:

AttributeTypeDescription
NamestringSpecification Field ID
CategoryIdintegerCategory ID
FieldIdintegerSpecification Field ID
IsActivebooleanIf the Specification Field is active
IsRequiredbooleanIf the Specification Field is required
FieldTypeIdintegerSpecification Field Type ID
FieldValueIdintegerSpecification Field Value ID
DescriptionintegerSpecification Field Description
IsStockKeepingUnitbooleanIf is a SKU Specification Field
IsFilterbooleanIf is a Filter Specification
IsOnProductDetailsbooleanIf is visible in Product Page
PositionintegerSpecification Field Position
IsWizardbooleanObsolete Field
IsTopMenuLinkActivebooleanIf is visible in Top Menu
IsSideMenuLinkActivebooleanIf is visible in Menu Link
DefaultValuestringSpecification Field default Value
FieldGroupIdintegerSpecification Field Group ID
FieldGroupNamestringSpecification Field Group Name

Authentication

This is a private API which requires credentials with viewer access.

Learn more about Creating appKeys and appTokens to authenticate integrations

Language
Authentication
URL
Click Try It! to start a request and see the response here!