reward_offer_performance

Name

Type

Description

total_number_of_awardsNumberThe number of awards the rewards participant received from the specified offer during the last 12 months.
average_weekly_awarded_amountNumberThe average amount of money per week awarded from this offer during the last 12 months
targeted_number_of_purchasesNumber

The number of purchases that should be done in order for the offer to be awarded. This information comes from the reward offer, if the offer is of classification REWARD_LOYALTY_TRANSACTION_NUMBER_BASED or REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED

From R14.7.0, the Rewards Offer setting "Apply Only If No Spend Requests Were Submitted" is also taken into consideration, so that if enabled, only the purchases which are not related with spend requests are calculated


current_number_of_purchasesNumber

The number of purchases that were done so far if the offer is of classification REWARD_LOYALTY_TRANSACTION_NUMBER_BASED or REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED. The counted purchases must fulfill all the offer's award conditions, should have not been processed for being awarded yet and the purchases are performed within the offer's transaction period range condition.

From R14.7.0, the Rewards Offer setting "Apply Only If No Spend Requests Were Submitted" is also taken into consideration, so that if enabled, only the purchases which are not related with spend requests are calculated

targeted_purchased_amountNumber

The total amount of purchases that should be done in order for the offer to be awarded. This information comes from the reward offer, if the offer is of classification REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED

From R14.7.0, the Rewards Offer setting "Apply Only If No Spend Requests Were Submitted" is also taken into consideration, so that if enabled, only the purchases which are not related with spend requests are calculated


current_purchased_amountNumber

The amount of money that was purchased so far if the offer is of classification REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED. The purchased amount must fulfill all the offer's award conditions, should have not been processed for being awarded yet and the purchases are performed within the offer's transaction period range condition.

From R14.7.0, the Rewards Offer setting "Apply Only If No Spend Requests Were Submitted" is also taken into consideration, so that if enabled, only the purchases which are not related with spend requests are calculated


targeted_dateDate

The date up to which that amount of money should be purchased from the first date of the transaction, if the offer is of classification REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED or REWARD_LOYALTY_TRANSACTION_NUMBER_BASED or REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED

expiration_dateDateThe date the reward offer will expire. If the date is during birthday or nameday then the date is calculated dynamically based on participant's birthday or nameday respectively.
latest_awarded_dateDateThe latest date that the reward offer was awarded
marketing_informationReward Offer Marketing Information Object

The reward offer's marketing information

Referred Objects Response Data

 reward offer marketing information object response data

Name

Type

Description

long_descriptionStringThe offer's long description
short_descriptionStringThe offer's short description
no_awards_status_textString

The text that should appear to inform the participant that he has not been awarded yet.

Deprecated from CRM.COM R17.0.0

times_awarded_status_textString

The text that should appear to inform the participant that the number displayed is the times he has been awarded.

Deprecated from CRM.COM R17.0.0

average_weekly_awarded_amount_textString

The text that should appear to inform the participant that the amount displayed is the average weekly awarded amount.

Deprecated from CRM.COM R17.0.0

offer_imageReward Offer Image ObjectThe reward large (standard) offer image
offer_small_imageReward Offer Image ObjectThe reward small offer image
offer_backgroundReward Offer Background Object

The reward offer background which can be an image or a color

Deprecated from CRM.COM R17.0.0

offer_stamp_imageReward Offer Stamp Image Object

The reward offer stamp image

Available from CRM.COM R15.0.0

Deprecated from CRM.COM R17.0.0

Referred Objects Response Data

 Reward offer Marketing Information Image Object

Name

Type

Description

file_nameStringThe name of the file.
file_content_urlStringThe url that can be used to access the actual content of the file.
file_mime_typeStringThe mime type of the attached file
file_alt_textStringThe alternative text of the attached file, if the file is an image

 Reward scheme Marketing Information Background Object

Name

Type

Description

file_nameStringThe name of the file.
file_content_urlStringThe url that can be used to access the actual content of the file.
file_mime_typeStringThe mime type of the attached file
file_alt_textStringThe alternative text of the attached file, if the file is an image
colorStringThe hexadecimal value of the color that will be used as a background

 Reward offer Marketing Information Stamp Image Object

Name

Type

Description

file_nameStringThe name of the file.
file_content_urlStringThe url that can be used to access the actual content of the file.
file_mime_typeStringThe mime type of the attached file
file_alt_textStringThe alternative text of the attached file, if the file is an image