| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
reward_award_transaction_identifier (semi-optional) | String | The identifier of the reward award transaction that should be returned as a result. The allowed reward award transaction identifier fields are the following:
| ||||||||
| wallet_transaction_identifier (semi-optional) | Wallet Transaction identifier | The identifier of the wallet transaction related with the reward award transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:
| ||||||||
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 |
...
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 whose reward award transactions should be returned as a results. The allowed rewards participant identifier fields are the following:
| ||||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the accounts receivable related with the rewards participant that should be returned as a result. The allowed accounts receivable identifier fields are the following:
| ||||||||
| wallet_identifier (semi-optional) | Wallet identifier | The identifier of the reward participant's wallet which was affected by the reward award transactions that should be returned as a result. The allowed wallet identifier fields are the following:
| ||||||||
purchase_customer_event_identifier (semi-optional) | Purchase Customer Event identifier | The identifier of the purchase customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
| ||||||||
referral_customer_event_identifier (semi-optional) | Referral Customer Event identifier | The identifier of the referral customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
| ||||||||
social_media_customer_event_identifier (semi-optional) | Social Media Customer Event identifier | The identifier of the social media customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
| ||||||||
web_customer_event_identifier (semi-optional) | Web Customer Event identifier | The identifier of the web purchase customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
| ||||||||
achievement_customer_event_identifier (semi-optional) | Achievement Customer Event identifier | The identifier of the achievement customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
| ||||||||
financial_achievement_customer_event_identifier (semi-optional) | Financial Achievement Customer Event identifier | The identifier of the financial achievement customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
| ||||||||
submitted_after_date (optional) | Date | If specified then reward award transactions that were submitted after the specified date should be retrieved
| ||||||||
submitted_before_date (optional) | Date | If specified then reward award transactions that were submitted before the specified date should be retrieved
| ||||||||
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 |
...
GET reward_transactions/awards/get_allocated_spends
| Tip |
|---|
This method returns information related with the spend reward transactions that were allocated against a specific award reward transaction. Multiple spend reward transactions are retrieved by each call.
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
reward_award_transaction_identifier (semi-optional) | Award Reward Transaction Identifier | The identifier of the award reward transaction that should be retrieved. The allowed award reward transaction identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
reward_spend_transaction_identifier (semi-optional) | String | The identifier of the reward spend transaction that should be returned as a result. The allowed reward spend transaction identifier fields are the following:
| ||||||||
| wallet_transaction_identifier (semi-optional) | Wallet Transaction identifier | The identifier of the wallet transaction related with the reward spend transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:
| ||||||||
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 |
...
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 whose reward spend transactions should be returned as a results. The allowed rewards participant identifier fields are the following:
| ||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the accounts receivable related with the rewards participant whose spend transactions should be returned as a result. The allowed accounts receivable identifier fields are the following:
| ||||||
| wallet_identifier (semi-optional) | Wallet identifier | The identifier of the reward participant's wallet which was affected by the reward spend transactions that should be returned as a result. The allowed wallet identifier fields are the following:
| ||||||
customer_event_identifier (semi-optional) | Customer Event identifier | The identifier of the customer event that triggered the creation of the reward spend transaction that should be returned as a result. Only Spend Request Customer Events are allowed to be specified. The allowed customer event identifier fields are the following:
| ||||||
submitted_after_date (optional) | Date | If specified then reward spend transactions that were submitted after the specified date should be retrieved
| ||||||
submitted_before_date (optional) | Date | If specified then reward spend transactions that were submitted before the specified date should be retrieved
| ||||||
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 |
...
GET reward_transactions/spend/get_allocated_awards
| Tip |
|---|
This method returns information related with the award reward transactions that were allocated against a specific spend reward transaction. Multiple award reward transactions are retrieved by each call.
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
reward_spend_transaction_identifier (semi-optional) | Spend Reward Transaction Identifier | The identifier of the spend reward transaction that should be retrieved. The allowed spend reward transaction identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
reward_award_expiration_transaction_identifier (semi-optional) | String | The identifier of the reward award expiration transaction that should be returned as a result. The allowed reward award expiration transaction identifier fields are the following:
| ||||||||
| wallet_transaction_identifier (semi-optional) | Wallet Transaction identifier | The identifier of the wallet transaction related with the reward award expiration transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:
| ||||||||
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 |
...
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 whose reward award expiration transactions should be returned as a results. The allowed rewards participant identifier fields are the following:
| ||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the accounts receivable related with the rewards participant whose reward award expiration transactions should be returned as a result. The allowed accounts receivable identifier fields are the following:
| ||||||
| wallet_identifier (semi-optional) | Wallet identifier | The identifier of the reward participant's wallet which was affected by the reward award expiration transactions that should be returned as a result. The allowed wallet identifier fields are the following:
| ||||||
award_reward_transaction_identifier (semi-optional) | Award Reward Transaction identifier | The identifier of the reward award transaction which was expired by the reward award expiration transaction that should be returned as a result. The allowed award reward transaction 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 |
...