reward_offer_transaction_condition

 reward_offer_transaction_condition object response data

Name

Type

Description

transaction_amount_fromNumber

The minimum required transaction amount in order for the offer to be applied. Applicable only for reward offers classified as:

  • INCREASE_REVENUE_TRANSACTION_BASED
  • REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED
transaction_amount_toNumberThe maximum required transaction amount in order for the offer to be applied. This value is optional. Applicable only for reward offers classified as:
  • INCREASE_REVENUE_TRANSACTION_BASED 
  • REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED

transaction_amount_to deprecated in CRM.COM R12.2.0 for REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED reward offers

transaction_number_fromNumber

The minimum required number of transactions in order for the offer to be applied. Applicable only for reward offers classified as REWARD_LOYALTY_TRANSACTION_NUMBER_BASED and REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED

REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available form CRM.COM R12.0.0


transaction_number_toNumber

The maximum required number of transactions in order for the offer to be applied. This value is optional. Applicable only for reward offers classified as REWARD_LOYALTY_TRANSACTION_NUMBER_BASED

Deprecated in CRM.COM R12.2.0


lottery_transaction_conditions_setSet of Reward Offer Lottery Transaction Conditions Object

A set of the transaction conditions. Applicable only for reward offers classified as LOTTERY

Available from CRM.COM R14.2.0

transaction_period_range_periodTime Period object

The time period that the events will have to be performed within, in order to award the offer. Applicable only for reward offers classified as REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED or REWARD_LOYALTY_TRANSACTION_NUMBER_BASED or REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED.

REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available form CRM.COM R12.0.0


Referred Objects Response Data

 reward_offer_lottery__transaction_conditions object response data

Name

Type

Description

minimum_number_customer_eventsNumber

The minimum number of customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY

Available from CRM.COM R14.2.0

maximum_number_customer_events Number

 The maximum number of customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY

Available from CRM.COM R14.2.0

 customer_event_typeString

 The type of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY. The supported values are:

PURCHASED, REFERRAL, WEB, SOCIAL_MEDIA, ACHIEVEMENT, SPEND_REQUEST, FINANCIAL_ACHIEVEMENT, FINANCIAL_STATEMENT

Available from CRM.COM R14.2.0

minimum_total_amountNumber

The minimum total amount of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or SPEND_REQUEST

Available from CRM.COM R14.2.0

maximum_total_amountNumber

The minimum total amount of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or SPEND_REQUEST

Available from CRM.COM R14.2.0

payment_medium_brandPayment Medium Brand object

The classification of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or FINANCIAL_ACHIEVEMENT

Available from CRM.COM R14.2.0

payment_medium_typePayment Medium Type object

The classification of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or FINANCIAL_ACHIEVEMENT

Available from CRM.COM R14.2.0

 customer_event_classificationCustomer Event Type object

The classification of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY

Available from CRM.COM R14.2.0

Referred Objects Response Data

 payment_medium_brand object response data

Name

Type

Description

id

String

The id of the retrieved payment medium brand

name

String

The name of the retrieved payment medium brand

alternative_code

String

The alternative code of the retrieved payment medium brand

descriptionString

The description  of the retrieved payment medium brand

 

 payment_medium_type object response data

Name

Type

Description

id

String

The id of the retrieved payment medium type

name

String

The name of the retrieved payment medium type

alternative_code

String

The alternative code of the retrieved payment medium type

descriptionString

The description  of the retrieved payment medium type

 

 customer event classification object response data

Name

Type

Description

id

String

The id of the retrieved customer event classification

name

String

The name of the retrieved customer event classification

alternative_code

String

The alternative code of the retrieved customer event classification

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS