DDINTEGRA-9861 DT API para consulta de Estoque - Winthor Smart Hub

01. DADOS GERAIS

Produto:	TOTVS Distribuição e Varejo
Linha de Produto:	Linha Winthor
Segmento:	Distribuição TOTVS Goiânia
Módulo:	VTEX
Função:	ESTOQUE
Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :	DDINTEGRA-9861

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": [
        "7891132000449-2"
    ],
    "idRetaguardaLoja": [
        "1",
        "2"
    ]
}

Parâmetros de entrada (Request):

Parâmetro	Tipo	Obrigatório	Objetivo
idRetaguardaProduto	Lista	S	Lista de produtos que deseja realizar a consulta.
idRetaguardaLoja	Lista	N	Quando informado, irá pesquisar estoque somente das lojas informadas, quando não, irá devolver o estoque de todas as Lojas

Retorno:

{
    "success": true,
    "hasNext": false,
    "message": "",
    "data": [
        {
            "idRetaguardaProduto": "7891132000449-2",
            "estoque": [
                {
                    "quantidade": 0,
                    "loja": {
                        "idRetaguarda": "1",
                        "endereco": "GOIÂNIA - ROD. ARQ. HELDER CANDIA MT 010 KM 4,7",
                        "descricao": "TESTES"
                    }
                },
                {
                    "quantidade": 10000,
                    "loja": {
                        "idRetaguarda": "2",
                        "endereco": "GOIANIA - ROD. ARQ. HELDER CANDIA MT 010 KM 4,7",
                        "descricao": "TOTVS BRASILIA"
                    }
                }
            ]
        }
    ]
}

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

Campo	Tipo	Objetivo
idRetaguardaProduto	String	Apresenta o código auxiliar(pcembalagem) do produto mais o código do produto(pcprodut), representa o dado no PDVSync.
estoque	Lista[]	Lista com todas as lojas do Winthor 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.
endereco	String	Endereço da Loja, estará dentro do objeto loja.

04. DEMAIS INFORMAÇÕES

Não se aplica

05. ASSUNTOS RELACIONADOS