get
https://sandbox-api.crmbonus.com/bonus/overview
Visão geral dos bônus gerados
Dicionário de Dados | Resposta
| Campo | Descrição |
|---|---|
| users | Lista de clientes. |
| name | Nome do cliente. |
| phone | Celular do cliente. |
| document_type | Tipo do documento do cliente. |
| document_number | Número do documento do cliente. |
| orders | Compras do cliente. |
| [orders] sequence | Sequência de compras do cliente na loja. |
| [orders] is_ecommerce | Informa se a loja da compra é um e-commerce ou não. |
| [orders] bonus_generated_origin | Origem do bônus gerado. |
| [orders] generation_store | Dados da loja de geração que gerou o bônus. |
| [generation_store] name | Nome da loja de geração que gerou o bônus. |
| [generation_store] token | Código de integração da loja que gerou o bônus. |
| [generation_store] internal_code | Código interno da loja. |
| [orders] bonus_generated_id | Id do bônus gerado. |
| [orders] bonus_generated_value | Valor do bônus gerado. |
| [orders] order_value | Valor do pedido. |
| [orders] invoice | Nota fiscal (NF) da compra. |
| [orders] ticket | Identificador do pedido. |
| [orders] generated_in | Data de geração do bônus. |
| [orders] expiry_date | Dados da expiração do bônus. |
| [expiry_date] start | Data de validade inicial do bônus. |
| [expiry_date] end | Data de validade final do bônus. |
| [orders] redeem | Dados de resgate. |
| [redeem] date | Data de resgate. |
| [redeem] redemption_store | Dados da loja de resgate. |
| [redeem][redemption_store] name | Nome da loja de geração que resgatou o bônus. |
| [redeem][redemption_store] token | Código de integração da loja que resgatou o bônus. |
| [redeem][redemption_store] internal_code | Código de integração da loja que resgatou o bônus. |
| [redeem] redeemed_bonus_origin | Origem do bônus que foi resgatado. |
| [redeem] redeemed_value | Valor do bônus resgatado. |
| [redeem] lost_bonus_value | Valor de bônus que o cliente deixou de usar e perdeu. |
| [orders] reactivation | Dados de reativação do bônus gerado. |
| [reactivation] date | Data de reativação. |
| [reactivation] reactivated | Informa se o bônus gerado foi fruto de uma reativação ou não. |
| [orders] final_balance | Saldo final de bônus do cliente após a compra. |
