Create Specification

v1.0.0

Creates a new Product or SKU Specification.

Request body example

json

{
    "FieldTypeId": 1,
    "CategoryId": 4,
    "FieldGroupId": 20,
    "Name": "Material",
    "Description": "Composition of the product.",
    "Position": 1,
    "IsFilter": true,
    "IsRequired": true,
    "IsOnProductDetails": false,
    "IsStockKeepingUnit": false,
    "IsActive": true,
    "IsTopMenuLinkActive": false,
    "IsSideMenuLinkActive": true,
    "DefaultValue": "Cotton"
}

Response body example

json

{
    "Id": 88,
    "FieldTypeId": 1,
    "CategoryId": 4,
    "FieldGroupId": 20,
    "Name": "Material",
    "Description": "Composition of the product.",
    "Position": 1,
    "IsFilter": true,
    "IsRequired": true,
    "IsOnProductDetails": false,
    "IsStockKeepingUnit": false,
    "IsWizard": false,
    "IsActive": true,
    "IsTopMenuLinkActive": false,
    "IsSideMenuLinkActive": true,
    "DefaultValue": "Cotton"
}

Input

{
  "type": "object",
  "properties": {
    "Accept": {
      "type": "string"
    },
    "CategoryId": {
      "type": "integer",
      "description": "Category ID associated with this specification."
    },
    "Content-Type": {
      "type": "string"
    },
    "DefaultValue": {
      "type": "string",
      "description": "Specification default value."
    },
    "Description": {
      "type": "string"
    },
    "FieldGroupId": {
      "type": "integer",
      "description": "ID of the group of specifications that contains the new specification."
    },
    "FieldTypeId": {
      "type": "integer",
      "description": "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`."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Enable (`true`) or disable (`false`) specification."
    },
    "IsFilter": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar.\r\n"
    },
    "IsOnProductDetails": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal -If specification is visible on the product page.\r\n"
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Makes the specification mandatory (`true`) or optional (`false`)."
    },
    "IsSideMenuLinkActive": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To make the specification field clickable in the search navigation bar.\r\n"
    },
    "IsStockKeepingUnit": {
      "type": "boolean",
      "description": "If `true`, it will be added as a SKU specification. If `false`, it will be added as a product specification field."
    },
    "IsTopMenuLinkActive": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To make the specification visible in the store's upper menu.\r\n"
    },
    "IsWizard": {
      "type": "boolean"
    },
    "Name": {
      "type": "string",
      "description": "Specification name."
    },
    "Position": {
      "type": "integer",
      "description": "Store Framework - Deprecated.\r\nLegacy 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.\r\n"
    }
  },
  "required": [
    "Accept",
    "Content-Type",
    "FieldGroupId",
    "FieldTypeId",
    "Name"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "CategoryId": {
      "type": "integer",
      "description": "Category ID associated with this specification."
    },
    "DefaultValue": {
      "type": "string",
      "description": "Specification default value."
    },
    "Description": {
      "type": "string"
    },
    "FieldGroupId": {
      "type": "integer",
      "description": "ID of the group of specifications that contains the new specification."
    },
    "FieldTypeId": {
      "type": "integer",
      "description": "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`."
    },
    "Id": {
      "type": "integer",
      "description": "Specification ID."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Enable (`true`) or disable (`false`) specification."
    },
    "IsFilter": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar.\r\n"
    },
    "IsOnProductDetails": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal -If specification is visible on the product page.\r\n"
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Makes the specification mandatory (`true`) or optional (`false`)."
    },
    "IsSideMenuLinkActive": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To make the specification field clickable in the search navigation bar.\r\n"
    },
    "IsStockKeepingUnit": {
      "type": "boolean",
      "description": "If `true`, it will be added as a SKU specification. If `false`, it will be added as a product specification field."
    },
    "IsTopMenuLinkActive": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To make the specification visible in the store's upper menu.\r\n"
    },
    "IsWizard": {
      "type": "boolean"
    },
    "Name": {
      "type": "string",
      "description": "Specification name."
    },
    "Position": {
      "type": "integer",
      "description": "Store Framework - Deprecated.\r\nLegacy 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.\r\n"
    }
  }
}