openthorDocumentação
Abrir o painel

GET /v1/agg/campaign/sell-out-by-rep-line

Caixas de venda (exclui bonificação) por RCA × linha de produto, para apuração de campanha. · domínio Vendas

Exemplo

cURL
curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/agg/campaign/sell-out-by-rep-line?from=2026-06-01&to=2026-06-30&limit=5"

A autenticação e o formato do envelope { data, meta } são comuns a todos os endpoints — veja Autenticação e Resposta e metadados.

Filtros e período

Campos filtráveis com a sintaxe campo=op:valor:

  • supplier_code — numérico (eq · in · gte · lte · gt · lt)
  • rep_code — numérico (eq · in · gte · lte · gt · lt)
  • customer_code — numérico (eq · in · gte · lte · gt · lt)
  • line_code — numérico (eq · in · gte · lte · gt · lt)

Janela de datas: from/to (inclusivos, formato YYYY-MM-DD) sobre moved_at.

Métricas

Selecione com metrics=m1,m2 (padrão: todas):

  • caixas_sale
  • qty_sale

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: caixas_sale · positivados · qty_sale · nfs_sale. Limite padrão 2000, máximo 5000 linhas por chamada; pagine com offset enquanto meta.has_more for true.

O que sua chave enxerga

O recorte da credencial (filial, vendedor, cliente, fornecedor, janela de datas) é aplicado no servidor e não pode ser ampliado por filtros — dois usuários podem ver totais diferentes no mesmo endpoint, por desenho.