Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Type

Description

total_award_amountNumberThe total amount that will be awarded for that purchase customer event
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

Tip

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
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
Tip

Available from CRM.COM R13.0.0


rewards_participant_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_nameString

The full name of the retrieved rewards participant

Tip

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

wallet_balanceNumber

The current wallet balance of the customer

Tip

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