...
...
| Tip |
|---|
| Excerpt |
|---|
This method returns information related with reward offers. Multiple reward offers are returned by each call |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
reward offers are returned by each call |
Resource URL
Parameters
Name | Type | Description | ||||||||||
token | String | The token retrieved from the login method | ||||||||||
| classification_identifier | Classification Identifier | The identifier of the classifications that the reward offers retrieved should be classified as. The allowed fields are the following:
| ||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group owns reward offer. The allowed unit identifier fields are the following:
| ||||||||||
reward_scheme_identifier (optional) | Reward scheme identifier | The identifier of the reward scheme related with the reward offer that should be returned as a result. The allowed reward scheme identifier fields are the following:
| ||||||||||
category_identifier | Reward offer category identifier | The identifier of the reward offer category related with the reward offer that should be returned as a result. The allowed reward offer category identifier fields are the following:
| ||||||||||
evaluation_method (optional) | Reward offer evaluation method identifier | The identifier of the reward offer evaluation method related with the reward offer that should be returned as a result. The allowed reward offer evaluation method identifier fields are the following:BATCH_PROCESS or INTERACTIVELY. | ||||||||||
spend_method (optional) | Reward Offer spend method | The identifier of the reward offer spend method related with the reward offer that should be returned as a result. The allowed reward offer spend method identifier fields are the following: SPEND_ON_REQUEST, SPEND_INSTANTLY or SPEND_INSTANTLY_THROUGH_VOUCHER | ||||||||||
award_currency (optional) | Currency Identifier | The identifier of the currency in which the reward offer will award rewards participants. The allowed currency identifier fields are the following:
classification (optional) | Classification Identifier | The identifier of the classification for which the reward offer will have. The allowed reward offer classification fields are the following: | ||||||||
rewards_participant_identifier (semi-optional) | Rewards participant identifier | The identifier of the rewards participant who might benefit from the reward offer that will be returned as a result. The allowed rewards participant identifier fields are the following:
| ||||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the rewards participant's accounts receivable. The allowed accounts receivable identifier fields are the following:
| ||||||||||
wallet_identifier (semi-optional) | Wallet identifier | The identifier of the reward participant's wallet. The allowed wallet identifier fields are the following:
| ||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call | ||||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number | ||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...