Versão 4.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. |
| id_tabela_preco | Sim | Inteiro | Filtro | Utilizado para determinar em qual tabela de preços o valor do produto será calculado. |
| id_condicao_pgto | Sim | Inteiro | Filtro | Utilizado para determinar em qual condição de pagamento o valor do produto será calculado. |
| id_inicial | Não | Inteiro | Filtro | Id inicial do registro a ser considerado. |
| id_final | Não | Inteiro | Filtro | Id final do registro a ser considerado. |
| max_registros | Não | Inteiro | Filtro | Determina a quantidade máxima de registros a serem retornados. |
| id_estoque | Não | Inteiro | Filtro | Utilizado para filtrar qual o id do estoque no qual o sistema irá se basear para retornar a quantidade disponível em estoque. Se omitido, a consulta irá assumir o id do estoque padrão para vendas configurado no sistema |
Estrutura de retorno
| Nome | Nível | Tipo de dado | Descrição |
|---|---|---|---|
| produtos | 0 | Estrutural | |
| produto | 1 | Estrutural | |
| id | 2 | Inteiro | Id do produto |
| codigo | 2 | Texto(30) | Código alfanúmerico do produto |
| id_empresa | 2 | Inteiro | Id da empresa em que o produto foi cadastrado |
| codigo_barras | 2 | Texto(30) | Código de barras do produto |
| referencia | 2 | Texto(30) | Código de referência do produto |
| descricao | 2 | Texto(80) | Descrição do produto |
| descricao_similar | 2 | Texto(80) | Descrição similar do produto |
| descricao_res_web | 2 | Texto(250) | Descrição resumida para e-commerce |
| descricao_resumida | 2 | Texto(22) | Descrição resumida do produto |
| id_grupo | 2 | Inteiro | Id do grupo do produto |
| grupo | 2 | Texto(40) | Descrição do grupo do produto |
| id_subgrupo | 2 | Inteiro | Id do subgrupo do produto |
| subgrupo | 2 | Texto(40) | Descrição subgrupo do produto |
| largura | 2 | Real | Largura do produto |
| altura | 2 | Real | Altura do produto |
| profundidade | 2 | Real | Profundidade do produto |
| diametro | 2 | Real | Diâmetro do produto |
| unidade | 2 | Texto(5) | Descrição da unidade do produto |
| volume | 2 | Real | Volume do produto |
| unidade_volume | 2 | Texto(3) | Descrição da unidade do produto |
| peso | 2 | Real | Peso do produto |
| id_estoque | 2 | Inteiro | Id do estoque da consulta |
| estoque | 2 | Real | Quantidade disponível em estoque |
| pendente_recebimento | 2 | Real | Quantidade pendente para recebimento |
| data_recebimento | 2 | Data | Data prevista para recebimento |
| fabricante | 2 | Texto(80) | Fabricante do produto |
| observacoes_tecnicas | 2 | Texto | Observações técnicas do produto |
| descricao_utilizacao_produto | 2 | Texto | Descrição técnicas do produto |
| observacoes_tecnicas_web | 2 | Texto | Observações próprias para e-commerce |
| valor_custo | 2 | Real | Valor de custo do produto |
| valor_venda | 2 | Real | Valor de venda do produto |
| ativo | 2 | Lógico | Determina que produto está ativo |
| servico | 2 | Lógico | Determina se produto é um serviço |
| preco_sob_consulta | 2 | Lógico | Define o preço do produto apenas sob consulta |
| ecommerce | 2 | Lógico | Determina se o produto é utilizado no e-commerce |
| encomenda | 2 | Lógico | Determina se o produto precisa ser encomendado |
| desconto_maximo | 2 | Real | Desconto máximo aplicado no produto |
| grade_caracteristicas | 2 | Lógico | Define que produto é resultante de uma grade de características |
| id_grade | 2 | Inteiro | Id da grade de produto |
| produtos_gerados_grade | 2 | Estrutural | |
| produto_gerado | 3 | Estrutural | |
| id | 4 | Inteiro | Id do produto gerado na grade |
Exemplos de consultas
//Mostra o produto 3 <servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" id="3"/>
//Todos os produtos vinculados a condição de pagamento 39 <servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" id_condicao_pgto="39"/>
Exemplo de retorno
<produtos versao="4.00"> <produto> <id>1</id> <id_empresa>0</id_empresa> <codigo>000001</codigo> <codigo_barras>7896184106842</codigo_barras> <referencia>F1A128-RI</referencia> <descricao>LAMPADA FLUOR TUB 20W</descricao> <descricao_similar>LAMPADA FLUOR TUB 20W SYLVANIA</descricao_similar> <descricao_res_web/> <descricao_resumida>LAMPADA FLUOR</descricao_resumida> <id_grupo>1</id_grupo> <grupo>ILUMINACAO</grupo> <id_subgrupo>29</id_subgrupo> <subgrupo>5000k</subgrupo> <largura>0.00</largura> <altura>0.00</altura> <profundidade>0.00</profundidade> <diametro>0.00</diametro> <unidade>PC</unidade> <volume>0.00</volume> <unidade_volume/> <peso>0.00</peso> <id_estoque>1</id_estoque> <estoque>415.00</estoque> <pendente_recebimento>0.00</pendente_recebimento> <data_recebimento/> <fabricante>SYLVANIA</fabricante> <observacoes_tecnicas>PLUS</observacoes_tecnicas> <descricao_utilizacao_produto/> <observacoes_tecnicas_web/> <valor_custo>4.09</valor_custo> <valor_venda>4.99</valor_venda> <ativo>true</ativo> <servico>false</servico> <preco_sob_consulta>false</preco_sob_consulta> <ecommerce>false</ecommerce> <encomenda>false</encomenda> <desconto_maximo>4.00</desconto_maximo> <grade_caracteristicas>false</grade_caracteristicas> <id_grade>0</id_grade> <produtos_gerados_grade/> </produto> </produtos>