Versions Compared

Key

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

Name

Type

Description

reward_offerReward Offer ObjectThe information of the reward offer
marketing_information_setSet of Reward Offer Marketing Information

The reward offer's marketing information

offer_expiration_dateDate

The date the 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.

total_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
target_transactionstargeted_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

total_transactions

or REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED

Tip

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

target_amount 

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

Tip

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

total

Tip

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_amount Number

The amount of money that was purchased so far if the offer is of classification REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED

target_amount_date  The

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

Tip

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

This date should be calculated depending on the
  • Transactions Within Period Range field specified on the offer and 
  • the first transaction date in the last 30 days

    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

    Anchor
    reward offer performance referred objects
    reward offer performance referred objects
    Referred Objects Response Data Include Pagereward_offer_shortreward_offer_short

    Include Page
    reward_offer_marketing_information
    reward_offer_marketing_information