Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta de regras de incentivo.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/regra/regra-incentivo

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
nroEmpresaParâmetro para filtrar o número da empresa.IntegerNão há
idProdutoCódigo sequencial do cadastro do produtoIntegerNão há
dataAtualizacaoData da ultima atualização Formato: YYYY-MM-DDThh:mm:ssstringQuando informada a dataAtualizacao serão filtrados os registros que tiveram alteração a partir desta data.
idClienteCódigo do clienteIntegerNão há
numeroFormaPagtoNúmero da Forma de PagamentoIntegerNão há
numeroSegmentoNúmero do segmento de venda específico para busca de algumas informações. Quando não informado, considera-se o segmento principal da empresa.IntegerNão há
_pageNo
IntegerNão há
_pageSize
IntegerNão há

Parâmetros do Corpo (Body Parameters)

Não há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

{
  "Descricao": "string",
  "IdRegraIncentivo": 0,
  "DataInicial": "2021-05-17T12:02:52.372Z",
  "DataFinal": "2021-05-17T12:02:52.372Z",
  "ValorMinimo": 0,
  "ValorMaximo": 0,
  "Quantidade_Minima_Produtos": 0,
  "Indicar_Qtde_Considerar": "string",
  "Porcentagem_Incentivo": 0,
  "Tempo_Adicional": 0,
  "Usuario_Alteracao": "string",
  "Data_Alteracao": "2021-05-17T12:02:52.373Z",
  "Acumular_Pontos": "string",
  "indicar_lista_verificacao": "string",
  "indicar_apenas_marca": "string",
  "indicar_cliente_tempo_máximo": "string",
  "tipo_regra": "string",
  "tipo_aplicativo": "string",
  "tipo_verificacao": "string",
  "indicar_replicacao": "string",
  "indicar_replicacao_gerada": "string",
  "status": "string",
  "tipo_cobranca": "string",
  "gerar_desconto": "string",
  "quantidade_verificacao": "string",
  "indicar_aplicacao_sugere": "string",
  "produtos_verificacao": "string",
  "clientes_verificacao": "string",
  "Descricao_tipo_produtos": "string",
  "numero_contrato": 0,
  "numero_contrato_empresa": 0,
  "indica_saldo_controle_sem_acordo": "string",
  "empresa_numero": 0,
  "seq_regra": 0,
  "contrato_sequencia_associado": 0,
  "indica_todos_clientes_grupo_especialmente": "string",
  "indica_gerar_fatura_desconto_valor": "string",
  "indica_constituir_imposto": "string",
  "indica_controle_orcamento_pdv": "string",
  "indica_gerar_fatura_desconto_percentual": "string",
  "Cod_Parceiro": 0,
  "quantidade_limite_geral": 0,
  "forma_regra_incentivo_pagamento": [
    {
      "numero_forma_pagamento": 0,
      "forma_pagamento": "string",
      "indica_cartao_fidelidade": "string",
      "status": "string",
      "usuario_alteracao": "string",
      "data_alteracao": "2021-05-17T12:02:52.373Z",
      "seq_regra": 0,
      "ind_replicacao": "string",
      "ind_replicacao_gerada": "string"
    }
  ],
  "regra_incentivo_produtos_pdv": [
    {
      "seq_produto": 0,
      "descricao_completa": "string",
      "seq_regra": 0,
      "quantidade_embalagem": 0,
      "porcentagem_produto_incentivo": 0,
      "preco_base": 0,
      "embalagem_incentivo_preco": 0,
      "ind_replicacao": "string",
      "status": "string",
      "usuario_base_precos_alteracao": "string",
      "data_base_precos_alteracao": "2021-05-17T12:02:52.374Z",
	  "quantidade_limite": 0
    }
  ],
  "clientes_grupo": [
    {
      "descricao": "string",
      "seq_grupo": 0,
      "seq_regra": 0,
      "ind_replicacao": "string",
      "status": "string"
    }
  ],
  "segmentos": [
    {
      "numero_segmento": 0,
      "descricao_segmento": "string",
      "seq_regra": 0,
      "status": "string",
      "usuario_alteracao": "string",
      "data_alteracao": "2021-05-17T12:02:52.374Z",
      "ind_replicacao": "string",
      "ind_replicacao_gerada": "string"
    }
  ],
  "empresa": [
    {
      "numero_empresa": 0,
      "nome_reduzido": "string",
      "seq_regra": 0,
      "status": "string",
      "usuario_alteracao": "string",
      "data_alteracao": "2021-05-17T12:02:52.374Z",
      "ind_replicacao": "string",
      "ind_replicacao_gerada": "string"
    }
  ],
  "cliente": [
    {
      "seq_regra": 0,
      "seq_cliente": 0,
      "cliente_horario_adicional": 0,
      "ind_replicacao": "string",
      "status": "string"
    }
  ]
}