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.

GET/api/v1/admin/commission-summaryAdmin

Resumo 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

bash

curl "$BASE_URL/api/v1/admin/commission-summary" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Resumo devolvido

json

{
  "total_commissions": 249480071,
  "total_vendor_earnings": 2245320655,
  "pending_entries": 3,
  "pending_amount": 1458,
  "confirmed_entries": 41269,
  "confirmed_amount": 184042162,
  "pending_payouts": 1,
  "pending_payout_amount": 99816,
  "total_paid_out": 587135876,
  "rule_count": 2
}

Campos da resposta

total_commissionsinteger

Tudo que a loja reteve, em centavos, somando todas as entradas do razão.

total_vendor_earningsinteger

Tudo que os sellers ganharam, em centavos, somando todas as entradas.

pending_entriesinteger

Quantidade de entradas pendentes (P).

pending_amountinteger

Comissão da loja nas entradas pendentes, em centavos.

confirmed_entriesinteger

Quantidade de entradas confirmadas (A).

confirmed_amountinteger

Comissão da loja nas entradas confirmadas, em centavos.

pending_payoutsinteger

Repasses gerados ainda em aberto.

pending_payout_amountinteger

Valor desses repasses em aberto, em centavos.

total_paid_outinteger

Total de repasses concluídos, em centavos.

rule_countinteger

Quantidade de regras de comissão ativas.

Erros

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.

GET/api/v1/admin/commissions/summaryAdmin

Resumo do razão de comissões (caminho alternativo)

Sem parâmetros.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/commissions/summary" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Resumo devolvido

json

{
  "total_commissions": 249480071,
  "total_vendor_earnings": 2245320655,
  "pending_entries": 3,
  "pending_amount": 1458,
  "confirmed_entries": 41269,
  "confirmed_amount": 184042162,
  "pending_payouts": 1,
  "pending_payout_amount": 99816,
  "total_paid_out": 587135876,
  "rule_count": 2
}

Campos da resposta

total_commissionsinteger

Tudo que a loja reteve, em centavos, somando todas as entradas do razão.

total_vendor_earningsinteger

Tudo que os sellers ganharam, em centavos, somando todas as entradas.

pending_entriesinteger

Quantidade de entradas pendentes (P).

pending_amountinteger

Comissão da loja nas entradas pendentes, em centavos.

confirmed_entriesinteger

Quantidade de entradas confirmadas (A).

confirmed_amountinteger

Comissão da loja nas entradas confirmadas, em centavos.

pending_payoutsinteger

Repasses gerados ainda em aberto.

pending_payout_amountinteger

Valor desses repasses em aberto, em centavos.

total_paid_outinteger

Total de repasses concluídos, em centavos.

rule_countinteger

Quantidade de regras de comissão ativas.

Erros

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.

GET/api/v1/admin/commissions/workflow-summaryAdmin

Resumo das comissões por plano (pendentes, aprovadas, pagas)

Parâmetros de consulta

vendor_iduuid

Restringe a um seller. Omitido, soma a loja inteira.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/commissions/workflow-summary?vendor_id=9d9d9d56-eb43-4719-889d-055632f7c7da" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Resumo devolvido

json

{
  "total_pending": 7794705,
  "total_approved": 0,
  "total_paid": 1041,
  "total_all_time": 7795746,
  "pending_count": 36927,
  "approved_count": 0,
  "paid_count": 1
}

Campos da resposta

total_pendinginteger

Soma das comissões por plano pendentes, em centavos.

total_approvedinteger

Soma das aprovadas e ainda não pagas, em centavos.

total_paidinteger

Soma das pagas, em centavos.

total_all_timeinteger

Pendentes + aprovadas + pagas. As canceladas ficam de fora.

pending_countinteger

Quantidade de pendentes.

approved_countinteger

Quantidade de aprovadas.

paid_countinteger

Quantidade de pagas.

Erros

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":"..."}`

Veja também

