Pedidos
Catálogo de Produtos
Abaixo detalhes sobre os campos e informações de produtos
Pedido
Nome | Descrição |
---|---|
Cabecalho | Cabeçalho do Pedido |
EnderecoDeCobranca | Endereço de Cobrança |
EnderecoDeEntrega | Endereço de Entrega |
Faturas | Faturas vinculadas ao pedido |
Itens | Itens do Pedido |
Cabecalho
Nome | Descrição |
---|---|
AtualizadoEm | Quando o pedido foi Atualizado |
ChaveERP | Chave de importação. Para uso interno do Winbooks. |
ChaveNFE | Utilizado para gravar o número da chave da NF-e ou NFC-e emitida. |
Classificacao | Campo livre para ser utilizado como classificação da origem da venda. Normalmente é usado quando a Editora tem mais de um selo. (Essa informação será é de interesse do usuário do sistema). |
Codigo | Código do Pedido do B2C/B2B deve ser preenchido pelo Integrador |
CriadoEm | Quando esse pedido foi criado no site |
EmpresaId | |
ExpedidoEm | Quando o pacote foi expedido |
Id | Numero do Pedido na Plataforma API |
Observacoes | Utilizado para inserir observações de texto livre, para serem importadas. (Essas informações devem ser aquelas de interesse do usuário do Winbooks. Portanto, não serão informadas da Nota Fiscal emitida). |
Rastreio | Após a expedição, se existir número de protocolo ou de código de rastreio registrado, este número será gravado nesse campo. |
Situacao | Situação do Pedido
|
TipoDeConsumidor |
|
TipoDeEnvio | Tipo de Envio Consulte a API de Tipo de Envio para listar todos os tipos de envio disponivéis. |
TipoDeFrete | Tipo de Frete
|
TipoDeImportacao | Tipo de Importação do Pedido Status do pedido para importação para o Winbooks:
|
UsarEmbalagemPresente |
|
Operacao | Válido somente para o modelo B2B
|
ValorDeDesconto | Utilizado para inserir valor de desconto em reais. Esse valor será rateado proporcionalmente ao itens, seguindo o layout da NF-e. Ex.: R$ 10,00 para um pedido com 2 produtos = R$ 5,00 de desconto para cada item. |
ValorDoFrete | Valor do Frete do Pedido |
ValorTotal | Total do Pedido: (Valor dos Itens - Desconto) + Frete |
Endereco
Nome | Descrição |
---|---|
Apelido | Nome fantasia ou apelido. |
AtualizadoEm | Quando o endereço foi atualizado |
Bairro | Bairro |
CEP | Cep (não informar caracteres especiais: ponto, traços, etc. Separar os últimos três dígitos com espaço). Ex.: 13050 544. |
Cidade | Cidade |
CnpjCpf | Número do CPF com 11 dígitos ou CNPJ com 14 dígitos (não informar caracteres especiais: ponto, traços, etc.). Ex.: CPF = 99999999999 CNPJ = 99999999999999). |
Complemento | Complemento do endereço. 50 caracteres |
Destinatario | Nome para entrega do pedido quando for diferente do nome do cliente. |
eMail (caso tenha mais de um e-mail, informar separado por ";".) | |
LinhaDeEndereco | Endereço (logradouro e nº separados por ","). Ex.: Rua Pedreira, 595. |
Nome | Nome do cliente. |
Pais | País (Ex: Brasil, Japão) |
Profissao | Profissão do cliente ou pessoa que receberá o pedido. |
RegTributario | Regime Tributário do Cliente:
|
RgIE | Número da Inscrição Estadual ou RG (não informar caracteres especiais: ponto, traços, etc.). Se o cliente for PJ e não possuir Inscrição Estadual, informar "ISENTO". Se o cliente for PF, esse campo não é obrigatório. |
TelefoneFixo | Telefone Fixo: DDD + Número (separar os blocos de dígitos com espaço. O DDD deve ter três dígitos). Ex.: 019 3227 1198. |
TelefoneMovel | Telefone Celular: DDD + Número (separar os blocos de dígitos com espaço. O DDD deve ter três dígitos). Ex.: 019 99431 7762 ou 031 8531 3685. |
Tipo |
|
UF | Estado (Sigla) |
Fatura
Campo | Descrição |
---|---|
AprovadoEm | Data de aprovação ou recebimento, constatado pelo EC. Ex.: data da confirmação da aprovação da compra pela administradora do cartão de crédito do cliente. |
AtualizadoEm | Quando foi atualizado |
Autorizacao | Para Cartões - Código de autorização da transação. Este número não é único e pode se repetir. Para efeito de conciliação deverá ser combinado com outras chaves como o NSU, data e valor da venda, número do cartão, meio de captura e número lógico do terminal. |
CodigoInterno | Para Boletos - Nosso Número, quando for Boleto emitido pelo site/aplicativo. |
FormaDePagamentoId | Forma de Pagamento Consulte a API de Formas de Pagamento para obter a lista ou criar formas de pagamento |
NSU | Para Cartões - NSU/DOC ou TID. (NSU/DOC: Número sequencial, também conhecido como DOC (número do documento), gerado no PDV ou POS que identifica a transação no dia em que ela foi realizada); (TID: Identificação da transação realizada no comércio eletrônico ou mobile payment). |
NumeroDeParcelas | Numero da Parcela |
NumeroDoCartao | Para Cartões - Número do cartão truncado (substituir todos os dígitos dos blocos centrais por "*", para segurança). Ex. 520132******0831. |
Resumo | Para Cartões - Número do resumo de operação ou número do lote. Contêm informações referentes a um grupo de vendas em uma determinada data. |
Valor | Valor da Parcela |
Vencimento | Quando a fatura vence. |
Item do Pedido
Nome | Descrição |
---|---|
AtualizadoEm | Quando o Item foi Atualizado |
CodigoDeBarras | Código de Barras do Produto (Não é obrigatório se o Id do Produto for preenchido) |
Desconto | Valor do desconto do produto (Esse valor será somado com o valor do desconto rateado do campo "Desconto do Pedido [ValorDeDesconto]", caso tenha sido informado). Ex.: R$ 15,00 de desconto para o produto 1. Se tiver sido informado o desconto rateado em reais, conforme exemplificado no "ValorDeDesconto" da Entidade de Pedidos, será somado o valor de R$ 5,00. Assim, o total do desconto do produto 1 será R$ 20,00). |
Id | Id do Numero do Item do Pedido |
ProdutoId | Id do Produto (Não é obrigatório se o Código de Barras for preenchido) |
Quantidade | Quantidade de Examples para o Produto |
ValorUnitario | Valor Unitário do Produto |
Forma de Pagamento
AltCodigo | Código Alternativo |
AtualizadoEm | |
Codigo | Código ID da Forma de Pagamento no Site/Aplicativo |
CodigoInterno | |
Descricao | Descrição da Forma de Pagamento acima. Ex.: Boleto Bancário. |
Tipo | Tipo da forma de pagamento
|
F