Informações |
---|
Este método é responsável pela consulta de estoque |
...
- Endpoint: /api/retaguarda/v2/ProcessoOnlineEstoqueSaldo/{idInquilino}/{idProdutoRetaguarda}/{idLojaOrigemRetaguarda}/{idLojasConsultaEstoqueRetaguarda}/{idProdutoEmbalagemRetaguarda}
- 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 | Observação | Obrigatório |
---|
inquilino | Identificador do inquilino | string |
S
| Sim |
idProdutoRetaguarda | Identificador do produto na retaguarda | string |
S
| Sim |
idLojaOrigemRetaguarda | Identificador da loja de consultante do saldo | string |
S
| Sim |
idLojasConsultaEstoqueRetaguarda | Identificador das lojas para consulta do estoque | string | Pode ser passar mais de um valor separando-os por vírgula (,) |
NNão |
idProdutoEmbalagemRetaguarda | Identificador da embalagem | string | Pode ser passar mais de um valor separando-os por vírgula (,) |
NRetornos
Deck of Cards |
---|
id | ProcessoOnlineEstoqueSaldoDC |
---|
|
Card |
---|
| 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.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.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 |
{ "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 |
---|
| 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 |
|
{ "success": false, "message": "string", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
|
...