Árvore de páginas

Versões comparadas

Chave

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

...

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

ParametroDescriçãoTipoObservaçãoObrigatório
inquilinoIdentificador do inquilinostring
Sim
idProdutoRetaguardaIdentificador do produto na retaguardastring
Sim
idLojaOrigemRetaguardaIdentificador da loja de consultante do saldostring
Sim
idLojasConsultaEstoqueRetaguardaIdentificador das lojas para consulta do estoquestring

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

Não

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

Retornos

Deck of Cards
idProcessoOnlineEstoqueSaldoDC
Card
label200 - OK

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


{
    "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
}

Card
label400 - Bad Request

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
}

...