Recupera uma lista de produtos existentes na loja.
Parâmetros de Entrada:
- status: (string) (não obrigatorio)
Caso não preenchido o sistema retornará todos os produtos ativos e inativos. Usar A para retornar somente os produtos ativos e I para inativos.
- Pagina: (Inteiro) (não obrigatorio)
Caso preenchido o status do torna obrigatório o numero da pagina a ser retornada.
Parâmetros de Retorno:
Produto:
- codigoAgrupador: (integer)
Código de agrupação de variações de cor, voltagem, sabor e tamanho.
- titulo: (string)
Titulo do produto.
- sku: (integer)
Código do produto.
- gradex: (integer)
Código da variação de cor.
- gradey: (integer)
Código da variação que pode ser de voltagem, tamanho ou sabor.
- status: (string)
Situação do produto: A = Ativo e I = Inativo
produtoLoja/ofertasmarketplaces -> Todas ofertas.
produtoLoja/ofertasmarketplaces/sku/{sku} -> filtro por sku
produtoLoja/ofertasmarketplaces/agrupador/{agrupador} -> por codigo agrupador
produtoLoja/ofertasmarketplaces/ref/{ref} por codigo referencia da loja.
Parâmetros de Retorno:
produto:
- sku: (integer)
Código do produto.
- codigoAgrupador: (integer)
Código agrupador do produto.
- precode: (numeric)
Preço de, ou seja, o preço anterior.
- precopor: (numeric)
Preço de Venda.
ofertamarkeplacecodigopai:
- markeplace: (string)
- datainicio: (string)
- horainicio: (string)
- datafim: (string)
- horafim: (string)
- valor: (numeric)
- percentualnegociacao: (string)
- percentualcategoria: "não/sim"
- saldolimite: (integer)
- vpc: (numeric)
- usuario: (string)
- datacadastro: (string)
ofertamarkeplacesku:
- sku: (integer)
- gradex: (integer)
Grade de variação de cor.
- gradey: (integer)
Grade de variação de voltagem, tamanho ou sabor.
- markeplace: (string)
- datainicio: (string)
- horainicio: (string)
- datafim: (string)
- horafim: (string)
- valor: (numeric)
- percentualnegociacao: (integer)
- percentualcategoria: "não/sim"
- saldolimite: (integer)
- vpc: (numeric)
- usuario: (string)
- datacadastro: (string)
Dados de Entrada:
produtoLoja/ofertasmarketplaces -> Todas ofertas.
produtoLoja/ofertasmarketplaces/sku/{sku} -> filtro por sku
produtoLoja/ofertasmarketplaces/agrupador/{agrupador} -> por codigo agrupador
produtoLoja/ofertasmarketplaces/ref/{ref} por codigo referencia da loja.
IdReferencia: (string) (obrigatorio caso não seja informado o sku ou codAgrupador)
Código de referencia do produto, o mesmo utilizado no ERP cliente.
codAgrupador: (integer) (obrigatorio caso não seja informado, sku ou IdReferencia)
Código pai do produto.
gradex e gradey: (integer) (obrigatorio somente quando utilizado codigo pai)
É a grade de cores, tamanho, sabor e voltagem. sku: (integer) (obrigatorio caso não seja informado o sku ou IdReferencia)
Código sku do produto
filialSaldo: (integer) (obrigatorio)
Informar o codigo da FL, utilizar 1 caso utilize somente uma filial.
saldoReal: (integer) (obrigatorio)
Informar o saldo real em estoque.
saldoDisponivel: (integer) (obrigatorio)
Informar o saldo que será disponibilizado para venda.
Saldo real em estoque: é o saldo físico que a loja tem do produto. Se informado zera o prazo adicional de entrega (crosdoking). O saldo disponível de venda: é o saldo que a loja quer disponibilizar ao cliente para compra.
Prazo Adicional: (integer) prazo adicional de expedição do produto
Tipo Saldo: (string) A: Automático - interação via API M: Estoque Fixo - inserção manual B: Baixando - inserção manual, baixa automatica
Parâmetros de Retorno:
IdReferencia: (string)
Código de referencia do produto, o mesmo utilizado no ERP cliente.
sku: (integer)
Código sku do produto
idMensagem: (integer) (obrigatorio)
Código do retorno. Zero para sucesso.
mensagem: (integer) (obrigatorio)
Descrição da mensagem.
Enviar no máximo 100 registros por chamada. Aguardar no mínimo um segundo entre as chamadas.
Caso já existe oferta vigente no canal a mesma será inativada, para a inserção da nova oferta.
As ofertas são criadas pelo código agrupador, caso seja enviado preços diferenciados por variação o sistema irá considerar a primeira oferta do código agrupador contido no json enviado.
IdReferencia: (string) (obrigatório caso não seja informado o sku ou codAgrupador)
Código de referência do produto, o mesmo utilizado no ERP cliente.
sku: (integer) (obrigatório caso não seja informado o IdReferencia ou sku)
Código sku do produto
codAgrupador: (string) (obrigatório caso não seja informado, sku ou IdReferencia)
Código pai do produto.
preco: (numeric)
Preço da oferta.
canal: (string) (obrigatório)
Nome do canal de vendas. Segue a lista de canais disponíveis:
IdReferencia: (string)
Código de referência do produto, o mesmo utilizado no ERP cliente.
sku: (integer)
Código sku do produto
codAgrupador: (string)
Código pai do produto.
canal: (string) (obrigatório)
Nome do canal de vendas, segue a lista de canais disponíveis:
idMensagem: (integer)
Código do retorno. Zero para sucesso.
mensagem: (string)
Descrição da mensagem.
Segue a lista de mensagens:
0 - sucesso
1 - Um dos campos IdReferencia, sku ou codAgrupador tem que ser preenchido.
2 - produto não encontrado
3 - Não atualizado. Limite de skus ultrapassado. Enviar até 100 skus por requisição.
4 - Canal de venda não encontrado
5 - Oferta já existe
6 - Erro ao salvar oferta
7 - Variação de preço muito grande
Operação que cria um pedido no Lojista.
Todo pedido gerado entrará com status novo. A alteração de status se dará no Pedido/GET caso o financeiro seja do parceiro ou no PedidoTransaciona/POST caso o financeiro seja do Lojista
Parâmetros de Entrada:
- idPedidoParceiro: (string) (obrigatório)
É o seu codigo de pedido.
- valorFrete: (numeric) (obrigatório)
Valor total do frete.
- prazoEntrega:(integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- valorTotalCompra: (numeric)
Valor total da compra. Soma entre o total de pedidos + total de itens. Caso seja seja enviado o sistema não irá realizar a validação.
- formaPagamento: (string) (obrigatório)
Forma de pagamento. Exemplo: visa, mastercard, dieners, boleto. Cada loja irá fornecer a lista das formas de pagamentos disponiveis.
- cpfCnpj: (string) (obrigatório)
CPF ou CNPJ do cliente
- nomeRazao: (string) (obrigatório)
Nome do cliente ou Razão social da empresa
- fantasia: (string) (obrigatório)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string) (opcional)
Usar M ou F
- dataNascimento: (string) (opcional)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string) (obrigatório)
E-mail do cliente.
- cep: (string) (obrigatório)
CEP do endereço de entrega
- numero: (string) (obrigatório)
Número da residência, caso não tenha enviar s/n
- bairro: (string) (obrigatório)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string) (obrigatório)
Cidade do endereço de entrega
- uf: (string) (obrigatório)
Estado do endereço de entrega
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string) (obrigatório)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string) (obrigatório)
Telefone celular do cliente
Pagamento:
- valor: (numeric) (obrigatório)
Valor total do meio de pagamento.
- quantidadeParcelas: (integer) (obrigatório)
Quantidade de parcelas do meio de pagamento.
- meioPagamento: (string) (opcional)
Nome do meio do pagamento, exemplo: visa, master, boleto.
- autorizacao: (string) (opcional)
Número da autorização. Obrigatório somente quando o gateway de pagamento for da loja e a transação for realizada pelo parceiro e somente quando for venda cartão.
- nsu: (string) (opcional)
Número do NSU. Obrigatório somente quando o gateway de pagamento for da loja e a transação for realizada pelo parceiro e somente quando for venda cartão.
Itens:
- sku: (integer) (obrigatório)
Código SKU do produto
- valorUnitario: (numeric) (obrigatório)
Valor unitário do produto
- quantidade: (integer) (obrigatório)
Quantidade de itens comprado do sku
SEFAZ:
-idOperacao
Indicador de intermediador/marketplace
0=Operação sem intermediador (em site ou plataforma própria)
1=Operação em site ou plataforma de terceiros (intermediadores/marketplace)
-idFormaPagamento
Indicador da Forma de Pagamento
0=Pagamento à Vista
1=Pagamento a Prazo
-idMeioPagamento
Meio de pagamento
01=Dinheiro
02=Cheque
03=Cartão de Crédito
04=Cartão de Débito
05=Crédito Loja
10=Vale Alimentação
11=Vale Refeição
12=Vale Presente
13=Vale Combustível
15=Boleto Bancário
16=Depósito Bancário
17=Pagamento Instantâneo (PIX)
18=Transferência bancária, Carteira Digital
19=Programa de fidelidade, Cashback, Crédito Virtual
20=Pontos Livelo
90=Sem pagamento
99=Outros
-cnpjInstituicaoPagamento
CNPJ da instituição de pagamento
Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja
processado pelo intermediador da transação, informar o CNPJ deste
-idBandeira
Código da bandeira da operadora de cartão de crédito e/ou débito
Utilizar a Tabela de Códigos das Operadoras de cartão de
crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica
01=Visa;
02=Mastercard;
03=American Express;
04=Sorocred;
99=Outros;
-autorizacao
Número de autorização da operação cartão de crédito e/ou débito
Identifica o número da autorização da transação da operação com cartão de crédito e/ou débito
-cnpjIntermediadorTransacao
CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios
Informar o CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e
similar) de serviços e de negócios
-intermediadorIdentificador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador (agenciador, plataforma de
delivery, marketplace e similar) de serviços e de negócios.
Parâmetros de Retorno:
- numeroPedido: (integer)
Número do pedido gerado pela loja
- idPedidoParceiro: (string)
É o seu código de pedido, ou seja, o código enviado no momento de gerar o pedido
- mensagem: (string)
Mensagem de erro ou sucesso gerada pelo sistema. Em caso de sucesso será gerado o mensagem "sucesso" ou "pedido já gerado"
É obrigatório o envio do codigoPedido e/ou idPedidoParceiro
- codigoPedido: (integer)
É o seu codigo gerado pela loja no momento da criação do pedido.
- idPedidoParceiro: (string)
É o seu codigo de pedido.
Parâmetros de Retorno:
- idPedidoParceiro: (string)
É o seu codigo de pedido.
- valorFrete: (numeric)
Valor total do frete.
- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy
- valorTotalCompra: (numeric)
Valor total da compra. Soma entre o total de pedidos + total de itens. Caso seja seja enviado o sistema não irá realizar a validação.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda boleto.
- idAfiliado: (integer)
Código do afiliados, ou seja, do parceiro que efetuou a venda.
- nomeAfiliado (string)
Nome do afiliados, ou seja, do parceiro que efetuou a venda.
- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário do produto
- quantidade: (integer)
Quantidade de itens comprado do sku
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto
- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status
Dados de Entrada:
api/v1/pedido/pedido/{codigoPedido}/{idPedidoParceiro}
ou
api/v1/pedido/pedido/{codigoPedido}/
ou
api/v1/pedido/pedido/0/{idPedidoParceiro}
Retorna todos os pedidos fulfillment que ainda não foi confirmado a sincronização dos dados fiscais pelo erp.
A lista de pedidos retornados é dividida em lotes de 20 pedidos por pagina, o número da página deve ser passado por parâmetro.
A ordenação dos pedidos é feita utilizando a data como parâmetro ordem decrescente.
OBS: Api utilizada para sincronizar pedidos Fulfillment do Mercado Livre, os pedidos são faturados pelo sistema deles e está api retorna o xml e danf gerado pelo sistema de faturamento do Mercado livre.
"Sempre que os dados do pedido for consumido com sucesso pelo erp, o pedido deve ser removido da fila utilizando a api de confirmação de recebimento".
Parâmetros de Entrada:
Parâmetros de Retorno:
- codigoPrecode
codigo de referencia do pedido na precode
- codigoMarketplace
codigo de referencia do pedido no marketplace
- numeroNf
Numero da nota
- chaveNf
chave completa da nota
- linkXmlNf
Link do xml
- linkPdfNf
link do pdf
- data
data do pedido
Dados de Entrada:
- numeroPagina
Representa o numero da pagina, o parametro deve ser inserido na url
Sempre irá retornar um arquivo .zip contendo todas as notas emitidas pelo canal do mês solicitado, os arquvios são atualizados para a base da Precode e ficam disponiveis na API de 1 em 1 hora.
Para o Marketplace Amazon, a API possui algumas particularidades, nela, será retornado as notas dos pedidos FBA Classic, sempre retornando notas do dia anterior para trás, nunca da data atual. Para obter as notas é possivel buscar do mês e também passando um dia específico. (Recomendamos buscar informando o dia nos parametros por conta do grande volume de notas retornado no mês)
Parâmetros de Entrada:
{marketplace} - Canal de venda que deseja consultar os arquivos
{mesDownload} - Mês em que deseja obter as notas, usar o padrão Y-m, para o marketplace amazon é possivel passar o dia também, ficando no padrão Y-m-d
- idTicktCliente: (string) (obrigatório)
É o seu codigo SAC de atendimento. Utilizar um ID único.
- idPedidoParceiro: (string) (obrigatório)
Caso o atendimento seja referente a um pedido, informar o codigo do pedido parceiro, ou seja, o seu número de pedido.
- nomeCliente: (string) (obrigatório)
Favor informar o nome do cliente/pessoa de contato.
- descricaoTickt: (string) (obrigatório)
É a descrição do atendimento, contendo duvidas/reclamações. Caso não seja enviado o código do pedido informar detalhes de contato do cliente.
Parâmetros de Retorno:
- idTicktCliente: (string)
É o seu codigo SAC de atendimento.
- idTicktLoja: (string)
Número do chamado SAC gerado pela loja.
- idPedidoParceiro: (string) (obrigatório)
É o seu codigo de pedido.
- valorFrete: (numeric) (obrigatório)
Valor total do frete.
- codFilialVenda: (integer) (obrigatório)
Codigo da filial que fez a venda
- prazoEntrega:(integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- valorTotalCompra: (numeric)
Valor total da compra. Soma entre o total de pedidos + total de itens. Caso seja seja enviado o sistema não irá realizar a validação.
- formaPagamento: (string) (obrigatório)
Forma de pagamento. Exemplo: visa, mastercard, dieners, boleto. Cada loja irá fornecer a lista das formas de pagamentos disponiveis.
- cpfCnpj: (string) (obrigatório)
CPF ou CNPJ do cliente
- nomeRazao: (string) (obrigatório)
Nome do cliente ou Razão social da empresa
- fantasia: (string) (obrigatório)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string) (opcional)
Usar M ou F
- dataNascimento: (string) (opcional)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string) (obrigatório)
E-mail do cliente.
- cep: (string) (obrigatório)
CEP do endereço de entrega
- numero: (string) (obrigatório)
Número da residência, caso não tenha enviar s/n
- bairro: (string) (obrigatório)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string) (obrigatório)
Cidade do endereço de entrega
- uf: (string) (obrigatório)
Estado do endereço de entrega
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string) (obrigatório)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string) (obrigatório)
Telefone celular do cliente
Pagamento:
- valor: (numeric) (obrigatório)
Valor total do meio de pagamento.
- quantidadeParcelas: (integer) (obrigatório)
Quantidade de parcelas do meio de pagamento.
- meioPagamento: (string) (opcional)
Nome do meio do pagamento, exemplo: visa, master, boleto.
- autorizacao: (string) (opcional)
Número da autorização. Obrigatório somente quando o gateway de pagamento for da loja e a transação for realizada pelo parceiro e somente quando for venda cartão.
- nsu: (string) (opcional)
Número do NSU. Obrigatório somente quando o gateway de pagamento for da loja e a transação for realizada pelo parceiro e somente quando for venda cartão.
Itens:
- sku: (integer) (obrigatório)
Código SKU do produto
- valorUnitario: (numeric) (obrigatório)
Valor unitário do produto
- quantidade: (integer) (obrigatório)
Quantidade de itens comprado do sku
Parâmetros de Retorno:
- numeroPedido: (integer)
Número do pedido gerado pela loja
- idPedidoParceiro: (string)
É o seu código de pedido, ou seja, o código enviado no momento de gerar o pedido
- mensagem: (string)
Mensagem de erro ou sucesso gerada pelo sistema. Em caso de sucesso será gerado o mensagem "sucesso" ou "pedido já gerado"
- Cada GET na api retorna uma lista com 50 pedidos, sendo assim o offset precisa ser passado de 50 em 50 (o fim da lista é indicado por um array vazio).
- Para o parametro de data usar sempre o padrão Y-m (ano e mês).
Recupera lista de pedidos pendentes. (pedidos para serem reservados, e não liberados para faturamento).
Parâmetros de Entrada:
Retornará os 100 ultimos novos registros.
Parâmetros de Retorno:
- codigoPedido: (integer)
Número do pedido Precode.
- pedidoParceiro: (string)
Número do pedido marketplace.
- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.
- tipoPedido
Informa se o pedido é fulfillment ou não, valores possíveis ["fulfillment", "default"]
OBS: Se o pedido for fulfillment e do mercado livre, o mesmo não deve ser faturado pelo erp, pois o faturamento ocorre pelo sistema do mercado livre,
a nota e xml gerado pelo mercado livre é retornada pela api pedido/fulfillment.
- codigoMapa(integer)
Número do mapa de carga.
- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.
- valorFrete: (numeric)
Valor total do frete.
- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy
- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo de desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto
- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
- ncm: (string)
Código fiscal do produto
- volumesUnitario: (string)
Quantidade de volumes por item
- pesoUnitario: (string)
Peso do item
- idagrupador: (integer)
Código agrupador do produto
- gradex: (integer)
Código da Cor
- gradey: (integer)
Código da voltagem, sabor, tamanho, etc
- tipo: (integer)
Por ser produto ou servico.
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto
- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status
SEFAZ:
-idOperacao
Indicador de intermediador/marketplace
0=Operação sem intermediador (em site ou plataforma própria)
1=Operação em site ou plataforma de terceiros (intermediadores/marketplace)
-idFormaPagamento
Indicador da Forma de Pagamento
0=Pagamento à Vista
1=Pagamento a Prazo
-idMeioPagamento
Meio de pagamento
01=Dinheiro
02=Cheque
03=Cartão de Crédito
04=Cartão de Débito
05=Crédito Loja
10=Vale Alimentação
11=Vale Refeição
12=Vale Presente
13=Vale Combustível
15=Boleto Bancário
16=Depósito Bancário
17=Pagamento Instantâneo (PIX)
18=Transferência bancária, Carteira Digital
19=Programa de fidelidade, Cashback, Crédito Virtual
90=Sem pagamento
99=Outros
-cnpjInstituicaoPagamento
CNPJ da instituição de pagamento
Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja
processado pelo intermediador da transação, informar o CNPJ deste
-idBandeira
Código da bandeira da operadora de cartão de crédito e/ou débito
Utilizar a Tabela de Códigos das Operadoras de cartão de
crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica
01=Visa;
02=Mastercard;
03=American Express;
04=Sorocred;
99=Outros;
-autorizacao
Número de autorização da operação cartão de crédito e/ou débito
Identifica o número da autorização da transação da operação com cartão de crédito e/ou débito
-cnpjIntermediadorTransacao
CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios
Informar o CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e
similar) de serviços e de negócios
-intermediadorIdentificador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador (agenciador, plataforma de
delivery, marketplace e similar) de serviços e de negócios.
- codigoPedido: (integer)
Número do pedido Precode.
- pedidoParceiro: (string)
Número do pedido marketplace.
- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.
- tipoPedido
Informa se o pedido é fulfillment ou não, valores possíveis ["fulfillment", "default"]
OBS: Se o pedido for fulfillment e do mercado livre, o mesmo não deve ser faturado pelo erp, pois o faturamento ocorre pelo sistema do mercado livre,
a nota e xml gerado pelo mercado livre é retornada pela api pedido/fulfillment.
- codigoMapa(integer)
Número do mapa de carga.
- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.
- valorFrete: (numeric)
Valor total do frete.
- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy
- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo de desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto
- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
- ncm: (string)
Código fiscal do produto
- volumesUnitario: (string)
Quantidade de volumes por item
- pesoUnitario: (string)
Peso do item
- idagrupador: (integer)
Código agrupador do produto
- gradex: (integer)
Código da Cor
- gradey: (integer)
Código da voltagem, sabor, tamanho, etc
- tipo: (integer)
Por ser produto ou servico.
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto
- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status
SEFAZ:
-idOperacao
Indicador de intermediador/marketplace
0=Operação sem intermediador (em site ou plataforma própria)
1=Operação em site ou plataforma de terceiros (intermediadores/marketplace)
-idFormaPagamento
Indicador da Forma de Pagamento
0=Pagamento à Vista
1=Pagamento a Prazo
-idMeioPagamento
Meio de pagamento
01=Dinheiro
02=Cheque
03=Cartão de Crédito
04=Cartão de Débito
05=Crédito Loja
10=Vale Alimentação
11=Vale Refeição
12=Vale Presente
13=Vale Combustível
15=Boleto Bancário
16=Depósito Bancário
17=Pagamento Instantâneo (PIX)
18=Transferência bancária, Carteira Digital
19=Programa de fidelidade, Cashback, Crédito Virtual
90=Sem pagamento
99=Outros
-cnpjInstituicaoPagamento
CNPJ da instituição de pagamento
Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja
processado pelo intermediador da transação, informar o CNPJ deste
-idBandeira
Código da bandeira da operadora de cartão de crédito e/ou débito
Utilizar a Tabela de Códigos das Operadoras de cartão de
crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica
01=Visa;
02=Mastercard;
03=American Express;
04=Sorocred;
99=Outros;
-autorizacao
Número de autorização da operação cartão de crédito e/ou débito
Identifica o número da autorização da transação da operação com cartão de crédito e/ou débito
-cnpjIntermediadorTransacao
CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios
Informar o CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e
similar) de serviços e de negócios
-intermediadorIdentificador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador (agenciador, plataforma de
delivery, marketplace e similar) de serviços e de negócios.
Recupera lista de pedidos aprovados. (pedidos prontos para serem faturados).
Parâmetros de Entrada:
Recupera lista de pedidos aprovados. LImite de 100 registros por pagina.
Parâmetros de Retorno:
- codigoPedido: (integer)
Número do pedido Precode.
- pedidoParceiro: (string)
Número do pedido marketplace.
- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.
- tipoPedido
Informa se o pedido é fulfillment ou não, valores possíveis ["fulfillment", "default"]
OBS: Se o pedido for fulfillment e do mercado livre, o mesmo não deve ser faturado pelo erp, pois o faturamento ocorre pelo sistema do mercado livre,
a nota e xml gerado pelo mercado livre é retornada pela api pedido/fulfillment.
- codigoMapa(integer)
Número do mapa de carga.
- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.
- valorFrete: (numeric)
Valor total do frete.
- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy
- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo de desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto
- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
- ncm: (string)
Código fiscal do produto
- volumesUnitario: (string)
Quantidade de volumes por item
- pesoUnitario: (string)
Peso do item
- idagrupador: (integer)
Código agrupador do produto
- gradex: (integer)
Código da Cor
- gradey: (integer)
Código da voltagem, sabor, tamanho, etc
- tipo: (integer)
Por ser produto ou servico.
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto
- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status
SEFAZ:
-idOperacao
Indicador de intermediador/marketplace
0=Operação sem intermediador (em site ou plataforma própria)
1=Operação em site ou plataforma de terceiros (intermediadores/marketplace)
-idFormaPagamento
Indicador da Forma de Pagamento
0=Pagamento à Vista
1=Pagamento a Prazo
-idMeioPagamento
Meio de pagamento
01=Dinheiro
02=Cheque
03=Cartão de Crédito
04=Cartão de Débito
05=Crédito Loja
10=Vale Alimentação
11=Vale Refeição
12=Vale Presente
13=Vale Combustível
15=Boleto Bancário
16=Depósito Bancário
17=Pagamento Instantâneo (PIX)
18=Transferência bancária, Carteira Digital
19=Programa de fidelidade, Cashback, Crédito Virtual
90=Sem pagamento
99=Outros
-cnpjInstituicaoPagamento
CNPJ da instituição de pagamento
Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja
processado pelo intermediador da transação, informar o CNPJ deste
-idBandeira
Código da bandeira da operadora de cartão de crédito e/ou débito
Utilizar a Tabela de Códigos das Operadoras de cartão de
crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica
01=Visa;
02=Mastercard;
03=American Express;
04=Sorocred;
99=Outros;
-autorizacao
Número de autorização da operação cartão de crédito e/ou débito
Identifica o número da autorização da transação da operação com cartão de crédito e/ou débito
-cnpjIntermediadorTransacao
CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios
Informar o CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e
similar) de serviços e de negócios
-intermediadorIdentificador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador (agenciador, plataforma de
delivery, marketplace e similar) de serviços e de negócios.
Recurso para informar o número do pedido ERP e realizar o aceite do pedido.
Parâmetros de Entrada:
- codigoPedido: (integer) (obrigatório)
Número do pedido Precode
- numeroPedidoERP: (integer) (obrigatório)
Número do pedido ERP
- numeroFilialFatura (string) (obrigatório para empresas configuradas com mais de uma Filial)
Número da Filial de Faturamento.
- numeroFilialSaldo (string) (obrigatório para empresas configuradas com mais de centro de distribuição)
Número do centro de distribuição.
- numeroMapa: (integer) (não obrigatório)
Caso o seu ERP já coloque automaticamente no mapa no momento da criação do pedido basta informar o número do mapa.
Se o seu ERP cria o mapa em outra etapa você pode informar o dígito 1 (um) e o sistema colocará em uma mapa de carga de espera, para poder receber o mapa de carga correto no juntamente com os dados na nota fiscal.
Se o seu ERP não possui controle de mapa de carga basta informar null que o sistema criará um mapa de carga para cada pedido, ou seja, um mapa de carga sequencial.
Parâmetros de Retorno:
- codigoPedido: (integer)
Código do pedido Precode
- codigoPedido: (integer)
Número do pedido Precode.
- pedidoParceiro: (string)
Número do pedido marketplace.
- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.
- tipoPedido
Informa se o pedido é fulfillment ou não, valores possíveis ["fulfillment", "default"]
OBS: Se o pedido for fulfillment e do mercado livre, o mesmo não deve ser faturado pelo erp, pois o faturamento ocorre pelo sistema do mercado livre,
a nota e xml gerado pelo mercado livre é retornada pela api pedido/fulfillment.
- codigoMapa(integer)
Número do mapa de carga.
- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.
- valorFrete: (numeric)
Valor total do frete.
- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy
- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo de desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto
- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
- ncm: (string)
Código fiscal do produto
- volumesUnitario: (string)
Quantidade de volumes por item
- pesoUnitario: (string)
Peso do item
- idagrupador: (integer)
Código agrupador do produto
- gradex: (integer)
Código da Cor
- gradey: (integer)
Código da voltagem, sabor, tamanho, etc
- tipo: (integer)
Por ser produto ou servico.
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto
- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status
SEFAZ:
-idOperacao
Indicador de intermediador/marketplace
0=Operação sem intermediador (em site ou plataforma própria)
1=Operação em site ou plataforma de terceiros (intermediadores/marketplace)
-idFormaPagamento
Indicador da Forma de Pagamento
0=Pagamento à Vista
1=Pagamento a Prazo
-idMeioPagamento
Meio de pagamento
01=Dinheiro
02=Cheque
03=Cartão de Crédito
04=Cartão de Débito
05=Crédito Loja
10=Vale Alimentação
11=Vale Refeição
12=Vale Presente
13=Vale Combustível
15=Boleto Bancário
16=Depósito Bancário
17=Pagamento Instantâneo (PIX)
18=Transferência bancária, Carteira Digital
19=Programa de fidelidade, Cashback, Crédito Virtual
90=Sem pagamento
99=Outros
-cnpjInstituicaoPagamento
CNPJ da instituição de pagamento
Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja
processado pelo intermediador da transação, informar o CNPJ deste
-idBandeira
Código da bandeira da operadora de cartão de crédito e/ou débito
Utilizar a Tabela de Códigos das Operadoras de cartão de
crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica
01=Visa;
02=Mastercard;
03=American Express;
04=Sorocred;
99=Outros;
-autorizacao
Número de autorização da operação cartão de crédito e/ou débito
Identifica o número da autorização da transação da operação com cartão de crédito e/ou débito
-cnpjIntermediadorTransacao
CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios
Informar o CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e
similar) de serviços e de negócios
-intermediadorIdentificador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador (agenciador, plataforma de
delivery, marketplace e similar) de serviços e de negócios.
- codigoPedido: (integer)
Número do pedido Precode.
- pedidoParceiro: (string)
Número do pedido marketplace.
- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.
- tipoPedido
Informa se o pedido é fulfillment ou não, valores possíveis ["fulfillment", "default"]
OBS: Se o pedido for fulfillment e do mercado livre, o mesmo não deve ser faturado pelo erp, pois o faturamento ocorre pelo sistema do mercado livre,
a nota e xml gerado pelo mercado livre é retornada pela api pedido/fulfillment.
- codigoMapa(integer)
Número do mapa de carga.
- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.
- valorFrete: (numeric)
Valor total do frete.
- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy
- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo de desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto
- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
- ncm: (string)
Código fiscal do produto
- volumesUnitario: (string)
Quantidade de volumes por item
- pesoUnitario: (string)
Peso do item
- idagrupador: (integer)
Código agrupador do produto
- gradex: (integer)
Código da Cor
- gradey: (integer)
Código da voltagem, sabor, tamanho, etc
- tipo: (integer)
Por ser produto ou servico.
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto
- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status
SEFAZ:
-idOperacao
Indicador de intermediador/marketplace
0=Operação sem intermediador (em site ou plataforma própria)
1=Operação em site ou plataforma de terceiros (intermediadores/marketplace)
-idFormaPagamento
Indicador da Forma de Pagamento
0=Pagamento à Vista
1=Pagamento a Prazo
-idMeioPagamento
Meio de pagamento
01=Dinheiro
02=Cheque
03=Cartão de Crédito
04=Cartão de Débito
05=Crédito Loja
10=Vale Alimentação
11=Vale Refeição
12=Vale Presente
13=Vale Combustível
15=Boleto Bancário
16=Depósito Bancário
17=Pagamento Instantâneo (PIX)
18=Transferência bancária, Carteira Digital
19=Programa de fidelidade, Cashback, Crédito Virtual
90=Sem pagamento
99=Outros
-cnpjInstituicaoPagamento
CNPJ da instituição de pagamento
Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja
processado pelo intermediador da transação, informar o CNPJ deste
-idBandeira
Código da bandeira da operadora de cartão de crédito e/ou débito
Utilizar a Tabela de Códigos das Operadoras de cartão de
crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica
01=Visa;
02=Mastercard;
03=American Express;
04=Sorocred;
99=Outros;
-autorizacao
Número de autorização da operação cartão de crédito e/ou débito
Identifica o número da autorização da transação da operação com cartão de crédito e/ou débito
-cnpjIntermediadorTransacao
CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios
Informar o CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e
similar) de serviços e de negócios
-intermediadorIdentificador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador (agenciador, plataforma de
delivery, marketplace e similar) de serviços e de negócios.
- codigoPedido: (integer) (obrigatório)
Número do pedido Precode
- chaveNF (string) (obrigatório)
Chave da Nota Fiscal
- url (string) (opcional)
Url PDF da nota fiscal, para que o cliente possa imprimir sua nota.
- numeroMapa: (integer) ((opcional) )
Se o seu ERP tiver controle de mapa de carga basta informar o número, caso contrário envie null.
- xml (string) (obrigatório)
xml da nota fiscal em base 64.
- protocoloCorreio (string) (opcional)
Se o produto for enviado por correios, informar protocolo.
- php (integer) (opcional)
código da plp dos correios para auditoria automática de frete. Se informado o numeroMapa será obrigatório.
Parâmetros de Retorno:
- codigoPedido: (integer)
Código do pedido Precode
Recupera lista de pedidos aguardando coleta. (envio ao cliente)
Parâmetros de Entrada:
Retornará os 100 ultimos novos registros.
Parâmetros de Retorno:
- codigoPedido: (integer)
Número do pedido Precode.
- pedidoParceiro: (string)
Número do pedido marketplace.
- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.
- tipoPedido
Informa se o pedido é fulfillment ou não, valores possíveis ["fulfillment", "default"]
OBS: Se o pedido for fulfillment e do mercado livre, o mesmo não deve ser faturado pelo erp, pois o faturamento ocorre pelo sistema do mercado livre,
a nota e xml gerado pelo mercado livre é retornada pela api pedido/fulfillment.
- codigoMapa(integer)
Número do mapa de carga.
- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.
- valorFrete: (numeric)
Valor total do frete.
- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy
- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo de desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto
- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
- ncm: (string)
Código fiscal do produto
- volumesUnitario: (string)
Quantidade de volumes por item
- pesoUnitario: (string)
Peso do item
- idagrupador: (integer)
Código agrupador do produto
- gradex: (integer)
Código da Cor
- gradey: (integer)
Código da voltagem, sabor, tamanho, etc
- tipo: (integer)
Por ser produto ou servico.
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto
- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status
SEFAZ:
-idOperacao
Indicador de intermediador/marketplace
0=Operação sem intermediador (em site ou plataforma própria)
1=Operação em site ou plataforma de terceiros (intermediadores/marketplace)
-idFormaPagamento
Indicador da Forma de Pagamento
0=Pagamento à Vista
1=Pagamento a Prazo
-idMeioPagamento
Meio de pagamento
01=Dinheiro
02=Cheque
03=Cartão de Crédito
04=Cartão de Débito
05=Crédito Loja
10=Vale Alimentação
11=Vale Refeição
12=Vale Presente
13=Vale Combustível
15=Boleto Bancário
16=Depósito Bancário
17=Pagamento Instantâneo (PIX)
18=Transferência bancária, Carteira Digital
19=Programa de fidelidade, Cashback, Crédito Virtual
90=Sem pagamento
99=Outros
-cnpjInstituicaoPagamento
CNPJ da instituição de pagamento
Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja
processado pelo intermediador da transação, informar o CNPJ deste
-idBandeira
Código da bandeira da operadora de cartão de crédito e/ou débito
Utilizar a Tabela de Códigos das Operadoras de cartão de
crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica
01=Visa;
02=Mastercard;
03=American Express;
04=Sorocred;
99=Outros;
-autorizacao
Número de autorização da operação cartão de crédito e/ou débito
Identifica o número da autorização da transação da operação com cartão de crédito e/ou débito
-cnpjIntermediadorTransacao
CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios
Informar o CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e
similar) de serviços e de negócios
-intermediadorIdentificador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador (agenciador, plataforma de
delivery, marketplace e similar) de serviços e de negócios.
Recurso para informar o envio do pedido ao cliente.
Parâmetros de Entrada:
- codigoPedido: (integer) (obrigatório)
Número do pedido Precode
- protocoloCorreio (string) (opcional)
Se o produto for enviado por correios, informar protocolo.
- numeroMapa (integer) (opcional)
código do mapa de carga
- php (integer) (opcional)
código da plp dos correios para auditoria automática de frete. Se informado o numeroMapa será obrigatório.
Parâmetros de Retorno:
- codigoPedido: (integer)
Código do pedido Precode
- codigoPedido: (integer)
Número do pedido Precode.
- pedidoParceiro: (string)
Número do pedido marketplace.
- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.
- tipoPedido
Informa se o pedido é fulfillment ou não, valores possíveis ["fulfillment", "default"]
OBS: Se o pedido for fulfillment e do mercado livre, o mesmo não deve ser faturado pelo erp, pois o faturamento ocorre pelo sistema do mercado livre,
a nota e xml gerado pelo mercado livre é retornada pela api pedido/fulfillment.
- codigoMapa(integer)
Número do mapa de carga.
- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.
- valorFrete: (numeric)
Valor total do frete.
- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy
- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo de desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto
- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
- ncm: (string)
Código fiscal do produto
- volumesUnitario: (string)
Quantidade de volumes por item
- pesoUnitario: (string)
Peso do item
- idagrupador: (integer)
Código agrupador do produto
- gradex: (integer)
Código da Cor
- gradey: (integer)
Código da voltagem, sabor, tamanho, etc
- tipo: (integer)
Por ser produto ou servico.
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto
- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status
SEFAZ:
-idOperacao
Indicador de intermediador/marketplace
0=Operação sem intermediador (em site ou plataforma própria)
1=Operação em site ou plataforma de terceiros (intermediadores/marketplace)
-idFormaPagamento
Indicador da Forma de Pagamento
0=Pagamento à Vista
1=Pagamento a Prazo
-idMeioPagamento
Meio de pagamento
01=Dinheiro
02=Cheque
03=Cartão de Crédito
04=Cartão de Débito
05=Crédito Loja
10=Vale Alimentação
11=Vale Refeição
12=Vale Presente
13=Vale Combustível
15=Boleto Bancário
16=Depósito Bancário
17=Pagamento Instantâneo (PIX)
18=Transferência bancária, Carteira Digital
19=Programa de fidelidade, Cashback, Crédito Virtual
90=Sem pagamento
99=Outros
-cnpjInstituicaoPagamento
CNPJ da instituição de pagamento
Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja
processado pelo intermediador da transação, informar o CNPJ deste
-idBandeira
Código da bandeira da operadora de cartão de crédito e/ou débito
Utilizar a Tabela de Códigos das Operadoras de cartão de
crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica
01=Visa;
02=Mastercard;
03=American Express;
04=Sorocred;
99=Outros;
-autorizacao
Número de autorização da operação cartão de crédito e/ou débito
Identifica o número da autorização da transação da operação com cartão de crédito e/ou débito
-cnpjIntermediadorTransacao
CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios
Informar o CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e
similar) de serviços e de negócios
-intermediadorIdentificador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador (agenciador, plataforma de
delivery, marketplace e similar) de serviços e de negócios.
- codigoPedido: (integer)
Número do pedido Precode.
Parâmetros de Retorno:
- codigoPedido: (integer)
Número do pedido Precode.
- pedidoParceiro: (string)
Número do pedido marketplace.
- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.
- tipoPedido
Informa se o pedido é fulfillment ou não, valores possíveis ["fulfillment", "default"]
OBS: Se o pedido for fulfillment e do mercado livre, o mesmo não deve ser faturado pelo erp, pois o faturamento ocorre pelo sistema do mercado livre,
a nota e xml gerado pelo mercado livre é retornada pela api pedido/fulfillment.
- codigoMapa(integer)
Número do mapa de carga.
- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.
- valorFrete: (numeric)
Valor total do frete.
- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.
- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy
- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo de desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto
- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
- ncm: (string)
Código fiscal do produto
- volumesUnitario: (string)
Quantidade de volumes por item
- pesoUnitario: (string)
Peso do item
- idagrupador: (integer)
Código agrupador do produto
- gradex: (integer)
Código da Cor
- gradey: (integer)
Código da voltagem, sabor, tamanho, etc
- tipo: (integer)
Por ser produto ou servico.
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto
- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status
SEFAZ:
-idOperacao
Indicador de intermediador/marketplace
0=Operação sem intermediador (em site ou plataforma própria)
1=Operação em site ou plataforma de terceiros (intermediadores/marketplace)
-idFormaPagamento
Indicador da Forma de Pagamento
0=Pagamento à Vista
1=Pagamento a Prazo
-idMeioPagamento
Meio de pagamento
01=Dinheiro
02=Cheque
03=Cartão de Crédito
04=Cartão de Débito
05=Crédito Loja
10=Vale Alimentação
11=Vale Refeição
12=Vale Presente
13=Vale Combustível
15=Boleto Bancário
16=Depósito Bancário
17=Pagamento Instantâneo (PIX)
18=Transferência bancária, Carteira Digital
19=Programa de fidelidade, Cashback, Crédito Virtual
90=Sem pagamento
99=Outros
-cnpjInstituicaoPagamento
CNPJ da instituição de pagamento
Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja
processado pelo intermediador da transação, informar o CNPJ deste
-idBandeira
Código da bandeira da operadora de cartão de crédito e/ou débito
Utilizar a Tabela de Códigos das Operadoras de cartão de
crédito e/ou débito publicada no Portal Nacional da Nota Fiscal Eletrônica
01=Visa;
02=Mastercard;
03=American Express;
04=Sorocred;
99=Outros;
-autorizacao
Número de autorização da operação cartão de crédito e/ou débito
Identifica o número da autorização da transação da operação com cartão de crédito e/ou débito
-cnpjIntermediadorTransacao
CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios
Informar o CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e
similar) de serviços e de negócios
-intermediadorIdentificador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador (agenciador, plataforma de
delivery, marketplace e similar) de serviços e de negócios.
Retorna as etiquetas de expedição de acordo com o formato desejado, no momento esta funcionando com b2w envios, mercado livre envios, integração direta com os correios e transportadoras.
Parâmetros de Entrada:
- orders
Codigo do pedido, no momento só é possivel gerar uma etiqueta por requisição e a loja precisa estar configurada para gerar mapas de carga automaticamente.
- responseType
Tipo de etiqueta que deseja gerar, valores validos: pdf, json e zpl
obs: formato zpl é criado para o tamanho padrão de etiqueta termica 150X100
Parâmetros de Retorno:
para a opção zpl é retornado um arquivo .zip contendo um txt com os códigos zpl e um arquivo pdf para plp caso o a transportadora do pedido seja o correios, na opção de pdf retorna um pdf no formato a4 e no formato json retorna o json contendo as informações das etiquetas
Dados de Entrada:
Dados JSON de Retorno:
Codigos de Respostas:
200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
