/bonusGerados

Relatório de bônus gerados

🚧

Campos específicos

Os dados de cpf, email, birth e genero podem ou não aparecer na resposta a depender das configurações da loja.

Dicionário de Dados | Resposta

CampoDescrição
total_rtvTotal de RTV.
porcentagemPorcentagem.
total_geradoQuantidade total de bônus gerados no período filtrado.
total_dinheiroTotal em dinheiro.
total_vendaTotal em venda.
total_consumidor_ativoTotal de consumidores ativos.
total_prime_smsTotal SMS enviados para clientes com módulo prime ativo.
total_prime_assinaturaTotal de assinaturas Prime realizadas no período filtrado.
count_sms_venda_primeTotal de SMS de venda de módulo Prime enviados.
count_assinaturas_primeTotal de assinaturas do módulo Prime.
listArray de objetos com os dados referentes a cada registro de bônus gerado no período filtrado.
clienteObjeto de dados pessoais do cliente.
cliente_idID do cliente.
clienteNome do cliente.
celularNúmero de celular do cliente cadastrado.
cpfNúmero do CPF do cliente.
emailEndereço de e-mail do cliente.
birthData de nascimento do cliente.
generoGênero do cliente.
bonus_idID do bônus gerado.
originOrigem de geração do bônus.
loja_idID da loja onde o bônus foi gerado.
tipo_lojaTipo de loja ("Franquia" ou "Própria", por exemplo).
loja_nomeNome da loja cadastrado no CRMBonus.
loja_cod_linxCódigo de integração da loja.
cod_loja_internoCódigo identificador da loja dentro da marca.
cnpjCNPJ da loja onde o bônus foi gerado.
is_multi_resgateInforma se a loja está configurada como multi-resgate.
lojas_multi_resgateArray de lojas dentro da configuração de multi-resgate.
dataData da geração de bônus.
validade_inicioData em que o bônus fica disponível para resgate.
validade_fimData em que o bônus deixa de estar disponível para resgate.
totalValor do bônus gerado.
total_bonus_usadoValor utilizado deste bônus.
data_utilizacao_bonusData em que o bônus foi utilizado.
id_loja_utilizacaoID da loja em que o bônus foi utilizado.
nome_loja_utilizacaoNome da loja onde o bônus foi utilizado.
cnpj_loja_utilizacaoCNPJ da loja onde o bônus foi utilizado.
nome_vendedorNome do vendedor responsável pela geração deste bônus.
nfNota fiscal associada à venda que gerou este bônus.
ticketNúmero do pedido/identificador da venda que gerou este bônus.
terminalTerminal/caixa onde a compra responsável pela geração deste bônus fora realizada.
total_bonus_geradoValor do bônus gerado.
total_bonus_resgatadoValor de bônus usado na compra responsável pela geração deste bônus.
pinCódigo pin utilizado na confirmação do celular do cliente.
is_pin_masterCampo responsável por informar se foi utilizado PIN Master.
is_reativacaoCampo responsável por informar se é um bônus de reativação.
date_reativacaoData em que o bônus foi reativado.
data_compraData da compra.
campanha_idId da campanha que gerou o bônus.
campanha_nomeNome da campanha.
campanha_tipoTipo da campanha.
porcentagem_acumuloPorcentagem de acúmulo.
ids_bonus_usedId dos bônus utilizados.
valor_compraValor da compra.
valor_pagoValor pago pelo cliente.
Path Params
string
required
Defaults to 2024-02-01T00:00:00 TO 2024-02-26T23:59:59

Intervalo de data (Ex: 2024-05-06T00:00:00 TO 2024-05-06T23:59:59)

string
required
Defaults to 5511999999999

Celular do cliente sem máscara

string
required
Defaults to 74809899039

CPF do cliente sem máscara

string
required
Defaults to Fidelidade

Origem do bônus (Esse campo é case sensitive)

string
required
Defaults to total_gerado, asc

Ordenação do resultado

int32
required

Paginação do resultado

Headers
string
required
Defaults to base64

Token de autenticação enviado pela CRMBonus

string
required
Defaults to base64

Token de autenticação enviado pela CRMBonus

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json