You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 50
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 |
| classification | String | The classification 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 |
| terms_and_conditions | String | The terms and conditions for the retrieved reward offer |
| 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_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. |
| 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. |
| 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 |
| owned_by_group | Group object | The group that is owning the reward offer |
| 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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |