Histórico da Página

...

Método para incluir promoções personalizadas.

Chamada

POST /api/v1/PromocaoPersonalizadaParceiro[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

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)

...

number($doublenumber($double)

	Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
	descricao	Descrição da promoção	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.	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á.
	indExigeAtivacaoOferta	Indica se exige a ativação da oferta em aplicativo ou website	string	Nã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.	string	Não há.
	qtdLimiteCliente	Quantidade limite de aplicação da promoção por clientelimite 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($doubleinteger($int32)	Não há.
	vlrTicketMedioMinimovlrTicketMedioMaximo	Valor médio mínimo máximo de compras do cliente, para que se tenha direito a receber a promoçãoa promoção	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).	number($double)	Não há.
	vlrTicketMedioMaximovlrDesconto	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).
	nroSegmento	Número do segmento de venda que se aplica a promoção. Opcional. Quando não informado, será considerado o segmento principal entre as empresas incluídas, desde que todas as empresas informadas tenham o mesmo segmento principal.	integer($int32)	Não há.	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).
	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á.
	nroSegmentoseqPessoaResp	Número do segmento de venda que se aplica a promoção. Opcional. Quando não informado, será considerado o segmento principal entre as empresas incluídas, desde que todas as empresas informadas tenham o mesmo segmento principal.	Indica o código do fornecedor em que será gerado o título financeiro, referente ao acordo promocional, da verba apurada.	Integer($int32integer($int32)	Não há.
empresas	AdicionarPromocao Personalizada 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á.
produtos	AdicionarPromocao Personalizada ProdutoParceiroDto	Lista de Produtos incluídos na promoção. Obrigatória quando o tipo da promoção é 1, 2 ou 3 e ignorada quando o tipo da promoção é 4.		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.	string	Não há.
	qtdEmbalagem	Embalagem do produto para promoção	number($double)	Não há.
	status	Status do Produto	string	Nã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çã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	expandables	Propriedade para expansão dos campos	string	Não há.

Bloco de código

language	actionscript3

{
  "descricao": "string",
  "textoLegal": "string",
  "dtaInicial": "20202021-1107-25T1814T16:1342:1020.338Z195Z",
  "dtaFinal": "20202021-1107-25T1814T16:1342:1020.338Z195Z",
  "indTipoPromocao": "string",
  "indExigeIdenficacaoCliente": "string",
  "indExigeRegistroCompleto": "string",
  "indExigeAtivacaoOferta": "string",
  "qtdTotalAlocada": 0,
  "qtdLimiteCliente": 0,
  "vlrTicketMedioMinimo": 0,
  "qtdLimiteClientevlrTicketMedioMaximo": 0,
  "vlrTicketMedioMinimovlrMinimoCompra": 0,
  "vlrTicketMedioMaximoseqPessoaResp": 0,
  "vlrMinimoCompraindControleVerbaPdv": 0"string",
  "vlrDesconto": 0,
  "nroSegmento": 0,
  "empresas": [
    {
      "nroEmpresa": 0,
      "cnpj": "string"
    }
  ],
  "produtos": [
    {
      "seqProduto": 0,
      "codAcesso": "string",
      "qtdEmbalagem": 0,
      "nroSegmento": 0,
      "vlrPrecoPromocional": 0,
      "vlrDesconto": 0,
      "percDesconto": 0,
      "qtdTotalAlocada": 0,
      "qtdLimiteCliente": 0
    }
  ],
  "expandables": [
    "string"
  ]
}

Informações para Resposta (Response Information)

...

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	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.	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á.
	indExigeAtivacaoOferta	Indica se exige a ativação da oferta em aplicativo ou website	string	Nã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.	string	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á.
	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($double)	Não há.
	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).	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

PromocaoPersonalizadaEmpresaParceiroDto

PromocaoPersonalizada EmpresaParceiroDto	Lista 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	string	Não há.
status	Situação da empresa na promoção. A = Ativa ou I = Inativa.	string	Nã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ção	string($date-time)	Não há.
produtos	PromocaoPersonalizada

PromocaoPersonalizadaProdutoParceiroDto

ProdutoParceiroDto	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.	string	Não há.
qtdEmbalagem	Embalagem do produto para promoção	number($double)	Não há.
status	Status do Produto	string	Nã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çã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á.
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á.

Bloco de código

language	actionscript3

{
  "seqPromocPersonalizada": 0,
  "descricao": "string",
  "textoLegal": "string",
  "dtaInicial": "20202021-1107-25T1814T16:1342:1020.343Z248Z",
  "dtaFinal": "20202021-1107-25T1814T16:1342:1020.343Z248Z",
  "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:42:20.248Z",
"dtaHorAlteracao": "20202021-1107-25T1814T16:1342:10.343Z",
  "dtaHorAlteracao20.248Z",
"seqPessoaResp": 0,
"indControleVerbaPdv": "2020-11-25T18:13:10.343Zstring",
  "empresas": [
    {
      "seqPromocPersonalizada": 0,
      "nroEmpresa": 0,
      "cnpj": "string",
      "status": "string",
      ,
"dtaHorInclusao": "20202021-1107-25T1814T16:1342:1020.343Z248Z",
      "dtaHorAlteracao": "20202021-1107-25T1814T16:1342:1020.343Z248Z"
    }
  ],
  "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:1342:1020.344Z248Z",
      "dtaHorAlteracao": "20202021-1107-25T1814T16:1342:1020.344Z248Z"
    }
  ]
}

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

Árvore de páginas

Versões comparadas

Versão antiga 18

Nova versão Atual

Chave

Chamada

Permissionamento

Assuntos Relacionados

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

Informações para Resposta (Response Information)