VTEX · Schema

CreateCategoryRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
Id	integer	Category unique identifier. If not informed, it will be automatically generated by VTEX.
Name	string	Category name.
Keywords	string	Substitute words for the category.
Title	string	Text used in title tag for category page.
Description	string	Text used in meta description tag for category page.
AdWordsRemarketingCode	string	This is a legacy field. Do not take this information into consideration.
LomadeeCampaignCode	string	This is a legacy field. Do not take this information into consideration.
FatherCategoryId	integer	ID of the parent category, apply in case of category and subcategory.
GlobalCategoryId	integer	Google global category ID.
ShowInStoreFront	boolean	If `true`, the category is shown in the top and side menu.
IsActive	boolean	If `true`, the category page becomes available in store.
ActiveStoreFrontLink	boolean	If `true`, the category link becomes active in store.
ShowBrandFilter	boolean	If `true`, the category page displays a brand filter.
Score	integer	Score for search sorting order.
StockKeepingUnitSelectionMode	string	Defines how the SKU will be exhibited

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateCategoryRequest",
  "title": "CreateCategoryRequest",
  "type": "object",
  "required": [
    "Name",
    "Keywords",
    "Title",
    "Description",
    "AdWordsRemarketingCode",
    "LomadeeCampaignCode",
    "FatherCategoryId",
    "GlobalCategoryId",
    "ShowInStoreFront",
    "IsActive",
    "ActiveStoreFrontLink",
    "ShowBrandFilter",
    "Score",
    "StockKeepingUnitSelectionMode"
  ],
  "properties": {
    "Id": {
      "type": "integer",
      "description": "Category unique identifier. If not informed, it will be automatically generated by VTEX.",
      "example": 1
    },
    "Name": {
      "type": "string",
      "description": "Category name.",
      "example": "Home Appliances"
    },
    "Keywords": {
      "type": "string",
      "description": "Substitute words for the category.",
      "example": "Kitchen, Laundry, Appliances"
    },
    "Title": {
      "type": "string",
      "description": "Text used in title tag for category page.",
      "example": "Home Appliances"
    },
    "Description": {
      "type": "string",
      "description": "Text used in meta description tag for category page.",
      "example": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now."
    },
    "AdWordsRemarketingCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration.",
      "example": "Sale",
      "nullable": true,
      "deprecated": true
    },
    "LomadeeCampaignCode": {
      "type": "string",
      "description": "This is a legacy field. Do not take this information into consideration.",
      "example": "Sale",
      "nullable": true,
      "deprecated": true
    },
    "FatherCategoryId": {
      "type": "integer",
      "description": "ID of the parent category, apply in case of category and subcategory.",
      "example": 2,
      "nullable": true
    },
    "GlobalCategoryId": {
      "type": "integer",
      "description": "Google global category ID.",
      "example": 222
    },
    "ShowInStoreFront": {
      "type": "boolean",
      "description": "If `true`, the category is shown in the top and side menu.",
      "example": true
    },
    "IsActive": {
      "type": "boolean",
      "description": "If `true`, the category page becomes available in store.",
      "example": true
    },
    "ActiveStoreFrontLink": {
      "type": "boolean",
      "description": "If `true`, the category link becomes active in store.",
      "example": true
    },
    "ShowBrandFilter": {
      "type": "boolean",
      "description": "If `true`, the category page displays a brand filter.",
      "example": true
    },
    "Score": {
      "type": "integer",
      "description": "Score for search sorting order.",
      "nullable": true,
      "example": 3
    },
    "StockKeepingUnitSelectionMode": {
      "type": "string",
      "description": "Defines how the SKU will be exhibited",
      "example": "SPECIFICATION"
    }
  },
  "example": {
    "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": null,
    "AdWordsRemarketingCode": null,
    "ShowInStoreFront": true,
    "ShowBrandFilter": true,
    "ActiveStoreFrontLink": true,
    "GlobalCategoryId": 800,
    "StockKeepingUnitSelectionMode": "SPECIFICATION",
    "Score": null
  }
}