Árvore de páginas

Objetivo

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

Chamada

PUT [URLAPI]/PromocaoPersonalizadaAPI/api/v1/PromocaoPersonalizadaParceiro

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


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 Promoção Personalizada

integer($int32)

Obrigatório.

Parâmetros do Corpo (Body Parameters)

AtualizarPromocaoPersonalizadaParceiroDto


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.

stringNão há.

textoLegalTexto descritivo baseado em leis, quando se trata de uma promoção que necessita ser regulamentada e autorizada por entidade competentestringNã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á.

indTipoPromocaoIndica 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.stringNão há.

indExigeIdenficacaoCliente

Indica se exige a identificação do cliente no PDV

stringNão há.

indExigeRegistroCompleto

Indica se exige o registro completo do cliente, na plataforma de dados do parceiro de negócios (CRM)

stringNão há.

indExigeAtivacaoOferta

Indica se exige a ativação da oferta em aplicativo ou website

stringNão há.

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)Não há.

vlrTicketMedioMinimo

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ção

number($double)Não há.

vlrMinimoCompraValor 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($double)Não há.

vlrDescontoValor 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).number($double)Não há.

 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. StringNã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)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á.
cnpjCNPJ 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.


stringNã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).

stringNão há.
expandablesCampo para expandir as propriedades.stringNã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.

stringNão há.
status   Status do ProdutostringNão há.
qtdEmbalagem

Embalagem do produto para promoção

number($double)Não há.
vlrPrecoPromocionalValor 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á.
vlrDescontoValor do desconto para o produto. Só há informação quando o tipo da promoção é 2 (Valor de Desconto)number($double)Não há.
percDescontoPercentual do desconto para o produto. Só há informação quando o tipo da promoção é 3 (Percentual de Desconto)number($double)Não há.
qtdTotalAlocadaQuantidade limite total específica do produto, para aplicação da promoção, em unidadesinteger($int32)Não há.
qtdLimiteClienteQuantidade limite específica do produto, para aplicação da promoção, por cliente, em unidadesinteger($int32)Não há.
expandablesPropriedade para expansão dos camposstring
{
"status": "string",
"descricao": "string",
"textoLegal": "string",
"dtaInicial": "2021-07-14T16:44:17.332Z",
"dtaFinal": "2021-07-14T16:44:17.332Z",
"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)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

PromocaoPersonalizadaParceiroDto


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

seqPromocPersonalizada

Número do código da promoção

integer($int32)Não há.

descricao

Descrição da promoção

stringNão há.

textoLegalTexto descritivo baseado em leis, quando se trata de uma promoção que necessita ser regulamentada e autorizada por entidade competentestringNã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á.

indTipoPromocaoIndica 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.stringNão há.

indExigeIdenficacaoCliente

Indica se exige a identificação do cliente no PDV

stringNão há.

indExigeRegistroCompleto

Indica se exige o registro completo do cliente, na plataforma de dados do parceiro de negócios (CRM)

stringNão há.

indExigeAtivacaoOferta

Indica se exige a ativação da oferta em aplicativo ou website

stringNão há.

qtdTotalAlocada

Quantidade total definida como limite para aplicação da promoção

integer($int32)Não há.

status

Situação da Promoção. A = Ativa ou I = Inativa.

stringNão há.

qtdLimiteCliente

Quantidade limite de aplicação da promoção por cliente

integer($int32)Não há.

vlrTicketMedioMinimo

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ção

number($double)Não há.

vlrMinimoCompraValor 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($double)Não há.

vlrDescontoValor 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).number($double)Não há.

dtaHorInclusao

Data e hora em que a promoção foi incluída no ERP

string($date-time)Não há.

dtaHorAlteracao

Data e hora em que a promoção foi alterada no ERP

string($date-time)Não há.






empresas

PromocaoPersonalizadaEmpresaParceiroDtoLista das Empresas participantes da promoção
Não há.
seqPromocPersonalizada

Número do código da promoção

integer($int32)Não há.
nroEmpresa

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

integer($int32)Não há.
cnpj

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

stringNão há.
status

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

stringNão há.
dtaHorInclusao

Data e hora em que a empresa foi incluída na promoção

string($date-time)Não há.
dtaHorAlteracao  Data e hora em que houve alteração da empresa na promoçãostring($date-time)Não há.









produtos

PromocaoPersonalizadaProdutoParceiroDto

Lista de Produtos incluídos na promoção


Não há.
seqPromocPersonalizada

Número do código da promoção

integer($int32)Não há.
seqProduto

Código sequencial do produto no ERP

integer($int32)Não há.
codAcesso

Código de barras EAN ou DUN do produto.

stringNão há.
qtdEmbalagem

Embalagem do produto para promoção

number($double)Não há.
status   Status do ProdutostringNão há.
nroSegmento

Número do segmento de venda que se aplica a promoção

integer($int32)Não há.
vlrPrecoAtual   Maior preço válido atual do produto, entre as empresas vinculadas a promoção, no         segmento de aplicação da promoçãonumber($double)Não há.
vlrPrecoPromocionalValor 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á.
vlrDescontoValor do desconto para o produto. Só há informação quando o tipo da promoção é 2 (Valor de Desconto)number($double)Não há.
percDescontoPercentual do desconto para o produto. Só há informação quando o tipo da promoção é 3 (Percentual de Desconto)number($double)Não há.
qtdTotalAlocadaQuantidade limite total específica do produto, para aplicação da promoção, em unidadesinteger($int32)Não há.
qtdLimiteClienteQuantidade limite específica do produto, para aplicação da promoção, por cliente, em unidadesinteger($int32)Não há.
dtaHorInclusao

Data e hora em que o produto foi incluído na promoção

string($date-time)Não há.
dtaHorAlteracao

Data e hora em que houve alteração do produto na promoção

string($date-time)Não há.
{
"seqPromocPersonalizada": 0,
"descricao": "string",
"textoLegal": "string",
"dtaInicial": "2021-07-14T16:44:17.335Z",
"dtaFinal": "2021-07-14T16:44:17.335Z",
"indTipoPromocao": "string",
"indExigeIdenficacaoCliente": "string",
"indExigeRegistroCompleto": "string",
"indExigeAtivacaoOferta": "string",
"qtdTotalAlocada": 0,
"status": "string",
"qtdLimiteCliente": 0,
"vlrTicketMedioMinimo": 0,
"vlrTicketMedioMaximo": 0,
"vlrMinimoCompra": 0,
"vlrDesconto": 0,
"dtaHorInclusao": "2021-07-14T16:44:17.335Z",
"dtaHorAlteracao": "2021-07-14T16:44:17.335Z",
"seqPessoaResp": 0,
"indControleVerbaPdv": "string",
"empresas": [
{
"seqPromocPersonalizada": 0,
"nroEmpresa": 0,
"cnpj": "string",
"status": "string",
"dtaHorInclusao": "2021-07-14T16:44:17.335Z",
"dtaHorAlteracao": "2021-07-14T16:44:17.335Z"
}
],
"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": "2021-07-14T16:44:17.335Z",
"dtaHorAlteracao": "2021-07-14T16:44:17.335Z"
}
]
}

application/json, text/json

CODE 400 - BAD

{
"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
}
]
}