| 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
...
The token retrieved from the login method
...
group_identifier
(optional)
...
The identifier of the group owns reward offer. The allowed unit identifier fields are the following:
...
reward_scheme_identifier
(optional)
...
| 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 | The token retrieved from the login method | ||||||||||
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) | Reward offer category identifierClassification Identifier | The identifier of the reward offer category related with classification for which the reward offer that should be returned as a resultwill have. The allowed reward offer category identifier classification fields are the following: | Include Page | | V4:reward_offer_category_identifier | V4:reward_offer_category_identifier |
| Note |
|---|
Deprecated from CRM.COM R15.0.0 |
evaluation_method
(optional)
rewards_participant_identifier
(semi-optional)
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
spend_method
(optional)
the following:
| Include Page | ||||
|---|---|---|---|---|
|
accounts_receivable_identifier
(semi-optional)
The identifier of the rewards participant's accounts receivable. The allowed accounts receivable identifier fields are the following:
award_currency
(optional)
| Include Page | ||||
|---|---|---|---|---|
|
wallet_identifier
(semi-optional)
The identifier of the
reward participant's wallet. The allowed
wallet identifier fields are the following:
| Include Page | ||
|---|---|---|
|
|
|
number_of_results
(optional)
The number of results that can be retrieved through each call
offset
(optional)
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
...