/bonus/overview

Visão geral dos bônus gerados

Dicionário de Dados | Resposta


CampoDescrição
usersLista de clientes.
nameNome do cliente.
phoneCelular do cliente.
document_typeTipo do documento do cliente.
document_numberNúmero do documento do cliente.
ordersCompras do cliente.
[orders] sequenceSequência de compras do cliente na loja.
[orders] is_ecommerceInforma se a loja da compra é um e-commerce ou não.
[orders] bonus_generated_originOrigem do bônus gerado.
[orders] generation_storeDados da loja de geração que gerou o bônus.
[generation_store] nameNome da loja de geração que gerou o bônus.
[generation_store] tokenCódigo de integração da loja que gerou o bônus.
[generation_store] internal_codeCódigo interno da loja.
[orders] bonus_generated_idId do bônus gerado.
[orders] bonus_generated_valueValor do bônus gerado.
[orders] order_valueValor do pedido.
[orders] invoiceNota fiscal (NF) da compra.
[orders] ticketIdentificador do pedido.
[orders] generated_inData de geração do bônus.
[orders] expiry_dateDados da expiração do bônus.
[expiry_date] startData de validade inicial do bônus.
[expiry_date] endData de validade final do bônus.
[orders] redeemDados de resgate.
[redeem] dateData de resgate.
[redeem] redemption_storeDados da loja de resgate.
[redeem][redemption_store] nameNome da loja de geração que resgatou o bônus.
[redeem][redemption_store] tokenCódigo de integração da loja que resgatou o bônus.
[redeem][redemption_store] internal_codeCódigo de integração da loja que resgatou o bônus.
[redeem] redeemed_bonus_originOrigem do bônus que foi resgatado.
[redeem] redeemed_valueValor do bônus resgatado.
[redeem] lost_bonus_valueValor de bônus que o cliente deixou de usar e perdeu.
[orders] reactivationDados de reativação do bônus gerado.
[reactivation] dateData de reativação.
[reactivation] reactivatedInforma se o bônus gerado foi fruto de uma reativação ou não.
[orders] final_balanceSaldo final de bônus do cliente após a compra.
Path Params
string
required
Defaults to 2025-01-01T00:00:00 TO 2025-01-05T23:59:59

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

Headers
string
required
Defaults to base64

Token de integração enviado pela CRMBonus

string
required
Defaults to base64

Token de integraçã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