Versão 1.00
Parâmetros padrões:
| Nome | Obrigatório | Tipo de dado | Finalidade | Descrição |
|---|---|---|---|---|
| id | Não | Inteiro | Filtro | É utilizado para filtrar o registro a ser consultado. Indicado para pesquisas singulares. |
Estrutura de retorno
| Nome | Nível | Tipo de dado | Descrição |
|---|---|---|---|
| pedidos | 0 | Estrutural | |
| pedido | 1 | Estrutural | |
| id | 2 | Inteiro | Id do pedido gerado |
| id_cliente | 2 | Inteiro | Id do cliente |
| id_agenciador | 2 | Inteiro | Id do agenciador informado na criação do pedido |
| id_tabela_preco | 2 | Inteiro | Id da tabela de preço informada na criação do pedido |
| id_forma_entrega | 2 | Inteiro | Id da forma de entrega informada na criação do pedido |
| id_status | 2 | Inteiro | Id do status atual do pedido |
| id_transportadora | 2 | Inteiro | Id da transportadora informada na criação do pedido |
| id_vendedor | 2 | Inteiro | Id do vendedor do pedido de venda |
| condicao_pagamento | 2 | Texto(40) | Descrição da condição de pagamento aplicada ao financeiro do pedido |
| data_entrega | 2 | Data | Data de entrega prevista para o pedido de venda |
| data_cadastro | 2 | Data | Data de cadastro do pedido de venda |
| reservado | 2 | Lógico | Determina se o pedido de venda está com o seu estoque reservado |
| bonificacao | 2 | Lógico | Determina se o pedido de venda é do tipo bonificação |
| observacao | 2 | Texto | Observações gerais do pedido |
| valor_itens | 2 | Real | Valor total dos itens do pedido |
| valor_frete | 2 | Real | Valor do frete |
| valor_total | 2 | Real | Valor total do pedido de venda |
| codigo_rastreio | 2 | Texto | Código de rastreio associado ao pedido de venda |
| endereco_entrega | 2 | Estrutural | Endereço de entrega do documento |
| cep | 3 | Texto(9) | CEP do endereço de entrega |
| logradouro_com_numero | 3 | Texto(80) | Informação completada do endereço de entrega |
| ponto_referencia | 3 | Texto(40) | Ponto de referência do endereço de entrega |
| estado | 3 | Texto(2) | Estado do endereço de entrega |
| cidade | 3 | Texto(40) | Cidade do endereço de entrega |
| itens | 2 | Estrutural | Itens do documento de venda |
| item | 3 | Estrutural | |
| id | 4 | Inteiro | Id do item |
| unidade | 4 | Texto(3) | Descrição da unidade do item |
| quantidade | 4 | Real | Quantidade comercializada do item |
| desconto_perc | 4 | Real | Desconto em percentual aplicado ao item |
| desconto_valor | 4 | Real | Desconto aplicado ao item |
| valor_unitario | 4 | Real | Valor unitário do item |
| valor_total | 4 | Real | Valor total dos itens |
| tabela_preco | 4 | Texto(20) | Descrição da tabela de preço aplicada ao item |
| documento_fiscal | 2 | Estrutural | Documento fiscal gerado para o pedido de venda (Informações da nota ou cupom fiscal) |
| id | 3 | Inteiro | Id do documento fiscal |
| id_empresa | 3 | Inteiro | Id da empresa na qual o documento foi processado |
| id_modelo | 3 | Inteiro | Id do modelo do documento |
| origem_documento | 3 | Inteiro | Tipo do documento fiscal gerado. 0 - nota fiscal |
| numero_documento | 3 | Inteiro | Número do documento |
| serie | 3 | Texto(5) | Série utilizada no documento fiscal |
| id_cliente | 3 | Inteiro | Id do cliente do documento fiscal |
| id_tabela_preco | 3 | Texto(20) | Id da tabela de preço |
| id_forma_entrega | 3 | Inteiro | Id da forma de entrega |
| id_transportadora | 3 | Inteiro | Id da transportadora |
| condicao_pagamento | 3 | Texto(40) | Descrição da condição de pagamento |
| data_entrega | 3 | Data | Data de entrega |
| data_cadastro | 3 | Data | Data de cadastro |
| observacao | 3 | Texto | Observações gerais do documento |
| valor_itens | 3 | Real | Valor dos itens |
| valor_frete | 3 | Real | Valor do frete |
| valor_total | 3 | Real | Valor total do documento |
| chave_acesso_nfe | 3 | Texto | Chave de acesso para consultar a NF-e |
| codigo_rastreio | 3 | Texto | Código de rastreio do documento |
| endereco_entrega | 3 | Estrutural | |
| cep | 4 | Texto(9) | CEP do endereço de entrega |
| logradouro_com_numero | 4 | Texto(80) | Informação completada do endereço de entrega |
| ponto_referencia | 4 | Texto(40) | Ponto de referência do endereço de entrega |
| estado | 4 | Texto(2) | Estado do endereço de entrega |
| cidade | 4 | Texto(40) | Cidade do endereço de entrega |
| itens | 3 | Estrutural | Itens do documento |
| item | 4 | Estrutural | |
| id | 5 | Inteiro | Id do item |
| unidade | 5 | Texto(3) | Descrição da unidade do item |
| quantidade | 5 | Real | Quantidade comercializada do item |
| desconto_perc | 5 | Real | Desconto em percentual aplicado ao item |
| desconto_valor | 5 | Real | Desconto aplicado ao item |
| valor_unitario | 5 | Real | Valor unitário do item |
| valor_total | 5 | Real | Valor total dos items |
| tabela_preco | 5 | Texto(20) | Descrição da tabela de preço aplicada ao item |
Exemplos de consultas
//Informações do pedido criado com o ID 90 <servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" id="90"/>
Exemplo de retorno
<pedidos versao="1.00">
<pedido>
<id>236773</id>
<id_cliente>133879</id_cliente>
<id_agenciador>0</id_agenciador>
<id_tabela_preco>1</id_tabela_preco>
<id_forma_entrega>1</id_forma_entrega>
<id_status>11</id_status>
<id_transportadora>0</id_transportadora>
<id_vendedor>8966536</id_vendedor>
<condicao_pagamento />
<data_entrega>2014-03-15T16:31:05-03:00</data_entrega>
<data_cadastro>2014-03-14T00:00:00-03:00</data_cadastro>
<reservado>true</reservado>
<bonificacao>false</bonificacao>
<observacao />
<valor_itens>1357.20</valor_itens>
<valor_frete>0.00</valor_frete>
<valor_total>1357.20</valor_total>
<codigo_rastreio />
<endereco_entrega>
<cep>13000-091</cep>
<logradouro_com_numero>Rua das Oliveiras, nº 135</logradouro_com_numero>
<ponto_referencia />
<estado>SP</estado>
<cidade>CAMPINAS</cidade>
</endereco_entrega>
<itens>
<item>
<id>6064</id>
<unidade>UN</unidade>
<quantidade>1.000</quantidade>
<desconto_perc>0.00</desconto_perc>
<desconto_valor>0.00</desconto_valor>
<valor_unitario>1350.00</valor_unitario>
<valor_total>1350.00</valor_total>
<tabela_preco>NORMAL</tabela_preco>
</item>
<item>
<id>845</id>
<unidade>UN</unidade>
<quantidade>6.000</quantidade>
<desconto_perc>0.00</desconto_perc>
<desconto_valor>0.00</desconto_valor>
<valor_unitario>1.20</valor_unitario>
<valor_total>7.20</valor_total>
<tabela_preco>NORMAL</tabela_preco>
</item>
</itens>
<documento_fiscal>
<id>3962</id>
<id_empresa>1</id_empresa>
<id_modelo>3</id_modelo>
<origem_documento>0</origem_documento>
<numero_documento>3371</numero_documento>
<serie>01</serie>
<id_cliente>13579</id_cliente>
<id_tabela_preco>1</id_tabela_preco>
<id_forma_entrega>1</id_forma_entrega>
<id_transportadora>0</id_transportadora>
<condicao_pagamento>Boleto</condicao_pagamento>
<data_entrega>2014-03-15T00:00:00-03:00</data_entrega>
<data_cadastro>2014-03-14T00:00:00-03:00</data_cadastro>
<observacao />
<valor_itens>1357.20</valor_itens>
<valor_frete>0.00</valor_frete>
<valor_total>1357.20</valor_total>
<chave_acesso_nfe>76387096569100002569370010000033711049539620</chave_acesso_nfe>
<codigo_rastreio>BRL67895655640923RT</codigo_rastreio>
<endereco_entrega>
<cep>13000-091</cep>
<logradouro_com_numero>Rua das Oliveiras, nº 135</logradouro_com_numero>
<ponto_referencia />
<estado>SP</estado>
<cidade>CAMPINAS</cidade>
</endereco_entrega>
<itens>
<item>
<id>6064</id>
<unidade>UN</unidade>
<quantidade>1.000</quantidade>
<desconto_perc>0.00</desconto_perc>
<desconto_valor>0.00</desconto_valor>
<valor_unitario>1350.00</valor_unitario>
<valor_total>1350.00</valor_total>
<tabela_preco>NORMAL</tabela_preco>
</item>
<item>
<id>845</id>
<unidade>UN</unidade>
<quantidade>6.000</quantidade>
<desconto_perc>0.00</desconto_perc>
<desconto_valor>0.00</desconto_valor>
<valor_unitario>1.20</valor_unitario>
<valor_total>7.20</valor_total>
<tabela_preco>NORMAL</tabela_preco>
</item>
</itens>
</documento_fiscal>
</pedido>
</pedidos>
Exemplo de falha no retorno
<retorno>
<mensagens>
<mensagem>
<id>13</id>
<descricao>Documento de venda não localizado ou inexistente.</descricao>
</mensagem>
</mensagens>
</retorno>