7f3ebb042f1a
latestOpenAPI 3.1.02026-08-04650218.3 KB/bonus/overview
Visão geral dos bônus gerados
get/bonus/overview
Path parameters
generated_betweenstring required
Intervalo de data (Ex: 2024-05-06T00:00:00 TO 2024-05-06T23:59:59)
Headers
Tokenstring required
Token de integração enviado pela CRMBonus
Authorizationstring required
Token de integração enviado pela CRMBonus
Response
200
Example response
{
"users": [
{
"name": "PAULO MARQUES",
"phone": "55 (11) 99955-1100",
"document_number": "56286895450",
"document_type": "CPF",
"orders": [
{
"sequence": 1,
"bonus_generated_origin": "fidelidade",
"generation_store": {
"name": "XPTO",
"token": "GG333ASDBtUYLX5x",
"internal_code": "A1O0"
},
"bonus_generated_id": 432393382,
"bonus_generated_value": 582,
"order_value": 1579.96,
"invoice": "44312",
"ticket": "FÍSICA",
"generated_in": "2025-01-01T15:11:09",
"expiry_date": {
"start": "2025-01-09T21:00:00",
"end": "2025-02-24T20:59:59"
},
"redeem": {
"date": "2024-02-16T13:11:51",
"redemption_store": {
"name": "XPTO",
"token": "GG333ASDBtUYLX5x",
"internal_code": "A100"
},
"redeemed_value": 28
}
}
]
}
],
"paginacao": {
"total": 2191,
"per_page": 1000,
"pages": 3
}
}