API

Catálogo

Endpoints para gerenciar catálogos de produtos

Os endpoints de catálogo exigem o plano Essential ou superior.

📋 Listar Catálogos

GET/guilds/{guildId}/catalogs

Query Params

Prop

Type

Resposta

[
  {
    "id": "clx...",
    "reference": "catalogo-verao",
    "title": "Coleção Verão",
    "description": "Produtos da coleção de verão",
    "products": ["id1", "id2"],
    "status": "ACTIVED"
  }
]

GET/guilds/{guildId}/catalogs/{id}

Também é possível buscar pela referência:

GET/guilds/{guildId}/catalogs/by-reference/{reference}

POST/guilds/{guildId}/catalogs

Body

Prop

Type

Exemplo

{
  "reference": "catalogo-verao",
  "createdBy": "123456789012345678",
  "title": "Coleção Verão",
  "products": ["clx_produto_1", "clx_produto_2"]
}

PATCH/guilds/{guildId}/catalogs/{id}

Prop

Type


DELETE/guilds/{guildId}/catalogs/{id}

🔢 Contar Catálogos

GET/guilds/{guildId}/catalogs/count
{ "count": 5 }