Versão 5.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.
disponivel_ecommerce	Não	Lógico	Filtro	True = Retorno apenas os produtos definidos como disponível no e-commerce False = Retorno apenas os produtos NÃO definidos como disponível no e-commerce
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
id_empresa	2	Inteiro	Id da empresa em que o produto está cadastrado
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
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_fabricante	2	Inteiro	Id do fabricante do produto
fabricante	2	Texto(80)	Descrição do fabricante do produto
id_unidade_volume	2	Inteiro	Id da unidade de volume do produto
unidade_volume	2	Texto(3)	Descrição da unidade do volume
id_unidade	2	Inteiro	Id da unidade do produto
unidade	2	Texto(3)	Descrição da unidade 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 do subgrupo do produto
observacoes_tecnicas	2	Texto	Observações técnicas do produto
descricao_utilizacao_produto	2	Texto	Descrição da utilização do produto
observacoes_tecnicas_web	2	Texto	Observações técnicas específicas para e-commerce
ativo	2	Lógico	Determina se o produto está ativo
servico	2	Lógico	Determina se produto é um serviço
preco_sob_consulta	2	Lógico	Define se o preço do produto aparece apenas sob consulta
ecommerce	2	Lógico	Determina se produto é utilizado no e-commerce
encomenda	2	Lógico	Determina se produto precisa ser encomendado
id_grade	2	Inteiro	Id da grade do produto
grade_caracteristicas	2	Lógico	Define que produto é resultante de uma grade de características
caracteristicas	2	Estrutural
caracteristica	3	Estrutural
id	4	Inteiro	Id da característica do produto
sequencia	4	Inteiro	Sequência a ser considerada
descricao	4	Texto(40)	Descrição da característica do produto
atributo_coloracao	4	Lógico	Determina se característica é uma cor
ativa	4	Lógico	Determina se característica está ativa
medidas	2	Estrutural
largura	3	Real	Largura do produto
altura	3	Real	Altura do produto
profundidade	3	Real	Profundidade do produto
diametro	3	Real	Diâmetro do produto
peso	3	Real	Peso do produto
valores	2	Estrutural
valor	3	Estrutural
id_tabela_preco	4	Inteiro	Id da tabela de preço
valor_venda	4	Real	Valor de venda do produto
valor_promocional	4	Real	Valor promocional do produto
validade_inicial_promo	4	Data	Data inicial da validade do valor promocional do produto
validade_final_promo	4	Data	Data final da validade do valor promocional do produto
estoques	2	Estrutural
estoque	3	Estrutural
id_estoque	4	Inteiro	Id do estoque onde está alocado o produto
quantidade	4	Real	Quantidade do produto em estoque
produtos_gerados_grade	2	Estrutural
produto_gerado	3	Estrutural
id	4	Inteiro	Id do produto resultante
id_empresa	4	Inteiro	Id da empresa em que o produto está cadastrado
codigo	4	Texto(30)	Código alfanúmerico do produto resultante
codigo_barras	4	Texto(30)	Código de barras do produto resultante
referencia	4	Texto(30)	Código de referência do produto resultante
descricao	4	Texto(80)	Descrição do produto referente
descricao_similar	4	Texto(80)	Descrição similar do produto resultante
descricao_res_web	4	Texto(250)	Descrição resumida para e-commerce
descricao_resumida	4	Texto(22)	Descrição do produto resultante
id_fabricante	4	Inteiro	Id do fabricante do produto resultante
fabricante	4	Texto(80)	Descrição do fabricante do produto resultante
id_unidade_volume	4	Inteiro	Id da unidade do volume do produto resultante
unidade_volume	4	Texto(3)	Descrição da unidade do volume do produto resultante
id_unidade	4	Inteiro	Id da unidade do produto resultante
unidade	4	Texto(3)	Descrição da unidade do produto resultante
id_grupo	4	Inteiro	Id do grupo do produto resultante
grupo	4	Texto(40)	Descrição do grupo do produto resultante
id_subgrupo	4	Inteiro	Id do subgrupo do produto resultante
subgrupo	4	Texto(40)	Descrição do subgrupo do produto resultante
observacoes_tecnicas	4	Texto	Observações técnicas do produto resultante
descricao_utilizacao_produto	4	Texto	Descrição da utilização do produto resultante
observacoes_tecnicas_web	4	Texto	Observações técnicas para produtos e-commerce resultantes
ativo	4	Lógico	Determina se produto resultante está ativo
servico	4	Lógico	Determina se produto resultante é um serviço
preco_sob_consulta	4	Lógico	Define o preço do produto resultante apenas sob consulta
ecommerce	4	Lógico	Determina se produto resultante é utilizado no e-commerce
encomenda	4	Lógico	Determina se produto resultante precisa ser encomendado
medidas	4	Estrutural
largura	5	Real	Largura do produto
altura	5	Real	Altura do produto
profundidade	5	Real	Profundidade do produto
diametro	5	Real	Diâmetro do produto
peso	5	Real	Peso do produto
atributos	4	Estrutural
atributo	5	Estrutural
id	6	Inteiro	Id do atributo do produto
id_caracteristica	6	Inteiro	Id da característica do atributo do produto
valor	6	Texto(40)	Valor do atributo
ativo	6	Lógico	Determina se atributo está ativo
valores	4	Estrutural
valor	5	Estrutural
id_tabela_preco	6	Inteiro	Id da tabela de preço referente a produto
valor_venda	6	Real	Valor de venda do produto
valor_promocional	6	Real	Valor promocional do produto
validade_inicial_promo	6	Data	Valor inicial do valor promocional do produto
validade_final_promo	6	Data	Valor final do valor promocional do produto
estoques	4	Estrutural
estoque	5	Estrutural
id_estoque	6	Inteiro	Id do estoque do produto
quantidade	6	Real	Quantidade de produtos em estoque

