Get Reward Summary
Gets the reward summary information for the customer.
| GET /customers/<token>/rewards
|
| Path Param |
Type |
Required |
Description |
| token |
string |
Required |
The security token for the customer |
| Query Param |
Type |
Required |
Description |
| channelId |
int |
Required |
Value from Channel list |
| locationId |
int |
Required |
Value from Location list |
Output
This endpoint returns a RewardSummaryTotals object.
| Property |
Type |
Description |
| yearToDate |
RewardSummary |
A reward summary for the year-to-date time frame |
| previousYear |
RewardSummary |
A reward summary for the previous calendar year |
| previousMonth |
RewardSummary |
A reward summary for the previous month |
| rollingTwelveMonths |
RewardSummary |
A reward summary for the previous 12 months |
| currentMonth |
RewardSummary |
A reward summary for the current calendar month |
| pending |
RewardSummary |
A reward summary for the rewards that have not yet been processed |
Example
Request
| GET /api/v1/customers/C1FA3C38-1B28-4B54-A2F8-E577FFEEF9F5/rewards?channelId=5&locationId=2
|