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: - INCREASE_REVENUE_TRANSACTION_BASED
- REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED
|
| 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:- INCREASE_REVENUE_TRANSACTION_BASED
- REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED
|
| 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
|
| 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
|
| 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 |
| 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
|
| 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
|
| 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
|
| 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
|
| 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
|
| 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
|
| 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
|
| 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.
|
Referred Objects Response Data
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 |
payment_medium_brand object 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 |
payment_medium_type object response data
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 |
customer event classification object response data
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 |