Árvores de Categorias
Visão Geral
Uma árvore de categorias é uma estrutura hierárquica utilizada para organizar informações em múltiplos níveis, permitindo que categorias principais contenham subcategorias.
Seu objetivo é proporcionar:
- Melhor organização dos dados
- Facilidade de navegação
- Maior escalabilidade
- Consistência estrutural dentro do sistema
- SEO
- Integrações com ferramentas do Google
- Construção de breadcrumb
- Exibição de menus e navegação
- Estruturação da navegação da loja
Os endpoints de árvores de categorias podem atender a diferentes finalidades, como:
Esses endpoints são fundamentais para definir grupos de produtos e determinar onde devem ser exibidos dentro da loja.
Árvore de uma categoria
/publics/products/categories/{categoryId}/tree
Retorna estrutura hierárquica de uma categoria específica com suas subcategorias, irmãs e pais
Descrição
Endpoint responsável por retornar a estrutura hierárquica de uma categoria específica, incluindo:
- Subcategorias
- Categorias irmãs
- Categorias pai
Trata-se de uma rota pública, estando sujeita a uma busca criteriosa para garantir desempenho e segurança na consulta dos dados.
Parâmetros de Query
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| categoryId | integer | Sim | ID único da categoria |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/publics/products/categories/{categoryId}/tree \3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \✅ Resposta de Sucesso
HTTP Status: 200 OK
1{2 "current": {3 "id": 10,4 "name": "Smartphones",5 "url": "/categoria/smartphones"6 },7 "children": [8 {9 "id": 101,10 "name": "iPhone",11 "url": "/categoria/iphone"12 },13 {14 "id": 102,15 "name": "Samsung Galaxy",16 "url": "/categoria/samsung-galaxy"17 }18 ],19 "sisters": [20 {21 "id": 11,22 "name": "Tablets",23 "url": "/categoria/tablets"24 },25 {26 "id": 12,27 "name": "Notebooks",28 "url": "/categoria/notebooks"29 }30 ],31 "parent": [32 {33 "id": 1,34 "name": "Eletrônicos",35 "url": "/categoria/eletronicos"36 }37 ]38}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
1{2 "status": false,3 "data": {4 "code": 404,5 "errorCode": "UAPPI_STORE_CATEGORY_NOT_FOUND",6 "message": "The requested category was not found."7 }8}Árvore de Categorias
/publics/products/categories/tree
Retorna estrutura hierárquica completa de categorias ativas
Descrição
Endpoint responsável por retornar a estrutura hierárquica completa das categorias ativas 🌳📂.
A resposta inclui todos os níveis da árvore de categorias disponíveis.
Trata-se de uma rota pública, portanto está sujeita a uma busca criteriosa para garantir desempenho, segurança e retorno apenas de categorias ativas.
Parâmetros de Query
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/publics/products/categories/tree \✅ Resposta de Sucesso
1[2 {3 "id": 1,4 "name": "Eletrônicos",5 "url": "/categoria/eletronicos",6 "children": [7 {8 "id": 10,9 "name": "Smartphones",10 "url": "/categoria/smartphones",11 "children": [12 {13 "id": 101,14 "name": "iPhone",15 "url": "/categoria/iphone",16 "children": []17 },18 {19 "id": 102,20 "name": "Samsung Galaxy",21 "url": "/categoria/samsung-galaxy",22 "children": []23 }24 ]25 },26 {27 "id": 11,28 "name": "Tablets",29 "url": "/categoria/tablets",30 "children": [31 {32 "id": 111,33 "name": "iPad",34 "url": "/categoria/ipad",35 "children": []36 }37 ]38 }39 ]40 },41 {42 "id": 2,43 "name": "Roupas",44 "url": "/categoria/roupas",45 "children": [46 {47 "id": 20,48 "name": "Masculino",49 "url": "/categoria/masculino",50 "children": [51 {52 "id": 201,53 "name": "Camisetas",54 "url": "/categoria/camisetas-masculinas",55 "children": []56 }57 ]58 }59 ]60 }61]