Page Comparison

...

Name

Type

Description

id

String

The ID of the retrieved reward offer

number

String

The number of the retrieved reward offer

name

String

The name of the retrieved reward offer

alternative_code

String

The alternative code of the retrieved reward offer

description

String

The description of the retrieved reward offer

classification

String

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_method

String

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

award_scope

String

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

Tip
Deprecated from CRM.COM R17.0.0

spend_method

String

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_offers

Boolean

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

Tip
Deprecated from CRM.COM R17.0.0

life_cycle_state

String

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

latest_effective_date

Date

The latest effective date of the retrieved reward offer

latest_evaluation_date

Date

The latest date that the reward offer was evaluated. This is applicable only for reward offers with evaluation method equal to BATCH

terms_and_conditions

String

The terms and conditions for the retrieved reward offer

Tip
Available from CRM.COM R15.0.0

award_amount

Number

The awarded amount provided by the reward offer. An awarded amount can be specified in all reward offers classifications. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer.

award_percentage

Number

The award percentage of the financial transaction amount that triggered the award. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer. An offer's awarded percentage can only be specified in the offer is classified as: UTILISE_FREE_CAPACITY, INCREASE_REVENUE_TRANSACTION_BASED, INCREASE_REVENUE_PRODUCT_BASED, REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED and REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED

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.

Tip
Available from CRM.COM R14.2.0

award

_percentage_on_previous_awards

Award Percentage on Previous Awards Object

The award percentage on awards submitted within a specific period of time. Award percentage on previous awards can be specified in all reward offers classifications.

Tip
Available from CRM.COM R10.

1

0.0

reward

award_

scheme

currency

Reward Scheme

Currency Object

The

reward scheme of the retrieved reward offercategoryReward Offer Category ObjectThe category information of the retrieved reward offerreward_offer_validityReward Offer Validity ObjectThe validity settings

currency in which the Reward Offer's award will be provided which can either be in system or the alternative currency.
reward_scheme	Reward Scheme Object	The reward scheme of the retrieved reward offer

reward_award_validity

category

Reward

Award Validity

Offer Category Object

The

award validity settings

category information of the retrieved reward offer

's awarded amount


owned_by_group	Group object	The group that is owning the reward

offer privacy_levelPrivacy level objectThe privacy level of the reward offerlog_informationLog Information ObjectThe log information related with the retrieved reward offermarketing_informationReward Offer Marketing Information Object

The reward offer's marketing information

TipAvailable

offer

Tip
Deprecated from CRM.COM

R12

R18.

2

0.0

voucher_typeVoucher Type ObjectThe type of the voucher that will be issued if the reward offer's awarded amount will be instantly spent through a voucher

(replaced with owned_by_business_unit)

owned_by_business_unit

Business Unit Object

The business unit that is owning the accounts receivable

Tip
Available from CRM.COM

R14

R18.

2

The award percentage that will be applied, based on the value of each specified key performance indicator, as measured through financial statement customer events. This award option is applicable only if the reward offer is classified as REWARD_FINANCIAL_STATEMENTS

TipAvailable from CRM.COM R11.0.0

0.0

award_percentage_on_key_performance_indicator_valuesSet of Award Percentage on Key Performance Indicator Values Objects

marketing_information	Reward Offer Marketing Information Object	The reward offer's marketing information
log_information	Log Information Object	The log information related with the retrieved reward offer

Anchor

	reward offer referred objects
	reward offer referred objects

Referred Objects Response Data

Include Page

	currency_short
	currency_short

Include Page

	reward_offerscheme_award_percentage_on_previous_awardsshort
	reward_scheme_short

Include Page

	reward_offer_award_percentage_on_previouskey_awards_short

Include Page

reward_scheme_short

include

performance_indicator_values_short
	reward_offer_categoryaward_shortrewardpercentage_offeron_category_short

Include Page

reward_offer_validity_short

reward_offer_validitykey_performance_indicator_values_short

Include Page

	reward_offer_award_validitycategory_short
	reward_offer_award_validitycategory_short

Include Page

	group_short
	group_short

Include Page

	privacybusiness_levelunit_short	privacy_level_short

Include Page

	log_information_short	log_informationbusiness_unit_short

Include Page

	reward_offer_marketing_information
	reward_offer_marketing_information

Include Page

	voucherlog_typeinformation_short	voucher_type_short

Include Page

reward_offer_award_percentage_on_key_performance_indicator_values_short

log_information_short

Versions Compared

Old Version 45

New Version Current

Key