Obter uma Árvore de Categorias

GET https://.account-name.krzlabs.io/api/v1/category-trees/:id

Realiza a busca de uma árvore de categorias.


Path Params

id string required
ID da árvore de categorias.

Response

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type Description optional Searchable
code (unique) string Código da categoria. required true
name translate Nome da categoria. required true
description translate Descrição da categoria. not required false
tags array(string) Tags da categoria. not required false
enabled boolean Ativo da categoria. required false
default boolean Default da categoria. not required false
catalogs array(ObjectId) Catalogos da categoria. not required false
Exemplo em JSON
{
  "code": "CAT001",
  "name": {
    "pt": "Nome da Categoria",
    "en": "Category Name"
  },
  "description": {
    "pt": "Descrição da categoria",
    "en": "Category description"
  },
  "tags": [
    "promoção",
    "oferta",
    "novidade"
  ],
  "enabled": true,
  "default": false,
  "catalogs": [
    "64f1d5f8e5d135790abcdef1",
    "64f1d5f8e5d135790abcdef2"
  ]
}

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved