- Created by Georgia Kountouri, last modified by p_demou (Deactivated) on Jun 01, 2018
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 42 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 BATCH_PROCESS_AND_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 Available from CRM.COM R10.0.0 |
| spend_method | String | The method that will be used to spend the offers which can be SPEND_ON_REQUEST, SPEND_INSTANTLY, SPEND_ON_VOUCHER Available from CRM.COM R10.0.0 Spend on voucher option available from CRM.COM R14.2.0 |
| apply_if_best_award_is_provided | Boolean | If true then the reward offer will be applicable only if the provided award is the best award among other reward offers that might be applicable Available from CRM.COM R10.1.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 |
| 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 REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED is available from CRM.COM R12.0.0 |
| number_of_awarded_participants | Number | The number of the participants to be awarded within the period provided through lottery_award_period parameter. Available only if the reward offer is classified as LOTTERY Available from CRM.COM R14.2.0 |
| 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. 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. Available from CRM.COM R10.1.0 |
| reward_scheme | Reward Scheme Object | The reward scheme of the retrieved reward offer |
| type | Reward Offer Type Object | The type information 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 Available from CRM.COM R12.2.0 |
| 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 Available from CRM.COM R14.2.0 |
| 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 Available from CRM.COM R11.0.0 |
| award_conditions_set | Set of Reward Offer Award Conditions objects | The reward offer's award conditions that should be met in order for the rewards participant to benefit from the reward offer |
| spend_conditions_set | Set of Reward Offer Spend Conditions objects | The reward offer's conditions based on which the rewards participant is allowed to spend the awarded amount |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| award_period_value | Number | The period value |
award_period_uot | String | The period unit of time. The supported values are the following: DAYS, WEEKS, MONTHS |
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 Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
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 |
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 |
| 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:
|
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 |
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 |
| 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:
|
| 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 |
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 The VALID_DURING_BIRTHDAY_PERIOD, VALID_DURING_NAME_DAY_PERIOD, VALID_DURING_RECURRING_PERIOD options are available from CRM.COM R11.1.0 onwards |
| 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 Available from CRM.COM R11.1.0 |
| 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 Available from CRM.COM R11.1.0 |
| 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 Available from CRM.COM R11.1.0 |
| 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 Available from CRM.COM R11.1.0 |
| 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
Available from CRM.COM R12.4.5
|
| 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 Available from CRM.COM R12.4.5 |
| 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 Available from CRM.COM R11.1.0 |
Referred Objects Response Data
| 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 |
| 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
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 |
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 VALID_BASED_ON_REWARD_SCHEME available from CRM.COM R12.2.0 |
| 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. |
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 |
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 Available from CRM.COM R16.2.2 |
description | String | The description of the retrieved group |
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 |
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 |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0 | |
User Object | The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled | |
Unit Object | The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
User Object | The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled |
Referred Objects 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 |
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 |
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 |
String | The email of the retrieved user |
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. Deprecated from CRM.COM R17.0.0 |
| 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. Deprecated from CRM.COM R17.0.0 |
| 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. Deprecated from CRM.COM R17.0.0 |
| 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 Deprecated from CRM.COM R17.0.0 |
| offer_stamp_image | Reward 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
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 |
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 |
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 |
| 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 From CRM.COM R13.1.0 and onwards for voucher types of classification equal to "Electronic Voucher" the supported option is VARIABLE From CRM.COM R14.0.0 and onwards for voucher types of classification equal to "Refund Voucher" the supported option is VARIABLE |
| classification | String | The Classification of the retrieved voucher type Available from CRM.COM R13.1.0 |
| description | String | The Description of the retrieved voucher type |
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 |
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 |
| Name | Type | Description |
|---|---|---|
| birthday_condition | String | Defines whether the offer will be applied on the date of the rewards participant birthday or once during the month of their birthday. Available options are ACTUAL_DAY and DURING_BIRTHDAY_MONTH. Applicable only for reward offers classified as REWARD_ON_BIRTHDAY |
| nameday_condition | String | Defines whether the offer will be applied on the date of the rewards participant nameday or once during the month of their nameday. Available options are ACTUAL_DAY and DURING_NAMEDAY_MONTH. Applicable only for reward offers classified as REWARD_ON_NAMEDAY |
| sign_up_condition | Boolean | Defines whether the offer will be applied on newly signed up reward participants only or not Applicable only for reward offers classified as REWARD_SIGN_UPS |
| referral_condition | Boolean | Defines whether the offer will be applied to an existing Rewards Participant who has referred other new Rewards Participants. Applicable only for reward offers classified as REWARD_REFERRALS |
| just_money_condition | String | It defines how many awards can be provided to each customer by this offer. The available values are ONLY_ONE and MULTIPLE. Applicable only for offers classified as JUST_MONEY. |
| behavior_conditions | Reward Offer Behavior Condition Object | The actions that the Rewards Participant should perform in order for the reward offer to be applied.Applicable only for reward offers classified as REWARD_BEHAVIOR |
| transaction_condition | Reward Offer Transaction Condition Object | The transaction range that the purchase customer event needs to be within, in order to award the offer. Applicable only for reward offers classified as INCREASE_REVENUE_TRANSACTION_BASED, REWARD_LOYALTY_TRANSACTION_AMOUNT, REWARD_LOYALTY_TRANSACTION_NUMBER, REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY, LOTTERY REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY offer type available from CRM.COM R12.0.0 LOTTERY offer type available from CRM.COM R14.2.0 |
| lottery_conditions_creation_period | Lottery Condition Creation Period Object | Period within which the system looks back to retrieve customer events or awards (applicable for both Lottery and Transaction conditions). Available only if the reward offer is classified as LOTTERY Available from CRM.COM R14.2.0 |
| lottery_conditions_set | Set of Reward Offer Lottery Condition Object | The awards of specific reward offers that were provided in order to award the offer. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0 |
| subscription_maturity_condition | Reward Offer Subscription Maturity Condition Object | The subscription maturity information that should be met in order for the offer to be applied. Applicable only for reward offers classified as REWARD_SUBSCRIPTION_MATURITY |
| personal_data_completeness_condition | Reward Offer Personal Data Completeness Conditions Object | The personal data that the rewards participant should provide in order for the offer to be applied. Applicable only for reward offers classified as REWARD_PERSONAL_DATA_COMPLETENESS |
| achievement_conditions | Reward Offer Achievement Conditions Object | The reward offer achievement condition that should be met in order to apply the offer. Applicable only for offers classified as REWARD_ACHIEVEMENTS |
| financial_achievement_conditions | Reward Offer Financial Achievement Conditions Object | The reward offer financial achievement condition that should be met in order to apply the offer. Applicable only for offers classified as REWARD_FINANCIAL_ACHIEVEMENTS |
| financial_statement_conditions | Reward Offer Financial Statement Conditions Object | The reward offer financial statement condition that should be met in order to apply the offer. Applicable only for offers classified as REWARD_FINANCIAL_STATEMENTS Available from CRM.COM R11.0.0 |
| period_conditions | Reward Offer Period Conditions | The reward offer period condition that should be met in order to apply the offer. Applicable only for offers classified as:
|
| time_conditions_set | Set of Reward Offer Time Condition Objects | The time conditions related with the retrieved reward offer award time condition. Applicable only for reward offers classified as:
Time Conditions set available in:
from CRM.COM R12.7.0, R13.3.0 and R14.2.0 onwards |
| product_conditions_set | Set of Reward Offer Product Condition Objects | The product conditions related with the retrieved reward offer award condition. Applicable only for reward offers classified as:
Product Conditions set available in:
from CRM.COM R12.0.0 |
| payment_medium_conditions_set | Set of Payment Medium Condition Objects | A list of payment medium brands and types conditions that should be met in order to apply the offer. Applicable only for offers classified as:
REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available from CRM.COM R12.0.0 |
| location_conditions_set | Set of Location Condition Objects | A list of Location conditions that should be met in order to apply the offer. Applicable only for offers classified as:
REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available from CRM.COM R12.0.0 |
| segment_conditions_set | Set of Segment objects | A list of Segments which consist the reward offer's segment award conditions |
| organisational_unit_conditions_set | Set of Organisational Unit objects | A list of Organisational Units which consist the reward offer's segment award conditions |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| award_facebook_likes | Boolean | Defines whether rewards participants will be awarded if they like a specific Facebook page. |
| facebook_page_like | String | The Facebook page that the Rewards Participant should like in order for the offer to be applied. Applicable only if award_facebook_likes is set to true. |
| award_website_visit | Boolean | Defines whether rewards participants will be awarded if they have visited a specific web site |
| website_url | String | The Website URL that the Rewards Participant should visit in order for the offer to be applied. Applicable only if award_website_visit is set to true. |
Name | Type | Description |
|---|---|---|
| transaction_amount_from | Number | The minimum required transaction amount in order for the offer to be applied. Applicable only for reward offers classified as:
|
| transaction_amount_to | Number | The maximum required transaction amount in order for the offer to be applied. This value is optional. Applicable only for reward offers classified as:
transaction_amount_to deprecated in CRM.COM R12.2.0 for REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED reward offers |
| transaction_number_from | Number | The minimum required number of transactions in order for the offer to be applied. Applicable only for reward offers classified as REWARD_LOYALTY_TRANSACTION_NUMBER_BASED and REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available form CRM.COM R12.0.0 |
| transaction_number_to | Number | The maximum required number of transactions in order for the offer to be applied. This value is optional. Applicable only for reward offers classified as REWARD_LOYALTY_TRANSACTION_NUMBER_BASED Deprecated in CRM.COM R12.2.0 |
| lottery_transaction_conditions_set | Set of Reward Offer Lottery Transaction Conditions Object | A set of the transaction conditions. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0 |
| transaction_period_range_period | Time Period object | The time period that the events will have to be performed within, in order to award the offer. Applicable only for reward offers classified as REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED or REWARD_LOYALTY_TRANSACTION_NUMBER_BASED or REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED. REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available form CRM.COM R12.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| minimum_number_customer_events | Number | The minimum number of customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0 |
| maximum_number_customer_events | Number | The maximum number of customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0 |
| customer_event_type | String | The type of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY. The supported values are: PURCHASED, REFERRAL, WEB, SOCIAL_MEDIA, ACHIEVEMENT, SPEND_REQUEST, FINANCIAL_ACHIEVEMENT, FINANCIAL_STATEMENT Available from CRM.COM R14.2.0 |
| minimum_total_amount | Number | The minimum total amount of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or SPEND_REQUEST Available from CRM.COM R14.2.0 |
| maximum_total_amount | Number | The minimum total amount of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or SPEND_REQUEST Available from CRM.COM R14.2.0 |
| payment_medium_brand | Payment Medium Brand object | The classification of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or FINANCIAL_ACHIEVEMENT Available from CRM.COM R14.2.0 |
| payment_medium_type | Payment Medium Type object | The classification of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or FINANCIAL_ACHIEVEMENT Available from CRM.COM R14.2.0 |
| customer_event_classification | Customer Event Type object | The classification of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium brand |
name | String | The name of the retrieved payment medium brand |
alternative_code | String | The alternative code of the retrieved payment medium brand |
| description | String | The description of the retrieved payment medium brand |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium type |
name | String | The name of the retrieved payment medium type |
alternative_code | String | The alternative code of the retrieved payment medium type |
| description | String | The description of the retrieved payment medium type |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved customer event classification |
name | String | The name of the retrieved customer event classification |
alternative_code | String | The alternative code of the retrieved customer event classification |
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 |
Name | Type | Description |
|---|---|---|
| award_period_value | Number | The period value |
award_period_uot | String | The period unit of time. The supported values are the following: DAYS, WEEKS, MONTHS |
Name | Type | Description |
|---|---|---|
| minimum_number_awards | Number | The minimum number of awards of the specified rewards offer that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0 |
| maximum_number_awards | Number | The maximum number of awards of the specified rewards offer that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0 |
| reward_offer | Reward Offer object | The reward offer that should have awarded the customer within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0 |
Referred Objects 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 |
| description | String | A description of the retrieved reward offer |
| life_cycle_state | String | The life cycle state of the reward offer which can be EFFECTIVE or NOT_EFFECTIVE |
| marketing_information_short_description | String | The offer's short description Available from CRM.COM R12.2.0 |
| reward_scheme | Reward Scheme Object | The reward scheme that the reward offer belongs to Available from CRM.COM R11.0.0 |
Referred Objects 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 |
Name | Type | Description |
|---|---|---|
| uninterrupted_subscription_period | Time Period Object | The uninterrupted subscription period of time that a Rewards Participant needs to have, in order to award the offer |
| maximum_interruption_period | Time Period Object | A maximum interruption threshold, always measured in days |
Referred Objects 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 |
Name | Type | Description |
|---|---|---|
| award_date_of_birth_completeness | Boolean | The offer is applied if the rewards participant completes the date of birth. |
| award_name_day_completeness | Boolean | The offer is applied if the rewards participant completes the nameday |
| data_completeness_period | Personal Data Completeness Period object | Defines the period in date range during which the personal data completeness customer event must be performed in order for the rewards participant to be awarded |
| address_completeness_set | Award Address Completeness Set of objects | A list of address types and the address information that should be completed by the rewards participant in order for the offer to be applied |
| phone_completeness_set | Award Phone Completeness Set of objects | A list of phone types and the address information that should be completed by the rewards participant in order for the offer to be applied |
| email_completeness_set | Award Email Completeness Set of objects | A list of email types and the address information that should be completed by the rewards participant in order for the offer to be applied |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| complete_data_from | Date | The date from which the rewards participant should complete the personal data in order for the offer to be applied |
| complete_data_to | Date | The date until which the rewards participant should complete the personal data in order for the offer to be applied |
Name | Type | Description |
|---|---|---|
| address_type | String | The type of the address that the rewards participant should provide which can either be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
| address_fields_set | Address Field Set of Objects | A list address fields that should be provided by the rewards participant. |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
address_field | String | The address field which should be specified by the rewards participant. The supported values are the following: COUNTRY, STREET NAME, STREET NUMBER, FLOOR, AREA, DISTRICT, CARE OF, PO BOX, PO BOX POSTAL CODE, POSTAL CODE, APARTMENT NUMBER, TOWN, MUNICIPALITY From R14.2.0 the following values are also available: ADDRESS_LINE_1, ADDRESS_LINE_2, STATE_PROVINCE_COUNTY |
Name | Type | Description |
|---|---|---|
| phone_type | String | The type of the phone that the rewards participant should provide which can either be LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
| phone_fields_set | Phone Fields Set of Objects | A list phone fields that should be provided by the rewards participant. |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
phone_field | String | The phone field which should be specified by the rewards participant. The supported values are the following: COUNTRY, AREA CODE, NUMBER, NOTES |
Name | Type | Description |
|---|---|---|
| email_type | String | The type of the email that the rewards participant should provide which can either be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
| email_address | Boolean | Defines that the email address should be specified by the rewards participant in order for this condition to be met |
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: DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description |
|---|---|---|
| days_condition_set | Days Condition set of objects | A set of days on which the customer event should be performed in order to be awarded. |
| hours_condition_set | Hours Condition set of objects | A set of hour ranges during which the customer event should be performed in order to be awarded |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| day_of_week | String | The day of week condition related with the retrieved reward offer time condition. The supported values are the following: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY |
Name | Type | Description |
|---|---|---|
| from | Number | The start of the time period condition related with the retrieved reward offer time condition |
| to | Number | The end of the time period condition related with the retrieved reward offer time condition |
| from_hour_minutes | String | The starting hour from which the customer event should be performed in order to be awarded in HH::MM format which also includes minutes Available form CRM.COM R12.3.0 |
| to-hour_minutes | String | The hour up until which the customer event should be performed in order to be awarded in HH::MM format which also includes minutes Available form CRM.COM R12.3.0 |
Name | Type | Description |
|---|---|---|
| all_products_should_exist | Boolean | Defines whether the product condition is met if all or at least one of the specified products or products of the specified product types or families are included in purchase customer events. Applicable only for reward offers classified as:
Available from CRM.COM R12.0.0 |
| product | Product object | The product related with the retrieved reward offer condition |
| product_type | Product Type object | The product type related with the retrieved reward offer condition |
| product_family | Product Family object | The product family related with the retrieved reward offer condition. Product family condition is applicable for reward offers classified as:
|
| product_brand | Product Brand object | The product brand related with the retrieved reward offer condition. Product brand condition is applicable for reward offers classified as:
Available from CRM.COM R15.0.0 |
| product_category | Product Category object | The product category related with the retrieved reward offer condition. Product category condition is applicable for reward offers classified as:
Available from CRM.COM R15.0.0 |
| purchase_event_amount_condition | Purchase Event Condition object | The amount range that the related product or product type purchase customer event needs to be related with, in order to award the offer. Applicable in conditions related to reward offer which are classified as INCREASE_REVENUE_PRODUCT_BASED |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product Available from CRM.COM R12.3.0 |
| global_rate | Global Rate Object | The global rate of the retrieved product Available from CRM.COM R15.0.0 |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0 |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following:
From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED |
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between
|
| uot | String | The 'UOT' applicable for the rate
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects 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 |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0 |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product family |
| name | String | The Name of the retrieved product family |
| code | String | The code of the retrieved product family |
| description | String | The Description of the retrieved product family |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product brand |
| name | String | The Name of the retrieved product brand |
| alternative_code | String | The Alternative Code of the retrieved product brand |
| description | String | The Description of the retrieved product brand |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product category |
| name | String | The Name of the retrieved product category |
| code | String | The code of the retrieved product category |
| description | String | The Description of the retrieved product category |
| Name | Type | Description |
|---|---|---|
| amount_from | Number | The minimum purchase event amount that is required in order for the reward offer condition to be met |
| amount_to | Number | The maximum purchase event amount that is required in order for the reward offer condition to be met. This amount is optional |
Name | Type | Description |
|---|---|---|
| all_achievements_should_exist | Boolean | Defines whether the achievement condition is met if all of the specified achievement events should exist or at least one. |
| number_of_awards | String | It defines how many awards can be provided to each customer by this offer. The available values are MULTIPLE, ONLY_ONE and ONLY_ONE_PER_PERIOD Available from CRM.COM R11.0.0 |
| number_of_awards_period | Period Object | Defines the period during which a customer will be awarded by the offer only once among all of the achievement events. Applicable only if the number of awards is set to ONLY_ONE_PER_PERIOD Available from CRM.COM R11.0.0 |
| achievement_classifications_set | Set of Customer Event Classification objects | The customer event classification related with the retrieved reward offer condition. Only classifications for ACHIEVEMENTS are included. |
Referred Objects 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: DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved customer event classification |
name | String | The name of the retrieved customer event classification |
alternative_code | String | The alternative code of the retrieved customer event classification |
Name | Type | Description |
|---|---|---|
| all_achievements_should_exist | Boolean | Defines whether the financial achievement condition is met if all of the specified financial achievement event classifications should exist or at least one. |
| number_of_awards | String | It defines how many awards can be provided to each customer by this offer. The available values are MULTIPLE, ONLY_ONE and ONLY_ONE_PER_PERIOD Available from CRM.COM R11.0.0 |
| number_of_awards_period | Period Object | Defines the period during which a customer will be awarded by the offer only once among all of the financial achievement events. Applicable only if the number of awards is set to ONLY_ONE_PER_PERIOD Available from CRM.COM R11.0.0 |
| financial_achievement_amount_range | Financial Achievement Amount Range Object | The minimum and maximum amount that a financial achievement customer event should have in order for this condition to be met. Available from CRM.COM R11.0.0 |
| financial_achievement_classifications_set | Set of Customer Event Classification objects | The customer event classification related with the retrieved reward offer condition. Only classifications for FINANCIAL_ACHIEVEMENTS are included. |
Referred Objects 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: DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description |
|---|---|---|
from_value | Number | The minimum required amount |
to_value | Number | The maximum required amount |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved customer event classification |
name | String | The name of the retrieved customer event classification |
alternative_code | String | The alternative code of the retrieved customer event classification |
Name | Type | Description |
|---|---|---|
| number_of_awards | String | It defines how many awards can be provided to each customer by this offer. The available values are MULTIPLE, ONLY_ONE and ONLY_ONE_PER_PERIOD |
| number_of_awards_period | Period Object | Defines the period during which a customer will be awarded by the offer only once among all of the financial achievement events. Applicable only if the number of awards is set to ONLY_ONE_PER_PERIOD |
| financial_statement_classifications_set | Set of Customer Event Classification objects | The customer event classification related with the retrieved reward offer condition. Only classifications for FINANCIAL_STATEMENTS are included. |
| key_performance_indicator_conditions_set | Set of Key Performance Indicator Condition Objects | The key performance indicator conditions related with the retrieved reward offer condition |
Referred Objects 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: DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved customer event classification |
name | String | The name of the retrieved customer event classification |
alternative_code | String | The alternative code of the retrieved customer event classification |
Name | Type | Description |
|---|---|---|
from_value | Number | The minimum required value |
to_value | Number | The maximum required value |
| key_performance_indicator | Key Performance Indicator Object | The key performance indicator evaluated by the condition |
| product | Product Object | The product which is measured by the evaluated key performance indicator |
Referred Objects 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 |
Name | Type | Description |
|---|---|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product Available from CRM.COM R12.3.0 |
| global_rate | Global Rate Object | The global rate of the retrieved product Available from CRM.COM R15.0.0 |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0 |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following:
From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED |
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between
|
| uot | String | The 'UOT' applicable for the rate
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects 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 |
Name | Type | Description |
|---|---|---|
| payment_medium_brand_condition_set | Payment Medium Brand Condition set of objects |
|
| payment_medium_type_condition_set | Payment Medium Type Condition set of objects | A set of payment medium types which the customer event should be performed in order to be awarded. |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium brand |
name | String | The name of the retrieved payment medium brand |
alternative_code | String | The alternative code of the retrieved payment medium brand |
| description | String | The description of the retrieved payment medium brand |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium type |
name | String | The name of the retrieved payment medium type |
alternative_code | String | The alternative code of the retrieved payment medium type |
| description | String | The description of the retrieved payment medium type |
Name | Type | Description |
|---|---|---|
| area | String | The area in which the rewards participant lives in order to be awarded |
| city | String | The town/city in which the rewards participant lives in order to be awarded |
| district | String | The district in which the rewards participant lives in order to be awarded |
Name | Type | Description |
|---|---|---|
| option | String | Defines whether the condition's segment will be used to include or exclude the Rewards Participants that are allowed to be awarded. Available options are INCLUDE and EXCLUDE |
| segment | Segment object | The segment included in the reward offer's segments condition |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved segment |
| number | String | The number of the retrieved segment |
name | String | The name of the retrieved segment |
alternative_code | String | The alternative code of the retrieved segment |
description | String | The description of the retrieved segment |
Name | Type | Description |
|---|---|---|
| business_unit | Business Unit Object | The business unit included in the reward offer's organisational unit condition Available from CRM.COM R18.0.0 |
| unit | Unit object | The unit included in the reward offer's organisational unit condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit) |
| group | Group object | The group included in the reward offer's organisational unit condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit) |
Referred Objects 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 |
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 Available from CRM.COM R16.2.2 |
description | String | The description of the retrieved group |
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 |
| Name | Type | Description |
|---|---|---|
| allowed_spend_period_after_award | Time Period object | The period during which the awarded amount can be spend since the award was offered. |
| time_conditions_set | Set of Reward Offer Time Condition Objects | The days and time conditions related with the retrieved reward offer spend time condition which define on which days and hours range the awarded amount can be spent. |
| product_conditions_set | Set of Reward Offer Product Condition Objects | The product conditions related with the retrieved reward offer spend condition. |
| organisational_unit_conditions_set | Set of Organisational Unit objects | A list of Organisational Units which consist the reward offer's segment spend conditions |
Referred Objects 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 |
Name | Type | Description |
|---|---|---|
| days_condition_set | Days Condition set of objects | A set of days on which the customer event should be performed in order to be awarded. |
| hours_condition_set | Hours Condition set of objects | A set of hour ranges during which the customer event should be performed in order to be awarded |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| day_of_week | String | The day of week condition related with the retrieved reward offer time condition. The supported values are the following: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY |
Name | Type | Description |
|---|---|---|
| from | Number | The start of the time period condition related with the retrieved reward offer time condition |
| to | Number | The end of the time period condition related with the retrieved reward offer time condition |
| from_hour_minutes | String | The starting hour from which the customer event should be performed in order to be awarded in HH::MM format which also includes minutes Available form CRM.COM R12.3.0 |
| to-hour_minutes | String | The hour up until which the customer event should be performed in order to be awarded in HH::MM format which also includes minutes Available form CRM.COM R12.3.0 |
Name | Type | Description |
|---|---|---|
| product | Product object | The product related with the retrieved reward offer spend condition |
| product_type | Product Type object | The product type related with the retrieved reward offer spend condition |
| product_family | Product Family object | The product family related with the retrieved reward offer spend condition |
| product_brand | Product Brand object | The product brand related with the retrieved reward offer spend condition. Available from CRM.COM R15.0.0 |
| product_category | Product Category object | The product category related with the retrieved reward offer spend condition. Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product Available from CRM.COM R12.3.0 |
| global_rate | Global Rate Object | The global rate of the retrieved product Available from CRM.COM R15.0.0 |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0 |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following:
From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED |
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between
|
| uot | String | The 'UOT' applicable for the rate
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects 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 |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0 |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product family |
| name | String | The Name of the retrieved product family |
| code | String | The code of the retrieved product family |
| description | String | The Description of the retrieved product family |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product brand |
| name | String | The Name of the retrieved product brand |
| alternative_code | String | The Alternative Code of the retrieved product brand |
| description | String | The Description of the retrieved product brand |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product category |
| name | String | The Name of the retrieved product category |
| code | String | The code of the retrieved product category |
| description | String | The Description of the retrieved product category |
Name | Type | Description |
|---|---|---|
| business_unit | Business Unit Object | The business unit included in the reward offer's organisational unit condition Available from CRM.COM R18.0.0 |
| unit | Unit object | The unit included in the reward offer's organisational unit condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit) |
| group | Group object | The group included in the reward offer's organisational unit condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit) |
Referred Objects 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 |
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 Available from CRM.COM R16.2.2 |
description | String | The description of the retrieved group |
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 |
- No labels