Get Category Tree

v1.0.0

Retrieves the Category Tree of your store. Get all the category levels registered in the Catalog or define the level up to which you want to get.

📘 Onboarding guide

Check the new . We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey.

Response body example

json

[
    {
        "id": 1,
        "name": "Alimentação",
        "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ção Seca",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/racao-seca",
                "children": [],
                "Title": "Ração Seca para Gatos",
                "MetaTagDescription": ""
            },
            {
                "id": 11,
                "name": "Ração Úmida",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/racao-umida",
                "children": [],
                "Title": "Ração Úmida para Gatos",
                "MetaTagDescription": ""
            }
        ],
        "Title": "Alimentação para Gatos",
        "MetaTagDescription": ""
    },
    {
        "id": 2,
        "name": "Brinquedos",
        "hasChildren": true,
        "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos",
        "children": [
            {
                "id": 12,
                "name": "Bolinhas",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos/bolinhas",
                "children": [],
                "Title": "Bolinhas para Gatos",
                "MetaTagDescription": ""
            },
            {
                "id": 13,
                "name": "Ratinhos",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos/ratinhos",
                "children": [],
                "Title": "Ratinhos",
                "MetaTagDescription": ""
            },
            {
                "id": 19,
                "name": "Arranhador para gato",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos/arranhador-para-gato",
                "children": [],
                "Title": "Brinquedo Arranhador para gatos",
                "MetaTagDescription": "Arranhador gatos é indispensável no lar com felinos. Ideais para afiar as unhas e garantir a diversão"
            }
        ],
        "Title": "Brinquedos para Gatos",
        "MetaTagDescription": ""
    }
]

Input

{
  "type": "object",
  "properties": {
    "Accept": {
      "type": "string"
    },
    "Content-Type": {
      "type": "string"
    },
    "categoryLevels": {
      "type": "string"
    }
  },
  "required": [
    "Accept",
    "Content-Type",
    "categoryLevels"
  ],
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "name",
      "hasChildren",
      "url",
      "children",
      "Title",
      "MetaTagDescription"
    ],
    "properties": {
      "MetaTagDescription": {
        "type": "string",
        "description": "Category page Meta tag description."
      },
      "Title": {
        "type": "string",
        "description": "Category page title."
      },
      "children": {
        "type": "array",
        "description": "Array with information about the category's children.",
        "items": {
          "type": "object",
          "required": [
            "id",
            "name",
            "hasChildren",
            "url",
            "children",
            "Title",
            "MetaTagDescription"
          ],
          "properties": {
            "MetaTagDescription": {
              "type": "string",
              "description": "Category page Meta tag description."
            },
            "Title": {
              "type": "string",
              "description": "Category page title."
            },
            "children": {
              "type": "array",
              "description": "Array with information about the category's children.",
              "items": {
                "type": "object"
              }
            },
            "hasChildren": {
              "type": "boolean",
              "description": "If the category has a category child (`true`) or not (`false`)."
            },
            "id": {
              "type": "integer",
              "format": "int32",
              "description": "Category ID."
            },
            "name": {
              "type": "string",
              "description": "Category name."
            },
            "url": {
              "type": "string",
              "description": "Category URL."
            }
          }
        }
      },
      "hasChildren": {
        "type": "boolean",
        "description": "If the category has a category child (`true`) or not (`false`)."
      },
      "id": {
        "type": "integer",
        "format": "int32",
        "description": "Category ID."
      },
      "name": {
        "type": "string",
        "description": "Category name."
      },
      "url": {
        "type": "string",
        "description": "Category URL."
      }
    }
  }
}