Histórico da Página

...

Método para alteração das promoções personalizadas.

Chamada

PUT [URLAPI]/PromocaoPersonalizadaAPI/api/v1/PromocaoPersonalizadaParceiro/{seqPromocPersonalizada}

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

Parâmetros URI (URI Parameters)

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 de Promoções Personalizadas Parceiros

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)
seqPromocPersonalizada*
Código de 
Nome (Name)
Descrição (Description)
Tipo (Type)
Informações Adicionais (Adittional Information)
seqPromocPersonalizada*
Código de Promoção Personalizada
integer($int32)
Obrigatório.
...
number($double)number($double

Nome (Name)
Descrição (Description)
Tipo (Type)
Informações Adicionais (Adittional Information)

status
Usado para alterar a situação da Promoção. A = Ativa ou I = Inativa. Opcional: Padrão A.
string
Não há.

textoLegal
Texto descritivo baseado em leis, quando se trata de uma promoção que necessita ser regulamentada e autorizada por entidade competente
string
Não há.

dtaInicial
Data inicial da promoção
string($date-time)
Não há.

dtaFinal
Data final da promoção
string($date-time)
Não há.

indTipoPromocao
Indica o tipo de mecânica da promoção. Tipos Possíveis: 1 = Redução de Preço, 2 = Valor de Desconto, 3 = Percentual de Desconto e 4 = Compre e Ganhe.= Percentual de Desconto e 4 = Compre e Ganhe.
string
Não há.

indExigeIdenficacaoCliente
Indica se exige a identificação do cliente no PDV
string
Não há.

indExigeRegistroCompleto
Indica se exige o registro completo do cliente, na plataforma de dados do parceiro de negócios (CRM)
string
Não há.

indExigeIdenficacaoClienteindExigeAtivacaoOferta
Indica se exige a identificação do cliente no PDVativação da oferta em aplicativo ou website
string
Não há.
indExigeRegistroCompleto
Indica se exige o registro completo do cliente, na plataforma de dados do parceiro de negócios (CRM)

qtdTotalAlocada
Quantidade total definida como limite para aplicação da promoção
integer($int32)
Não há.

qtdLimiteCliente
Quantidade limite de aplicação da promoção por cliente
integer($int32)string
Não há.
indExigeAtivacaoOferta
Indica se exige a ativação da oferta em aplicativo ou website

vlrTicketMedioMinimo
Valor médio mínimo de compras do cliente, para que se tenha direito a receber a promoção
number($double)string
Não há.

vlrTicketMedioMaximo
Valor médio máximo de compras do cliente, para que se tenha direito a receber a promoção
number($double
qtdTotalAlocada
Quantidade total definida como limite para aplicação da promoção
integer($int32)
Não há.
qtdLimiteCliente
Quantidade limite de aplicação da promoção por cliente

vlrMinimoCompra
Valor mínimo da compra para se tenha direito ao desconto. Só há informação quando o tipo da promoção é 4 (Compre e Ganhe).
number($doubleinteger($int32)
Não há.

vlrTicketMedioMinimovlrDesconto
Valor médio mínimo de compras do cliente, para que se tenha direito a receber a promoção
number($double)
Não há.
vlrTicketMedioMaximo
Valor médio máximo de compras do cliente, para que se tenha direito a receber a promoçãode desconto a ser concedido quando o valor da compra é maior ou igual ao valor mínimo de compra. Só há informação quando o tipo da promoção é 4 (Compre e Ganhe).
number($double)
Não há.
vlrMinimoCompra
Valor mínimo da compra para se tenha direito ao desconto. Só há informação quando o tipo da promoção é 4 (Compre e Ganhe).

 indControleVerbaPdv
 Indica se a regra de incentivo faz o controle de verba nas vendas por PDV, para posterior apuração e geração de acordo promocional com fornecedores. 
String
Não há.

seqPessoaResp
 Indica o código do fornecedor em que será gerado o título financeiro, referente ao acordo promocional, da verba apurada.
integer($int32
vlrDesconto
Valor de desconto a ser concedido quando o valor da compra é maior ou igual ao valor mínimo de compra. Só há informação quando o tipo da promoção é 4 (Compre e Ganhe).
)
Não há.



empresas
AtualizarPromocaoPersonalizada
EmpresaParceiroDto
Lista das Empresas participantes da promoção

Não há.
nroEmpresa
Número de cadastro da empresa no ERP que está vinculada a promoção. Opcional. Obrigatório quando não informado CNPJ da empresa.
integer($int32)
Não há.
cnpj
CNPJ da empresa que está vinculada a promoção. Opcional. Obrigatório quando não informado número da empresa. Se enviar número e CNPJ, prevalece o número.

string
Não há.
status
Usado para alterar a situação da empresa na promoção. A = Ativa ou I = Inativa. Obrigatório quando se informa uma empresa (Número ou CNPJ).
string
Não há.
expandables
Campo para expandir as propriedades.
string
Não há.









produtos










AtualizarPromocaoPersonalizada
ProdutoParceiroDto
Lista de Produtos na promoção

Opcional. Quando se informa um produto que já existe na promoção, o mesmo será atualizado. Quando se informa um produto que ainda não está na promoção, o mesmo será incluído
seqProduto
Código sequencial do produto no ERP
integer($int32)
Não há.
codAcesso
Código de barras EAN ou DUN do produto.
string
Não há.
status
   Status do Produto
string
Não há.
qtdEmbalagem
Embalagem do produto para promoção
number($double)
Não há.
vlrPrecoPromocional
Valor do preço de promoção do produto. Só há informação quando o tipo da promoção é 1 (Redução de Preço)
number($double)
Não há.
vlrDesconto
Valor do desconto para o produto. Só há informação quando o tipo da promoção é 2 (Valor de Desconto)
number($double)
Não há.
percDesconto
Percentual do desconto para o produto. Só há informação quando o tipo da promoção é 3 (Percentual de Desconto)
number($double)
Não há.
qtdTotalAlocada
Quantidade limite total específica do produto, para aplicação da promoção, em unidades
integer($int32)
Não há.
qtdLimiteCliente
Quantidade limite específica do produto, para aplicação da promoção, por cliente, em unidades
integer($int32)
Não há.
expandables
Propriedade para expansão dos campos
string

 Bloco de código
language
actionscript3
{
  "status": "string",
  "descricao": "string",
  "textoLegal": "string",
  "dtaInicial": "20202021-1107-25T1814T16:4044:5917.022Z332Z",
  "dtaFinal": "20202021-1107-25T1814T16:4044:5917.022Z332Z",
  "indExigeIdenficacaoCliente": "string",
  "indExigeRegistroCompleto": "string",
  "indExigeAtivacaoOferta": "string",
  "qtdTotalAlocada": 0,
  "qtdLimiteCliente": 0,
  "vlrTicketMedioMinimo": 0,
  "vlrTicketMedioMaximo": 0,
  "vlrMinimoCompra": 0,
  "vlrDesconto": 0,
"seqPessoaResp": 0,
"indControleVerbaPdv": "string",
"empresas": [
    {
      "nroEmpresa": 0,
      "cnpj": "string",
      "status": "string",
      "expandables": [
        "string"
      ]
    }
  ],
  "produtos": [
    {
      "seqProduto": 0,
      "codAcesso": "string",
      "status": "string",
      "qtdEmbalagem": 0,
      "vlrPrecoPromocional": 0,
      "vlrDesconto": 0,
      "percDesconto": 0,
      "qtdTotalAlocada": 0,
      "qtdLimiteCliente": 0,
      "expandables": [
        "string"
      
]
    }
  ],
  "expandables": [
    "string"
  ]
}

Informações para Resposta (Response Information)
...
 Bloco de código
language
actionscript3
{
  "seqPromocPersonalizada": 0,
  "descricao": "string",
  "textoLegal": "string",
  "dtaInicial": "20202021-1107-25T1814T16:4044:5917.061Z335Z",
  "dtaFinal": "20202021-1107-25T1814T16:4044:5917.061Z335Z",
  "indTipoPromocao": "string",
  "indExigeIdenficacaoCliente": "string",
  "indExigeRegistroCompleto": "string",
  "indExigeAtivacaoOferta": "string",
  "qtdTotalAlocada": 0,
  "status": "string",
  "qtdLimiteCliente": 0,
  "vlrTicketMedioMinimo": 0,
  "vlrTicketMedioMaximo": 0,
  "vlrMinimoCompra": 0,
  "vlrDesconto": 0,
  "dtaHorInclusao"dtaHorInclusao": "2021-07-14T16:44:17.335Z",
"dtaHorAlteracao": "20202021-1107-25T1814T16:4044:59.061Z",
  "dtaHorAlteracao17.335Z",
"seqPessoaResp": 0,
"indControleVerbaPdv": "2020-11-25T18:40:59.062Zstring",
  "empresas": [
    {
      "seqPromocPersonalizada": 0,
      "nroEmpresa": 0,
      "cnpj": "string",
      "status": "string",
      
"dtaHorInclusao": "20202021-1107-25T1814T16:4044:5917.062Z335Z",
      "dtaHorAlteracao": "20202021-1107-25T1814T16:4044:5917.062Z335Z"
    }
  ],
  "produtos": [
    {
      "seqPromocPersonalizada": 0,
      "seqProduto": 0,
      "descCompleta": "string",
"codAcesso": "string",
      "qtdEmbalagem": 0,
      "status": "string",
      "nroSegmento": 0,
      "vlrPrecoAtual": 0,
      "vlrPrecoPromocional": 0,
      "vlrDesconto": 0,
      "percDesconto": 0,
      "qtdTotalAlocada": 0,
      "qtdLimiteCliente": 0,
      "dtaHorInclusao": "20202021-1107-25T1814T16:4044:5917.062Z335Z",
      "dtaHorAlteracao": "20202021-1107-25T1814T16:4044:5917.062Z335Z"
    }
  ]
}
application/json, text/json
...
 Bloco de código
language
actionscript3
{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}