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. |
| 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. |
| disponivel_ecommerce | Não | Lógico | Filtro | Retorna apenas os registros configurados como disponíveis para e-commerce. |
| disponivel_mobile | Não | Lógico | Filtro | Retorna apenas os registros configurados como disponíveis para utilização com o mobile. |
Estrutura de retorno
| Nome | Nível | Tipo de dado | Descrição |
|---|---|---|---|
| produtos | 0 | Estrutural | |
| produto | 1 | Estrutural | |
| id | 2 | Inteiro | Id do Produto |
| id_empresa | 2 | Inteiro | Id da empresa em que o produto será disponibilizado |
| codigo | 2 | Texto(30) | Código alfanúmerico do produto |
| 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 |
| observacoes_tecnicas | 2 | Texto | Observações técnicas do produto |
| id_grupo | 2 | Inteiro | Id do grupo do produto |
| grupo | 2 | Texto(40) | Descrição do grupo do produto |
| id_unidade | 2 | Inteiro | Id da unidade do produto |
| fornecedor | 2 | Inteiro | Id do fornecedor do produto |
| fabricante | 2 | Texto(80) | Descrição do fabricante do produto |
| unidade | 2 | Texto(5) | Unidade do produto |
| codigo_ipi | 2 | Texto(12) | Código do IPI |
| base_icms | 2 | Real | Base do ICMS do produto |
| servico | 2 | Lógico | Determina se o produto é um serviço |
| data_cadastro | 2 | Data | Data do cadastro |
| movimenta_estoque | 2 | Lógico | Determina se produto movimenta estoque |
| volume | 2 | Real | Volume do produto |
| unidade_volume | 2 | Texto(3) | Descrição unidade do volume |
| ativo | 2 | Lógico | Determina se o produto está ativo |
| usa_balanca | 2 | Lógico | Determina se o produto utiliza balança |
| preco_sob_consulta | 2 | Lógico | Define o preço do produto apenas sob consulta |
| descricao_resumida | 2 | Texto(22) | Descrição resumida do produto |
| peso | 2 | Real | Peso do produto |
| id_subgrupo | 2 | Inteiro | Id do subgrupo do produto |
| descricao_similar | 2 | Texto(80) | Descrição similar do produto |
| descricao_res_web | 2 | Texto(250) | Descrição resumida para e-commerce |
| ecommerce | 2 | Lógico | Define se o produto é utilizado no e-commerce |
| largura | 2 | Real | Largura da embalagem do produto |
| altura | 2 | Real | Altura da embalagem do produto |
| profundidade | 2 | Real | Profundidade da embalagem do produto |
| diametro | 2 | Real | Diâmetro da embalagem do produto |
| formato_embalagem | 2 | Inteiro | Formato da embalagem do produto 0 - Caixa 1 - Cilindro |
| cod_busca | 2 | Texto(30) | Código de busca |
| encomenda | 2 | Lógico | Determina se o produto precisa ser encomendado |
| controle_policia_federal | 2 | Lógico | Define se produto é controlado pela polícia federal |
| controle_policia_civil | 2 | Lógico | Define se o produto é controlado pela polícia civil |
| desc_faturamento | 2 | Texto(80) | Descrição do produto para faturamento |
| fora_de_linha | 2 | Lógico | Determina que o produto está fora de linha |
| controla_lote | 2 | Lógico | Determina que o produto controla lote |
| descricao_pesquisa | 2 | Texto(80) | Descrição do produto para pesquisas |
| cnae | 2 | Texto(15) | CNAE do produto |
| bebida | 2 | Lógico | Determina que produto é uma bebida |
| produto_proprio | 2 | Lógico | Determina que produto é um produto próprio |
| grade_caracteristicas | 2 | Lógico | Define que produto é resultante de uma grade de características |
| id_grade | 2 | Inteiro | Id da grade do produto |
Exemplos de consultas
//Mostra o produto 3 <servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" id="3"/>
//Todos os produtos a partir do id 39 <servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" id_inicial="39"/>
Exemplo de retorno
<produtos versao="1.00"> <produto> <id>1</id> <id_empresa>0</id_empresa> <codigo>000001</codigo> <codigo_barras>7896184106842</codigo_barras> <referencia>7896184106842</referencia> <descricao>LAMPADA FLUOR TUB 20W</descricao> <observacoes_tecnicas>PLUS</observacoes_tecnicas> <id_grupo>1</id_grupo> <grupo>ILUMINACAO</grupo> <id_unidade>3</id_unidade> <fabricante>SYLVANIA</fabricante> <unidade>PC</unidade> <codigo_ipi/> <base_icms>0.00</base_icms> <servico>false</servico> <data_cadastro>2014-05-28T16:34:59-03:00</data_cadastro> <movimenta_estoque>false</movimenta_estoque> <volume>0.00</volume> <unidade_volume/> <ativo>true</ativo> <usa_balanca>false</usa_balanca> <preco_sob_consulta>false</preco_sob_consulta> <descricao_resumida>LAMPADA FLUOR TUB 20W</descricao_resumida> <peso>0.00</peso> <id_subgrupo>29</id_subgrupo> <descricao_similar>LAMPADA FLUOR TUB 20W</descricao_similar> <descricao_res_web/> <ecommerce>false</ecommerce> <largura>0.00</largura> <altura>0.00</altura> <profundidade>0.00</profundidade> <diametro>0.00</diametro> <formato_embalagem>0</formato_embalagem> <cod_busca/> <encomenda>false</encomenda> <controle_policia_federal>false</controle_policia_federal> <controle_policia_civil>false</controle_policia_civil> <desc_faturamento/> <fora_de_linha>false</fora_de_linha> <controla_lote>false</controla_lote> <descricao_pesquisa>LAMPADA FLUOR TUB 20W</descricao_pesquisa> <cnae/> <bebida>false</bebida> <produto_proprio>false</produto_proprio> <grade_caracteristicas>false</grade_caracteristicas> <id_grade>0</id_grade> </produto> </produtos>