Pedido
GET
https://www.sellerpay.com.br/api/v1/pedido/analises/comissoes
Consulta análise de comissão, previsão de comissão e repasse dos pedidos.
🔒 Limite de requisição: 60 requisições por minuto.
Descrição
Consulta análises de comissão, previsão de comissão e repasse dos pedidos. Retorna dados consolidados com suporte a filtros por período, canal, pedido e situação, além de paginação e ordenação.
Versão 2 disponível: a api/v2/pedido/analises/comissoes segue a regra das telas do painel: comissão do canal nula enquanto o repasse está aberto e o canal ainda não cobrou, filtros de devolução e de taxa de cancelamento iguais aos das telas, período padrão e retorno com a data da venda, e dataTipo validado. Esta versão (v1) mantém o comportamento de sempre.
Exemplo de chamada:
- https://www.sellerpay.com.br/api/v1/pedido/analises/comissoes
- https://www.sellerpay.com.br/api/v1/pedido/analises/comissoes?periodo=01/01/2024%20-%2031/12/2024&canal=Mercado%20Livre&limite=50&pagina=0
- https://www.sellerpay.com.br/api/v1/pedido/analises/comissoes?situacaoPedido=entregue&ordenacao=1|-3&dataTipo=dataHoraRegistro
Versão 2 disponível: a api/v2/pedido/analises/comissoes segue a regra das telas do painel: comissão do canal nula enquanto o repasse está aberto e o canal ainda não cobrou, filtros de devolução e de taxa de cancelamento iguais aos das telas, período padrão e retorno com a data da venda, e dataTipo validado. Esta versão (v1) mantém o comportamento de sempre.
Exemplo de chamada:
- https://www.sellerpay.com.br/api/v1/pedido/analises/comissoes
- https://www.sellerpay.com.br/api/v1/pedido/analises/comissoes?periodo=01/01/2024%20-%2031/12/2024&canal=Mercado%20Livre&limite=50&pagina=0
- https://www.sellerpay.com.br/api/v1/pedido/analises/comissoes?situacaoPedido=entregue&ordenacao=1|-3&dataTipo=dataHoraRegistro
Parâmetros Path
Body
JSON
Parâmetros de Entrada
| Campo | Descrição | Tipo | Tamanho | Obrigatório |
| periodo | Período de datas para filtrar os pedidos. Formato: dd/mm/yyyy - dd/mm/yyyy. Intervalo máximo de 365 dias. | string | 23 | não |
| canal | Nome do marketplace/canal de vendas para filtrar os pedidos (ex: Mercado Livre, Amazon, Shopee) | string | 100 | não |
| pedido | Número do pedido específico para consulta | string | 50 | não |
| situacaoPedido | Situação do pedido. Aceito: aprovado, faturado, despachado, entregue, emDevolucao, cancelado, fatDesEnt, taxaCancelamento. fatDesEnt = aprovado, faturado, despachado ou entregue. taxaCancelamento = pedidos com repasse negativo, em qualquer situação no canal. emDevolucao: a lista traz os pedidos "em devolução", mas totalRegistros conta todos os pedidos dos demais filtros. A v2 aplica a regra das telas do painel | string | 20 | não |
| limite | Quantidade máxima de registros por página. Mínimo: 1, Máximo: 200. Padrão: 50 | integer | 3 | não |
| pagina | Número da página de resultados (base zero). Primeira página = 0. Padrão: 0 | integer | não | |
| ordenacao | IDs numéricos separados por pipe (|) indicando campos e direção de ordenação. Positivo = descendente, negativo = ascendente. Ex: 1|-3 (pedido descendente, depois pedidoCanal ascendente). Sem ordenacao: percComissaoDiferenca ascendente. IDs: 1=pedido, 2=pedidoERP, 3=pedidoCanal, 4=valorTotalPedido, 5=totalRepassesRetencao, 6=valorTotalAReceber, 7=percentualGeral, 8=percentualParcial, 9=percComissaoPrevista, 10=percComissaoDiferenca, 11=valorComissaoDiferenca, 12=canal, 13=valorComissaoPrevista, 14=situacaoPedido, 15=numeroNFe | string | não | |
| dataTipo | Campo de data utilizado no filtro de período. Aceito: dataHoraRegistro (padrão), dataVenda, dataFaturamento, dataEventoTitulo, dataEventoPedido, dataVencimentoTitulo. Outro nome é usado como campo de data do pedido no filtro (a v2 recusa com HTTP 400) | string | 25 | não |
Resposta de Sucesso
200 OK
{
"paginacao": {
"totalRegistros": 150,
"limite": 50,
"pagina": 0
},
"comissoes": [
{
"pedido": "123456789",
"marketplace": "Mercado Livre",
"valorPedido": 299.90,
"comissaoPrevista": 35.99,
"comissaoCalculada": 12.50,
"valorRepasse": 263.91,
"diferenca": -2.50,
"status": "entregue",
"dataPedido": "2024-01-15T14:30:00",
"comissaoCanalValor": 33.49,
"comissaoCanalPercentual": 11.17,
"retencaoCanalValor": 35.99,
"retencaoCanalPercentual": 12.00,
"retencaoFechada": true,
"baseCalculo": 299.90,
"baseOrigem": "canal",
"produtos": [
{
"sku": "CAM-001",
"titulo": "Camiseta Básica Preta G",
"quantidade": 2,
"valor": 89.95,
"valorTotal": 179.90
},
{
"sku": "BON-045",
"titulo": "Boné Aba Reta Preto",
"quantidade": 1,
"valor": 120.00,
"valorTotal": 120.00
}
]
},
{
"pedido": "987654321",
"marketplace": "Amazon",
"valorPedido": 159.90,
"comissaoPrevista": 19.19,
"comissaoCalculada": 8.00,
"valorRepasse": 140.71,
"diferenca": 0.00,
"status": "faturado",
"dataPedido": "2024-02-10T09:15:30",
"comissaoCanalValor": 0.00,
"comissaoCanalPercentual": null,
"retencaoCanalValor": null,
"retencaoCanalPercentual": null,
"retencaoFechada": false,
"baseCalculo": 159.90,
"baseOrigem": "pedido",
"produtos": [
{
"sku": "ELE-100",
"titulo": "Fone Bluetooth TWS",
"quantidade": 1,
"valor": 159.90,
"valorTotal": 159.90
}
]
}
]
}
Dados de Resposta
| Campo | Descrição | Tipo |
| paginacao | Objeto com metadados de paginação | object |
| totalRegistros | Total de registros encontrados na consulta | integer |
| limite | Quantidade máxima de registros por página utilizada | integer |
| pagina | Número da página atual (base zero) | integer |
| comissoes | Array com os registros de comissão dos pedidos | array |
| pedido | Número do pedido | string |
| marketplace | Nome do canal de vendas (marketplace) | string |
| valorPedido | Valor total do pedido em reais (2 casas decimais) | number |
| comissaoPrevista | Valor estimado de comissão em reais (2 casas decimais) | number |
| comissaoCalculada | Legado. Percentual geral de retenção do pedido, historicamente rotulado como comissão. Mantido por compatibilidade; para o valor honesto de comissão do canal use comissaoCanalValor / comissaoCanalPercentual (2 casas decimais) | number |
| valorRepasse | Valor total de repasses e retenções em reais (2 casas decimais) | number |
| diferenca | Diferença entre comissão prevista e calculada em reais (2 casas decimais) | number |
| status | Situação atual do pedido | string |
| dataPedido | Data de registro do pedido no formato ISO 8601 (yyyy-MM-ddTHH:mm:ss) | string |
| comissaoCanalValor | Valor de comissão efetivamente cobrada pelo canal em reais, derivado dos eventos do pedido (2 casas decimais). Líquido do "Cancelamento de Comissão": a devolução abate a comissão até zero (o que passar dela fica como crédito do canal) e o cancelamento descontado pelo canal soma como cobrança. Na MadeiraMadeira, o "Cancelamento de Comissão" com o valor da parcela é a reversão do cancelamento (pedido cancelado e entregue): a venda volta e a comissão não é abatida (pedido conciliado antes dessa regra passa a refleti-la no próximo processamento). null em pedido sem essa composição. Com o repasse aberto, é a comissão já cobrada até agora: 0.00 enquanto o canal não cobrou nada (a v2 devolve null nesse caso) | number |
| comissaoCanalPercentual | Percentual de comissão do canal sobre a base de cálculo (2 casas decimais). Com "Cancelamento de Comissão" e base presumida do valor do pedido (baseOrigem = pedido), a base é o valor do pedido menos o cancelado da venda (a reversão do cancelamento devolve o valor à base). null quando não há comissão identificável, quando a venda foi toda cancelada ou o repasse não fechou | number |
| retencaoCanalValor | Retenção total do canal em reais (base − repasse): quanto do pedido ficou no canal (2 casas decimais). Na MadeiraMadeira, o "Pedido cancelado, mas entrega feita e saldo recuperado na conta" é a venda da parcela cancelada devolvida ao seller: entra no repasse junto com o repasse da parcela cancelada (a comissão retida), e a comissão segue cobrada. null enquanto o repasse não fecha | number |
| retencaoCanalPercentual | Percentual de retenção total do canal sobre a base de cálculo (2 casas decimais). null enquanto o repasse não fecha | number |
| retencaoFechada | Indica se o repasse liquidou. Quando false, retencaoCanalValor, retencaoCanalPercentual e comissaoCanalPercentual são null por estarem aguardando fechamento do repasse (não são zero); comissaoCanalValor traz a comissão já cobrada até agora | boolean |
| baseCalculo | Base usada no cálculo dos percentuais do canal em reais (2 casas decimais). Com "Cancelamento de Comissão" e baseOrigem = pedido, comissaoCanalPercentual usa esta base menos o cancelado da venda; retencaoCanalPercentual usa sempre esta base | number |
| baseOrigem | Origem da base de cálculo: "canal" (base contratual do canal) ou "pedido" (fallback pelo valor total do pedido) | string |
| produtos | Array com os produtos do pedido | array |
| sku | Código SKU do produto | string |
| titulo | Título/nome do produto | string |
| quantidade | Quantidade vendida | integer |
| valor | Valor unitário do produto em reais | number |
| valorTotal | Valor total do produto (valor × quantidade) | number |
Resposta de Erro
400 Bad Request
{
"mensagem": ""
}
| Campo | Descrição | Tipo | Tamanho |
|---|---|---|---|
| mensagem | Mensagem de retorno. Exemplo: Json não informado Loja não ativa |
string | 255 |