openthorDocumentação

GET /v1/agg/trade/penetration-scorecard

Scorecard de penetração de portfólio por fornecedor. · domínio Trade

Exemplo

cURL
curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/agg/trade/penetration-scorecard?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)

Sem janela de datas — este endpoint é um retrato do momento (from/to não se aplicam).

Colunas retornadas

  • supplier_code — Fornecedor (cód.)
  • registered_skus — SKUs cadastrados
  • sold_skus — SKUs vendidos
  • penetration_pct — Penetração (%)
  • customers — Clientes
  • value — Faturamento (R$)

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: penetration_pct · sold_skus · value · customers. Limite padrão 100, máximo 500 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.

Ferramentas MCP sobre este endpoint