...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Tip |
---|
Excerpt |
---|
This method returns information related with reward award transactions. Multiple reward award transactions 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 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
|
created_after_date
(semi-optional)
If specified then reward award transactions that were created after the specified date should be retrieved
Tip |
---|
Available from CRM.COM R15.1.0 |
created_before_date
(optional)
If specified then reward award transactions that were created 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...