Objetivo
A finalidade deste método é possibilitar a consulta de descrições especiais dos produtos.
Chamada
GET [URLAPI]/SMProdutosAPI/api/v4/produtos/descricoes-especiais
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.idFamilia | Código sequencial do cadastro de família do produto | Integer | Não há |
| modelo.idProduto | Código sequencial do cadastro do produto | Integer | Não há |
| modelo.statusVenda | Status da Venda | String | Não há |
| tipoDescricaoEspecial | Tipo da descrição especial | String | Não há |
| codigoDescricaoEspecial | Código descrição especial | String | Não há |
| modelo._pageNo | Integer | Não há | |
| 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) |
| DescricoesEspeciais | Descrições especiais do Produto | Array of objects (DescricoesEspeciaisRespostaDTO) | Não há |
| CodigoAcessoPrincipal | Código de acesso principal | String | Não há |
| IdProduto | Código sequencial do cadastro do produto | Integer | Não há |
| IdFamilia | Código sequencial do cadastro da família do produto | Integer | Não há |
| IdProdutoBase | Código sequencial do cadastro 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