Skip to end of banner
Go to start of banner

reward_offer_performance

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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_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_transactionsNumberThe 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_transactionsNumberThe number of purchases that were done so far if the offer is of classification REWARD_LOYALTY_TRANSACTION_NUMBER_BASED
target_amount 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_purchased_amount The amount of money that was purchased so far if the offer is of classification REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED
target_amount_date  The date up to which that amount of money should 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

Referred Objects Response Data

 reward offer object response data

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

descriptionStringA description of the retrieved reward offer
life_cycle_stateStringThe life cycle state of the reward offer which can be EFFECTIVE or NOT_EFFECTIVE
marketing_information_short_descriptionString

The offer's short description

Available from CRM.COM R12.2.0

reward_schemeReward Scheme Object

The reward scheme that the reward offer belongs to

Available from CRM.COM R11.0.0

Referred Objects Response Data

 reward scheme object response data

Name

Type

Description

id

String

The ID of the retrieved reward scheme

name

String

The name of the retrieved reward scheme

alternative_code

String

The alternative code of the retrieved reward scheme

descriptionStringA description of the retrieved reward scheme
life_cycle_stateStringThe life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE

 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

  • No labels