Name | Type | Description | ||
|---|---|---|---|---|
id | String | The ID of the retrieved reward offer | ||
number | String | The number of the retrieved reward offer | ||
| name | String | The name of the retrieved reward offer | ||
| alternative_code | String | The alternative code of the retrieved reward offer | ||
| description | String | The description of the retrieved reward offer | ||
| classification | String | The reward offer classification of the retrieved reward offer, which can be one of the following:
| ||
| evaluation_method | String | The method that will be used to evaluate the offers which can be BATCH_PROCESS or INTERACTIVELY | ||
| award_scope | String | The award scope that defines if the award provided by the reward offer should be applied per transaction or per transaction item, which can be APPLY_AWARD_PER_TRANSACTION or APPLY_AWARD_PER_TRANSACTION_ITEM | ||
| spend_method | String | The method that will be used to spend the offers which can be SPEND_ON_REQUEST, SPEND_INSTANTLY, SPEND_INSTANTLY_THROUGH_VOUCHER | ||
| apply_on_top_of_other_applicable_offers | Boolean | If false then the reward offer will be applicable only if the provided award is the best award among other reward offers that might be applicable. If true then it will be applied irrespective of any other applicable reward offers | ||
life_cycle_state | String | The life cycle state of the retrieved lead which can be EFFECTIVE or NOT EFFECTIVE | ||
| latest_effective_date | Date | The latest effective date of the retrieved reward offer | ||
| latest_evaluation_date | Date | The latest date that the reward offer was evaluated. This is applicable only for reward offers with evaluation method equal to BATCH | ||
| terms_and_conditions | String | The terms and conditions for the retrieved reward offer
| ||
| award_amount | Number | The awarded amount provided by the reward offer. An awarded amount can be specified in all reward offers classifications. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer. | ||
| award_percentage | Number | The award percentage of the financial transaction amount that triggered the award. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer. An offer's awarded percentage can only be specified in the offer is classified as: UTILISE_FREE_CAPACITY, INCREASE_REVENUE_TRANSACTION_BASED, INCREASE_REVENUE_PRODUCT_BASED, REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED and REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED | ||
| award_percentage_on_previous_awards | Award Percentage on Previous Awards Object | The award percentage on awards submitted within a specific period of time. Award percentage on previous awards can be specified in all reward offers classifications.
| ||
| award_currency | Currency Object | The currency in which the Reward Offer's award will be provided which can either be in system or the alternative currency. | ||
| reward_scheme | Reward Scheme Object | The reward scheme of the retrieved reward offer | ||
| category | Reward Offer Category Object | The category information of the retrieved reward offer | ||
| owned_by_group | Group object | The group that is owning the reward offer | ||
| marketing_information | Reward Offer Marketing Information Object | The reward offer's marketing information | ||
| log_information | Log Information Object | The log information related with the retrieved reward offer |
...