Vendas

adjust_product_stock

Escrita

Soma ou tira do estoque (ex.: +10 chegou mercadoria, -1 venda fora do sistema).

Permissão

sales:write

Operação

products.stock.adjust

Módulo

sales

Parâmetros

productIdstringobrigatório

adjustmentintegerobrigatório

analyze_sales_pipeline

Leitura

Números do funil: totais, conversão, previsão e análise. Use para resumos e para priorizar.

Permissão

sales:read

Operação

sales.insights

Módulo

sales

Parâmetros

Sem parâmetros.

create_product

Escrita

Cadastra um produto ou serviço no catálogo (e na vitrine, a não ser que showInShop venha false).

Permissão

sales:write

Operação

products.create

Módulo

sales

Parâmetros

namestringobrigatório

descriptionstringopcional

pricenumberobrigatório

Em reais (ex.: 89.9).

compareAtPricenumberopcional

Preço "de" (riscado).

priceUnitstringopcional

Por mês, hora, m², kg…

categorystringopcional

imageUrlstringopcional

Foto da capa (https); o Cognizy guarda uma cópia.

stockintegeropcional

null = sem controle.

showInShopbooleanopcional

Aparece na vitrine pública.

kindstringopcional

PHYSICALSERVICE

conditionstringopcional

NEWUSEDREFURBISHED

brandstringopcional

tagsstring[]opcional

create_sales_deal

Escrita

Cria um negócio para um contato, na etapa e no funil informados (ou na primeira etapa do funil padrão). Valor direto ou por itens de produto.

Permissão

sales:write

Operação

deals.create

Módulo

sales

Parâmetros

titlestringobrigatório

contactIdstringobrigatório

valuenumberopcional

Valor. Com itens, o valor vem da soma deles.

itemsobject[]opcional

items[].productIdstringobrigatório

items[].quantitynumberobrigatório

items[].unitPricenumberobrigatório

pipelineIdstringopcional

pipelineStageIdstringopcional

Etapa de entrada (define também o funil).

conversationIdstringopcional

assignedToIdstringopcional

notesstringopcional

expectedCloseDatestringopcional

Data prevista de fechamento.

originSourceTypestringopcional

CAMPAIGNFORMINBOUNDIMPORTMANUAL

originCampaignIdstringopcional

originFunnelIdstringopcional

dealTemplateIdstringopcional

Modelo de negócio (pode ter campos próprios).

customFieldsobjectopcional

Campos de negócio por chave (gerais e do modelo; veja list_custom_fields). Valor inválido recusa a criação.

create_sales_pipeline_stage

Escrita

Cria uma etapa no fim do funil de vendas informado (ou do padrão).

Permissão

sales:write

Operação

pipeline.stages.create

Módulo

sales

Parâmetros

namestringobrigatório

colorstringopcional

probabilitynumberopcional

Chance de ganho na etapa (0–100).

pipelineIdstringopcional

entryActivityTypestringopcional

Atividade criada para o responsável quando um negócio entra na etapa.

delete_sales_deal

Escrita

Apaga um negócio. Exige o id exato; não dá para desfazer.

Permissão

sales:write

Operação

deals.delete

Módulo

sales

Parâmetros

dealIdstringobrigatório

delete_sales_pipeline_stage

Escrita

Apaga uma etapa do funil de vendas que não tenha negócios.

Permissão

sales:write

Operação

pipeline.stages.delete

Módulo

sales

Parâmetros

stageIdstringobrigatório

get_deal_score

Leitura

Saúde (0–100) e chance de ganhar um negócio, com risco, tendência, a frase que explica a nota, os motivos e o próximo passo sugerido. Use para revisar negócios em risco ou explicar a previsão.

Permissão

sales:read

Operação

deals.score

Módulo

sales

Parâmetros

dealIdstringobrigatório

get_product

Leitura

Um produto completo, com as fotos e as variações (tamanho, cor…) com preço e estoque de cada uma.

Permissão

sales:read

Operação

products.get

Módulo

sales

Parâmetros

productIdstringobrigatório

