Obter todas as categorias

GET https://.account-name.krzlabs.io/api/v1/categories

Realiza a busca de todas as categorias.

---

Request

paginação / link de referência

Entenda como aplicar paginação e ordenação na sua listagem

filtros / link de referência

Entenda como aplicar filtros na sua listagem

expansão / link de referência

Entenda como expandir entidades relacionadas nos documentos da listagem

---

Response

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	optional	searchable
category_id	ObjectId	O identificador da categoria.	not required	false
code	String	Código da categoria. O código deve ser único e é o identificador global da categoria.	required	true
name	Translate	Nome de como a categoria será referenciada no sistema.	required	true
description	Translate	Descrição da categoria. Mais especificamente, sua descrição comercial ou todas as informações que julgar necessário da categoria.	not required	true
tags	Array(String)	Tags da categoria. Tags são utilizadas para categorizar as categorias, permitindo regras de negócio específicas para cada tag e novas organizações de dados.	not required	false
enabled	Boolean	Indica se a categoria está ativa ou não.	required	false
category_tree_id	ObjectId	Identificador global da categoria pai.	required	false
catalog_id	ObjectId	Identificador global do catálogo.	not required	false
catalogs	array(ObjectId)	Identificador global do catálogo.	not required	false
depth	number	Profundidade da categoria.	not required	false
attribute_groups	array(ObjectId)	Identificador global do catálogo.	not required	false

Exemplo de resposta em JSON

{
   "page": 1,
    "skip": 0,
    "limit": 10,
    "sort": {
        "campo": "asc"
    },
    "pages": 5,
    "total": 50,
    "next": true,
    "previous": "2",
    "nextUrl": "https://api.exemplo.com?page=2",
    "previousUrl": false,
    "filters": {
        "status": "ativo"
    },
    "data": [{
        "category_id": "64f1b3d4e5d987654321cdef",
        "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,
        "category_tree_id": "64f1c4e6e5d567890abcd123",
        "catalog_id": "64f1d5f8e5d135790abcdef1",
        "catalogs": [
            "64f1d5f8e5d135790abcdef2",
            "64f1d5f8e5d135790abcdef3"
        ],
        "depth": 2,
        "attribute_groups": [
            "64f1d5f8e5d135790abcdef4",
            "64f1d5f8e5d135790abcdef5"
        ]
    }]
}

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