DT API para consulta de Estoque - Smart Hub Protheus

01. DADOS GERAIS

Linha de Produto:	TOTVS Varejo Lojas
Segmento:	Varejo
Módulo:	SigaLoja (Controle de Loja)
Função:	estoqueobj
Ticket:	Não há.
Story:	DVARLOJ1-9668

02. SITUAÇÃO/REQUISITO

Disponibilizar alguma maneira de consultar o estoque, onde seja possível visualizar os produtos com estoque.

03. SOLUÇÃO

Foi disponibilizada API no seguinte caminho: http://{urlRest}/api/retail/v1/estoque/lista

A API utiliza o método POST, caso queria informar parâmetros para filtro os mesmos devem ser passados no corpo.

Exemplo:

{
    "idRetaguardaProduto": [
        "LJTEST01",
        "IPI"
    ],
    "idRetaguardaLojasConsultaEstoque": [
        "D MG 01",
        "D PR 02"
    ],
    "idRetaguardaLojaOrigem": "D MG 01"
}

Parâmetros de entrada (Request):

Parâmetro	Tipo	Obrigatório	Objetivo
idRetaguardaProduto	Lista	Sim	Lista de produtos que deseja realizar a consulta.
idRetaguardaLojasConsultaEstoque	Lista	Não	Quando informado, irá pesquisar estoque somente das lojas informadas, quando não, irá devolver o estoque de todas as Lojas
idRetaguardaLojaOrigem	String	Sim	Identificar qual loja está realizando a consulta de estoque (não é a loja onde possui o saldo de estoque

Retorno:

{
    "success": true,
    "message": "",
    "data": [
        {
            "idRetaguardaProduto": "IPI            ",
            "estoque": [
                {
                    "quantidade": 9939,
                    "loja": {
                        "idRetaguarda": "D MG 01 ",
                        "descricao": "Grupo TOTVS - Matriz 01 AM",
                        "endereco": "SAO PAULO - Av Amazonia, 1717"
                    }
                },
                {
                    "quantidade": 1,
                    "loja": {
                        "idRetaguarda": "D PR 02 ",
                        "descricao": "Grupo TOTVS - Filial 02 SP",
                        "endereco": "SAO PAULO - Avenida Braz Leme, 1717"
                    }
                }
            ]
        },
        {
            "idRetaguardaProduto": "LJTEST01       ",
            "estoque": [
                {
                    "quantidade": 1593,
                    "loja": {
                        "idRetaguarda": "D MG 01 ",
                        "descricao": "Grupo TOTVS - Matriz 01 AM",
                        "endereco": "SAO PAULO - Av Amazonia, 1717"
                    }
                },
                {
                    "quantidade": 99999999410,
                    "loja": {
                        "idRetaguarda": "D PR 02 ",
                        "descricao": "Grupo TOTVS - Filial 02 SP",
                        "endereco": "SAO PAULO - Avenida Braz Leme, 1717"
                    }
                }
            ]
        }
    ],
    "hasNext": false
}

Valores de retorno (Response): Retorna uma lista de produtos

Campo	Tipo	Objetivo
idRetaguardaProduto	String
estoque	Lista[]	Lista com todas as lojas do Protheus onde houve a consulta de estoque. Ex: Quando não informar onde quer consultar o estoque, será retornada uma lista de todas as lojas e quando não possuir o saldo, será retornada a quantidade = 0.
quantidade	Float	Total disponível em todos os locais de estoque da Loja.
loja	Objeto	Agrupador para as informações da loja.
idRetaguarda	String	Id da Loja que possui o estoque, estará dentro do objeto loja.
descricao	String	Descrição da Loja, estará dentro do objeto loja. Será composto pela junção dos campos M0_NOME + M0_FILIAL, para dar uma melhor visibilidade.
endereco	String	Endereço da Loja, estará dentro do objeto loja.

04. DEMAIS INFORMAÇÕES

Não há

05. ASSUNTOS RELACIONADOS

Árvore de páginas