openthorDocumentação
Abrir o painel

GET /v1/margin/catalog

Margem de cadastro (rotina 8133) por produto — estado atual do catálogo de preços. · domínio Vendas

Exemplo

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

Colunas retornadas

  • product_code — Produto (cód.)
  • description — Descrição
  • supplier_code — Fornecedor (cód.)
  • region — Região de preço
  • uf — UF
  • list_price — Preço de tabela (R$)
  • custo_240 — Custo próxima compra (R$)
  • registered_margin_pct — Margem digitada no cadastro (%)
  • margin_pct — Margem (%)
  • sem_tributacao — Sem figura tributária (UF)

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: margin_pct · list_price · product_code · supplier_code. Limite padrão 100, máximo 1000 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