Histórico da Página
...
Método de consulta de promoções do tipo normal no ERP.
Chamada
GET [URLAPI]/PromocaoAPI/api/v1/Promocao
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 Promoções > API Promoções Normais do ERP
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)
...
| Nome | Descrição | Tipo (Type) | Exigência | Informações Adicionais (Adittional Information) |
|---|---|---|---|---|
| CnpjEmpresa | CNPJ da empresa utilizada como filtro de informações das promoções | string | Opcional | Não há |
| NroEmpresa | Número de Empresa para filtrar as promoções | integer($int32) | Opcional | Não há |
| NroSegmento | Número do segmento de venda para filtrar as promoções | integer($int32) | Opcional | Não há |
| Status | A = ativo (somente produtos ativos), I = inativo (somente produtos inativos), T = todos (produtos ativos e inativos). Status padrão: A. | string | Opcional | Não há |
| Vigente | Somente Promoções em vigor no momento | string | Opcional | Não há |
| SeqPromocao | Filtro de promoção normal específica | integer($int32) | Opcional | Não há |
DtaHoraAlteracao | Filtro para buscar promoções alteradas a partir de uma data (item / cabeçalho) | string($date-time) | Opcional | Não há |
| DataInicio | Filtro para buscar promoções que tem início a partir de uma data | string($date-time) | Opcional | Não há |
| Fields | Campos | string | Não há | Valores aceitáveis: seqPromocao, descricao, dtaInicio, dtaFim, faixaAcrFinanceiro, seqGrupoPromoc, indUsaAcrescTabVenda, tipoMediaVda, inativaPromocaoCCAcord, dtaHoraInclusao, dtaHoraAlteracao |
| Order | Ordenação dos Campos | string | Não há | Valores aceitáveis: seqPromocao, descricao, dtaInicio, dtaFim, faixaAcrFinanceiro, seqGrupoPromoc, indUsaAcrescTabVenda, tipoMediaVda, inativaPromocaoCCAcord, dtaHoraInclusao, dtaHoraAlteracao |
| Page | Número da Página | integer($int32) | Não há | Não há |
| PageSize | Tamanho da Página | integer($int32) | Não há | Não há |
Parâmetros do Corpo (Body Parameters)
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas