purchase_customer_event_preview_complete

Name

Type

Description

total_award_amountNumberThe total amount that will be awarded for that purchase customer event in system currency
total_award_alternative_amountNumber

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

Available from CRM.COM R14.2.0

total_instant_spend_amountNumberThe total amount that will be spend instantly on that purchase customer event
total_automatic_spend_amountNumber

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

Available from CRM.COM R13.0.0

total_additional_spend_amountNumberThe 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_transactionNumberThe minimum amount that can be spend per each spend request customer event
maximum_spend_amount_per_transactionNumberThe maximum amount that can be spend per each spend request customer event
reduction_methodString

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

Available from CRM.COM R13.0.0


rewards_participant_id

String

The ID of the purchase customer event's rewards participant

Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward

rewards_participant_nameString

The full name of the retrieved rewards participant

Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward

wallet_balanceNumber

The current wallet balance of the customer in wallet currency

Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward

wallet_alternative_balanceNumber

The current wallet balance of the customer in wallet alternative

Available from CRM.COM R14.2.0

allow_spendingBoolean

It determines if spending is allowed to be done on the specific purchase customer event

Available from CRM.COM R14.4.0

voucher_types_setSet of Voucher Types Objects

The set of type of the voucher that will be awarded instantly if such a purchase customer event is performed

Available from CRM.COM R14.2.0

applied_reward_offers_setSet of Applied Reward Offers

A set of reward offers that will be applied on the specific purchase customer event

Available from CRM.COM R14.4.0

 

Referred Objects Response Data

 voucher_type response data object
NameType Description
IdStringThe ID of the retrieved voucher type
nameStringThe Name of the retrieved voucher type
alternative_codeStringThe Alternative Code of the retrieved voucher type
value_optionsString

Defines if the value should be fixed, as defined in the voucher type, or a variable, as defined during the creation of the vouchers. The supported options are FIXED and VARIABLE

From CRM.COM R13.1.0 and onwards for voucher types of classification equal to "Electronic Voucher" the supported option is VARIABLE

From CRM.COM R14.0.0 and onwards for voucher types of classification equal to "Refund Voucher" the supported option is VARIABLE

classificationString

The Classification of the retrieved voucher type

Available from CRM.COM R13.1.0

descriptionStringThe Description of the retrieved voucher type

 applied reward offers short response data object
NameType Description
IdStringThe ID of the applied reward offer
nameStringThe name of the applied reward offer
scheme_nameStringThe reward scheme name of the applied reward offer