Árvore de páginas

Objetivo

Incluir regra de incentivo.

Chamada

POST [URLAPI]/RegraIncentivoAPI/api/v1/RegraIncentivoPdv

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 Regras de Incentivo


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)
DescricaoDescrição da regra de incentivoStringNão há
DtaInicioData de início da regra de incentivoString($date-time)Não há
DtaFimData fim da regra de incentivoString($date-time)Não há
TipoRegraTipo da regra de incentivoStringNão há
crmCódigo do parceiro de CRMInteger($int32)Não há
indControlaVerbaPdvÍndice de controle de verba pelo PDVStringNão há
percIncentivoPercentual de descontoNumber($double)Não há
vlrMinimoValor mínimo de compraNumber($double)Não há
vlrMaximoValor máximo de compraNumber($double)Não há
nroEmpresaNúmero da empresaInteger($int32)Não há
cnpjCnpj da empresaStringNão há
nroFormaPagtoNumero da forma de pagamentoInteger($int32)Não há
formaPagtoDescrição da forma de pagamentoStringNão há
seqProdutoCódigo do produtoInteger($int32)Não há
codAcessCódigo de barras do produtoStringNão há
qtdEmbalagemQuantidade da embalagemInteger($int32)Não há
percIncentivoProdPercentual de desconto de incentivo no produtoInteger($int64)Não há
precoIncentivoEmbPreço base do produtoInteger($int64)Não há
nroSegmentoNúmero do segmentoInteger($int32)Não há
statusStatus do segmentoStringNão há
seqPessoaCódigo do clienteInteger($int32)Não há
cpfCpf ou cnpf do clienteStringNão há

Parâmetros do Corpo (Body Parameters)

Não há.

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

[
  {
    "seqRegraIncentivo": 0,
    "expandables": [
      "string"
    ]
  }
]


CODE 400 - BADapplication/json, text/json

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