Sales

adjust_product_stock

Write

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

Permission

sales:write

Operation

products.stock.adjust

Module

sales

Parameters

productIdstringrequired

adjustmentintegerrequired

analyze_sales_pipeline

Read

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

Permission

sales:read

Operation

sales.insights

Module

sales

Parameters

No parameters.

create_product

Write

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

Permission

sales:write

Operation

products.create

Module

sales

Parameters

namestringrequired

descriptionstringoptional

pricenumberrequired

Em reais (ex.: 89.9).

compareAtPricenumberoptional

Preço "de" (riscado).

priceUnitstringoptional

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

categorystringoptional

imageUrlstringoptional

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

stockintegeroptional

null = sem controle.

showInShopbooleanoptional

Aparece na vitrine pública.

kindstringoptional

PHYSICALSERVICE

conditionstringoptional

NEWUSEDREFURBISHED

brandstringoptional

tagsstring[]optional

create_sales_deal

Write

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.

Permission

sales:write

Operation

deals.create

Module

sales

Parameters

titlestringrequired

contactIdstringrequired

valuenumberoptional

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

itemsobject[]optional

items[].productIdstringrequired

items[].quantitynumberrequired

items[].unitPricenumberrequired

pipelineIdstringoptional

pipelineStageIdstringoptional

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

conversationIdstringoptional

assignedToIdstringoptional

notesstringoptional

expectedCloseDatestringoptional

Data prevista de fechamento.

originSourceTypestringoptional

CAMPAIGNFORMINBOUNDIMPORTMANUAL

originCampaignIdstringoptional

originFunnelIdstringoptional

dealTemplateIdstringoptional

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

customFieldsobjectoptional

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

Write

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

Permission

sales:write

Operation

pipeline.stages.create

Module

sales

Parameters

namestringrequired

colorstringoptional

probabilitynumberoptional

Chance de ganho na etapa (0–100).

pipelineIdstringoptional

entryActivityTypestringoptional

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

delete_sales_deal

Write

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

Permission

sales:write

Operation

deals.delete

Module

sales

Parameters

dealIdstringrequired

delete_sales_pipeline_stage

Write

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

Permission

sales:write

Operation

pipeline.stages.delete

Module

sales

Parameters

stageIdstringrequired

get_deal_score

Read

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.

Permission

sales:read

Operation

deals.score

Module

sales

Parameters

dealIdstringrequired

get_product

Read

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

Permission

sales:read

Operation

products.get

Module

sales

Parameters

productIdstringrequired

get_sales_deal

Read

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

Permission

sales:read

Operation

deals.get

Module

sales

Parameters

dealIdstringrequired

get_sales_summary

Read

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.

Permission

sales:read

Operation

sales.summary

Module

sales

Parameters

daysintegeroptional

Período em dias.

pipelineIdstringoptional

list_payments

Read

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.

Permission

sales:read

Operation

payments.list

Module

sales

Parameters

statusstringoptional

PENDINGPAIDCANCELLED

dealIdstringoptional

dateFromstringoptional

dateTostringoptional

limitintegeroptional

list_products

Read

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.

Permission

sales:read

Operation

products.list

Module

sales

Parameters

searchstringoptional

categorystringoptional

inShopbooleanoptional

lowStockintegeroptional

Só com estoque até este número.

list_quotes

Read

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.

Permission

sales:read

Operation

proposals.list

Module

sales

Parameters

statusstringoptional

DRAFTSENTVIEWEDACCEPTEDREJECTED

dealIdstringoptional

dateFromstringoptional

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

dateTostringoptional

limitintegeroptional

list_sales_deals

Read

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.

Permission

sales:read

Operation

deals.list

Module

sales

Parameters

openbooleanoptional

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

stagestringoptional

LEADQUALIFIEDPROPOSALNEGOTIATIONWONLOST

pipelineStageIdstringoptional

stageNamestringoptional

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

searchstringoptional

contactIdstringoptional

assignedToIdstringoptional

pipelineIdstringoptional

minValuenumberoptional

maxValuenumberoptional

sortstringoptional

recentvalue

pageintegeroptional

limitintegeroptional

list_sales_pipeline_stages

Read

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.

Permission

sales:read

Operation

pipeline.stages

Module

sales

Parameters

pipelineIdstringoptional

includeDealsbooleanoptional

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

move_sales_deal

Write

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.

Permission

sales:write

Operation

deals.move

Module

sales

Parameters

dealIdstringrequired

pipelineStageIdstringrequired

lostReasonstringoptional

reorder_sales_pipeline_stage

Write

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

Permission

sales:write

Operation

pipeline.stages.reorder

Module

sales

Parameters

stageIdstringrequired

orderintegerrequired

schedule_deal_activity

Write

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.

Permission

sales:write

Operation

deals.activities.create

Module

sales

Parameters

dealIdstringrequired

typestringrequired

CALLVISITMEETINGSEND_PROPOSALFOLLOW_UPOTHER

titlestringoptional

descriptionstringoptional

dueDatestring (date-time)optional

ISO 8601 com fuso.

assigneeIdstringoptional

send_sales_quote

WriteNeeds approval

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.

Permission

sales:write

Operation

deals.proposals.send

Module

sales

Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.

Parameters

dealIdstringrequired

itemsobject[]optional

items[].productIdstringrequired

items[].quantitynumberrequired

channelstringoptional

WHATSAPPEMAIL

conditionsstringoptional

set_deal_custom_fields

Write

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.

Permission

sales:write

Operation

deals.custom_fields.set

Module

sales

Parameters

dealIdstringrequired

valuesobjectrequired

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

Write

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).

Permission

sales:write

Operation

products.update

Module

sales

Parameters

productIdstringrequired

namestringoptional

descriptionstringoptional

pricenumberoptional

Em reais (ex.: 89.9).

compareAtPricenumberoptional

Preço "de" (riscado).

priceUnitstringoptional

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

categorystringoptional

imageUrlstringoptional

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

stockintegeroptional

null = sem controle.

showInShopbooleanoptional

Aparece na vitrine pública.

kindstringoptional

PHYSICALSERVICE

conditionstringoptional

NEWUSEDREFURBISHED

brandstringoptional

tagsstring[]optional

update_sales_deal

Write

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.

Permission

sales:write

Operation

deals.update

Module

sales

Parameters

dealIdstringrequired

titlestringoptional

valuenumberoptional

contactIdstringoptional

assignedToIdstringoptional

Nulo tira o responsável.

notesstringoptional

Nulo limpa.

lostReasonstringoptional

expectedCloseDatestringoptional

Nulo limpa.

update_sales_pipeline_stage

Write

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

Permission

sales:write

Operation

pipeline.stages.update

Module

sales

Parameters

stageIdstringrequired

namestringoptional

colorstringoptional

probabilitynumberoptional

Chance de ganho na etapa (0–100).

entryActivityTypestringoptional

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