Busca Estoque

Para obtermos informações sobre estoque de um produto devemos usar o serviço ConsultaProdutosSP.getDetalhesEstoques do módulo mgecom.

É possível consultar estoque de um produto por vez.
Os estoques retornados neste serviço dependem da configuração realizada na tela 'Consulta de Produtos'.

Sugere-se configurar a tela para o usuário utilizado na integração do sistema, desta forma apenas os estoques utilizados no sistema externo serão retornados.

Parâmetros de chamada

criterio

Elemento XML que possui diversos atributos que devem ser utilizados para refinar e configurar a consulta.
Os atributos disponíveis estão documentados no exemplo contido neste documento.

Dados modificados

Nenhuma informação é modificada por este serviço, pois trata-se de um serviço exclusivo para consultas.

Detalhes do HTTP

Método de requisição: POST
URL:
https://api.sankhya.com.br/gateway/v1/mgecom/service.sbr?serviceName=ConsultaProdutosSP.getDetalhesEstoques

Headers HTTP:
- Content-Type: text/xml;charset=ISO-8859-1

- Autorization: bearerToken=[TOKEN gerado no serviço de autenticação]

Estrutura básica da requisição:

<criterio>
			<filtroPersonalizado>
				<expression></expression>
			</filtroPersonalizado>
</criterio>

Estrutura básica do resultado:

<produto>
     <volumes>
        <volume/>
     </volumes>
	<estoques>
		<estoque/>
	</estoques>
</produto>

Exemplo de uso

Corpo da requisição:

<!-- o elemento 'criterio' possui alguns atributos que configuram a consulta, e estão detalhados em uma tabela mais abaixo. -->
		<criterio RESOURCEID="br.com.sankhya.com.cons.consultaProdutos" 
CODPROD="108" 
MANDARVOLUMES="true"
>
<!--
Filtro que será aplicado a tabela de estoque (TGFEST).
-->
			<filtroPersonalizado>
<!--
O elemento 'expression' é um trecho SQL. O alias 'this' faz referencia à tabela TGFEST.
Neste exemplo, apenas o estoque da empresa 1 será retornado.
-->
				<expression>(this.CODEMP = 1)</expression>
			</filtroPersonalizado>
		</criterio>

Atributos do elemento 'criterio'

Nome	Tipo	Descrição
CODPROD	Inteiro	Cód.Produto para obter o estoque
RESOURCEID	String	Identificador para configuração. Deve sempre ser informado o valor presente neste exemplo
MANDARVOLUMES	Boolean	Flag (true\|false) que determina se o serviço deve retornar, adicionalmente, informações sobre unidades de venda do produto
CODVOL	String	Unidade de venda em que o estoque deve ser retornado. Se for uma unidade alternativa então as quantidades retornadas estarão calculadas nesta medida. Quando não informada o estoque é retornado em unidade padrão.

Retorno bem sucedido:

<?xml version="1.0" encoding="ISO-8859-1"?>
<serviceResponse serviceName="ConsultaProdutosSP.getDetalhesEstoques" status="1" pendingPrinting="false" transactionId="df7c13ba-08f8-4b2a-88b1-40bc7814bc76">
	<responseBody>
		<produto>
<!--
O serviço foi configurado para retornar informações de undades de venda
-->
			<volumes>
				<volume>
					<PADRAO>true</PADRAO>
					<CODVOL>UN</CODVOL>
					<DESCRVOL>*Unidade</DESCRVOL>
					<TOOLTIP>Volume padrão</TOOLTIP>
				</volume>
			</volumes>
<!--
O elemento 'estoques' possui atributos totalizadores dos estoque retornados (neste caso, apenas 1).
QTDTOTALEST = total bruto do estoque
QTDTOTALRES = total reservado
QTDTOTALREC = total em recebimento pelo WMS
QTDTOTALWMSBLOQUEADO = total bloqueado no WMS
QTDTOTALESTMENOSRES = total disponível do estoque
-->
			<estoques QTDTOTALEST="10" QTDTOTALRES="0" QTDTOTALREC="0" QTDTOTALESTMENOSRES="10" QTDTOTALWMSBLOQUEADO="0">
<!--
Os elementos 'estoque' detalham o estoque, considerando empresa, local, controle, etc.
-->
				<estoque>
					<TIPO>Próprio</TIPO>
					<PODER>Próprio</PODER>
					<CODBARRA/>
					<STATUSLOTE>N</STATUSLOTE>
					<CODEMP>1</CODEMP>
					<NOMEFANTASIA>WCS PRESTAÇÃO DE SERVIÇOS</NOMEFANTASIA>
					<CODLOCAL>0</CODLOCAL>
					<DESCRLOCAL>&lt;SEM LOCAL&gt;</DESCRLOCAL>
					<CONTROLE> </CONTROLE>
					<ESTOQUE>10</ESTOQUE>
					<RESERVADO>0</RESERVADO>
					<WMSBLOQUEADO>0</WMSBLOQUEADO>
					<ESTDOCAWMS>0</ESTDOCAWMS>
					<DISPONIVEL>10</DISPONIVEL>
				</estoque>
			</estoques>
		</produto>
	</responseBody>
</serviceResponse>