You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 46
Next »
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 |
| 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 |
| 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 |
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 |
| 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_currency | Currency Object | The currency in which the Reward Offer's award will be provided which can either be in system or the alternative currency. |
| 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.
|
| reward_scheme | Reward Scheme Object | The reward scheme of the retrieved reward offer |
| category | Reward Offer Category Object | The category information of the retrieved reward offer |
| reward_offer_validity | Reward Offer Validity Object | The validity settings of the retrieved reward offer |
| reward_award_validity | Reward Award Validity Object | The award validity settings of the retrieved reward offer's awarded amount |
| owned_by_group | Group object | The group that is owning the reward offer |
| privacy_level | Privacy level object | The privacy level of the reward offer |
| log_information | Log Information Object | The log information related with the retrieved reward offer |
| marketing_information | Reward Offer Marketing Information Object | The reward offer's marketing information |
| voucher_type | Voucher Type Object | The type of the voucher that will be issued if the reward offer's awarded amount will be instantly spent through a voucher |
| award_percentage_on_key_performance_indicator_values | Set of Award Percentage on Key Performance Indicator Values Objects | 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 |
Referred Objects Response Data
currency object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
award percentage on previous awards object response data
Name | Type | Description |
|---|
| percentage | Number | Defines the award percentage that should be applied on the amount of money that was awarded within a period of time
|
| period | Time Period Object | Defines that period of time
|
| applicable_reward_offer_types_set | Set of Reward Offer Type Objects | The reward offer types that should be related with the awards that will be taken into consideration while calculating the amount to be awarded |
| applicable_reward_schemes_set | Set of Reward Scheme Objects | The reward schemes that should be related with the awards that will be taken into consideration while calculating the amount to be awarded |
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
reward_offer_type response data object
| Name | Type | Description |
|---|
| id | String | The ID of the retrieved reward offer type |
| name | String | The Name of the retrieved reward offer type |
| alternative_code | String | The Alternative Code of the retrieved reward offer type |
| description | String | The Description of the retrieved reward offer type |
| classification | String | The Classification of the retrieved reward offer type. Available values are: - UTILISE_FREE_CAPACITY
- REWARD_SIGN_UPS
- REWARD_REFERRALS
- INCREASE_REVENUE_TRANSACTION_BASED
- INCREASE_REVENUE_PRODUCT_BASED
- REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED
- REWARD_LOYALTY_TRANSACTION_NUMBER_BASED
- REWARD_BEHAVIOR
- REWARD_ON_BIRTHDAY
- REWARD_SUBSCRIPTION_MATURITY
- REWARD_PERSONAL_DATA_COMPLETENESS
- REWARD_ACHIEVEMENTS
- JUST_MONEY
- REWARD_FINANCIAL_ACHIEVEMENTS
- REWARD_ON_NAMEDAY
|
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 |
| description | String | A description of the retrieved reward scheme |
| life_cycle_state | String | The life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE |
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 |
| description | String | A description of the retrieved reward scheme |
| life_cycle_state | String | The life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE |
reward_offer_category data object
| Name | Type | Description |
|---|
| id | String | The ID of the retrieved reward offer category |
| name | String | The Name of the retrieved reward offer category |
| code | String | The Code of the retrieved reward offer category |
| description | String | The Description of the retrieved reward offer category |
| parent_id | String | The id of the retrieved category's parent category |
reward offer validity object response data
Name | Type | Description |
|---|
| validity_options | String | Defines the reward offer's validity options. The available values are VALID_FROM_LATEST_EFFECTIVE_DATE and VALID_FOR_SPECIFIC_PERIOD, VALID_DURING_BIRTHDAY_PERIOD, VALID_DURING_NAME_DAY_PERIOD, VALID_DURING_RECURRING_PERIOD
|
| valid_x_days_before_birthday_date | Integer | Defines the number of days before the birthday date during which the offer will become valid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD
|
| valid_x_days_after_birthday_date | Integer | Defines the number of days after the birthday date during which the offer will become invalid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD |
| valid_x_days_before_name_day_date | Integer | Defines the number of days before the name day date during which the offer will become valid. Applicable only when the reward offer's validity option is set to VALID_DURING_NAME_DAY_PERIOD
|
| valid_x_days_after_name_day_date | Integer | Defines the number of days after the name day date during which the offer will become invalid. Applicable only when the reward offer's validity option is set to VALID_DURING_NAME_DAY_PERIOD |
| valid_from | Date | The date from which the reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD or VALID_DURING_NAME_DAY_PERIOD
|
| valid_to | Date | The date that the reward offer should become invalid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD or VALID_DURING_NAME_DAY_PERIOD |
| validity_periods_set | Set of Reward Offer Validity Period objects | The periods during which the retrieved reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_FOR_SPECIFIC_PERIOD. |
| validity_recurring_periods_set | Set of Reward Offer Validity Recurring Period objects | The recurring periods during which the retrieved reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_DURING_RECURRING_PERIOD
|
Referred Objects Response Data
reward_offer_validity_periods response data object
| Name | Type | Description |
|---|
| id | String | The ID of the retrieved reward offer validity period |
| valid_from | Date | The date from which the reward offer will be valid |
| valid_to | Date | The date that the reward offer should become invalid. This is optional as reward offer can be valid for ever, starting from a specific date |
reward_offer_validity_recurring_periods response data object
| Name | Type | Description |
|---|
| id | String | The ID of the retrieved reward offer validity recurring period |
| valid_from | Recurring Period Object | The recurring period that the reward offer should become valid. |
| valid_to | Recurring Period Object | The recurring period that the reward offer should become invalid. |
Referred Objects Response Data
recurring period object response data
Name | Type | Description |
|---|
| day | Integer | The day of the recurring period which can be from 1 up to 31 (depending on the retrieved month) |
| month | Integer | The month of the recurring period which can be from 1 up to 12 |
reward award validity object response data
Name | Type | Description |
|---|
| validity_options | String | Defines the reward offer's awarded amount validity options. The available values are ALWAYS_VALID, VALID_FOR_SPECIFIC_PERIOD and VALID_BASED_ON_REWARD_SCHEME
|
| award_valid_up_to_date | Date | The date until which the reward offer's awarded amount will be valid. Applicable only if the award's validity option is set to VALID_FOR_SPECIFIC_PERIOD and only as long as award_validity_period is not defined.
|
| award_validity_period_duration | Time Period Object | Defines that the awarded amount will be valid for a specific period of time after the related award transaction's creation date. Applicable only if the award's validity option is set to VALID_FOR_SPECIFIC_PERIOD and only as long as award_valid_up_to_date is not defined.
|
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
group object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved group |
name | String | The name of the retrieved group |
community_name | String | The name of the community that the retrieved group belongs to |
alternative_code | String | The alternative code of the retrieved group |
| unified_code | String | The unified code of the retrieved group |
description | String | The description of the retrieved group |
privacy_level object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved privacy level |
| number | String | The number of the retrieved privacy level |
name | String | The name of the retrieved privacy level |
hierarchy_level | String | The hierarchy level of the retrieved privacy level |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
reward offer marketing information object response data
Name | Type | Description |
|---|
| long_description | String | The offer's long description |
| short_description | String | The offer's short description |
| no_awards_status_text | String | The text that should appear to inform the participant that he has not been awarded yet. |
| times_awarded_status_text | String | The text that should appear to inform the participant that the number displayed is the times he has been awarded. |
| average_weekly_awarded_amount_text | String | The text that should appear to inform the participant that the amount displayed is the average weekly awarded amount. |
| offer_image | Reward Offer Image Object | The reward large (standard) offer image |
| offer_small_image | Reward Offer Image Object | The reward small offer image |
| offer_background | Reward Offer Background Object | The reward offer background which can be an image or a color |
| offer_stamp_image | Reward Offer Stamp Image Object | The reward offer stamp image |
Referred Objects Response Data
Reward offer Marketing Information Image Object
Name | Type | Description |
|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
Reward scheme Marketing Information Background Object
Name | Type | Description |
|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
| color | String | The hexadecimal value of the color that will be used as a background |
Reward offer Marketing Information Stamp Image Object
Name | Type | Description |
|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
voucher_type response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved voucher type |
| name | String | The Name of the retrieved voucher type |
| alternative_code | String | The Alternative Code of the retrieved voucher type |
| value_options | String | Defines if the value should be fixed, as defined in the voucher type, or a variable, as defined during the creation of the vouchers. The supported options are FIXED and VARIABLE |
| classification | String | The Classification of the retrieved voucher type |
| description | String | The Description of the retrieved voucher type |
award percentage on key performance indicator values response data
Name | Type | Description |
|---|
| percentage | Number | Defines the award percentage that should be applied on the value of the specified key performance indicator
|
| key_performance_indicator | Key Performance Indicator Objects | The key performance indicator that will be awarded based on its value and the specified percentage |
key performance indicator object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved customer event key performance indicator |
name | String | The name of the retrieved customer event key performance indicator |
alternative_code | String | The alternative code of the retrieved customer event key performance indicator |