get_sales_deal

Leitura

Detalhe de um negócio: contato, etapa, itens, pagamentos e responsável.

Permissão

sales:read

Operação

deals.get

Módulo

sales

Parâmetros

dealIdstringobrigatório

get_sales_summary

Leitura

Resumo rápido das vendas: quanto está em aberto no funil e, no período, quanto foi ganho, quantos perdidos e a conversão. Para previsão e análise detalhada, use analyze_sales_pipeline.

Permissão

sales:read

Operação

sales.summary

Módulo

sales

Parâmetros

daysintegeropcional

Período em dias.

pipelineIdstringopcional

list_payments

Leitura

Cobranças dos negócios (Pix, cartão, boleto): valor, situação (PENDING, PAID, CANCELLED), quando foi paga, o negócio e o contato — e o total pago e pendente no filtro. Período pela data de pagamento com status PAID; senão pela criação.

Permissão

sales:read

Operação

payments.list

Módulo

sales

Parâmetros

statusstringopcional

PENDINGPAIDCANCELLED

dealIdstringopcional

dateFromstringopcional

dateTostringopcional

limitintegeropcional

list_products

Leitura

Produtos e serviços do catálogo (a vitrine): nome, preço, preço "de", estoque, se aparece na vitrine, tipo, condição, marca e foto. search busca por nome, descrição e etiqueta.

Permissão

sales:read

Operação

products.list

Módulo

sales

Parâmetros

searchstringopcional

categorystringopcional

inShopbooleanopcional

lowStockintegeropcional

Só com estoque até este número.

list_quotes

Leitura

Orçamentos (propostas) enviados: negócio, contato, valor, situação (DRAFT, SENT, VIEWED, ACCEPTED, REJECTED), quando foi enviado, aberto (e quantas vezes) e respondido, e o motivo da recusa.

Permissão

sales:read

Operação

proposals.list

Módulo

sales

Parâmetros

statusstringopcional

DRAFTSENTVIEWEDACCEPTEDREJECTED

dealIdstringopcional

dateFromstringopcional

Criados desde (AAAA-MM-DD, Brasília).

dateTostringopcional

limitintegeropcional

list_sales_deals

Leitura

Lista negócios do funil da empresa inteira, com filtros por etapa, abertos, busca (título ou contato), contato, responsável e faixa de valor, ordenados pelos mais recentes ou pelo maior valor. Use para revisar o funil, achar negócios parados ou os maiores abertos.

Permissão

sales:read

Operação

deals.list

Módulo

sales

Parâmetros

openbooleanopcional

Só negócios ainda abertos (nem ganhos nem perdidos).

stagestringopcional

LEADQUALIFIEDPROPOSALNEGOTIATIONWONLOST

pipelineStageIdstringopcional

stageNamestringopcional

Parte do nome da etapa do funil, ex.: "Negociação".

searchstringopcional

contactIdstringopcional

assignedToIdstringopcional

pipelineIdstringopcional

minValuenumberopcional

maxValuenumberopcional

sortstringopcional

recentvalue

pageintegeropcional

limitintegeropcional

list_sales_pipeline_stages

Leitura

Etapas do funil (id, nome, ordem e quantos negócios há em cada). Use antes de mover um negócio, para achar o id da etapa.

Permissão

sales:read

Operação

pipeline.stages

Módulo

sales

Parâmetros

pipelineIdstringopcional

includeDealsbooleanopcional

Traz os negócios de cada etapa (pesado; prefira list_sales_deals).

move_sales_deal

Escrita

Move um negócio para outra etapa do funil (registra histórico, webhooks e follow-ups). Perdido exige motivo. Pegue o id da etapa em list_sales_pipeline_stages.

Permissão

sales:write

Operação

deals.move

Módulo

sales

Parâmetros

dealIdstringobrigatório

pipelineStageIdstringobrigatório

lostReasonstringopcional

reorder_sales_pipeline_stage

Escrita

Muda a posição de uma etapa no funil (0 = primeira).

Permissão

sales:write

Operação

