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:
| Parametro | Descrição | Tipo | Obrigatório | Observação |
|---|---|---|---|---|
| inquilino | Identificador do inquilino | string | Sim | |
| idRetaguardaProduto | Identificador do produto na retaguarda | string | Sim | |
| idRetaguardaLojaOrigem | Identificador da loja de consultante do saldo | string | Sim | |
| idRetaguardaLojasConsultaEstoque | Identificador das lojas para consulta do estoque | string | Não |
Pode ser enviado mais de um valor separando-os por vírgula (,) |
| idRetaguardaProdutoEmbalagem | Identificador da embalagem | string | Não | Pode ser enviado mais de um valor separando-os por vírgula (,) |
Retornos
Campo |
Tipo |
Descrição |
|---|---|---|
| success | Booleano | Indica se a requisição retornou sucesso |
| message | String | Campo com as mensagens de erro |
| data | Lista de Objetos | Conteúdo de retorno |
| data.estoque | Lista de Objetos | Lista de estoques |
| data.estoque.deposito | Lista de Objetos | Lista de objetos de depósitos |
| data.estoque.deposito.idRetaguarda | String | Identificador de depósito na retaguarda |
| data.estoque.deposito.descricao | String | Descrição do depósito |
| data.estoque.deposito.quantidade | Decimal | Quantidade de produto disponível por depósito |
| data.estoque.deposito.padrao | Boolean | Depósito padrão para venda |
| data.estoque.armazem | Objeto | Objeto armazem |
| data.estoque.armazem.id | String | Identificador do armazem |
| data.estoque.armazem.descricao | String | descrição do armazem |
| data.estoque.loja | Objeto | Objeto loja |
| data.estoque.loja.endereco | String | Endereço da loja |
| data.estoque.loja.idRetaguarda | String | Identificador da loja na retaguarda |
| data.estoque.loja.descricao | String | Descrição da loja |
| data.estoque.produtoLote | Lista de Objetos | Identificação de lotes do produto |
| data.estoque.produtoLote.idRetaguarda | String | Identificador do lote do produto na retaguarda |
| data.estoque.produtoLote.quantidade | Numeric | Quantidade de produtos disponível no lote. |
| data.estoque.produtoLote.identificacaoLote | String | Código ou identificação única do lote. |
| data.estoque.produtoLote.dataValidade | DateTime (formato ISO 8601) | Data de validade do lote. |
| data.estoque.quantidade | Decimal | Quantidade em estoque |
| data.idRetaguardaProduto | String | Identificador do produto na retaguarda |
| errors | Nulo | Lista com erros |
| totalTime | Inteiro | Tempo de requisição |
| numberOfRecords | Inteiro | Número de linhas retornadas |
Json de Retorno
{
"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 |
|---|---|---|---|
| Success | bool | Indica se a requisição foi feita com sucesso | |
| Message | string | Mensagem de retorno de erros | |
| Data | Objeto | Objeto de retorno | |
| Errors | Lista de objetos | Lista de erros | Somente é retornado na V3 |
| TotalTime | Int | Tempo total da requisição | |
| NumberOfRecords | Int | Número de registros |
Json de Retorno
{
"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"
}
| Parametro | Tipo | Descrição | Obrigatório | Observação |
|---|---|---|---|---|
| idRetaguardaProduto | Lista de string | Lista contendo os IDs retaguardas dos produtos | Sim | n/c |
| idRetaguardaLojasConsultaEstoque | Lista de string | Lista contendo os IDs retaguardas das lojas para consulta | Sim | n/c |
| idRetaguardaLojaOrigem | string | Identificador da loja de origem da busca | Sim | n/c |
| idRetaguardaProdutoEmbalagem | string | Identificador do produto embalagem | Sim | n/c |
Retorno - Lista de Objetos
Campo |
Tipo |
Descrição |
|---|---|---|
| estoque | Lista de Objetos | Lista de estoques |
| estoque.deposito | Lista de Objetos | Lista de objetos de depósitos |
| estoque.deposito.idRetaguarda | String | Identificador de depósito na retaguarda |
| estoque.deposito.descricao | String | Descrição do depósito |
| estoque.deposito.quantidade | Decimal | Quantidade de produto disponível por depósito |
| estoque.deposito.padrao | Boolean | Depósito padrão para venda |
| estoque.armazem | Objeto | Objeto armazem |
| estoque.armazem.id | String | Identificador do armazem |
| estoque.armazem.descricao | String | descrição do armazem |
| estoque.loja | Objeto | Objeto loja |
| estoque.loja.endereco | String | Endereço da loja |
| estoque.loja.idRetaguarda | String | Identificador da loja na retaguarda |
| estoque.loja.descricao | String | Descrição da loja |
| estoque.produtoLote | Lista de Objetos | Identificação de lotes do produto |
| estoque.produtoLote.idRetaguarda | String | Identificador do lote do produto na retaguarda |
| estoque.produtoLote.quantidade | Numeric | Quantidade de produtos disponível no lote. |
| estoque.produtoLote.identificacaoLote | String | Código ou identificação única do lote. |
| estoque.produtoLote.dataValidade | DateTime (formato ISO 8601) | Data de validade do lote. |
| estoque.quantidade | Decimal | Quantidade em estoque |
| idRetaguardaProduto | String | Identificador do produto na retaguarda |
Json de Retorno
[
{
"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"
}
]
Visão Geral
Import HTML Content
Conteúdo das Ferramentas