openthorDocumentação
Abrir o painel

GET /v1/agg/devolucao/by-motivo

Devoluções de clientes agregadas por motivo (pedido em desacordo, produto avariado, etc.) — o motivo separa falha comercial de falha logística. · domínio Vendas

Exemplo

cURL
curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/agg/devolucao/by-motivo?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)
  • supervisor_code — numérico (eq · in · gte · lte · gt · lt)
  • customer_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):

  • return_value — Devoluções (R$)
  • return_qty
  • return_nfs

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: return_value · return_qty · return_nfs. Limite padrão 50, máximo 100 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