API atual/Referência completa/Comissões

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.

GET/api/v1/admin/commission-summaryAdmin

Resumo do razão de comissões

Sem parâmetros.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/commission-summary" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Resumo devolvido

json

{
  "total_commissions": 249480071,
  "total_vendor_earnings": 2245320655,
  "pending_entries": 3,
  "pending_amount": 1458,
  "confirmed_entries": 41269,
  "confirmed_amount": 184042162,
  "pending_payouts": 1,
  "pending_payout_amount": 99816,
  "total_paid_out": 587135876,
  "rule_count": 2
}

Campos da resposta

total_commissionsinteger

Tudo que a loja reteve, em centavos, somando todas as entradas do razão.

total_vendor_earningsinteger

Tudo que os sellers ganharam, em centavos, somando todas as entradas.

pending_entriesinteger

Quantidade de entradas pendentes (P).

pending_amountinteger

Comissão da loja nas entradas pendentes, em centavos.

confirmed_entriesinteger

Quantidade de entradas confirmadas (A).

confirmed_amountinteger

Comissão da loja nas entradas confirmadas, em centavos.

pending_payoutsinteger

Repasses gerados ainda em aberto.

pending_payout_amountinteger

Valor desses repasses em aberto, em centavos.

total_paid_outinteger

Total de repasses concluídos, em centavos.

rule_countinteger

Quantidade de regras de comissão ativas.

Erros

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.

GET/api/v1/admin/commissions/summaryAdmin

Resumo do razão de comissões (caminho alternativo)

Sem parâmetros.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/commissions/summary" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Resumo devolvido

json

{
  "total_commissions": 249480071,
  "total_vendor_earnings": 2245320655,
  "pending_entries": 3,
  "pending_amount": 1458,
  "confirmed_entries": 41269,
  "confirmed_amount": 184042162,
  "pending_payouts": 1,
  "pending_payout_amount": 99816,
  "total_paid_out": 587135876,
  "rule_count": 2
}

Campos da resposta

total_commissionsinteger

Tudo que a loja reteve, em centavos, somando todas as entradas do razão.

total_vendor_earningsinteger

Tudo que os sellers ganharam, em centavos, somando todas as entradas.

pending_entriesinteger

Quantidade de entradas pendentes (P).

pending_amountinteger

Comissão da loja nas entradas pendentes, em centavos.

confirmed_entriesinteger

Quantidade de entradas confirmadas (A).

confirmed_amountinteger

Comissão da loja nas entradas confirmadas, em centavos.

pending_payoutsinteger

Repasses gerados ainda em aberto.

pending_payout_amountinteger

Valor desses repasses em aberto, em centavos.

total_paid_outinteger

Total de repasses concluídos, em centavos.

rule_countinteger

Quantidade de regras de comissão ativas.

Erros

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.

GET/api/v1/admin/commissions/workflow-summaryAdmin

Resumo das comissões por plano (pendentes, aprovadas, pagas)

Parâmetros de consulta

vendor_iduuid

Restringe a um seller. Omitido, soma a loja inteira.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/commissions/workflow-summary?vendor_id=9d9d9d56-eb43-4719-889d-055632f7c7da" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Resumo devolvido

json

{
  "total_pending": 7794705,
  "total_approved": 0,
  "total_paid": 1041,
  "total_all_time": 7795746,
  "pending_count": 36927,
  "approved_count": 0,
  "paid_count": 1
}

Campos da resposta

total_pendinginteger

Soma das comissões por plano pendentes, em centavos.

total_approvedinteger

Soma das aprovadas e ainda não pagas, em centavos.

total_paidinteger

Soma das pagas, em centavos.

total_all_timeinteger

Pendentes + aprovadas + pagas. As canceladas ficam de fora.

pending_countinteger

Quantidade de pendentes.

approved_countinteger

Quantidade de aprovadas.

paid_countinteger

Quantidade de pagas.

Erros

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":"..."}`