put https://{accountName}.{environment}.com.br/api/catalog/pvt/specification/
Updates a Product or SKU Specification
Request body has the following properties:
Attribute | Type | Description |
---|---|---|
FieldTypeId | integer | Field Type can be 1 - Text, 2 - Multi-Line Text, 3 - Número, 4 - Combo, 5 - Radio, 6 - Checkbox, 7 - Indexed Text, 8 - Indexed Multi-Line Text |
CategoryId | integer | Specification Category ID |
FieldGroupId | integer | Numerical ID of the Group of Specifications that contains the new Specification |
Name | string | Specification Name |
Description | string | Specification Description |
Position | integer | The current Specification position in comparison to the others |
IsFilter | boolean | If the Specification can be used as a Filter |
IsRequired | boolean | If the Specification is required or not |
IsOnProductDetails | boolean | If the Specification will be shown on the Product screen in the specification area |
IsStockKeepingUnit | boolean | If the Specification is applied to a specific SKU |
IsWizard | boolean | Deprecated |
IsActive | boolean | If the Specification is active or not |
IsTopMenuLinkActive | boolean | Shows if the Specification is shown in the main menu of the site |
IsSideMenuLinkActive | boolean | Shows if the Specification is shown in the side menu |
DefaultValue | string | Specification Default Value |
Request body example:
{
"FieldTypeId": 5,
"CategoryId": 1,
"FieldGroupId": 13,
"Name": "Test",
"Description": "Test",
"Position": 1,
"IsFilter": true,
"IsRequired": true,
"IsOnProductDetails": true,
"IsStockKeepingUnit": false,
"IsWizard": false,
"IsActive": false,
"IsTopMenuLinkActive": false,
"IsSideMenuLinkActive": true,
"DefaultValue": "Test"
}
Response body has the following properties:
Attribute | Type | Description |
---|---|---|
Id | integer | Created Specification’s ID |
FieldTypeId | integer | Field Type can be 1 - Text, 2 - Multi-Line Text, 3 - Número, 4 - Combo, 5 - Radio, 6 - Checkbox, 7 - Indexed Text, 8 - Indexed Multi-Line Text |
CategoryId | integer | Category ID |
FieldGroupId | integer | Numerical ID of the Group of Specifications that contains the new Specification |
Name | string | Specification Name |
Description | string | Specification Description |
Position | integer | The current Specification position in comparison to the others |
IsFilter | boolean | If the Specification can be used as a Filter |
IsRequired | boolean | If the Specification is required or not |
IsOnProductDetails | boolean | If the Specification will be shown on the Product screen in the specification area |
IsStockKeepingUnit | boolean | If the Specification is applied to a specific SKU |
IsWizard | boolean | Deprecated |
IsActive | boolean | If the Specification is active or not |
IsTopMenuLinkActive | boolean | Shows if the Specification is shown in the main menu of the site |
IsSideMenuLinkActive | boolean | Shows if the Specification is shown in the side menu |
DefaultValue | string | Specification Default Value |
Response body example:
{
"Id": 25,
"FieldTypeId": 5,
"CategoryId": 1,
"FieldGroupId": 13,
"Name": "Test",
"Description": "Test",
"Position": 1,
"IsFilter": true,
"IsRequired": true,
"IsOnProductDetails": true,
"IsStockKeepingUnit": false,
"IsWizard": false,
"IsActive": false,
"IsTopMenuLinkActive": false,
"IsSideMenuLinkActive": true,
"DefaultValue": "Test"
}