Versão 2.00
Estrutura de envio
| Nome | Nível | Obrigatório | Tipo de dado | Descrição |
|---|---|---|---|---|
| pedidos | 0 | Sim | Estrutural | |
| pedido | 1 | Sim | Estrural | |
| id_externo | 1 | Não | Atributo de elemento (Texto) | Utilizado para fazer referência a um documento externo |
| id | 2 | Sim | Inteiro | É possível manipular o ID do registro gerado pelo sistema. Enviar 0 para utilizar o ID gerado pelo sistema. |
| id_cliente | 2 | Sim | Inteiro | Id do cliente do pedido de venda. |
| id_agenciador | 2 | Não | Inteiro | Id do agenciador aplicado ao pedido de venda. Enviar 0 quando não houver. |
| id_tabela_preco | 2 | Sim | Inteiro | Id da tabela preço. |
| id_forma_entrega | 2 | Sim | Inteiro | Id da forma de entrega. |
| id_status | 2 | Sim | Inteiro | Id do status inicial do pedido de venda. |
| id_transportadora | 2 | Sim | Inteiro | Id da transportadora do pedido de venda. |
| id_vendedor | 2 | Sim | Inteiro | Id do vendedor. Enviar 0 para assumir o vendedor configurado no sistema. |
| id_condicao_pagamento | 2 | Sim | Inteiro | Id da condição de pagamento do pedido de venda |
| id_estoque | 2 | Sim | Inteiro | Id do estoque do pedido de venda |
| data_entrega | 2 | Sim | Data | Data prevista para entrega dos produtos |
| data_cadastro | 2 | Sim | Data | Data da criação do pedido de venda |
| bonificacao | 2 | Sim | Lógico | Determina se o pedido será considerado como bonificação |
| reservado | 2 | Sim | Lógico | Define se pedido é criado com as mercadorias reservadas |
| observacao | 2 | Sim | Texto | Observações gerais do pedido de venda |
| valor_itens | 2 | Sim | Real | Soma total do valor dos itens |
| valor_frete | 2 | Sim | Real | Valor do frete |
| valor_total | 2 | Sim | Real | Valor total do pedido de venda (itens + frete) |
| endereco_entrega | 2 | Sim | Estrutural | |
| cep | 3 | Sim | Texto(9) | CEP do endereço de entrega |
| logradouro_com_numero | 3 | Sim | Texto(80) | Logradouro com o número do endereço de entrega |
| ponto_referencia | 3 | Sim | Texto(40) | Ponto de referência do endereço de entrega |
| estado | 3 | Sim | Texto(2) | Estado do endereço de entrega |
| cidade | 3 | Sim | Texto(40) | Cidade do endereço de entrega |
| bairro | 3 | Sim | Texto(40) | Bairro do endereço de entrega |
| endereco_faturamento | 2 | Sim | Estrutural | |
| cep | 3 | Sim | Texto(9) | Cep do endereço de faturamento |
| logradouro_com_numero | 3 | Sim | Texto(80) | Logradouro com o número do endereço de faturamento |
| ponto_referencia | 3 | Sim | Texto(40) | Ponto de referência do endereço de faturamento |
| estado | 3 | Sim | Texto(2) | Estado do endereço de faturamento |
| cidade | 3 | Sim | Texto(40) | Cidade do endereço de faturamento |
| bairro | 3 | Sim | Texto(40) | Bairro do endereço de cobrança |
| ecommerce | 2 | Não | Lógico | Categoriza o pedido como origem e-commerce. |
| lancar_financeiro | 2 | Não | Lógico | Automatiza o lançamento no financeiro com base nas configurações padrões da condição de pagamento utilizada no pedido de venda. Se enviado como verdadeiro, não se faz necessário o uso do serviço LancarPedidoFinanceiro |
| itens | 2 | Sim | Estrutural | |
| item | 3 | Sim | Estrutural | |
| id | 4 | Sim | Inteiro | Id do produto |
| unidade | 4 | Sim | Texto(3) | Unidade de venda do produto |
| quantidade | 4 | Sim | Real | Quantidade vendida |
| desconto_perc | 4 | Sim | Real | Percentual de desconto aplicado no item |
| desconto_valor | 4 | Sim | Real | Valor do desconto aplicado no item |
| acrescimo_perc | 4 | Sim | Real | |
| acrescimo_valor | 4 | Sim | Real | |
| valor_unitario_bruto | 4 | Sim | Real | |
| valor_unitario_liquido | 4 | Sim | Real | |
| valor_total | 4 | Sim | Real | Soma total do produto, incluindo os descontos |
| tabela_preco | 4 | Sim | Texto(20) | Descrição da tabela de preço aplicada ao produto. Enviar em branco caso utilizar a mesma do pedido |
| observacoes | 4 | Não | Texto(250) | Observações gerais por produto |
Exemplo de envio
<pedidos versao="2.00" token="tkn-vinhasoft-001" id_empresa="1">
<pedido id_externo="id_ext_8ff5">
<id>0</id>
<id_cliente>31</id_cliente>
<id_agenciador>0</id_agenciador>
<id_tabela_preco>1</id_tabela_preco>
<id_forma_entrega>1</id_forma_entrega>
<id_status>7</id_status>
<id_transportadora>0</id_transportadora>
<id_vendedor>0</id_vendedor>
<id_condicao_pagamento>7</id_condicao_pagamento>
<id_estoque>1</id_estoque>
<data_entrega>2016-07-21T08:00:10.5</data_entrega>
<data_cadastro>2016-07-21T08:00:10.5</data_cadastro>
<bonificacao>false</bonificacao>
<reservado>true</reservado>
<observacao>Observacao</observacao>
<valor_itens>570.00</valor_itens>
<valor_frete>0.00</valor_frete>
<valor_total>570.00</valor_total>
<ecommerce>true</ecommerce>
<endereco_entrega>
<cep>13160000</cep>
<logradouro_com_numero>Rua dos Relógios, Nº 123</logradouro_com_numero>
<ponto_referencia>Ponto de referencia</ponto_referencia>
<estado>SP</estado>
<cidade>Campinas</cidade>
<bairro>Centro</bairro>
</endereco_entrega>
<endereco_faturamento>
<cep>13160000</cep>
<logradouro_com_numero>Rua dos Relógios, Nº 123</logradouro_com_numero>
<ponto_referencia>Ponto de referencia</ponto_referencia>
<estado>SP</estado>
<cidade>Campinas</cidade>
<bairro>Centro</bairro>
</endereco_faturamento>
<itens>
<item>
<id>5094</id>
<unidade>UN</unidade>
<quantidade>1</quantidade>
<desconto_perc>0</desconto_perc>
<desconto_valor>0</desconto_valor>
<acrescimo_perc>0</acrescimo_perc>
<acrescimo_valor>0</acrescimo_valor>
<valor_unitario_bruto>285.00</valor_unitario_bruto>
<valor_unitario_liquido>285.00</valor_unitario_liquido>
<valor_total>285</valor_total>
<tabela_preco />
<observacoes>Enviar apenas nas cores amarelas</observacoes>
</item>
<item>
<id>3079</id>
<unidade>UN</unidade>
<quantidade>1</quantidade>
<desconto_perc>0</desconto_perc>
<desconto_valor>0</desconto_valor>
<acrescimo_perc>0</acrescimo_perc>
<acrescimo_valor>0</acrescimo_valor>
<valor_unitario_bruto>285.00</valor_unitario_bruto>
<valor_unitario_liquido>285.00</valor_unitario_liquido>
<valor_total>285</valor_total>
<tabela_preco />
</item>
</itens>
</pedido>
</pedidos>
Exemplo de retorno
<retorno>
<mensagens>
<mensagem />
</mensagens>
<status>1</status>
<registros>
<registro>
<id>id_ext_8ff5</id>
<id_gerado>1241771</id_gerado>
<status>1</status>
<mensagens>
<mensagem>
<id>7</id>
<descricao>Registro inserido com sucesso.</descricao>
</mensagem>
</mensagens>
</registro>
</registros>
</retorno>
Pedidos com a flag lancar_financeiro = true são retornados com os detalhes das parcelas geradas no lançamento financeiro
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<registros>
<registro>
<id>id_ext_8ff5</id>
<id_gerado>1243621</id_gerado>
<status>1</status>
<mensagens>
<mensagem>
<id>7</id>
<descricao>Registro inserido com sucesso.</descricao>
</mensagem>
</mensagens>
<extras>
<ocorrencias>
<detalhes>
<detalhe categoria="financeiro">
<id>1687541</id>
<descricao>Parcela lançada no financeiro</descricao>
</detalhe>
<detalhe categoria="financeiro">
<id>1687551</id>
<descricao>Parcela lançada no financeiro</descricao>
</detalhe>
</detalhes>
</ocorrencias>
</extras>
</registro>
</registros>
<status>1</status>
</retorno>
A informação retornada na tag extras->ocorrencias->detalhes->detalhe->id é o ID da parcela gerada para o financeiro do pedido de venda inserido.
Com o ID da parcela é possível realizar a sua quitação através do serviço de quitação financeira.