/bonusResgatadoGranular

Relatório de bônus resgatados granular

🚧

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
listArray de objetos com os dados referentes a cada registro do 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.
cod_clienteCódigo atribuído a clientes.
company_geradoraNome da loja cadastrado no CRMBonus.
tipo_lojaTipo de loja ("Franquia" ou "Própria", por exemplo).
cod_linxCódigo de integração da loja.
cod_loja_internoCódigo identificador da loja dentro da marca.
is_multi_resgateCampo responsável por informar se a loja está com a configuração de multi-resgate habilitada.
used_company_resgateNome da loja onde o bônus foi utilizado.
used_company_cnpjCNPJ da loja onde o bônus foi utilizado.
loja_idID da loja onde o bônus foi utilizado.
campaign_idID da campanha utilizada na geração bônus.
order_idID do pedido gerado na CRMBonus.
valor_vendaValor da venda em que o bônus foi gerado.
valor_bonusValor total do bônus.
idID do bônus.
total_bonus_usadoValor resgatado do bônus.
origemOrigem de geração do bônus.
createdData da geração do 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.
date_usedData em que o bônus foi utilizado.
venda_incrementalValor de venda incremental.
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.
tipo_bonusTipo do bônus.
tag_transactionTag da transação.
percentual_takeratePercentual de de take aplicado nessa compra.
Path Params
string
required
Defaults to 2024-05-06T00:00:00 TO 2024-05-06T23:59:59

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

string
required
Defaults to 5511999998888

Celular do cliente sem máscara

string
required
Defaults to 07655548251

CPF do cliente sem máscara

string
required
Defaults to Fidelidade

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

string
required
Defaults to venda_incremental, asc

Ordenação do resultado

int32
required
Defaults to 0

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