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 | ||||
| evaluation_method | String | The method that will be used to evaluate the offers which can be BATCH_PROCESS or BATCH_PROCESS_AND_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_ONTHROUGH_VOUCHER
| ||||
| apply_if_best_award_is_provided | Boolean | If true then the reward offer will be applicable only if the provided award is the best award among other reward offers that might be applicable
| ||||
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 | ||||
| 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
| ||||
| number_of_awarded_participants | Number | The number of the participants to be awarded within the period provided through lottery_award_period parameter. Available only if the reward offer is classified as LOTTERY
| ||||
| 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.
| ||||
| 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.
| ||||
| reward_scheme | Reward Scheme Object | The reward scheme of the retrieved reward offer | ||||
| type | Reward Offer Type Object | The type information of the retrieved reward offer | ||||
| category | Reward Offer Category Object | The category information of the retrieved reward offer | ||||
| reward_offer_validity | Reward Offer Validity Object | The validity settings of the retrieved reward offer | ||||
| reward_award_validity | Reward Award Validity Object | The award validity settings of the retrieved reward offer's awarded amount | ||||
| owned_by_group | Group object | The group that is owning the reward offer | ||||
| privacy_level | Privacy level object | The privacy level of the reward offer | ||||
| log_information | Log Information Object | The log information related with the retrieved reward offer | ||||
| marketing_information | Reward Offer Marketing Information Object | The reward offer's marketing information
| ||||
| voucher_type | Voucher Type Object | The type of the voucher that will be issued if the reward offer's awarded amount will be instantly spent through a voucher
| ||||
| award_percentage_on_key_performance_indicator_values | Set of Award Percentage on Key Performance Indicator Values Objects | The award percentage that will be applied, based on the value of each specified key performance indicator, as measured through financial statement customer events. This award option is applicable only if the reward offer is classified as REWARD_FINANCIAL_STATEMENTS
| ||||
| award_conditions_set | Set of Reward Offer Award Conditions objects | The reward offer's award conditions that should be met in order for the rewards participant to benefit from the reward offer | ||||
| spend_conditions_set | Set of Reward Offer Spend Conditions objects | The reward offer's conditions based on which the rewards participant is allowed to spend the awarded amount |
...