Get Category Tree

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.

Response body has the following properties:

AttributeTypeDescription
idintegerCategory ID
namestringCategory Name
hasChildrenbooleanIf the Category has a Category Child
urlintegerCategory URL
childrenarray of objectCategory Child Object
TitlestringCategory page Meta Title
MetaTagDescriptionstringCategory page Meta Description

Response body example:

[
    {
        "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": ""
    },
    {
        "id": 3,
        "name": "Higiene",
        "hasChildren": true,
        "url": "https://lojadobreno.vtexcommercestable.com.br/higiene",
        "children": [
            {
                "id": 14,
                "name": "Areia",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/higiene/areia",
                "children": [],
                "Title": "Areia para Gatos",
                "MetaTagDescription": ""
            },
            {
                "id": 15,
                "name": "Caixa de Areia",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/higiene/caixa-de-areia",
                "children": [],
                "Title": "Caixa de Areia para Gatos",
                "MetaTagDescription": ""
            },
            {
                "id": 16,
                "name": "Pá Higiênica",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/higiene/pa-higienica",
                "children": [],
                "Title": "Pá Higiênica para Gatos",
                "MetaTagDescription": ""
            },
            {
                "id": 17,
                "name": "Tesoura de Unhas",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/higiene/tesoura-de-unhas",
                "children": [],
                "Title": "Tesoura de Unhas para Gatos",
                "MetaTagDescription": ""
            },
            {
                "id": 18,
                "name": "Escova",
                "hasChildren": false,
                "url": "https://lojadobreno.vtexcommercestable.com.br/higiene/escova",
                "children": [],
                "Title": "Escova para Gatos",
                "MetaTagDescription": ""
            }
        ],
        "Title": "Higiene para Gatos",
        "MetaTagDescription": ""
    },
    {
        "id": 4,
        "name": "Arranhadores",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/arranhadores",
        "children": [],
        "Title": "Arranhadores para Gatos",
        "MetaTagDescription": ""
    },
    {
        "id": 5,
        "name": "Caixas de Transporte",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/caixas-de-transporte",
        "children": [],
        "Title": "Caixas de Transporte de Gatos",
        "MetaTagDescription": ""
    },
    {
        "id": 20,
        "name": "teste",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/teste",
        "children": [],
        "Title": null,
        "MetaTagDescription": "teste"
    },
    {
        "id": 21,
        "name": "teste",
        "hasChildren": false,
        "url": "https://lojadobreno.vtexcommercestable.com.br/teste",
        "children": [],
        "Title": "aaaa",
        "MetaTagDescription": "teste"
    }
]

Authentication

This is a public API, so it does not need credentials to access.

Language
Authentication
URL
Click Try It! to start a request and see the response here!