Create Category

v1.0.0

Creates a new Category.

If there is a need to create a new category with a specific custom ID, specify the Id (integer) in the request. Otherwise, VTEX will generate the ID automatically.

Request body example (automatically generated ID)

json

{
    "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": 604,
    "StockKeepingUnitSelectionMode": "SPECIFICATION",
    "Score": null
}

Request body example (custom ID)

json

{
    "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": null,
    "AdWordsRemarketingCode": null,
    "ShowInStoreFront": true,
    "ShowBrandFilter": true,
    "ActiveStoreFrontLink": true,
    "GlobalCategoryId": 604,
    "StockKeepingUnitSelectionMode": "SPECIFICATION",
    "Score": null
}

Response body example

json

{
    "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": 604,
    "StockKeepingUnitSelectionMode": "LIST",
    "Score": null,
    "LinkId": "Alimentacao",
    "HasChildren": true
}

Input

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

Output

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