VTEX · Schema

GetCategoryTree

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	integer	Category ID.
name	string	Category name.
hasChildren	boolean	If the category has a category child (`true`) or not (`false`).
url	string	Category URL.
children	array	Array with information about the category's children.
Title	string	Category page title.
MetaTagDescription	string	Category page Meta tag description.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetCategoryTree",
  "title": "GetCategoryTree",
  "required": [
    "id",
    "name",
    "hasChildren",
    "url",
    "children",
    "Title",
    "MetaTagDescription"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Category ID.",
      "example": 1
    },
    "name": {
      "type": "string",
      "description": "Category name.",
      "example": "Toys"
    },
    "hasChildren": {
      "type": "boolean",
      "description": "If the category has a category child (`true`) or not (`false`).",
      "example": true
    },
    "url": {
      "type": "string",
      "description": "Category URL.",
      "example": "https://lojadobreno.vtexcommercestable.com.br/toys"
    },
    "children": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GetCategoryTreeChild"
      },
      "description": "Array with information about the category's children."
    },
    "Title": {
      "type": "string",
      "description": "Category page title.",
      "example": "Toys"
    },
    "MetaTagDescription": {
      "type": "string",
      "description": "Category page Meta tag description.",
      "example": "New and used toys for sale."
    }
  },
  "example": {
    "id": 1,
    "name": "Alimenta\u00e7\u00e3o",
    "hasChildren": true,
    "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao",
    "children": [
      {
        "id": 6,
        "name": "Bebedouro",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/bebedouro",
        "children": [],
        "Title": "Bebedouro para Gatos",
        "MetaTagDescription": ""
      },
      {
        "id": 7,
        "name": "Comedouro",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/comedouro",
        "children": [],
        "Title": "Comedouro para Gatos",
        "MetaTagDescription": ""
      },
      {
        "id": 8,
        "name": "Biscoitos",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/biscoitos",
        "children": [],
        "Title": "Biscoitos para Gatos",
        "MetaTagDescription": ""
      },
      {
        "id": 9,
        "name": "Petiscos",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/petiscos",
        "children": [],
        "Title": "Petiscos para Gatos",
        "MetaTagDescription": ""
      },
      {
        "id": 10,
        "name": "Ra\u00e7\u00e3o Seca",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/racao-seca",
        "children": [],
        "Title": "Ra\u00e7\u00e3o Seca para Gatos",
        "MetaTagDescription": ""
      },
      {
        "id": 11,
        "name": "Ra\u00e7\u00e3o \u00damida",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/racao-umida",
        "children": [],
        "Title": "Ra\u00e7\u00e3o \u00damida para Gatos",
        "MetaTagDescription": ""
      }
    ],
    "Title": "Alimenta\u00e7\u00e3o para Gatos",
    "MetaTagDescription": ""
  }
}