Alterar Regra de Incentivo - PUT

Objetivo

Alterar regra de incentivo.

Chamada

PUT [URLAPI]/RegraIncentivoAPI/api/v1/RegraIncentivoPdv/{seqRegraIncentivo}

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)
Descricao	Descrição da regra de incentivo	String	Não há
DtaInicio	Data de início da regra de incentivo	String($date-time)	Não há
DtaFim	Data fim da regra de incentivo	String($date-time)	Não há
TipoRegra	Tipo da regra de incentivo	String	Não há
crm	Código do parceiro de CRM	Integer($int32)	Não há
indControlaVerbaPdv	Índice de controle de verba pelo PDV	String	Não há
percIncentivo	Percentual de desconto	Number($double)	Não há
vlrMinimo	Valor mínimo de compra	Number($double)	Não há
vlrMaximo	Valor máximo de compra	Number($double)	Não há
status	Status da regra	string	Não há
nroEmpresa	Número da empresa	Integer($int32)	Não há
cnpj	Cnpj da empresa	String	Não há
status	Status da empresa	String	Não há
nroFormaPagto	Numero da forma de pagamento	Integer($int32)	Não há
formaPagto	Descrição da forma de pagamento	String	Não há
status	Status da forma de pagamento	String	Não há
seqProduto	Código do produto	Integer($int32)	Não há
codAcess	Código de barras do produto	String	Não há
qtdEmbalagem	Quantidade da embalagem	Integer($int32)	Não há
percIncentivoProd	Percentual de desconto de incentivo no produto	Integer($int64)	Não há
precoIncentivoEmb	Preço base do produto	Integer($int64)	Não há
status	Status do produto	String	Não há
nroSegmento	Número do segmento	Integer($int32)	Não há
status	Status do segmento	String	Não há
seqPessoa	Código do cliente	Integer($int32)	Não há
cpf	Cpf ou cnpf do cliente	String	Não há
status	Cpf ou cnpf do cliente	string	Nã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

{
  "hasNext": true,
  "items": [
    {
      "seqRegraIncentivo": 0,
      "descricao": "string",
      "status": "string",
      "dtaInicio": "2021-07-07T16:06:12.888Z",
      "dtaFim": "2021-07-07T16:06:12.888Z",
      "tipoRegra": "string",
      "crm": 0,
      "indControlaVerbaPdv": "string",
      "percIncentivo": 0,
      "vlrMinimo": 0,
      "vlrMaximo": 0,
      "dtaAlteracao": "2021-07-07T16:06:12.888Z",
      "empresas": [
        {
          "nroEmpresa": 0,
          "cnpj": "string",
          "nomeReduzido": "string",
          "status": "string",
          "dtaAlteracao": "2021-07-07T16:06:12.888Z",
          "expandables": [
            "string"
          ]
        }
      ],
      "produtos": [
        {
          "seqProduto": 0,
          "descCompleta": "string",
          "codAcess": "string",
          "qtdEmbalagem": 0,
          "status": "string",
          "percIncentivoProd": 0,
          "percoIncentivoEmb": 0,
          "expandables": [
            "string"
          ]
        }
      ],
      "segmentos": [
        {
          "nroSegmento": 0,
          "descSegmento": "string",
          "status": "string",
          "dtaAlteracao": "2021-07-07T16:06:12.888Z",
          "expandables": [
            "string"
          ]
        }
      ],
      "formaPagamento": [
        {
          "nroFormaPagto": 0,
          "formaPagto": "string",
          "status": "string",
          "dtaAlteracao": "2021-07-07T16:06:12.889Z",
          "expandables": [
            "string"
          ]
        }
      ],
      "clientes": [
        {
          "seqPessoa": 0,
          "nomeRazao": "string",
          "cpf": "string",
          "status": "string",
          "dtaAlteracao": "2021-07-07T16:06:12.889Z",
          "expandables": [
            "string"
          ]
        }
      ],
      "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
    }
  ]
}

Árvore de páginas