Objetivo
A finalidade deste método é possibilitar a consulta de descrições especiais dos produtos.
Chamada
GET [URLAPI]/SMProdutosAPI/api/v4/produtos/locais-produtos
Permissionamento
Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.
Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Produtos > API Produtos
Imagem 01 - Configurações de Sistemas/Módulos/Aplicações
Assuntos Relacionados
Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.
Informações para Requisição (Request Information)
Parâmetros URI (URI Parameters)
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| modelo.nroEmpresa | Parâmetro para filtrar o número da empresa. | Integer | Obrigatório, caso o CNPJ seja nulo |
| modelo.CNPJEmpresa | CNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000 | string | Obrigatório, caso o NroEmpresa seja nulo |
| modelo.statusVenda | Filtro de retorno dos produtos: A = ativo (devolve apenas produtos ativos para venda), I = inativo (devolve apenas produtos inativos para venda), S = suspenso (devolve apenas produtos suspensos para venda), T = todos (Retorna todos os produtos). Padrão: A. | string | Não há |
| modelo.idFamilia | Código sequencial do cadastro de família do produto | Integer | Não há |
| modelo.Local | Código do Local de Estoque | Integer | Não há. |
| modelo.idProduto | Código sequencial do cadastro do produto | Integer | Não há |
| modelo.CodigoAcesso | Código de acesso do produto | Integer | Não há |
| modelo._pageNo | |||
| modelo._pageSize | Integer | Não há |
Parâmetros do Corpo (Body Parameters)
Não há.
Informações para Resposta (Response Information)
Descrição do Recurso (Resource Description)
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| Local | Local onde o produto está | Array of objects (DescricoesEspeciaisRespostaDTO) | Não há |
| NroEmpresa | Número da empresa | String | Não há |
| Estoque | Quantidade de estoque onde o produto está | Integer | Não há |
| Rua | Rua | Integer | Não há |
| Predio | Predio | Integer | Não há |
| Apartamento | Apartamento | String | Não há |
| Sala | Sala | String | Não há |
| Frente | Frente | Integer | Não há |
| StatusVenda | Status de venda do produto | String | Não há |
| Lado | Lado | Integer | Não há |
| Base | Base | Integer | Não há |
| CodigoAcessoPrincipal | Código de acesso principal | String | Não há |
| IdProduto | Identificador único do produto | Integer | Não há |
| IdFamilia | Identificador único da família | Integer | Não há |
| IdProdutoBase | Identificador do produto base | Integer | Não há |
| DataUltimaAtualizacao | Data da ultima atualização | String | Não há |
Formatos de Resposta (Response Formats)
application/json, text/json
Exemplo (Sample):
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas