Versions Compared

Key

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


Name

Type

Description

id

String

The ID of the retrieved reward offer

number

String

The number of the retrieved reward offer

nameStringThe name of the retrieved reward offer
alternative_codeStringThe alternative code of the retrieved reward offer
descriptionStringThe description of the retrieved reward offer
classificationString

The reward offer classification, which can be one of the following:

  • UTILISE_FREE_CAPACITY
  • INCREASE_REVENUE_TRANSACTION_BASED
  • INCREASE_REVENUE_PRODUCT_BASED
  • REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED
  • REWARD_LOYALTY_TRANSACTION_NUMBER_BASED
  • REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED
  • REWARD_SIGN_UPS
  • REWARD_REFERRALS
  • REWARD_PERSONAL_DATA_COMPLETENESS
  • REWARD_ACHIEVEMENTS
  • REWARD_FINANCIAL_STATEMENTS
  • REWARD_SUBSCRIPTION_MATURITY
  • JUST_MONEY
  • LOTTERY
  • XTH_TRANSACTION_WINS
evaluation_methodString

The method that will be used to evaluate the offers which can be BATCH_PROCESS or INTERACTIVELY

award_scopeString

The award scope that defines if the award provided by the reward offer should be applied per transaction or per transaction item, which can be APPLY_AWARD_PER_TRANSACTION or APPLY_AWARD_PER_TRANSACTION_ITEM

spend_methodString

The method that will be used to spend the offers which can be SPEND_ON_REQUEST, SPEND_INSTANTLY, SPEND_INSTANTLY_THROUGH_VOUCHER

apply_on_top_of_other_applicable_offersBoolean

If false then the reward offer will be applicable only if the provided award is the best award among other reward offers that might be applicable. If true then it will be applied irrespective of any other applicable reward offers

life_cycle_state

String

The life cycle state of the retrieved lead which can be EFFECTIVE or NOT EFFECTIVE

latest_effective_dateDateThe latest effective date of the retrieved reward offer
latest_evaluation_dateDateThe latest date that the reward offer was evaluated. This is applicable only for reward offers with evaluation method equal to BATCH
offer_valid_fromDateThe date that the reward offer became valid
offer_valid_toDateThe date that the reward offer expires
award_valid_fromDateThe date that the award will become valid
award_valid_toDateThe date that the award will expire
award_currencyCurrency Object

The currency in which the Reward Offer's award will be provided which can either be in system or the alternative currency.

reward_schemeReward Scheme ObjectThe reward scheme of the retrieved reward offer
categoryReward Offer Category ObjectThe category information of the retrieved reward offer
owned_by_groupGroup object

The group that is owning the reward offer 

Tip

Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)


owned_by_business_unitBusiness Unit Object

The business unit that is owning the reward offer

Tip

Available from CRM.COM R18.0.0


marketing_informationReward Offer Marketing Information Object

The reward offer's marketing information

log_informationLog Information ObjectThe log information related with the retrieved reward offer

Anchor
reward offer referred objects
reward offer referred objects
Referred Objects Response Data

...

Include Page
log_information_short
log_information_short

Include Page
business_unit_short
business_unit_short