Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R10.0.0

Excerpt

This method returns information related with reward award transactions. Multiple reward award transactions are returned by each call

...

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:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

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:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

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:

Include Page
V4:wallet_identifier
V4:wallet_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

Tip

Available from CRM.COM R10.0.0

submitted_after_date

(optional)

Date

If specified then reward award transactions that were submitted after the specified date should be retrieved

Tip

Available from CRM.COM R12.2.0

submitted_before_date

(optional)

Date

If specified then reward award transactions that were submitted before the specified date should be retrieved

Tip

Available from CRM.COM R12.2.0

created_after_date

(semi-optional)

Date

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)

Date

If specified then reward award transactions that were created before the specified date should be retrieved

Tip

Available from CRM.COM R15.1.0

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

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

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

...