Árvore de páginas

Versões comparadas

Chave

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

Para acessar os dados a requisição é a seguinte

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

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

ParametroDescriçãoTipoObservação
inquilinoIdentificador do inquilinostringObrigatório
idProdutoRetaguardaIdentificador do produto na retaguardastringObrigatório
idLojaOrigemRetaguardaIdentificador da loja de consultante do saldostringObrigatório
idLojasConsultaEstoqueRetaguardaIdentificador das lojas para consulta do estoquestring

Opcional

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

idProdutoEmbalagemRetaguardaIdentificador da embalagemstringPode ser passar mais de um valor separando-os por vírgula (,)



Expandir
titleretornos
Expandir
title200 OK
Expandir
titleRetorno da requisição

{
    "success": true,
    "message": "",
    "data": [
        {
            "estoque": [
                {
                    "armazem": {
                        "id":"string",
                        "descricao":"string"
                    },
                    "loja": {
                        "endereco": "string",
                        "idRetaguarda": "string",
                        "descricao": "string"
                    },
                    "quantidade": 0.0
                }
            ],
            "idRetaguardaProduto": "string"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Expandir
titleDefinição dos campos de retorno

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.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.quantidadeDecimalQuantidade em estoque
data.idRetaguardaProdutoStringIdentificador do produto na retaguarda
errorsNuloLista com erros
totalTimeInteiroTempo de requisição
numberOfRecordsInteiroNúmero de linhas retornadas