Pedido

POST https://www.sellerpay.com.br/api/v1/pedido/novo

Cria um pedido

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

Descrição

Cria um pedido no sistema para controle de recebíveis.

Guarde a chavePedido devolvida na criação: é a chave recomendada para consultar (GET pedido/chavePedido/{chave}) e alterar (PUT pedido/situacao/chavePedido/{chave}) o pedido, porque é a única que não colide entre integrações.

Respostas sem criação do pedido:
- HTTP 200, motivo: importacaoDireta: a loja está integrada diretamente ao marketplace do pedido (Mercado Livre, Shopee) e o pedido será importado por essa integração. Não reenvie.
- HTTP 200, motivo: importadoPorOutraIntegracao: a mesma venda (canal + pedidoCanal) já foi importada por outra integração da loja. Não reenvie.
- HTTP 409, motivo: conflitoNumeroPedido: o número do pedido já é usado por outra integração nesta loja e a venda ainda não existe no SellerPay. O pedido não entrou: trate como falha e alerte.
- "Pedido já criado" / "Pedido Canal já criado": o pedido já existia e pode ser atualizado por você (foi criado pela sua integração, é um pedido antigo sem integração registrada, ou você é a integração direta do marketplace complementando o pedido); a resposta traz a chavePedido dele.

Body

JSON 
{
    "pedido": "",
    "pedidoERP": "",
    "tituloERP": "",
    "pedidoCanal": "",
    "pedidoComplementar": "",
    "chaveNFe": "",
    "filialFatura": "",
    "canal": "",
    "plataforma": "",
    "dataVenda": "",
    "dataFaturamento": "",
    "tipoDeAnuncio": "",
    "valorFrete": 0,
    "valorFreteSemDesconto": 0,
    "situacao": {
        "pedido": "",
        "canal": ""
    },
    "cliente": {
        "nome": "",
        "cpfCnpj": ""
    },
    "titulos": [
        {
            "codigoControle": "",
            "meioDePagamento": "",
            "qtTotalParcela": 0,
            "valorTotal": 0
        }
    ],
    "produtos": [
        {
            "codigo": "",
            "descricao": "",
            "categoria": "",
            "subCategoria": "",
            "quantidade": 0,
            "valorUnitario": 0
        }
    ],
    "eventosCalcular": [
        {
            "evento": "",
            "valor": 0
        }
    ],
    "xmlNFe": ""
}

Parâmetros de Entrada

Campo Descrição Tipo Tamanho Obrigatório
pedido Seu número de pedido string 100 sim
pedidoERP Número do pedido do ERP string 100 não
tituloERP Número do título gerado no ERP string 100 não
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 sim
pedidoComplementar Se acaso o canal possuir mais de um identificador. string 100 não
chaveNFe Chave da Nota fiscal eletrônica. string 44 sim
filialFatura Código da filial que emitiu a nota fiscal. string 40 não
canal Nome do canal de vendas. string 100 sim
plataforma Nome da Plataforma de vendas. string 100 sim
dataVenda Data da venda. Formato yyyy-mm-dd date sim
dataFaturamento Dada da emissão da NFe. Formato yyyy-mm-dd date sim
tipoDeAnuncio Tipo de anuncio utilizado para regra de comissão. Exemplo Meli: gold_pro, gold_premium, gold_special, etc. string 50 nao
valorFrete Valor do frete numeric 9,2 sim
valorSemDesconto Valor do frete que seria cobrado do cliente sem descontos de campanhas numeric 9,2 não
situacao Situações do Pedido object sim
pedido Situação do pedido na plataforma. Aceito: aprovado, faturado, despachado, entregue, em devolução, cancelado string 20 sim
canal Situação do pedido no canal de vendas. Aceito: aprovado, faturado, despachado, entregue, cancelado string 20 sim
cliente Dados do cliente object não
nome nome do cliente string 60 não
cpfCnpj CPF ou CNPJ do cliente string 11 não
titulos Lista de formas de pagamento array sim
codigoControle Código de controle do titulo string não
meioDePagamento Nome do meio de pagamento: Pix, Boleto, Cartão, etc. string não
qtTotalParcela Quantidade de parcelas integer sim
valorTotal Valor total deste pagamento numeric 9,2 sim
produtos Lista de produtos array sim
codigo Código identificador do produto string 100 não
descricao Descrição do produto string 300 não
categoria Categoria principal do produto (Eletrônicos, Móveis, etc) string 300 não
subCategoria Categoria secundaria do produto (TV, Sofá, etc) string 300 não
quantidade Quantidade de itens integer sim
valorUnitario Valor Unitário do item numeric 9,3 sim
xmlNFe XML da Nota fiscal eletrônica. Converter em base64 text não
eventosCalcular Lista de eventos considerados no cálculo, como rebates, taxas e outros detalhes de repasse não informados diretamente na planilha do canal. array não

Resposta de Sucesso

200 OK 
{
    "mensagem": "sucesso",
    "chavePedido": "",
    "pedido": "",
    "pedidoCanal": ""
}

Dados de Resposta

Campo Descrição Tipo Tamanho
mensagem Mensagem de retorno: sucesso string 255
chavePedido Número do documento criado no sistema string 40
pedido Seu número de pedido string 100
pedidoCanal Seu número de pedido canal string 100
motivo Presente apenas quando o pedido não foi criado; identifica o motivo da recusa (domínio fechado). Ausente na criação com sucesso e em "Pedido já criado" / "Pedido Canal já criado". Valores:
- importacaoDireta (HTTP 200): a loja está integrada diretamente ao marketplace e o pedido será importado por essa integração. Vem com mensagem, canal, pedido e pedidoCanal, sem chavePedido. Não reenvie.
- importadoPorOutraIntegracao (HTTP 200): a mesma venda (canal + pedidoCanal) já foi importada por outra integração da loja. Não reenvie.
- correcaoDesativada (HTTP 200): a integração direta do marketplace encontrou a venda criada por outra integração e a loja desligou a "Correção do Pedido"; nada é alterado. Não reenvie.
- conflitoNumeroPedido (HTTP 409): o número do pedido já é usado por outra integração nesta loja e a venda ainda não existe. O pedido não entrou: trate como falha e reenvie/alerte.		 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