VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Comissões

POSTPreencher histórico

Cria as entradas de comissão que faltam para pedidos de sellers já concluídos, uma única vez e sem duplicar.

Pedidos concluídos antes de a comissão estar ligada, ou por caminhos que não dispararam o evento de conclusão, ficam sem entradas no razão e sem linha no fluxo por plano. Esta rota é a manutenção que cria o que falta.

Percorre os sub-pedidos de sellers concluídos na janela de datas e cria, para os que ainda não têm, as entradas do razão (pending) e a linha do fluxo por plano. É idempotente: rodar de novo a mesma janela não cria nada novo. Não há tela para isso; é uma rota operacional.

POST/api/v1/admin/commissions/backfillAdmin

Gera entradas de comissão para pedidos já concluídos

Autenticação: Authorization: Bearer <token> de um administrador com o privilégio view_vendors ou manage_vendors (as escritas exigem manage_vendors). O módulo commissions precisa estar ativo na loja; com o módulo desligado a resposta é 403.

Corpo da requisição

fromstring
Data inicial, YYYY-MM-DD. Padrão: cinco anos atrás.
tostring
Data final, YYYY-MM-DD, inclusive (até 23:59:59 do dia). Padrão: agora.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/commissions/backfill" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "2026-01-01",
    "to": "2026-09-30"
  }'

Resposta

200Janela processada
json
{
  "orders_processed": 128
}

Campos da resposta

orders_processedinteger
Quantidade de sub-pedidos processados nesta chamada.

Erros

StatusQuandoCorpo
401Sem token ou token inválido{"error":"missing authorization header"}
403Sem o privilégio exigido, ou módulo desligado{"error":"module_disabled","module":"commissions"} / {"error":"insufficient privileges","required":"manage_vendors"}
400from ou to fora do formato YYYY-MM-DD{"error":"invalid 'from' date, expected YYYY-MM-DD","detail":"..."}
500Falha ao processar{"error":"failed to backfill commissions","detail":"..."}
O corpo é opcional

Sem corpo, a rota usa os últimos cinco anos. As entradas criadas levam a data do pedido, não a de hoje: assim a janela de retenção já está vencida e elas podem ser confirmadas e entrar num repasse logo em seguida.

Pedidos de marketplaces externos

Pedidos que vieram de marketplaces externos (Mercado Livre, Amazon, Shopee) não geram comissão, porque o pagamento acontece no canal e fora do repasse da loja.

Veja também

  • Razão de comissões
  • Comissões por plano
Anterior
Comissões por plano
Próxima
Repasses e dívidas
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também