Get Specification

v1.0.0

Retrieves information of a Product or SKU Specification.

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"
    },
    "Content-Type": {
      "type": "string"
    },
    "specificationId": {
      "type": "integer"
    }
  },
  "required": [
    "Accept",
    "Content-Type",
    "specificationId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "CategoryId",
    "DefaultValue",
    "Description",
    "FieldGroupId",
    "FieldTypeId",
    "Id",
    "IsActive",
    "IsFilter",
    "IsOnProductDetails",
    "IsRequired",
    "IsSideMenuLinkActive",
    "IsStockKeepingUnit",
    "IsTopMenuLinkActive",
    "IsWizard",
    "Name",
    "Position"
  ],
  "properties": {
    "CategoryId": {
      "type": "integer",
      "description": "Specification Category ID."
    },
    "DefaultValue": {
      "type": "string",
      "description": "Specification Default Value."
    },
    "Description": {
      "type": "string",
      "description": "Specification Description."
    },
    "FieldGroupId": {
      "type": "integer",
      "description": "Numerical ID of the Group of Specifications that contains the new Specification."
    },
    "FieldTypeId": {
      "type": "integer",
      "description": "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`."
    },
    "Id": {
      "type": "integer",
      "description": "Created Specification’s ID."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the Specification is active or not."
    },
    "IsFilter": {
      "type": "boolean",
      "description": "Defines if the Specification can be used as a Filter."
    },
    "IsOnProductDetails": {
      "type": "boolean",
      "description": "Defines if the Specification will be shown on the Product screen in the specification area."
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Defines if the Specification is required or not."
    },
    "IsSideMenuLinkActive": {
      "type": "boolean",
      "description": "Defines if the Specification is shown in the side menu."
    },
    "IsStockKeepingUnit": {
      "type": "boolean",
      "description": "Defines if the Specification is applied to a specific SKU."
    },
    "IsTopMenuLinkActive": {
      "type": "boolean",
      "description": "Defines if the Specification is shown in the main menu of the site."
    },
    "IsWizard": {
      "type": "boolean",
      "description": "Deprecated"
    },
    "Name": {
      "type": "string",
      "description": "Specification Name."
    },
    "Position": {
      "type": "integer",
      "description": "The current Specification's position in comparison to the other Specifications."
    }
  }
}