openthorDocumentação

get_top_products

Top produtos por venda · domínio Vendas · escopo mcp:sales

O que faz

Produtos mais vendidos em um período: valor, volume, margem e nº de clientes. Filtre por fornecedor (supplier_code). Use para 'produtos mais vendidos' ou 'top SKUs do fornecedor X'.

Exemplo de pergunta

produtos mais vendidos” — o assistente escolhe esta ferramenta sozinho; você não digita o nome dela.

Parâmetros

ParâmetroTipoObrigatórioPadrãoSignificado
fromdata (YYYY-MM-DD)sim
todata (YYYY-MM-DD)sim
supplier_codeintegernãoFiltra por fornecedor (opcional)
topinteger (1–200)não20
order_bystring (billed_value · sale_value · margin_value · qty)nãobilled_value

O que você recebe

  • product_code — Produto (cód.)
  • billed_value — Faturado (R$, inclui bonificação)
  • sale_value — Venda (R$, sem bonificação)
  • margin_value — Margem (R$)
  • qty — Quantidade
  • customers — Clientes

Cuidados ao ler o resultado

Leia antes de interpretar
  • Apenas produtos vendidos no período; ordenado por valor (ou order_by).

Por trás da ferramenta

Esta ferramenta consulta o endpoint /v1/agg/sales/by-product da API REST — as mesmas permissões e o mesmo recorte da sua credencial valem nos dois caminhos.