Este método é responsável pela consulta de quantidade de estoque disponível, por produto, na retaguarda.

Ao realizarmos uma consulta na API de ProcessoOnlineEstoqueSaldo, será possível verificar o saldo disponível em estoque do produto selecionado, inclusive por diferentes depositos, quando configurado.

  • Endpoint: /api/pdvsyncserver/retaguarda/v2/ProcessoOnlineEstoqueSaldo/{idInquilino}/{idProdutoRetaguarda}/{idLojaOrigemRetaguarda}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Client

Para esse endpoint, alguns parâmetro precisam ser enviados na requisição. Estes parâmetros são:

ParametroDescriçãoTipoObrigatórioObservação
inquilinoIdentificador do inquilinostringSim
idRetaguardaProdutoIdentificador do produto na retaguardastringSim
idRetaguardaLojaOrigemIdentificador da loja de consultante do saldostringSim
idRetaguardaLojasConsultaEstoqueIdentificador das lojas para consulta do estoquestring

Não

Pode ser enviado mais de um valor separando-os por vírgula (,)

idRetaguardaProdutoEmbalagemIdentificador da embalagemstringNãoPode ser enviado mais de um valor separando-os por vírgula (,)

Retornos

Campo

Tipo

Descrição

successBooleanoIndica se a requisição retornou sucesso
messageStringCampo com as mensagens de erro
dataLista de ObjetosConteúdo de retorno
data.estoqueLista de ObjetosLista de estoques
data.estoque.depositoLista de ObjetosLista de objetos de depósitos
data.estoque.deposito.idRetaguardaStringIdentificador de depósito na retaguarda
data.estoque.deposito.descricaoStringDescrição do depósito
data.estoque.deposito.quantidadeDecimalQuantidade de produto disponível por depósito
data.estoque.deposito.padraoBooleanDepósito padrão para venda
data.estoque.armazemObjetoObjeto armazem
data.estoque.armazem.idStringIdentificador do armazem
data.estoque.armazem.descricaoStringdescrição do armazem
data.estoque.lojaObjetoObjeto loja
data.estoque.loja.enderecoStringEndereço da loja
data.estoque.loja.idRetaguardaStringIdentificador da loja na retaguarda
data.estoque.loja.descricaoStringDescrição da loja
data.estoque.produtoLoteLista de ObjetosIdentificação de lotes do produto
data.estoque.produtoLote.idRetaguardaStringIdentificador do lote do produto na retaguarda
data.estoque.produtoLote.quantidadeNumericQuantidade de produtos disponível no lote.
data.estoque.produtoLote.identificacaoLoteStringCódigo ou identificação única do lote.
data.estoque.produtoLote.dataValidadeDateTime (formato ISO 8601)Data de validade do lote.
data.estoque.quantidadeDecimalQuantidade em estoque
data.idRetaguardaProdutoStringIdentificador do produto na retaguarda
errorsNuloLista com erros
totalTimeInteiroTempo de requisição
numberOfRecordsInteiroNúmero de linhas retornadas
{
    "success": true,
    "message": "",
    "data": [
        {
            "estoque": [
                {
				    "deposito": [
                         {
                             "idRetaguarda": "string",
                             "descricao": "string",
                             "quantidade": 0,
                             "padrao": false
                         }
                    ],
                    "armazem": {
                        "id":"string",
                        "descricao":"string"
                    },
                    "loja": {
                        "endereco": "string",
                        "idRetaguarda": "string",
                        "descricao": "string"
                    },

                    "produtoLote":
                    [
                         {
                             "idRetaguarda": "12345",
                             "quantidade": 50,
                             "identificacaoLote": "ABC10",
                             "dataValidade": "2025-10-28"
                         },
                         {
                             "idRetaguarda": "123456",
                             "quantidade": 50,
                             "identificacaoLote": "ABC11",
                             "dataValidade": "2025-10-28"                            
                         }
                    ],
                    "quantidade": 0.0
                }
            ],
            "idRetaguardaProduto": "string"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Campo

Tipo

Descrição

Observação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retorno
ErrorsLista de objetosLista de errosSomente é retornado na V3
TotalTimeIntTempo total da requisição
NumberOfRecordsIntNúmero de registros
{
    "success": false,
    "message": "string",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Método chamado na retaguarda pelo PDVSync.Server para consulta de estoque 

Este método é responsável pela consulta de quantidade de estoque disponível, por produto, na retaguarda.

Ao realizarmos uma consulta na API de ProcessoOnlineEstoqueSaldo, será possível verificar o saldo disponível em estoque do produto selecionado, inclusive por diferentes depositos, quando configurado.


  • Endpoint: Configurável no cadastro de Inquilinos no frontend, através do campo "EndpointEstoqueConsulta"
  • Método: POST
  • Autenticação: Definida pelo ERP Retaguarda, vide documentação do frontend
  • Permissão: Definido pelo ERP Retaguarda

Após o envio do POST, o microserviço se encarrega de transforma-lo em GET para comunicação com ERP Retaguarda e retornar os dados solicitados.


{
    "idRetaguardaLojaOrigem": "string",
    "idRetaguardaLojasConsultaEstoque": [
        "string"
    ],
    "idRetaguardaProduto": [
        "string"
    ],
    "idRetaguardaProdutoEmbalagem": "string"
}

ParametroTipoDescriçãoObrigatórioObservação
idRetaguardaProdutoLista de stringLista contendo os IDs retaguardas dos produtosSimn/c
idRetaguardaLojasConsultaEstoqueLista de stringLista contendo os IDs retaguardas das lojas para consultaSimn/c
idRetaguardaLojaOrigemstringIdentificador da loja de origem da buscaSimn/c
idRetaguardaProdutoEmbalagemstringIdentificador do produto embalagemSimn/c

Retorno - Lista de Objetos

Campo

Tipo

Descrição




estoqueLista de ObjetosLista de estoques
estoque.depositoLista de ObjetosLista de objetos de depósitos
estoque.deposito.idRetaguardaStringIdentificador de depósito na retaguarda
estoque.deposito.descricaoStringDescrição do depósito
estoque.deposito.quantidadeDecimalQuantidade de produto disponível por depósito
estoque.deposito.padraoBooleanDepósito padrão para venda
estoque.armazemObjetoObjeto armazem
estoque.armazem.idStringIdentificador do armazem
estoque.armazem.descricaoStringdescrição do armazem
estoque.lojaObjetoObjeto loja
estoque.loja.enderecoStringEndereço da loja
estoque.loja.idRetaguardaStringIdentificador da loja na retaguarda
estoque.loja.descricaoStringDescrição da loja
estoque.produtoLoteLista de ObjetosIdentificação de lotes do produto
estoque.produtoLote.idRetaguardaStringIdentificador do lote do produto na retaguarda
estoque.produtoLote.quantidadeNumericQuantidade de produtos disponível no lote.
estoque.produtoLote.identificacaoLoteStringCódigo ou identificação única do lote.
estoque.produtoLote.dataValidadeDateTime (formato ISO 8601)Data de validade do lote.
estoque.quantidadeDecimalQuantidade em estoque
idRetaguardaProdutoStringIdentificador do produto na retaguarda
[
    {
        "estoque": [
            {
                "armazem": {
                    "descricao": "string",
                    "id": "string"
                },
                "deposito": [
                    {
                        "descricao": "string",
                        "idRetaguarda": "string",
                        "padrao": false,
                        "quantidade": 0
                    }
                ],
                "loja": {
                    "descricao": "string",
                    "endereco": "string",
                    "idRetaguarda": "string"
                },
                "produtoLote": [
                    {
                        "dataValidade": "2025-10-28",
                        "identificacaoLote": "ABC10",
                        "idRetaguarda": "12345",
                        "quantidade": 50
                    },
                    {
                        "dataValidade": "2025-10-28",
                        "identificacaoLote": "ABC11",
                        "idRetaguarda": "123456",
                        "quantidade": 50
                    }
                ],
                "quantidade": 0.0
            }
        ],
        "idRetaguardaProduto": "string"
    }
]