Catalog
Catalogo de produtos e servicos
GET/api/ai-agents/{id}/catalog-items
Lista CatalogItems do bot
Escopo exigido: catalog.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
POST/api/ai-agents/{id}/catalog-items
Cria CatalogItem
Escopo exigido: catalog.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | sim | min 1, max 150 |
description | string | não | max 1000 |
price | number | sim | ≥ 0 |
imageUrl | object | string | null | não | — |
category | object | string | null | não | — |
active | boolean | não | — |
order | integer | não | — |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
201— Criado404— Não encontrado — também é a resposta quando o recurso é de outro workspace
PATCH/api/ai-agents/{id}/catalog-items/{itemId}
Edita CatalogItem
Escopo exigido: catalog.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
itemId | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | não | min 1, max 150 |
description | string | não | max 1000 |
price | number | não | ≥ 0 |
imageUrl | object | string | null | não | — |
category | object | string | null | não | — |
active | boolean | não | — |
order | integer | não | — |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items/{itemId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
DELETE/api/ai-agents/{id}/catalog-items/{itemId}
Remove CatalogItem sem mutar o recurso externo do provedor
Escopo exigido: catalog.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
itemId | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items/{itemId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
204— CatalogItem removido com sucesso404— Não encontrado — também é a resposta quando o recurso é de outro workspace