Obter todos os catálogos

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

Realiza a busca de todos os catálogos

---

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	optional	description	Searchable
code (unique)	string	not required	Código do catálogo. O código deve ser único e é o identificador global do catálogo.	true
name	string	required	Nome do catálogo.	true
description	string	not required	Descrição do catálogo.	false
enabled	boolean	not required	Indica se o catálogo está ativo ou não.	false
products	array(ObjectId)	not required	Identificadores globais dos produtos.	false
categories	array(ObjectId)	not required	Identificadores globais das categorias.	false
users_groups	array(ObjectId)	not required	Identificadores globais dos grupos de usuários.	false
users	array(ObjectId)	not required	Identificadores globais dos usuários.	false
tags	array(String)	not required	Tags do catálogo.	false
image	string	not required	Imagem do catálogo.	false

Exemplo de resposta em JSON

{
  "code": "catalogo_001",
  "name": "Catálogo de Verão",
  "description": "Coleção de produtos para a temporada de verão.",
  "enabled": true,
  "products": [
    "64f8a123bcf0a1e45f8c9d01",
    "64f8a123bcf0a1e45f8c9d02"
  ],
  "categories": [
    "64f8a123bcf0a1e45f8c9c11",
    "64f8a123bcf0a1e45f8c9c12"
  ],
  "users_groups": [
    "64f8a123bcf0a1e45f8c9b21"
  ],
  "users": [
    "64f8a123bcf0a1e45f8c9a01",
    "64f8a123bcf0a1e45f8c9a02"
  ],
  "tags": ["oferta", "sazonal", "lançamento"],
  "image": "https://cdn.exemplo.com/catalogos/catalogo_001.png"
}

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