| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| reward_offer_identifier (mandatory) | Lead identifier | The identifier of the reward offer that should be returned as a result. The allowed reward offer identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
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:
| ||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will provide the reward offer. The group is filtered against the reward offer's Award conditions organisational units. The allowed unit identifier fields are the following:
| ||||||
unit_identifier (optional) | Unit identifier | The identifier of the unit that will provide the reward offer. The unit is filtered against the reward offer's Award conditions organisational units. 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:
| ||||||
type_identifier | Reward offer type identifier | The identifier of the reward offer type related with the reward offer that should be returned as a result. The allowed reward offer type 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 BATCH_PROCESS_AND_INTERACTIVELY. | ||||||
award_scope (optional) | Award Scope identifier | The identifier of the award scope related with the reward offer that should be returned as a result. The allowed award scope identifier fields are the following: APPLY_AWARD_PER_TRANSACTION_ITEM or APPLY_AWARD_PER_TRANSACTION.
| ||||||
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 or SPEND_INSTANTLY.
| ||||||
purchase_product (optional) | Product identifier | The identifier of the product which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product identifier fields are the following:
| ||||||
purchase_product_type (optional) | Product type identifier | The identifier of the product type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product type identifier fields are the following:
| ||||||
purchase_product_family (optional) | Product family identifier | The identifier of the family type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product family identifier fields are the following:
| ||||||
purchase_amount (optional) | Number | The amount of the purchase that the rewards participant will have to make in order to benefit from the reward offer that will be returned as a result | ||||||
number_of_purchases (optional) | Number | The number of purchases that the rewards participant will have to make in order to benefit from the reward offer that will be returned as a result | ||||||
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 |
...
GET reward_offers/performance
| Tip |
|---|
Available from CRM.COM R12.2.0 |
This method returns information related with the performance of a rewards participant against a specific reward offer. A single reward offer performance is returned by each call
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| reward_offer_identifier (mandatory) | Rewards Offer identifier | The identifier of the reward offer that should be returned as a result. The allowed reward offer identifier fields are the following:
| ||||||
| rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The identifier of the rewards participant for which the performance should be returned. The allowed rewards participant identifier fields are the following:
| ||||||
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 |
...