Pedido

GET https://www.sellerpay.com.br/api/v1/pedido/analises/cancelamentos-indevidos

Consulta análise de pedidos cancelados indevidamente.

🔒 Limite de requisição: 60 requisições por minuto.

Descrição

Consulta análise de pedidos cancelados indevidamente. São pedidos que o canal de vendas cancelou, porém o produto foi entregue ao cliente. Retorna dados consolidados com suporte a filtros por período, canal e pedido, além de paginação e ordenação. Exemplo de chamada:
- https://www.sellerpay.com.br/api/v1/pedido/analises/cancelamentos-indevidos
- https://www.sellerpay.com.br/api/v1/pedido/analises/cancelamentos-indevidos?periodo=01/01/2024%20-%2031/12/2024&canal=Mercado%20Livre&limite=50&pagina=0
- https://www.sellerpay.com.br/api/v1/pedido/analises/cancelamentos-indevidos?pedido=123456789&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
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 = ascendente, negativo = descendente. Ex: 1|-3. 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), dataEventoTitulo, dataEventoPedido, dataVencimentoTitulo string 25 não

Resposta de Sucesso

200 OK 
{
    "paginacao": {
        "totalRegistros": 12,
        "limite": 50,
        "pagina": 0,
        "valorRepasseRetencao": -1250.80
    },
    "cancelamentos": [
        {
            "pedido": "123456789",
            "pedidoERP": "ERP-001234",
            "pedidoCanal": "MLB-9876543",
            "marketplace": "Mercado Livre",
            "valorPedido": 299.90,
            "valorRepasse": -45.50,
            "valorComissaoPrevista": 35.99,
            "diferenca": -10.49,
            "statusPedido": "entregue",
            "numeroNFe": "000012345",
            "dataPedido": "2024-01-15T14:30:00"
        },
        {
            "pedido": "987654321",
            "pedidoERP": "ERP-005678",
            "pedidoCanal": "AMZ-1234567",
            "marketplace": "Amazon",
            "valorPedido": 159.90,
            "valorRepasse": -25.30,
            "valorComissaoPrevista": 19.19,
            "diferenca": -6.11,
            "statusPedido": "entregue",
            "numeroNFe": "000067890",
            "dataPedido": "2024-02-10T09:15:30"
        }
    ]
}

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
valorRepasseRetencao Valor total de repasses/retenções dos cancelamentos indevidos number
cancelamentos Array com os registros de pedidos cancelados indevidamente array
pedido Número do pedido string
pedidoERP Número do pedido no ERP string
pedidoCanal Número do pedido no canal de vendas string
marketplace Nome do canal de vendas (marketplace) string
valorPedido Valor total do pedido em reais (2 casas decimais) number
valorRepasse Valor de repasse/retenção do cancelamento em reais (2 casas decimais) number
valorComissaoPrevista Valor da comissão prevista em reais (2 casas decimais) number
diferenca Diferença entre comissão prevista e calculada em reais (2 casas decimais) number
statusPedido Situação do pedido na plataforma string
numeroNFe Número da nota fiscal eletrônica string
dataPedido Data de registro do pedido no formato ISO 8601 (yyyy-MM-ddTHH:mm:ss) string

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