pipeline.stages.reorder

Módulo

sales

Parâmetros

stageIdstringobrigatório

orderintegerobrigatório

schedule_deal_activity

Escrita

Agenda uma atividade de venda (ligação, visita, reunião, enviar proposta, retorno) num negócio. Vira card no quadro de vendas, com lembrete 30 min antes. Responsável padrão: o dono do negócio.

Permissão

sales:write

Operação

deals.activities.create

Módulo

sales

Parâmetros

dealIdstringobrigatório

typestringobrigatório

CALLVISITMEETINGSEND_PROPOSALFOLLOW_UPOTHER

titlestringopcional

descriptionstringopcional

dueDatestring (date-time)opcional

ISO 8601 com fuso.

assigneeIdstringopcional

send_sales_quote

EscritaPede aprovação

Monta um orçamento (proposta) para o negócio com produtos do catálogo, no preço do catálogo, e envia ao contato pelo WhatsApp (com o PDF) ou e-mail. Sem itens, usa os itens do negócio. Com Asaas ou chave Pix, o cliente aceita e paga pelo link. Vindo de chave de API ou de agente, vai para a fila de aprovação (vence em 4 h) e só sai quando alguém da equipe aprova: diga que aguarda aprovação.

Permissão

sales:write

Operação

deals.proposals.send

Módulo

sales

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

dealIdstringobrigatório

itemsobject[]opcional

items[].productIdstringobrigatório

items[].quantitynumberobrigatório

channelstringopcional

WHATSAPPEMAIL

conditionsstringopcional

set_deal_custom_fields

Escrita

Grava campos personalizados de um negócio (os gerais e os do modelo dele; só os informados mudam; null apaga). Valor fora do tipo recusa tudo e diz o motivo.

Permissão

sales:write

Operação

deals.custom_fields.set

Módulo

sales

Parâmetros

dealIdstringobrigatório

valuesobjectobrigatório

Valores por chave do campo (veja list_custom_fields). Número aceita "850.000" ou "1.250,50"; data AAAA-MM-DD ou DD/MM/AAAA; seleção, uma das opções. null apaga.

update_product

Escrita

Edita um produto: nome, preço, preço "de", descrição, foto, estoque, vitrine, tipo, condição, marca, etiquetas. Produto com variações tem preço e estoque por variação (mude na tela).

Permissão

sales:write

Operação

products.update

Módulo

sales

Parâmetros

productIdstringobrigatório

namestringopcional

descriptionstringopcional

pricenumberopcional

Em reais (ex.: 89.9).

compareAtPricenumberopcional

Preço "de" (riscado).

priceUnitstringopcional

Por mês, hora, m², kg…

categorystringopcional

imageUrlstringopcional

Foto da capa (https); o Cognizy guarda uma cópia.

stockintegeropcional

null = sem controle.

showInShopbooleanopcional

Aparece na vitrine pública.

kindstringopcional

PHYSICALSERVICE

conditionstringopcional

NEWUSEDREFURBISHED

brandstringopcional

tagsstring[]opcional

update_sales_deal

Escrita

Altera título, valor, contato, responsável, observações, motivo de perda ou data prevista de um negócio. Para mudar de etapa, use move_sales_deal.

Permissão

sales:write

Operação

deals.update

Módulo

sales

Parâmetros

dealIdstringobrigatório

titlestringopcional

valuenumberopcional

contactIdstringopcional

assignedToIdstringopcional

Nulo tira o responsável.

notesstringopcional

Nulo limpa.

lostReasonstringopcional

expectedCloseDatestringopcional

Nulo limpa.

update_sales_pipeline_stage

Escrita

Altera nome, cor, chance de ganho ou atividade de entrada de uma etapa.

Permissão

sales:write

Operação

pipeline.stages.update

Módulo

sales

Parâmetros

stageIdstringobrigatório

namestringopcional

colorstringopcional

probabilitynumberopcional

Chance de ganho na etapa (0–100).

entryActivityTypestringopcional

Atividade criada para o responsável quando um negócio entra na etapa.