Pedido

GET https://www.sellerpay.com.br/api/v1/pedido/{filtro}/{valor}

Consulta detalhes do pedido por número, chave de NF etc.

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

Descrição

Busca o pedido. Exemplo:
- https://www.sellerpay.com.br/api/v1/pedido/pedido/00000000000
- https://www.sellerpay.com.br/api/v1/pedido/pedidoERP/00000000000
- https://www.sellerpay.com.br/api/v1/pedido/pedidoCanal/00000000000
- https://www.sellerpay.com.br/api/v1/pedido/notaFiscal/00000000000
- https://www.sellerpay.com.br/api/v1/pedido/chaveNF/32000000000000000000000000000000000000000000
- https://www.sellerpay.com.br/api/v1/pedido/chavePedido/7fc22e2d2e5e616bf872b0c40394009c

Parâmetros de Entrada

Campo Descrição Tipo Obrigatório
filtro nome do filtro: pedido, pedidoERP, pedidoCanal, notaFiscal, chaveNF, ou chavePedido string sim
valor número do pedido, número do pedido ERP, Número do pedido no canal, nota fiscal, chave da NFe ou código do documento. string sim

Resposta de Sucesso

200 OK 
{
    "_id": "",
    "idLoja": 0,
    "pedido": "",
    "pedidoERP": "",
    "pedidoCanal": "",
    "pedidoComplementar": "",
    "chaveNFe": "",
    "numeroNFe": "",
    "serieNFe": "",
    "filialFatura": "",
    "cpfCnpj": "",
    "canal": "",
    "plataforma": "",
    "idApp": 0,
    "nomeApp": "",
    "dataHoraRegistro": "",
    "dataVenda": "",
    "dataFaturamento": "",
    "tipoDeAnuncio": "",
    "expire": "",
    "situacao": {
        "titulo": "",
        "pedido": "",
        "canal": ""
    },
    "cliente": {
        "nome": "",
        "cpfCnpj": ""
    },
    "titulos": [
        {
            "codigoControle": "",
            "qtTotalParcela": 0,
            "valorTotal": 0,
            "parcelas": [
                {
                    "numero": 0,
                    "valorParcela": 0,
                    "situacao": "",
                    "eventos": []
                }
            ]
        }
    ],
    "eventos": [],
    "produtos": [
        {
            "codigo": "",
            "descricao": "",
            "categoria": "",
            "subCategoria": "",
            "quantidade": 0,
            "valorUnitario": 0,
            "valorTotal": 0,
        }
    ],
    "acaoComercialIds": [],
    "analises": [],
    "totalItens": {
        "valor": 0,
        "percComissaoPrevista": 0,
        "valorComissaoPrevista": 0,
        "percComissaoCobrado": null,
        "valorComissaoCobrado": null
    },
    "frete": {
        "valor": 20,
        "percComissaoPrevista": 0,
        "valorComissaoPrevista": 0,
        "idComissaoFrete": "",
        "percComissaoCobrado": null,
        "valorComissaoCobrado": null
    }
}

Dados de Resposta

Campo Descrição Tipo Tamanho
_id Chave do pedido string 100
idLoja Código da Loja integer
pedido Seu número de pedido string 100
pedidoERP Número do pedido do ERP string 100
pedidoCanal Número do pedido ou identificação da entrega do canal. Este campo é utilizado para identificação no arquivo da conciliação do marketplace. string 100
pedidoComplementar Se acaso o canal possuir mais de um identificador. string 100
chaveNFe Chave da Nota fiscal eletrônica. string 44
numeroNFe Número da Nota Fiscal. integer
serieNFe Serie da Nota Fiscal. integer
filialFatura Código da filial que emitiu a nota fiscal. string 40
cpfCnpj CNPJ do emitente da NFe. string 11
canal Nome do canal de vendas. string 100
plataforma Nome da Plataforma de vendas. string 100
idApp Código do Aplicativo que criou o pedido. integer
nomeApp nome do Aplicativo que criou o pedido. string 60
dataHoraRegistro Data e hora que o pedido foi criado. yyyy-mm-dd HH:ii:ss date 60
dataVenda Data da venda. date
dataFaturamento Dada da emissão da NFe date
expire Dada que o pedido sera excluído. date
tipoDeAnuncio Tipo de anuncio utilizado para regra de comissão. Exemplo Meli: gold_pro, gold_premium, gold_special, etc. string 50
situacao Situações do Pedido object
titulo Situação do titulo: pendente, pago parcial, pago, cancelado, cancelado parcial string 20
pedido Situação do pedido na plataforma: aprovado, faturado, despachado, entregue, em devolução, cancelado string 20
canal Situação do pedido no canal de vendas: aprovado, faturado, despachado, entregue, cancelado string 20
cliente Dados do cliente object
nome nome do cliente string 60
cpfCnpj CPF ou CNPJ do cliente string 11
titulos Lista de formas de pagamento array
codigoControle Código de Controle do titulo integer
qtTotalParcela Quantidade de parcelas integer
valorTotal Valor total deste pagamento numeric 9,2
parcelas Parcelas geradas array
numero Número sequencial da parcela integer
valorParcela Valor da parcela numeric 9,2
situacao Situação da parcela: pendente, pago, cancelado string 20
eventos Eventos relacionado ao titulo. array
codigoCiclo Identificador do ciclo. string 40
tipo Tipo do clico: repasse, comissão, cancelamento, cancelamento de comissão string 60
data Data do registro date
valor Valor do repasse numeric 9,2
comissao Valor da comissão numeric 9,2
percentualComissao Percentual de comissão numeric 9,4
numeroLinha Número da linha do arquivo integer
eventos Eventos relacionado ao pedido, ou seja, que não foram relacionados no titulo. array
codigoCiclo Identificador do ciclo. string 40
tipo Tipo do clico: rebate, ação judicial, ação comercial, descontos, frete reversa, frete, etc (que possui identificação de pedido) string 60
data Data do registro date
valor Valor do repasse numeric 9,2
comissao Valor da comissão numeric 9,2
percentualComissao Percentual de comissão numeric 9,4
numeroLinha Número da linha do arquivo integer
produtos Lista de produtos array
codigo Código identificador do produto string 100
descricao Descrição do produto string 300
categoria Categoria principal do produto (Eletrônicos, Móveis, etc) string 300
subCategoria Categoria secundaria do produto (TV, Sofá, etc) string 300
quantidade Quantidade de itens integer
valorUnitario Valor Unitário do item numeric 9,3
valorTotal Valor total. Unitário * Quantidade numeric 9,3
acaoComercialIds Lista de identificadores de ações comerciais array
analises Lista de retornos contendo análises do sistema sobre os pedidos e seus respectivos títulos array
totalItens Informações referente ao total dos itens array
valor Valor total dos itens numeric 9,2
percComissaoPrevista Percentual de comissão estimada para o total de itens. numeric 9,3
valorComissaoPrevista Valor estimado da comissão para o total de itens. numeric 9,2
percComissaoCobrado Percentual de comissão que foi cobrado para o total de itens numeric 9,3
valorComissaoCobrado Valor de comissão que foi cobrado para o total de itens numeric 9,2
frete Informações referente aos valores de frete array
valor Valor do frete numeric 9,2
percComissaoPrevista Percentual de comissão prevista no frete a ser cobrado numeric 9,3
valorComissaoPrevista Valor de comissão prevista no frete a ser cobrado numeric 9,2
percComissaoCobrado Percentual de comissão que foi cobrado no frete numeric 9,3
valorComissaoCobrado Valor de comissão que foi cobrado no frete numeric 9,2

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