Name | Type | Description |
|---|
| total_award_amount | Number | The total amount that will be awarded for that purchase customer event in system currency |
| total_award_alternative_amount | Number | The total amount that will be awarded for that purchase customer event in alternative currency and only if the awarded amount will be in alternative currency | Tip |
|---|
Available from CRM.COM R14.2.0 |
|
| total_instant_spend_amount | Number | The total amount that will be spend instantly on that purchase customer event |
| total_automatic_spend_amount | Number | The total amount that will be spend automatically on that purchase customer event, if the automatic awards spending is allowed. This amount does not include the amount that will be instantly spent on a voucher | Tip |
|---|
Available from CRM.COM R13.0.0 |
|
| total_additional_spend_amount | Number | The additional amount that is available and can be spend on that purchase customer event. This amount does not include the amount that will be instantly spent on a voucher |
| minimum_spend_amount_per_transaction | Number | The minimum amount that can be spend per each spend request customer event |
| maximum_spend_amount_per_transaction | Number | The maximum amount that can be spend per each spend request customer event |
| reduction_method | String | It defines how the amount that will be spend instantly or automatically will be reduced. The allowed methods are the following: - FRONT_END_REDUCTION: If selected then the reduction will be done by the front-end system (for example the POS). This is the default option
- BACK_END_REDUCTION: If selected then the reduction will be done by a back-end system (for example Paypal). If this option is selected then it is mandatory to specify the back-end reduction settings
| Tip |
|---|
Available from CRM.COM R13.0.0 |
|
| purchase_ rewards_participant Purchase Rewards Participant Object_id | String | The ID of the purchase customer event's rewards participant | Tip |
|---|
Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward |
|
| rewards_participant_name | String | The full name of the retrieved rewards participant | Tip |
|---|
Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward |
|
| wallet_balance | Number | The current wallet balance of the customer in wallet currency | Tip |
|---|
Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward |
|
| wallet_alternative_balance | Number | The current wallet balance of the customer in wallet alternative | Tip |
|---|
Available from CRM.COM R14.2.0 |
|
| allow_spending | Boolean | It determines if spending is allowed to be done on the specific purchase customer event | Tip |
|---|
Available from CRM.COM R14.4.0 |
|
| voucher_types_set | Set of Voucher Types Objects | The set of type of the voucher that will be awarded instantly if such a purchase customer event is performed | Tip |
|---|
Available from CRM.COM R14.2.0 |
|
| applied_reward_offers_set | Set of Applied Reward Offers | A set of reward offers that will be applied on the specific purchase customer event | Tip |
|---|
Available from CRM.COM R14.4.0 |
|
| Anchor |
|---|
| purchase customer event preview referred objects |
|---|
| purchase customer event preview referred objects |
|---|
|
Referred Objects Response Data
...
|
|---|
| voucher_type_short |
|---|
| voucher_type_short |
|---|
|
| Include Page |
|---|
| applied_reward_offers_short |
|---|
|
...
...
...