Exemplos de consultas

//Mostra o produto 3
<servico versao="5.00" token="tkn-vinhasoft-001" id_empresa="1" id="3"/>

//Todos os produtos a partir do id 39
<servico versao="5.00" token="tkn-vinhasoft-001" id_empresa="1" id_inicial="39"/>

Exemplo de retorno

<produtos versao="5.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>
		<descricao_similar>LAMPADA FLUORSYLVANIA</descricao_similar>
		<descricao_resumida>LAMPADA FLUOR TUB 20W</descricao_resumida>
		<descricao_res_web/>
		<id_fabricante>1</id_fabricante>
		<fabricante>SYLVANIA</fabricante>
		<id_unidade_volume>0</id_unidade_volume>
		<unidade_volume/>
		<id_unidade>3</id_unidade>
		<unidade>PC</unidade>
		<id_grupo>1</id_grupo>
		<grupo>ILUMINACAO</grupo>
		<id_subgrupo>29</id_subgrupo>
		<subgrupo>5000k</subgrupo>
		<observacoes_tecnicas>PLUS</observacoes_tecnicas>
		<descricao_utilizacao_produto/>
		<observacoes_tecnicas_web/>
		<ativo>true</ativo>
		<servico>false</servico>
		<preco_sob_consulta>false</preco_sob_consulta>
		<ecommerce>false</ecommerce>
		<encomenda>false</encomenda>
		<id_grade>0</id_grade>
		<grade_caracteristicas>false</grade_caracteristicas>
		<caracteristicas/>
		<medidas>
			<largura>0.00</largura>
			<altura>0.00</altura>
			<profundidade>0.00</profundidade>
			<diametro>0.00</diametro>
			<peso>0.00</peso>
		</medidas>
		<valores>
			<valor>
				<id_tabela_preco>1</id_tabela_preco>
				<valor_venda>4.99</valor_venda>
				<valor_promocional>4.99</valor_promocional>
				<validade_inicial_promo/>
				<validade_final_promo/>
			</valor>
		</valores>
		<estoques>
			<estoque>
				<id_estoque>1</id_estoque>
				<quantidade>415.000</quantidade>
			</estoque>
		</estoques>
		<produtos_gerados_grade/>
	</produto>
</produtos>