Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

02. SITUAÇÃO/REQUISITO

Disponibilizar alguma maneira de consultar o estoque de produtos que controla lotena API /api/retail/v1/estoque/lista informações do lote do produto quando o mesmo realiza o controle.

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 corpoond foi adicionado algumas informações sobre lote através da tag produtoLote.

Exemplo Resquest:

{
    "idRetaguardaProduto": [
        "ESTSE0000000000000000000001374"
    ],
    "idRetaguardaLojasConsultaEstoque": [
        "D MG 01",
        "D MG 02"
    ],
    "idRetaguardaLojaOrigem""D MG 01"
}

...

ParâmetroTipo ObrigatórioObjetivo
idRetaguardaProdutoListaSimLista de produtos que deseja realizar a consulta.
idRetaguardaLojasConsultaEstoqueListaNãoQuando informado, irá pesquisar estoque somente das lojas informadas, quando não, irá devolver o
estoque de todas as Lojas
idRetaguardaLojaOrigemStringSimIdentificar qual loja está realizando a consulta de estoque (não é a loja onde possui o saldo de estoque


Exemplo Retorno:

{
    "success": true,
    "message": "",
    "data": [
        {
            "idRetaguardaProduto": "ESTSE0000000000000000000001374",
            "estoque": [
                {
                    "quantidade": 75,
                    "armazem": {
                        "id": "01",
                        "descricao": "Armazem 01     "
                    },
                    "loja": {
                        "idRetaguarda": "D MG 01 ",
                        "descricao": "Grupo TOTVS 1 - Filial BELO HOR",
                        "endereco": "SAO PAULO - AV. BRAZ LEME, 1631"
                    },
                    "produtoLote": [
                        {
                            "idRetaguarda": "1106",
                            "quantidade": 25,
                            "identificacaoLote": "A         ",
                            "dataValidade": "2024-12-31"
                        },
                        {
                            "idRetaguarda": "1107",
                            "quantidade": 25,
                            "identificacaoLote": "B         ",
                            "dataValidade": "2024-12-31"
                        },
                        {
                            "idRetaguarda": "1109",
                            "quantidade": 25,
                            "identificacaoLote": "D         ",
                            "dataValidade": "2024-12-31"
                        }
                    ]
                },
                {
                    "quantidade": 0,
                    "armazem": {
                        "id": "",
                        "descricao": ""
                    },
                    "loja": {
                        "idRetaguarda": "D MG 02 ",
                        "descricao": "Grupo TOTVS 1 - Filial UBERABA",
                        "endereco": "MINAS GERAIS - "
                    },
                    "produtoLote": []
                }
            ]
        }
    ],
    "hasNext": false
}

...

CampoTipo   Objetivo
idRetaguardaProdutoString
estoqueLista[]

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.

quantidadeFloatTotal disponível em todos os locais de estoque da Loja.
lojaObjetoAgrupador para as informações da loja.
idRetaguardaStringId da Loja que possui o estoque, estará dentro do objeto loja.
descricaoString

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. 

enderecoStringEndereço da Loja, estará dentro do objeto loja.

04. DEMAIS INFORMAÇÕES

...

  • Caso o produto esteja configurado para controle de SUB-LOTE (B1_RASTRO = S) não será retornando na API de estoque online.
  • Não está contemplado retorno de Sub-Lote para o estoque do produto.

05. ASSUNTOS RELACIONADOS

...