Histórico da Página
Objetivo
Método para incluir promoções.
Chamada
POST [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)
Parâmetros URI (URI Parameters)
Não há.
Parâmetros do Corpo (Body Parameters)
AdicionarPromocaoDto
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) | |
| descricao | Descrição da promoção | string | Obrigatório | |
| dtaInicio | Data inicial da promoção | string($date-time) | Obrigatório | |
| dtaFim | Data final da promoção | string($date-time) | Obrigatório | |
| faixaAcrFinanceiro | Indica a faixa de acréscimo para cálculo do preço de tabela, na venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão | string | Opcional. Valor padrão = A. | |
| seqGrupoPromoc | Indica o código e descrição do grupo que a promoção pertence | integer($int32) | Opcional | |
| indUsaAcrescTabVenda | Indica se aplica acréscimo de tabela de venda, ao calcular o preço de venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão | string | Opcional | |
| tipoMediaVda | Indica o tipo cálculo de média de venda em que deve se enquadraras vendas dos produtos da promoção. P = Promoção / N = Normal | string | Opcional. Valor padrão = P. | |
empresas | AdicionarEmpresaDto | Lista de Empresas da Promoção | ||
| nroEmpresa | Número da empresa participante da promoção | integer($int32) | Opcional. Obrigatório quando não informado CNPJ da empresa. | |
| cnpjEmpresa | CNPJ da empresa participante da promoção | string | Opcional. Obrigatório quando não informado número da empresa. Se enviar número e CNPJ, prevalece o número. | |
segmentos | SegmentoPromocaoItemDto | Lista de Segmentos de Venda da Promoção | ||
| nroSegmento | Número do Segmento de Venda | integer($int32) | Obrigatório no mínimo 1. | |
produtos | AdicionarPromocaoItemDto | Lista de Produtos incluídos na promoção | ||
| seqProduto | Código sequencial do produto no ERP | integer($int32) | Opcional. Obrigatório quando não informado código de barras. | |
| codAcesso | Código de barras do produto (GTIN) de acordo com a embalagem da promoção. Quando existir mais de um código cadastrado, retorna o maior | string | Opcional. Obrigatório quando não informado o código sequencial do produto. Se enviar os dois códigos, prevalece o sequencial. | |
| qtdEmbalagem | Embalagem do produto para promoção | number($double) | Obrigatório quando não informado o código de barras do produto. | |
| precoPromocional | Valor do preço de promoção do produto | number($double) | Obrigatório | |
| _expandables | Propriedade para expandir os componentes. | |||
...
Informações para Resposta (Response Information)
Códigos do Recurso (Response Codes)
- OK (201)
- BadRequest (400)
Formatos de Resposta (Response Formats)
application/json, text/json
CODE 201 - SUCCESS
PromocaoDto
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas