1. Objetivo
Método disponibilizado para enviar para o BSeller os pedidos de venda, juntamente com os dados do cliente e de pagamento.
http://api.bseller.com.br/swagger-ui.html#!/pedidos/envioPedidoUsingPOST
2. Parâmetros de entrada (POST)
|
Campo |
Tamanho |
Obrigatório |
Descrição |
|
canalVenda |
X(4) |
Sim |
Canal de venda do pedido |
|
|
|
|
|
|
clienteEntrega |
|
|
|
|
- classificacao |
9(9) |
Sim |
Classificação de cliente de entrega 0 – Normal 1 – VIP 2 - Crítico |
|
- crt |
9(1) |
Talvez |
Código de Regime Tributário do cliente de entrega 1 – Simples Nacional 2 - Simples Nacional - excesso de sublimite da receita bruta 3 – Regime Normal
Obrigatório se tipoCliente for: - 1 - Pessoa Jurídica - 4 - Pessoa Jurídica SUFRAMA - 5 - Pessoa Jurídica no País sem IE - 6 - Pessoa Pública |
|
- dataNascimento |
Data |
Não |
Data de nascimento do cliente de entrega |
|
|
X(60) |
Não |
E-mail do cliente do endereço de entrega |
|
- endereco |
|
|
|
|
-- bairro |
X(50) |
Sim |
Bairro do endereço de entrega. Informação impressa na etiqueta de volume (que é colocada na caixa que é entrega para transportadora) e na nota fiscal |
|
-- cep |
9(8) |
Sim |
CEP do endereço de entrega. Informação impressa na etiqueta de volume (que é colocada na caixa que é entrega para transportadora) e na nota fiscal |
|
-- cidade |
X(50) |
Sim |
Cidade do endereço de entrega Informação impressa na etiqueta de volume (que é colocada na caixa que é entrega para transportadora) e na nota fiscal |
|
-- complemento |
X(50) |
Não |
Complemento do endereço de entrega Informação impressa na etiqueta de volume (que é colocada na caixa que é entrega para transportadora) |
|
-- estado |
X(2) |
Não |
Unidade Federativa do endereço de entrega Informação impressa na etiqueta de volume (que é colocada na caixa que é entrega para transportadora) e na nota fiscal |
|
-- logradouro |
X(3-60) |
Sim |
Endereço de Entrega Informação impressa na etiqueta de volume (que é colocada na caixa que é entrega para transportadora) e na nota fiscal |
|
-- numero |
9(6) |
Não |
Número do endereço de entrega. Apenas número. Em caso de “S/N” (sem número), informar “0” (zero) e colocar o “SN” concatenado com o “logradouro” Informação impressa na etiqueta de volume (que é colocada na caixa que é entrega para transportadora) e na nota fiscal |
|
-- pais |
X(30) |
Sim |
País do endereço de faturamento. Geralmente “Brasil”. |
|
-- pontoReferencia |
X(100) |
Não |
Ponto de referencia do endereço de entrega Informação impressa na etiqueta de volume (que é colocada na caixa que é entrega para transportadora) |
|
-- zipCode |
X(14) |
Não |
ZIP CODE do endereço de entrega |
|
- fax |
X(15) |
Não |
Fax do cliente do endereço de entrega |
|
- id |
9(14) |
Não |
CPF/CNPJ do cliente de entrega. Se estiver nulo, assume o do cliente fatura (clienteFaturamento.id) |
|
- inscricaoEstadual |
X(18) |
Talvez |
Inscrição Estadual do cliente do endereço de entrega. Obrigatório se tipoCliente for: - 1 - Pessoa Jurídica) - 4 - Pessoa Jurídica SUFRAMA - 7 - Produtor Rural
Caso cliente for Pessoa Jurídica, mas não tiver Inscrição Estadual, informar tipoCliente = 5 |
|
- Suframa |
X(9) |
Talvez |
Suframa é obrigatório se o tipo de cliente for: |
|
- nome |
X(40) |
Sim |
Nome do cliente do endereço de entrega. Informação impressa na etiqueta de volume (que é colocada na caixa que é entrega para transportadora) e na nota fiscal |
|
- rg |
X(20) |
Não |
RG do cliente de faturamento |
|
- sexo |
X(1) |
Não |
Sexo do cliente do endereço de entrega: [F] - Feminino [M] - Masculino
Se nulo considera Masculino |
|
- telefoneCelular |
X(15) |
Não |
Celular do cliente do endereço de entrega |
|
- telefoneComercial |
X(15) |
Não |
Telefone comercial do cliente do endereço de entrega |
|
- telefoneResidencial |
X(15) |
Sim |
Telefone residencial do cliente do endereço de entrega |
|
- tipoCliente |
9(9) |
Sim |
Tipo de cliente de entrega |
|
|
|
|
|
|
clienteFaturamento |
|
|
|
|
- classificacao |
9(9) |
Sim |
Classificação de cliente de faturamento 0 – Normal 1 – VIP 2 - Crítico |
|
- crt |
9(1) |
|
Código de Regime Tributário do cliente de faturamento 1 – Simples Nacional 3 – Regime Normal
Obrigatório se tipoCliente for: - 1 - Pessoa Jurídica) - 4 - Pessoa Jurídica SUFRAMA - 5 - Pessoa Jurídica no País sem IE - 6 - Pessoa Pública |
|
- dataNascimento |
Data |
|
Data de nascimento do cliente de faturamento |
|
|
X(60) |
Não |
E-mail do cliente de faturamento |
|
- endereco |
|
|
|
|
-- bairro |
X(50) |
Sim |
Bairro do endereço de faturamento |
|
-- cep |
9(8) |
Sim |
CEP do endereço de faturamento |
|
-- cidade |
X(50) |
Sim |
Cidade do endereço de faturamento |
|
-- complemento |
X(50) |
|
Complemento do endereço de faturamento |
|
-- estado |
X(2) |
Sim |
Unidade Federativa do endereço de faturamento |
|
-- logradouro |
X(3-60) |
Sim |
Endereço de Faturamento |
|
-- numero |
9(6) |
Sim |
Número do endereço de faturamento |
|
-- pais |
X(30) |
Sim |
País do endereço de faturamento. Geralmente “Brasil”. |
|
-- pontoReferencia |
X(100) |
|
Ponto de referencia do endereço de faturamento |
|
-- zipCode |
X(14) |
|
ZIP CODE do endereço de faturamento |
|
- fax |
X(15) |
|
Fax do cliente de faturamento |
|
- id |
9(14) |
|
CPF/CNPJ do cliente de faturamento |
|
- inscricaoEstadual |
X(18) |
|
Inscrição Estadual do cliente de faturamento. Obrigatório se tipoCliente for: - 1 - Pessoa Jurídica) - 4 - Pessoa Jurídica SUFRAMA - 7 - Produtor Rural
Caso cliente for Pessoa Jurídica, mas não tiver Inscrição Estadual, informar tipoCliente = 5 |
|
- Suframa |
X(9) |
Talvez |
Suframa é obrigatório se o tipo de cliente for: |
|
- nome |
X(40) |
Sim |
Nome do cliente de faturamento |
|
- rg |
X(20) |
|
RG do cliente de faturamento |
|
- sexo |
X(1) |
|
Sexo do cliente do endereço de faturamento: [F] - Feminino [M] - Masculino
Se nulo considera Masculino |
|
- telefoneCelular |
X(15) |
|
Celular do cliente de faturamento |
|
- telefoneComercial |
X(15) |
|
Telefone comercial do cliente de faturamento |
|
- telefoneResidencial |
X(15) |
Sim |
Telefone residencial do cliente de faturamento |
|
- tipoCliente |
9(9) |
Sim |
Tipo de cliente de faturamento |
|
|
|
|
|
|
codigoListaCompras |
9(9) |
|
Código da lista de compras previamente cadastrada no BSeller |
|
codigoVendedor |
9(9) |
|
Código do vendedor previamente cadastrado |
|
dataEmissao |
Data |
Sim |
Data da emissão do pedido no site. Não pode ser maior do que a dataInclusao |
|
dataInclusao |
Data |
Sim |
Data de inclusão do pedido no [B] SELLER, ou seja, a data atual. Não pode ser menor do que a dataEmissao |
|
|
|
|
|
|
entrega |
|
|
|
|
- dataEntregaAgendada |
Data |
|
Data de entrega agendada |
|
- periodoEntregaAgendada |
9(9) |
|
Período da entrega agendada 1 – Manhã 2 – Tarde 3 – Noite |
|
- tipoEntrega |
9(12) |
Sim |
Tipo de entrega. Depende da configuração do contrato da transportadora (campo “Tipo de transporte”). 1 - Normal 2 - Expressa 3 - Econômica 4 - Garantida 5 - Agendada 6 - B2W Correios 7 - Mercado Envios 8 - B2W Direct |
|
|
|
|
|
|
entregasQuebradas |
Boolean |
|
Permissão para o pedido possa ser "quebrado" em "N" entregas, caso haja condições no pedido para isso. |
|
idCotacao |
15 |
|
Identificação do Id da cotação na intelipost (quote_id) |
|
|
|
|
|
|
itens |
|
|
|
|
- cartaoPresente |
|
|
|
|
-- idCartaoPresente |
9(6) |
|
Código do cartão de presente previamente cadastrado no [B] Seller |
|
-- sequencial |
9(10) |
|
Sequencial do item que o cartão está vinculado |
|
-- textoCabecalho |
X(80) |
|
Nome do remetente da mensagem (De) |
|
-- textoMensagem |
X(500) |
|
Mensagem a ser impressa no cartão |
|
-- textoRodape |
X(80) |
|
Nome do destinatário da mensagem (Para) |
|
-- tipoEmbalagem |
9(9) |
|
Código da embalagem previamente cadastrada no [B] Seller |
|
- cnpjFilial |
9(14) |
Sim |
CNPJ da Filial que a mercadoria será expedida |
|
- codigoAgrupamentoProduzido |
9(12) |
|
Código do item de produção. Os componentes devem ser enviados em codigoItem |
|
- codigoEstabelecimentoEstoque |
9(4) |
Sim |
Código do estabelecimento de estoque de onde o saldo do item será consumido. |
|
- codigoEstabelecimentoSaida |
9(4) |
Sim |
Código do estabelecimento de estoque pelo qual a mercadoria será despachada. |
|
- codigoItem |
9(9) |
Sim |
Código do item comprado pelo consumidor final. É enviado pela interface de item ao site. |
|
- codigoItemGarantido |
9(9) |
Sim |
Código do item garantido. Só deve ser preenchido na venda de garantia estendida |
|
- codigoItemKit |
9(9) |
|
Item de Kit no WMS. Os componentes do KIT devem ser enviados em codigoItem |
|
- codigoItemPai |
9(9) |
|
Apesar do nome ser "itemPai", esse campo não tem relação com o item pai que é vinculado ao cadastro do item filho, esse aqui é um código usado para agrupar itens, garantindo que os itens que possuam esse código associado não sejam quebrados em entregas diferentes. é principalmente utilizado para informar o ID do KIT Comercial de modo que seja possível saber qual o KIT Comercial foi incluído em qual pedido. |
|
- descontoCondicionalUnitario |
9(15.3) |
Sim |
Valor do desconto condicional unitário |
|
- descontoIncondicionalUnitario |
9(15.3) |
Sim |
Valor do desconto incondicional unitário |
|
- grupoPersonalizacoes |
|
|
|
|
-- codigoAgrupamento |
9(9) |
|
Agrupamento permite juntar duas personalizações no mesmo produto. Por exemplo:
- Camisa com Nome + Número, - Camisa com Número - Camisa com Nome |
|
-- personalizacoes |
|
|
|
|
--- atributo |
X(200) |
|
O nome da personalização. Exemplo: Nome, Número |
|
--- descricao |
X(400) |
|
Descrição da personalização. Exemplo: Miguel, 24, Leonardo, 10 |
|
--- sequencial |
9(9) |
|
Sequencial da personalização. Isso permite que cada peça do mesmo item tenha personalizações diferentes |
|
-- quantidadePersonalizada |
9(9) |
|
Quantidade de personalizações |
|
- idContratoTransportadora |
X(150) |
|
Campo “Identificação Externa do Contrato” cadastrado no Contrato da transportadora no BSeller. Mais detalhes em https://bseller.zendesk.com/entries/94569078-Gest%C3%A3o-de-transporte-Transportadora |
|
- idTransportadora |
9(14) |
|
CNPJ da transportadora. Cadastrado em https://bseller.zendesk.com/entries/94569078-Gest%C3%A3o-de-transporte-Transportadora |
|
- itemBonificado |
Boolean |
|
Indicativo se o item é bonificado (true) ou não (false). |
|
- prazoCentroDistribuicao |
9(2) |
Sim |
|
|
- prazoFornecedor |
9(2) |
Sim |
|
|
- prazoTransitTime |
9(2) |
Sim |
|
|
- precoUnitario |
9(15.3) |
Sim |
Preço unitário do item, ou seja, de cada peça, desconsiderando descontos |
|
- quantidade |
9(8) |
Sim |
Quantidade de peças vendidas para este item |
|
- sequencial |
9(6) |
Sim |
Sequencial do item. Para cada linha de item deve ter um sequencial diferente. |
|
- sequencialAgrupamentoProduzido |
9(4) |
|
Sequencial do item de produção. Ou seja, este item compõe um item produção e deve-se informar o sequencial do item que ele compõe. |
|
- sequencialItemgarantido |
9(9) |
|
Sequencial do item garantido. Ou seja, este item é de garantia estendida e deve-se referenciar o item garantido. |
|
- tipoEstoque |
X(1) |
|
Tipo de estoque [N] Normal [X] Crossdocking [F] Fingido [P] Pré-Venda |
|
- tipoItem |
X(1) |
|
[P] indica se é um produto físico (default) [N] indica produto virtual |
|
- valorCustoGarantiaEstendida |
9(15.2) |
|
Custo da Garantia Estendida |
|
- valorDespesas |
9(15.2) |
|
Valor das despesas unitárias do item. |
|
- valorFrete |
9(15.2) |
Sim |
Valor do frete de todas as peças deste item |
|
|
|
|
|
|
numeroPedido |
9(20) |
Sim |
Número do pedido no site. Valor tem que único. Não podendo se repetir independente do Canal, Origem ou Unidade de Negócios. Apenas numérico. |
|
numeroPedidoExterno |
X(15) |
|
Número do pedido externo. Usado nos casos de venda para pessoa jurídica, por exemplo, onde o cliente PJ tem um número de pedido próprio e precisa que esta informação saia na nota fiscal.
Outro exemplo é na venda para marketplace, onde o pedido pode ser alfanumérico. Como no BSeller os pedidos são numéricos, pode-se usar este campo para fazer referência ao pedido do marketplace. |
|
numeroPedidoLoja |
X(30) |
|
Número do pedido na loja. |
|
observacoesEtiqueta |
X(100) |
|
Observação impressa nas etiquetas de volume do pedido. |
|
origemPedido |
X(2) |
Sim |
Fixo “LJ” |
|
|
|
|
|
|
pagamentos |
|
|
|
|
- cartaoCredito |
|
|
|
|
-- bandeira |
9(3) |
Obrigatório para meios de pagamento do tipo Cartão |
Bandeira do cartão de crédito: 1 - Visa 2 - Mastercard 3 - Amex 4 - Diners 5 - Elo 6 - Discover 7 - Hipercard 8 - Aura 9 - Cartão Muffato 10 - B2W 11 - CNova 12 - WalMart 13 - Rakuten |
|
-- codigoSeguranca |
X(1) |
Obrigatório para meios de pagamento do tipo Cartão |
Código de segurança do cartão de crédito |
|
-- cpfTitular |
X(30) |
Obrigatório para meios de pagamento do tipo Cartão |
CPF do Titular do Cartão |
|
-- dataVencimento |
X(300) |
Obrigatório para meios de pagamento do tipo Cartão |
Data de validade do cartão de crédito. Sem formato específico. |
|
-- numero |
X(70) |
Obrigatório para meios de pagamento do tipo Cartão |
Número do cartão de crédito |
|
-- numeroParcelas |
9(2) |
Obrigatório para meios de pagamento do tipo Cartão |
Número de parcelas |
|
-- percentualJuros |
9(5.2) |
|
Percentual de juros |
|
-- primeiros6digitos |
X(80) |
|
Seis primeiros dígitos do cartão |
|
-- situacaoCodigoSeguranca |
X(1) |
Obrigatório para meios de pagamento do tipo Cartão |
Situação do código de segurança:
1 – Capturado – enviar código no P_COD_SEGURANCA 2 – Ilegível 9 – Ausente |
|
-- titular |
X(30) |
Obrigatório para meios de pagamento do tipo Cartão |
Titular do cartão de crédito |
|
-- valorJuros |
9(5.2) |
Obrigatório para meios de pagamento do tipo Cartão |
Valor dos juros |
|
-- valorJurosAdministradora |
9(5.2) |
|
Valor dos juros da administradora |
|
- Boleto |
|
|
|
|
- codigoAgencia |
9(7) |
Obrigatório para meios de pagamento do tipo Boleto |
Código da agência, previamente cadastrada, sem dígito. |
|
- codigoBanco |
9(3) |
Obrigatório para meios de pagamento do tipo Boleto |
Código do banco, previamente cadastrado, sem dígito. |
|
- nossoNumero |
X(50) |
Opcional, usado em meio de pagamento do tipo Boleto |
Código de controle "Nosso Número" |
|
- codigoCondicaoPagamento |
9(9) |
Obrigatório para meios de pagamento do tipo Boleto a Prazo |
Campo obrigatório se o meio de pagamento for boleto à prazo e a data de vencimento não for preenchida. Condições de pagamento previamente cadastradas. |
|
- codigoCupom |
X(200) |
Obrigatório para meios de pagamento do tipo Cupom |
Código do cupom gerado pela loja. Não há validação se a informação é repetida. Apenas deve respeitar o tamanho do campo e o codigoMeioPagamento ser de cupom. |
|
- codigoMeioPagamento |
9(6) |
Sim |
Código do meio de pagamento, pré-existente no BSeller, de acordo com as regras de negócio de cada loja e disponíveis aqui. |
|
- codigoVale |
X(70) |
Obrigatório para meios de pagamento do tipo Vale |
Código do vale compras utilizado |
|
- dataVencimentoBoleto |
Data |
Obrigatório para meios de pagamento do tipo Boleto |
Data de vencimento do boleto. Não obrigatório se codigoCondicaoPagamento estiver preenchida. |
|
- endereco |
|
|
|
|
-- bairro |
X(20) |
|
Bairro do cliente de pagamento |
|
-- cep |
9(8) |
|
CEP do cliente do pagamento |
|
-- cidade |
X(50) |
|
Cidade do titular do cartão |
|
-- complemento |
X(50) |
|
Complemento do endereço do cliente de pagamento |
|
-- estado |
X(2) |
|
UF do cliente do pagamento |
|
-- logradouro |
X(3-60) |
|
Endereço do cliente do pagamento |
|
-- numero |
9(6) |
|
Número do endereço do cliente do pagamento |
|
-- pais |
X(30) |
|
País do cliente do pagamento |
|
-- pontoReferencia |
X(100) |
|
Ponto de referência do endereço do cliente do pagamento |
|
-- zipCode |
X(14) |
|
ZIP Code do endereço do cliente do pagamento |
|
- nossoNumero |
X(50) |
Opcional para pagamento do tipo Boleto |
Campo "nosso número" do Boleto |
|
- numeroConta |
9(10) |
Obrigatório para meios de pagamento do tipo Boleto |
Número da conta, previamente cadastrada, sem dígito. |
|
- pagamentoPix |
|
|
|
|
-- identificadorTransacao |
X(135) |
Obrigatório para pagamento do tipo PIX |
Refere-se ao TID do pagamento PIX |
|
- sequencial |
9(6) |
Sim |
Sequencial do meio de pagamento. Isto permite que o pedido possa ser realizado com mais de um meio de pagamento, cada bloco de pagamento, recebe um sequencial diferente (0, 1...) |
|
- valor |
9(15.2) |
Sim |
Valor deste meio de pagamento |
|
|
|
|
|
|
pedidoParaConsumo |
Boolean |
|
Indicativo se o pedido é para consumo (true) ou revenda (false) |
|
|
|
|
|
|
publicidade |
|
|
|
|
- campanha |
X(50) |
|
Nome da campanha individual, o slogan, o código promocional etc. de um produto (utm_campaign) |
|
- fonte |
X(50) |
|
Identifique o anunciante, o site, a publicação etc. que está enviando tráfego para sua propriedade (por exemplo, google, newsletter4, billboard) (utm_source).
Fonte: https://support.google.com/analytics/answer/1033863?hl=pt-BR (acessado em 25/07/2015) |
|
- midia |
X(50) |
|
A mídia de publicidade ou marketing (por exemplo: cpc, banner, email newsletter) (utm_medium). |
|
|
|
|
|
|
tipoFrete |
X(1) |
|
Indicativo de CIF/FOB:
[C]IF - o fornecedor é responsável por todos os custos e riscos com a entrega da mercadoria.
[F]OB - o comprador assume todos os riscos e custos com o transporte da mercadoria.
Se nulo = CIF
Mais detalhes em https://bseller.zendesk.com/hc/pt-br/articles/228209028 |
|
tipoPedido |
X(1) |
Sim |
Tipo do pedido
N - Normal O - Operação Presente R - Revenda T - Transferência Z - Doação |
|
unidadeNegocio |
9(9) |
Sim |
Unidade de Negócios do pedido |
|
|
|
|
|
|
valores |
|
|
|
|
- valorDespesasFinanceiras |
9(15.2) |
Sim |
Valor total das despesas financeiras (soma dos valores de pagamentos.cartaoCredito.valorJuros) |
|
- valorDespesasItem |
9(15.2) |
Sim |
Valor total das despesas do item (soma dos valores de itens.valorDespesas) |
|
- valorFrete |
9(15.2) |
Sim |
Valor total do frete dos itens (soma dos valores de itens.valorFrete) |
|
- valorTotalProdutos |
9(15.2) |
Sim |
Valor total dos produtos do pedido. Desconsiderando os descontos que possam ser dados nas mercadorias.
valorTotalProdutos = itens.precoUnitario * itens.quantidade |
Comentários
0 comentário
Artigo fechado para comentários.