Versions Compared

Old Version 42

changes.mady.by.user Marina Antoniadou (Unlicensed)

Saved on

compared with

New Version 43

changes.mady.by.user Marina Antoniadou (Unlicensed)

Saved on

Key

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

Available from CRM.COM R10.0.0

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

reward_offer_identifier

(mandatory)

Lead identifier  

The identifier of the reward offer that should be returned as a result. The allowed reward offer identifier fields are the following:

Include Page
V4:reward_offer_identifier
V4:reward_offer_identifier

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 who might benefit from the reward offer that will be returned as a result. 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 rewards participant's accounts receivable. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

wallet_identifier

(semi-optional)

Wallet identifier

The identifier of the reward participant's wallet. The allowed wallet identifier fields are the following:

Include Page
V4:wallet_identifier
V4:wallet_identifier

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:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Unit identifierThe 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:

Include Page
V4:unit_identifier
V4:unit_identifier

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:

Include Page
V4:reward_scheme_identifier
V4:reward_scheme_identifier

type_identifier
(optional)

Reward offer type identifier

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:

Include Page
V4:reward_offer_type_identifier
V4:reward_offer_type_identifier

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 BATCH_PROCESS_AND_INTERACTIVELY.  

award_scope

(optional)

Award Scope identifier

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)

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 or SPEND_INSTANTLY.  

Tip

Available from CRM.COM R10.0.0


purchase_product

(optional)

Product identifier

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:

Include Page
V4:product_identifier
V4:product_identifier

purchase_product_type

(optional)

Product type identifier

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:

Include Page
V4:product_type_identifier
V4:product_type_identifier

purchase_product_family

(optional)

Product family identifier

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:

Include Page
V4:product_family_identifier
V4:product_family_identifier

purchase_amount

(optional)

NumberThe amount of the purchase that the rewards participant will have to make in order to benefit from the reward offer that will be returned as a result

number_of_purchases

(optional)

NumberThe number of purchases that the rewards participant will have to make in order to benefit from the reward offer that will be returned as a result

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_offers/performance

Tip

Available from CRM.COM R12.2.0

This method returns information related with the performance of a rewards participant against a specific reward offer. A single reward offer performance is returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

reward_offer_identifier

(mandatory)

Rewards Offer identifier  

The identifier of the reward offer that should be returned as a result. The allowed reward offer identifier fields are the following:

Include Page
V4:reward_offer_identifier
V4:reward_offer_identifier

rewards_participant_identifier

(mandatory)

Rewards Participant IdentifierThe identifier of the rewards participant for which the performance should be returned. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

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

...

Expand
titleExample 1

HTTP Method: GET

Request: 

 

Code Block
{{server}}/crmapi/rest/v2/reward_offers/performance?token={{token}}&reward_offer_identifier=number=254&rewards_participant_identifier=number=RP0000000364

Response:

Code Block
languagejs
{
    "data": {
        "total_number_of_awards": 1,
        "average_weekly_awarded_amount": 5,
        "targeted_date": "2017-07-19T11:44:59",
        "latest_awarded_date": null"2017-06-08T14:29:43",
        "expiration_date": "Always Valid",
        "targeted_number_of_purchases": 3,
        "marketing_information": {
            "short_description": null,
            "times_awarded_status_text": null,
            "average_weekly_awarded_amount_text": null,
            "long_description": null,
            "no_awards_status_text": null,
            "offer_image": {
                "file_alt_text": null,
                "file_content_url": null
            },
            "offer_background": {
                "color": null,
                "file_alt_text": null,
                "file_mime_type": null
            }
        },
        "current_number_of_purchases": 1
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}