...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Excerpt |
|---|
This method returns the reward offers that are applicable for a specific rewards participant. Multiple reward offers are returned by each call |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
rewards_participant_identifier
(semi-optional)
...
The identifier of the rewards participant who might benefit from the reward offer that will be returned as a result. The allowed rewards participant identifier fields are the following:
...
accounts_receivable_identifier
(semi-optional)
...
The identifier of the rewards participant's accounts receivable. The allowed accounts receivable identifier fields are the following:
...
wallet_identifier
(semi-optional)
...
The identifier of the reward participant's wallet. The allowed wallet identifier fields are the following:
...
group_identifier
(optional)
...
The identifier of the group that will provide the reward offer. The group is filtered against the reward offer's Award conditions organisational units. The allowed unit identifier fields are the following:
...
unit_identifier
(optional)
...
reward_scheme_identifier
(optional)
...
The identifier of the reward scheme related with the reward offer that should be returned as a result. The allowed reward scheme identifier fields are the following:
...
type_identifier
(optional)
...
The identifier of the reward offer type related with the reward offer that should be returned as a result. The allowed reward offer type identifier fields are the following:
...
evaluation_method
(optional)
...
The identifier of the reward offer evaluation method related with the reward offer that should be returned as a result. The allowed reward offer evaluation method identifier fields are the following:BATCH_PROCESS or BATCH_PROCESS_AND_INTERACTIVELY.
...
award_scope
(optional)
...
The identifier of the award scope related with the reward offer that should be returned as a result. The allowed award scope identifier fields are the following: APPLY_AWARD_PER_TRANSACTION_ITEM or APPLY_AWARD_PER_TRANSACTION.
| Tip |
|---|
Available from CRM.COM R10.0.0 |
...
spend_method
(optional)
...
The identifier of the reward offer spend method related with the reward offer that should be returned as a result. The allowed reward offer spend method identifier fields are the following: SPEND_ON_REQUEST, SPEND_INSTANTLY or SPEND_INSTANTLY_THROUGH_VOUCHER
| Tip |
|---|
Available from CRM.COM R10.0.0 |
...
Spend instantly on voucher method available from CRM.COM R14.2.0
...
award_currency
(optional)
...
The identifier of the currency in which the reward offer will award rewards participants. The allowed currency identifier fields are the following:
...
| Tip |
|---|
Available from CRM.COM R14.2.0 |
...
purchase_product
(optional)
...
The identifier of the product which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product identifier fields are the following:
...
purchase_product_type
(optional)
...
The identifier of the product type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product type identifier fields are the following:
...
purchase_product_family
(optional)
...
The identifier of the family type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product family identifier fields are the following:
...
purchase_product_brand
(optional)
...
The identifier of the brand which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product brand identifier fields are the following:
...
| Tip |
|---|
Available from CRM.COM R15.0.0 |
...
purchase_product_category
(optional)
...
The identifier of the category type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product category identifier fields are the following:
...
| Tip |
|---|
Available from CRM.COM R15.0.0 |
...
purchase_amount
(optional)
...
number_of_purchases
(optional)
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions
- As input parameters one of the following semi-optional parameters must be specified:
- rewards_participant_identifier
- accounts_receivable_identifier
- wallet_identifier
- The rest of the input parameters are optional
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
| Code Block |
|---|
|
Body:
| Code Block |
|---|
|
Response:
| Code Block | ||
|---|---|---|
| ||
|
...
| title | Example 2 |
|---|
HTTP Method: POST
Request:
| Code Block |
|---|
|
Body:
| Code Block |
|---|
|
Response:
...
| language | js |
|---|
...
| Tip |
|---|
| Excerpt |
|---|
This method returns the reward offers that are applicable for a specific rewards participant. Multiple reward offers are returned by each call |
Resource URL
Parameters
Name | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||||
rewards_participant_identifier (semi-optional) | Rewards participant identifier | The identifier of the rewards participant who might benefit from the reward offer that will be returned as a result. The allowed rewards participant identifier fields are the following:
| ||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the rewards participant's accounts receivable. The allowed accounts receivable identifier fields are the following:
| ||||||||
wallet_identifier (semi-optional) | Wallet identifier | The identifier of the reward participant's wallet. The allowed wallet identifier fields are the following:
| ||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will provide the reward offer. The group is filtered against the reward offer's Award conditions organisational units. The allowed unit identifier fields are the following:
| ||||||||
unit_identifier (optional) | Unit identifier | The identifier of the unit that will provide the reward offer. The unit is filtered against the reward offer's Award conditions organisational units. The allowed unit identifier fields are the following:
| ||||||||
business_unit_identifier (optional) | Business Unit identifier | The identifier of the business unit that will provide the reward offer. The business unit is filtered against the reward offer's Award conditions organisational units. The allowed business unit identifier fields are the following:
| ||||||||
reward_scheme_identifier (optional) | Reward scheme identifier | The identifier of the reward scheme related with the reward offer that should be returned as a result. The allowed reward scheme identifier fields are the following:
| ||||||||
evaluation_method (optional) | Reward offer evaluation method identifier | The identifier of the reward offer evaluation method related with the reward offer that should be returned as a result. The allowed reward offer evaluation method identifier fields are the following:BATCH_PROCESS or INTERACTIVELY. | ||||||||
spend_method (optional) | Reward Offer spend method | The identifier of the reward offer spend method related with the reward offer that should be returned as a result. The allowed reward offer spend method identifier fields are the following: SPEND_ON_REQUEST, SPEND_INSTANTLY or SPEND_INSTANTLY_THROUGH_VOUCHER | ||||||||
award_currency (optional) | Currency Identifier | The identifier of the currency in which the reward offer will award rewards participants. The allowed currency identifier fields are the following:
| ||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call | ||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number | ||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- As input parameters one of the following semi-optional parameters must be specified:
- rewards_participant_identifier
- accounts_receivable_identifier
- wallet_identifier
- The rest of the input parameters are optional
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST Request:
Body
Response
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST Request:
Body
Response
|