Resumos de comissões
Totais para o painel: razão de comissões, repasses e fluxo de aprovação por plano.
Três rotas de leitura que agregam números prontos, sem paginação. Todos os valores são inteiros em centavos.
Resumo do razão
Totais do razão e dos repasses, para o painel de comissões. Soma tudo, de todos os sellers e de todo o período.
/api/v1/admin/commission-summaryAdminResumo do razão de comissões
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.
Sem parâmetros.
Exemplo de requisição
Resposta
Campos da resposta
total_commissionsintegertotal_vendor_earningsintegerpending_entriesintegerP).pending_amountintegerconfirmed_entriesintegerA).confirmed_amountintegerpending_payoutsintegerpending_payout_amountintegertotal_paid_outintegerrule_countintegerErros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token ou token inválido | {"error":"missing authorization header"} |
| 403 | Sem o privilégio exigido, ou módulo desligado | {"error":"module_disabled","module":"commissions"} / {"error":"insufficient privileges","required":"manage_vendors"} |
| 500 | Falha na consulta | {"error":"failed to get commission summary","detail":"..."} |
Resumo do razão (caminho alternativo)
Mesmo resumo da rota anterior, publicado sob /commissions. Não confunda com o resumo do fluxo por plano, que está em /commissions/workflow-summary.
/api/v1/admin/commissions/summaryAdminResumo do razão de comissões (caminho alternativo)
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.
Sem parâmetros.
Exemplo de requisição
Resposta
Campos da resposta
total_commissionsintegertotal_vendor_earningsintegerpending_entriesintegerP).pending_amountintegerconfirmed_entriesintegerA).confirmed_amountintegerpending_payoutsintegerpending_payout_amountintegertotal_paid_outintegerrule_countintegerErros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token ou token inválido | {"error":"missing authorization header"} |
| 403 | Sem o privilégio exigido, ou módulo desligado | {"error":"module_disabled","module":"commissions"} / {"error":"insufficient privileges","required":"manage_vendors"} |
| 500 | Falha na consulta | {"error":"failed to get commission summary","detail":"..."} |
Resumo do fluxo por plano
Totais das comissões por plano por estado. É o que alimenta os cartões da aba de fluxo de aprovação.
/api/v1/admin/commissions/workflow-summaryAdminResumo das comissões por plano (pendentes, aprovadas, pagas)
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.
Parâmetros de consulta
vendor_iduuidExemplo de requisição
Resposta
Campos da resposta
total_pendingintegertotal_approvedintegertotal_paidintegertotal_all_timeintegerpending_countintegerapproved_countintegerpaid_countintegerErros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token ou token inválido | {"error":"missing authorization header"} |
| 403 | Sem o privilégio exigido, ou módulo desligado | {"error":"module_disabled","module":"commissions"} / {"error":"insufficient privileges","required":"manage_vendors"} |
| 500 | vendor_id que não é UUID ou falha na consulta | {"error":"failed to get workflow summary","detail":"..."} |