/extrato

Extrato do cliente

🚧

Campos específicos

Os dados de email_cliente, birth_cliente e genero_cliente podem ou não aparecer na resposta a depender das configurações da loja.

Dicionário de Dados | Resposta


CampoDescrição
clienteObjeto de dados pessoais do cliente.
user_idID do cliente.
nome_clienteNome do cliente.
celular_clienteNúmero de celular do cliente cadastrado.
cpf_clienteNúmero do CPF do cliente.
email_clienteEndereço de e-mail do cliente.
birth_clienteData de nascimento do cliente.
genero_clienteGênero do cliente.
user_createdData de criação do cadastro do cliente.
saldo_disponivelValor de bônus disponíveis do cliente.
saldo_futuroValor de bônus a ativar do cliente.
saldo_perdidoValor de bônus perdidos do cliente.
saldo_usadoValor de bônus usados do cliente.
total_bonus_historiaValor total dos bônus que o cliente já teve.
total_gastoValor total já gasto pelo cliente.
extrato_bonusArray de objetos com os dados referentes a cada registro de bônus gerado pelo usuário.
bonus_idID do bônus.
is_multi_resgateCampo responsável por informar se a loja está com a configuração de muti-resgate habilitada.
loja_idID da loja em que o bônus foi gerado.
cod_loja_internoCódigo identificador da loja dentro da marca.
lojaNome da loja onde o bônus foi gerado.
tipo_lojaTipo de loja ("Franquia" ou "Própria", por exemplo).
totalValor 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.
data_criacaoData em que o bônus foi criado.
statusStatus do bônus.
usadoCampo responsável por informar se o bônus foi utilizado.
data_usadoData em que o bônus foi utilizado.
id_loja_usadoID da loja em que o bônus foi utilizado.
loja_usadoNome da loja onde o bônus foi utilizado.
extrato_granularArray de objetos com os dados detalhados de cada registro de bônus gerado no período filtrado.
order_idID do pedido gerado na CRMBonus.
loja_idID da loja em que o bônus foi utilizado.
cod_loja_interoCódigo identificador da loja dentro da marca.
loja_nomeNome da loja onde o bônus foi utilizado.
valor_compraValor da venda em que o bônus foi gerado.
data_compraData da venda em que o bônus foi gerado.
total_bonus_usadoValor resgatado do bônus.
ids_bonus_utilizadosID dos bônus utilizados.
bonus_geradoID bônus gerado.
valor_bonus_geradoValor do bônus.
canceladoCampo responsável por informar se o bônus foi cancelado.
bonus_gerado_utilizadoCampo responsável por informar se o bônus foi utilizado.
Path Params
string
required
Defaults to 5511999998888

Celular do cliente sem máscara. DDI + DDD + Celular (Ex: 5511999998888)

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

Responses

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