openthorDocumentação

GET /v1/agg/margin/catalog/by-supplier

Qualidade da margem de cadastro agregada por fornecedor. · domínio Vendas

Exemplo

cURL
curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/agg/margin/catalog/by-supplier?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:

  • product_code — numérico (eq · in · gte · lte · gt · lt)
  • region — numérico (eq · in · gte · lte · gt · lt)
  • margin_pct — numérico (eq · in · gte · lte · gt · lt)
  • uf — numérico (eq · in · gte · lte · gt · lt)
  • uf — texto (somente eq · in)

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

Métricas

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

  • skus_total — SKUs (total)
  • skus_negative — SKUs com margem negativa
  • min_margin_pct — Margem mínima (%)
  • avg_margin_pct — Margem média (%)
  • avg_registered_margin_pct — Margem digitada média (%)
  • skus_sem_tributacao — SKUs sem tributação

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: skus_total · skus_negative · min_margin_pct · avg_margin_pct · skus_sem_tributacao. Limite padrão 50, máximo 200 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.