VTEX · Schema

Category

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
Id integer Category ID.
Name string Category name.
FatherCategoryId integer ID of the father category, apply in case of category and subcategory.
Title string Category page title.
Description string Describes details about the category.
Keywords string Substitutes words for the category.
IsActive boolean Shows if the category is active (`true`) or not (`false`).
LomadeeCampaignCode string This is a legacy field. Do not take this information into consideration.
AdWordsRemarketingCode string This is a legacy field. Do not take this information into consideration.
ShowInStoreFront boolean Defines if the category is shown on side and upper menu (`true`) or not (`false`).
ShowBrandFilter boolean Defines if the category has brand filter (`true`) or not (`false`).
ActiveStoreFrontLink boolean Defines if the category has an active link on the website (`true`) or not (`false`).
GlobalCategoryId integer Google global category ID.
StockKeepingUnitSelectionMode string Defines how the SKU will be exhibited.
Score integer Score for search ordination.
LinkId string Text link.
HasChildren boolean Defines if the category has child categories (`true`) or not (`false`).
View JSON Schema on GitHub

JSON Schema

vtex-category-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Category",
  "title": "Category",
  "required": [
    "Id",
    "Name",
    "FatherCategoryId",
    "Title",
    "Description",
    "Keywords",
    "IsActive",
    "LomadeeCampaignCode",
    "AdWordsRemarketingCode",
    "ShowInStoreFront",
    "ShowBrandFilter",
    "ActiveStoreFrontLink",
    "GlobalCategoryId",
    "StockKeepingUnitSelectionMode",
    "Score",
    "LinkId",
    "HasChildren"
  ],
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer",
      "description": "Category ID."
    },
    "Name": {
      "type": "string",
      "description": "Category name."
    },
    "FatherCategoryId": {
      "type": "integer",
      "description": "ID of the father category, apply in case of category and subcategory.",
      "nullable": true
    },
    "Title": {
      "type": "string",
      "description": "Category page title."
    },
    "Description": {
      "type": "string",
      "description": "Describes details about the category."
    },
    "Keywords": {
      "type": "string",
      "description": "Substitutes words for the category."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Shows if the category is active (`true`) or not (`false`)."
    },
    "LomadeeCampaignCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration.",
      "deprecated": true
    },
    "AdWordsRemarketingCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration.",
      "deprecated": true
    },
    "ShowInStoreFront": {
      "type": "boolean",
      "description": "Defines if the category is shown on side and upper menu (`true`) or not (`false`)."
    },
    "ShowBrandFilter": {
      "type": "boolean",
      "description": "Defines if the category has brand filter (`true`) or not (`false`)."
    },
    "ActiveStoreFrontLink": {
      "type": "boolean",
      "description": "Defines if the category has an active link on the website (`true`) or not (`false`)."
    },
    "GlobalCategoryId": {
      "type": "integer",
      "description": "Google global category ID."
    },
    "StockKeepingUnitSelectionMode": {
      "type": "string",
      "description": "Defines how the SKU will be exhibited."
    },
    "Score": {
      "type": "integer",
      "description": "Score for search ordination.",
      "nullable": true
    },
    "LinkId": {
      "type": "string",
      "description": "Text link.",
      "nullable": true
    },
    "HasChildren": {
      "type": "boolean",
      "description": "Defines if the category has child categories (`true`) or not (`false`)."
    }
  },
  "example": {
    "Id": 1,
    "Name": "Home Appliances",
    "FatherCategoryId": null,
    "Title": "Home Appliances",
    "Description": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.",
    "Keywords": "Kitchen, Laundry, Appliances",
    "IsActive": true,
    "LomadeeCampaignCode": "",
    "AdWordsRemarketingCode": "",
    "ShowInStoreFront": true,
    "ShowBrandFilter": true,
    "ActiveStoreFrontLink": true,
    "GlobalCategoryId": 3367,
    "StockKeepingUnitSelectionMode": "LIST",
    "Score": null,
    "LinkId": "Alimentacao",
    "HasChildren": true
  }
}