Histórico da Página

Objetivo

Método para alterar promoções.

Chamada

PUT [URLAPI]/PromocaoAPI/api/v1/Promocao/{seqPromocao}

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

Image Added

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)
seqPromocao seqPromocao	Sequencial da Promoção	integer($int32)	Obrigatório

Parâmetros do Corpo (Body Parameters)

AtualizarPromocaoDto

Informações para alteração
	Nome	Descrição	Tipo(Type)	Exigência

Código da Promoção

Número do código

descricao

Descrição da promoção

que deseja ser alterada

string

Obrigatório

Descrição

Descrição da promoção

Obrigatório

Data Início da Promoção

dtaInicio

Data inicial da promoção

string($date-time)

Obrigatório

Data Fim da Promoção

dtaFim

Data final da promoção

string($date-time)

Obrigatório

Faixa de Acréscimo Financeiro

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.

Código do Grupo de Promoção

seqGrupoPromoc

Indica o grupo que a promoção pertence

integer($int32)

Opcional

Indicador se Usa Acréscimo de Tabela de venda

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

Tipo de Média de Venda

tipoMediaVda

Indica o tipo cálculo de média de venda em que deve se enquadrar as vendas dos produtos da promoção. P = Promoção / N = Normal.

string

Opcional. Valor padrão = P.

Inativa Promoção sem Saldo deAcordo

empresas (AtualizarEmpresaDto)

nroEmpresa

Indica se inativa a promoção quando não houver saldo do conta corrente de acordo promocional vinculado.

Opcional

Lista das Empresas participantes da promoção

(Obrigatória)

Número Empresa

Número de cadastro da empresa no ERP que está vinculada a promoção

integer($int32)

Opcional. Obrigatório quando não informado CNPJ da empresa.

CNPJ

cnpjEmpresa

CNPJ da empresa que está vinculada a promoção

string

Opcional. Obrigatório quando não informado número da empresa. Se enviar número e CNPJ, prevalece o número.

Status

status

Situação da empresa na promoção. A = Ativa, I = Inativa.

string

Opcional. Valor padrão = A.

Lista dos Segmentos de Venda da Promoção

(Obrigatória)

Segmento de Venda

segmentos (AtualizarSegmentoDto)

nroSegmento

Números dos segmentos de venda, que se aplicam a promoção

integer($int32)

Obrigatório no mínimo 1.

Status

status

Situação do segmento de venda na promoção. A = Ativa, I = Inativa.

string

Opcional. Valor padrão = A.

Lista de Produtos incluídos napromoção

(Obrigatória)

Código Sequencial do Produto

produtos (AtualizarPromocaoItemDto)

seqProduto

Código sequencial do produto no ERP

integer($int32)

Opcional. Obrigatório quando não informado código de barras.

Código de Barras do Produto

codAcesso

Código de barras EAN ou DUN do produto. Será considerada a embalagem em que o código informado está cadastrado.

string

Opcional. Obrigatório quando não informado o código sequencial do produto. Se enviar os dois códigos, prevalece o sequencial.

Status

status

Situação do produto na promoção. A = Ativa, I = Inativa.

string

Opcional. Valor padrão = A.

Embalagem de Venda

qtdEmbalagem

Embalagem do produto para promoção

number($double)

Obrigatório quando não informado o código de barras do produto.

Preço Promocional

precoPromocional

Valor do preço de promoção do produto

number($double)

Obrigatório

_

expandables

Propriedade

para

de expandir os

componentes

campos.

string

Obrigatório

Não há.

Bloco de código

language	actionscript3

{
  "seqPromocao": 0,
  "descricao": "string",
  "dtaInicio": "2020-12-31T1331T14:3440:0238.128Z142Z",
  "dtaFim": "2020-12-31T1331T14:3440:0238.128Z142Z",
  "faixaAcrFinanceiro": "string",
  "seqGrupoPromoc": 0,
  "indUsaAcrescTabVenda": "string",
  "tipoMediaVda": "string",
  "inativaPromocaoCCAcordempresas": "string",[
  "dtaHoraInclusao": "2020-12-31T13:34:02.128Z",  {
  "dtaHoraAlteracao": "2020-12-31T13:34:02.128Z",
  "empresasnroEmpresa": [
    {
  0,
    "nroEmpresacnpjEmpresa": 0"string",
      "cnpjEmpresastatus": "string"
    }
  ],
  "segmentos": [
    {
      "nroSegmento": 0,
      "descSegmentostatus": "string"
    }
  ],
  "produtos": [
    {
      "seqPromocao": 0,
      "seqProduto": 0,
      "codAcesso": "string",
      "qtdEmbalagem": 0,
      "status": "string",
      "precoPromocional": 0,
      "dtaHoraInclusaostatus": "2020-12-31T13:34:02.128Z",
      "dtaHoraAlteracao": "2020-12-31T13:34:02.128Z",
      "empresas": [
        {
          "nroEmpresa": 0string"
        }
      ],
      "segmentos": [
        {
          "nroSegmento": 0
        }
      ]
    }
  ],
  "_expandables": [
    "string"
  ]
}

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 201 - SUCCESS

ErrorResponse

...

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave

Objetivo

Chamada

Permissionamento

Assuntos Relacionados

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Códigos do Recurso (Response Codes)

Formatos de Resposta (Response Formats)

application/json, text/json