VTEX · Schema

SpecificationsInsertFieldUpdateRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
Name string Specification field ID.
CategoryId integer Category ID.
FieldId integer Specification field ID.
IsActive boolean Enables(`true`) or disables (`false`) the specification field.
IsRequired boolean Makes the specification field mandatory (`true`) or optional (`false`).
FieldTypeId integer Specification field type ID.
FieldValueId integer Specification field value ID.
Description string Specification field description.
IsStockKeepingUnit boolean If `true`, it will be added as a SKU specification field. If `false`, it will be added as a product specification field.
IsFilter boolean Store Framework - Deprecated. Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar.
IsOnProductDetails boolean Store Framework - Deprecated. Legacy CMS Portal -If specification is visible on the product page.
Position integer Specification field position.
IsWizard boolean Deprecated field.
IsTopMenuLinkActive boolean Store Framework - Deprecated. Legacy CMS Portal - To make the specification visible in the store's upper menu.
IsSideMenuLinkActive boolean Store Framework - Deprecated. Legacy CMS Portal - To make the specification field clickable in the search navigation bar.
DefaultValue string Specification field default value.
FieldGroupId integer Specification field group ID.
FieldGroupName string Specification field group name.
View JSON Schema on GitHub

JSON Schema

vtex-specificationsinsertfieldupdaterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SpecificationsInsertFieldUpdateRequest",
  "title": "SpecificationsInsertFieldUpdateRequest",
  "required": [
    "Name",
    "CategoryId",
    "IsActive",
    "FieldId",
    "IsRequired",
    "FieldTypeId",
    "Description",
    "IsStockKeepingUnit",
    "IsWizard",
    "IsFilter",
    "IsOnProductDetails",
    "Position",
    "IsTopMenuLinkActive",
    "IsSideMenuLinkActive",
    "DefaultValue",
    "FieldGroupId",
    "FieldGroupName"
  ],
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "Specification field ID."
    },
    "CategoryId": {
      "type": "integer",
      "nullable": true,
      "description": "Category ID."
    },
    "FieldId": {
      "type": "integer",
      "nullable": true,
      "description": "Specification field ID."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Enables(`true`) or disables (`false`) the specification field.",
      "example": true
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Makes the specification field mandatory (`true`) or optional (`false`)."
    },
    "FieldTypeId": {
      "type": "integer",
      "format": "int32",
      "description": "Specification field type ID."
    },
    "FieldValueId": {
      "type": "integer",
      "nullable": true,
      "description": "Specification field value ID."
    },
    "Description": {
      "type": "string",
      "nullable": true,
      "description": "Specification field description."
    },
    "IsStockKeepingUnit": {
      "type": "boolean",
      "description": "If `true`, it will be added as a SKU specification field. If `false`, it will be added as a product specification field."
    },
    "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."
    },
    "IsOnProductDetails": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal -If specification is visible on the product page."
    },
    "Position": {
      "type": "integer",
      "format": "int32",
      "description": "Specification field position."
    },
    "IsWizard": {
      "type": "boolean",
      "description": "Deprecated field.",
      "deprecated": true
    },
    "IsTopMenuLinkActive": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To make the specification visible in the store's upper menu."
    },
    "IsSideMenuLinkActive": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To make the specification field clickable in the search navigation bar.",
      "example": false
    },
    "DefaultValue": {
      "type": "string",
      "nullable": true,
      "example": null,
      "description": "Specification field default value."
    },
    "FieldGroupId": {
      "type": "integer",
      "format": "int32",
      "description": "Specification field group ID.",
      "example": 1
    },
    "FieldGroupName": {
      "type": "string",
      "description": "Specification field group name.",
      "example": "Name"
    }
  }
}