Consultar Regras de Incentivo - GET

Objetivo

Método de consulta regra de incentivo.

Chamada

GET [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)
CnpjEmpresa	Cnpj da empresa	string	não há
NroEmpresa	Número da empresa	integer($int32)	não há
NroSegmento	Número do segmento de venda	integer($int32)	não há
NroFormaPagamento	Código da forma de pagamento	integer($int32)	não há
Status	Status da promoção.	string	não há
Vigente	Vigência da promoção.	string	não há
SeqRegraIncentivo	Código da regra de incentivo	integer($int32)	não há
DtaAlteracao	Data de alteração da regra	string($date-time)	não há
DtaInicio	Data de inicio da promoção	string($date-time)	não há
Fields	Número de campos	string	não há
Order	Número do pedido	string	não há
Page	Número de páginas	integer($int32	não há
PageSize	Tamanho dá página	integer($int32	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-06-21T17:11:32.196Z",
      "dtaFIm": "2021-06-21T17:11:32.196Z",
      "tipoRegra": "string",
      "crm": 0,
      "indControlaVerbaPdv": "string",
      "percIncentivo": 0,
      "vlrMinimo": 0,
      "vlrMaximo": 0,
      "dtaAlteracao": "2021-06-21T17:11:32.196Z",
      "empresas": [
        {
          "status": "string",
          "dtaAlteracao": "2021-06-21T17:11:32.196Z",
          "empresa": {
            "nroEmpresa": 0,
            "status": "string",
            "nomeReduzido": "string",
            "cnpj": "string",
            "expandables": [
              "string"
            ]
          },
          "expandables": [
            "string"
          ]
        }
      ],
      "produtos": [
        {
          "qtdEmbalagem": 0,
          "status": "string",
          "percIncentivoProd": 0,
          "percoIncentivoEmb": 0,
          "dtaAlteracao": "2021-06-21T17:11:32.196Z",
          "produto": {
            "seqProduto": 0,
            "descCompleta": "string",
            "expandables": [
              "string"
            ]
          },
          "expandables": [
            "string"
          ]
        }
      ],
      "segmentos": [
        {
          "status": "string",
          "dtaAlteracao": "2021-06-21T17:11:32.196Z",
          "segmento": {
            "nroSegmento": 0,
            "descSegmento": "string",
            "expandables": [
              "string"
            ]
          },
          "expandables": [
            "string"
          ]
        }
      ],
      "formaPagamento": [
        {
          "status": "string",
          "dtaAlteracao": "2021-06-21T17:11:32.196Z",
          "formaPagto": {
            "nroFormaPagto": 0,
            "formaPagto": "string",
            "expandables": [
              "string"
            ]
          },
          "expandables": [
            "string"
          ]
        }
      ],
      "clientes": [
        {
          "status": "string",
          "dtaAlteracao": "2021-06-21T17:11:32.196Z",
          "pessoa": {
            "seqPessoa": 0,
            "nomeRazao": "string",
            "cpf": "string",
            "expandables": [
              "string"
            ]
          },
          "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