Skip to content

Categorias de Produtos

Visão Geral

As categorias são responsáveis por organizar os produtos dentro da loja, criando uma estrutura hierárquica que facilita a navegação do catálogo 🗂️.

Elas permitem agrupar produtos por tipo, finalidade ou segmento, como por exemplo:

Eletrônicos

  • Celulares
  • Notebooks

    • Casa e Decoração

  • Móveis
  • Iluminação

    • No contexto administrativo, o lojista pode criar, atualizar, organizar e remover categorias, garantindo que a estrutura do catálogo reflita corretamente a organização desejada.

    As categorias também podem possuir diferentes configurações dependendo da política comercial, permitindo comportamentos específicos conforme a regra aplicada.

    Entidades Envolvidas

  • Categoria (Category)
    • Representa a estrutura organizacional utilizada para agrupar produtos.

  • Produto (Product)
    • Produtos são vinculados às categorias para definir onde serão exibidos no catálogo.

  • Filtros (Filters)
    • Filtros podem ser associados a categorias, determinando quais opções de filtragem estarão disponíveis para os produtos daquela categoria.

  • Política Comercial (Trade Policy)
    • Algumas configurações de categorias podem variar conforme a política comercial aplicada.

    Notas e Considerações

  • Categorias podem possuir estrutura hierárquica, formando árvores de categorias.
  • Cada categoria pode possuir categorias pai e categorias filhas.
  • A organização correta das categorias melhora a navegação e descoberta de produtos dentro da loja.
  • Algumas configurações podem variar conforme a política comercial utilizada ⚙️.

Listagem de arvores de categoria

GET /products/categories/tree

Retorna uma lista de arvores de categorias da loja

Descrição

Endpoint responsável por listar as árvores de categorias cadastradas na loja 🌳.

Atua em contexto administrativo, permitindo que o lojista visualize a estrutura completa das categorias.

Por meio desse endpoint, é possível visualizar as categorias juntamente com suas hierarquias, entendendo a relação entre categorias pai e filhas.

Isso facilita a configuração e organização das categorias, tornando mais simples o gerenciamento da estrutura do catálogo dentro do painel administrativo ⚙️.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {userToken}Token de autenticação

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/products/categories/tree \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2  "registers": [
3    {
4			"id": 1,
5			"name": "tecnologia",
6			"url": "tecnologia",
7			"children": [
8				{
9					"id": 2,
10					"name": "smartphones",
11					"url": "",
12					"children": [],
13					"parentProductCategoryId": 1,
14					"code": "cat-smartphones",
15					"active": true,
16					"directAccess": true
17				},
18				{
19					"id": 3,
20					"name": "computadores",
21					"url": "",
22					"children": [],
23					"parentProductCategoryId": 1,
24					"code": "cat-computadores",
25					"active": true,
26					"directAccess": true
27				}
28			],
29			"parentProductCategoryId": null,
30			"code": "cat-tecnologia",
31			"active": true,
32			"directAccess": true
33		}
34  ],
35  "pagination": {
36    "limit": 10,
37    "offset": 0,
38    "pages": 1,
39    "registers": 10
40  }
41}

Busca detalhes de uma arvore de categoria

GET /products/categories/{categoryId}/tree

Permite que o lojista veja detalhes de uma arvore de categoria

Descrição

Endpoint responsável por retornar os detalhes de uma árvore de categorias a partir de uma categoria específica 🌳.

Atua em contexto administrativo, permitindo que o lojista visualize a estrutura hierárquica relacionada à categoria informada.

Por meio desse endpoint, é possível navegar pela árvore de categorias, entendendo como a categoria se organiza dentro da estrutura do catálogo.

Isso facilita a visualização de relações entre categorias pai e filhas, contribuindo para o gerenciamento e a organização da estrutura de categorias no painel administrativo.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {userToken}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
categoryIdintegerSimIdentificador da categoria a ser consultada

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/products/categories/{categoryId}/tree \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2  "current": {
3    "id": 3,
4    "name": "processador",
5    "url": "tecnologia/processador"
6  },
7  "children": [],
8  "sisters": [],
9  "parent": [
10    {
11      "id": 1,
12      "name": "Tecnologia",
13      "url": "tecnologia"
14    },
15    {
16      "id": 2,
17      "name": "computadores",
18      "url": "tecnologia/computadores"
19    }
20  ]
21}

⚠️ Erro retornado:

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}

Uappi é a melhor opção para o crescimento da sua loja!

Institucional

;