Page Comparison

...

Available from CRM.COM R14.3.0

...

Tip
Available from CRM.COM R14.3.0 Notice that this API maps to POST reward_offers/get_applicable For previous releases check the POST reward_offers/list (legacy) Web API

Excerpt
This method returns information related with reward offers. Multiple reward offers are returned by each call

Resource URL

Parameters

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:

number_of_resultsBATCH_PROCESS or INTERACTIVELY.

Name

Type

Description

token

String

The token retrieved from the login method

groupclassification_identifier

(optional)

Group Classification Identifier

The identifier of the group owns reward offerclassifications that the reward offers retrieved should be classified as. The allowed unit identifier fields are the following:

Include Page

V4:group_identifier

reward_scheme_identifier

(optional)

Reward scheme identifier

Include Page

V4:reward_scheme_identifier

category_identifier
(optional)

Reward offer category identifier

The identifier of the reward offer category related with the reward offer that should be returned as a result. The allowed reward offer category

UTILISE_FREE_CAPACITY
INCREASE_REVENUE_TRANSACTION_BASED
INCREASE_REVENUE_PRODUCT_BASED
REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED
REWARD_LOYALTY_TRANSACTION_NUMBER_BASED
REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED
REWARD_SIGN_UPS
REWARD_REFERRALS
REWARD_PERSONAL_DATA_COMPLETENESS
REWARD_ACHIEVEMENTS
REWARD_FINANCIAL_STATEMENTS
REWARD_SUBSCRIPTION_MATURITY
JUST_MONEY
LOTTERY
XTH_TRANSACTION_WINS

group_identifier

(optional)

Group Identifier

The identifier of the group owns reward offer. The allowed unit identifier fields are the following:

Include Page

	V4:rewardgroup_offer_category_identifier
	V4:group_identifier

reward_

offer

scheme_

category_

identifier

Note
Deprecated from CRM.COM R15.0.0

evaluation_method

(optional)

Reward offer evaluation method scheme identifier

The identifier of the reward offer evaluation method related scheme related with the reward offer that should be returned as a result. The allowed reward offer evaluation method scheme identifier fields are the following:BATCH_PROCESS or INTERACTIVELY. spend_method

Include Page

	V4:reward_scheme_identifier
	V4:reward_scheme_identifier

category_identifier
(optional)

Reward Offer spend methodoffer category identifier

The identifier of the reward offer

spend method

category related with the reward offer that should be returned as a result. The allowed reward offer

spend method

category identifier fields are the following:

Include Page

	V4:

SPEND

reward_

ON

offer_

REQUEST, SPEND_INSTANTLY or SPEND_INSTANTLY_THROUGH_VOUCHERaward_currency

category_identifier
	V4:reward_offer_category_identifier

Note
Deprecated from CRM.COM R15.0.0

evaluation_method

(optional)

Currency IdentifierReward offer evaluation method identifier

The identifier of the currency in which reward offer evaluation method related with the reward offer will award rewards participantsthat should be returned as a result. The allowed currency reward offer evaluation method identifier fields are the following:

Include Page

V4:currency_identifier

spend_method

(optional)

NumberReward Offer spend method

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

Response Data

...

Examples

...

title	Example 1

HTTP Method: POST

Request:

Code Block
http://cyn1lnx004:9080/crmapi/rest/v2/reward_offers/list

Body

Code Block

{
"token":"163317CACB7441CD88CB01C5427DF6E7",
"accounts_receivable_identifier":{"name":"ACR000879"},
"unit_identifier":{"name":"Test"},
"purchase_product":{"code":"TPG Bundle 3"},
"purchase_product_type":{"name":"Accessories"},
"purchase_product_family":{"name":"Analogue"}
}

Response

...

language	js

...

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:

Include Page

	V4:currency_identifier
	V4:currency_identifier

rewards_participant_identifier

(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_post
	V4:rewards_participants_identifier_post

Tip
Deprecated from CRM.COM R17.0.0

accounts_receivable_identifier

(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_post
	V4:accounts_receivable_identifier_post

wallet_identifier

(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

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

Response Data

Include Page

	V4:reward_offer_complete
	V4:reward_offer_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Code Block
{{server}}/crmapi/rest/v2/reward_offers/list

Body

Code Block
{ "token":"{{token}}", "rewards_participant_identifier":{"number":"33"}, "reward_scheme_identifier":{"name":"Main Rewards Scheme"}, "number_of_results":3 }

Response

Code Block

language	js

{
    "data": [
        {
            "award_valid_from": "2019-04-15T13:25:59",
            "alternative_code": "1OAP",
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "MU",
                    "group_name": "Main Group",
                    "community_name": "Main Community",
                    "name": "Main Unit",
                    "description": "Main Unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "MU",
                    "group_name": "Main Group",
                    "community_name": "Main Community",
                    "name": "Main Unit",
                    "description": "Main Unit",
                    "id": "1"
                },
                "created_date": "2018-02-09T14:07:20",
                "updated_date": "2019-04-15T13:23:01",
                "updated_by_user": {
                    "person_name": "Administrator Company",
                    "id": "1",
                    "email": "crm@crm.com",
                    "username": "mpadministrator"
                },
                "created_by_user": {
                    "person_name": "Eleni Michailidou",
                    "id": "086438FAB99B4704A3B6B971C7695222",
                    "email": "e_michailidou@crm.com",
                    "username": "emichailidou"
                }
            },
            "latest_evaluation_date": null,
            "offer_valid_to": null,
            "reward_scheme": {
                "alternative_code": "MRS",
                "name": "Main Rewards Scheme",
                "description": null,
                "id": "827918B0190B466FA578B14C080F02B8",
                "life_cycle_state": "EFFECTIVE"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "community_name": "Main Community",
                "name": "Main Group",
                "description": "Main Group",
                "id": "1"
            },
            "custom_field_set": [],
            "description": null,
            "spend_method": "SPEND_ON_REQUEST",
            "award_currency": {
                "suffix_symbol": null,
                "prefix_symbol": "€",
                "decimal_part_name": null,
                "code": "EUR",
                "integer_part_name": null,
                "id": "BC91",
                "life_cycle_state": "EFFECTIVE"
            },
            "offer_valid_from": "2018-02-09T14:08:57",
            "life_cycle_state": "EFFECTIVE",
            "classification": "UTILISE_FREE_CAPACITY",
            "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
            "latest_effective_date": "2018-02-09T14:08:57",
            "number": "2",
            "award_valid_to": "2019-04-20T13:25:59",
            "name": "10% off any purchase",
            "apply_on_top_of_other_applicable_offers": false,
            "id": "6A24D2B5E44F44B28451FE021FCAD51E",
            "award_scope": "APPLY_AWARD_PER_TRANSACTION",
            "category": null,
            "marketing_information": {
                "terms_and_conditions": null,
                "short_description": null,
                "times_awarded_status_text": null,
                "offer_stamp_image": {
                    "file_name": "6A24D2B5E44F44B28451FE021FCAD51E_offer_stamp_image_Capture1.JPG",
                    "file_alt_text": "angelosTest",
                    "file_content_url": "/crm/ImageDownloadServlet?id=6A24D2B5E44F44B28451FE021FCAD51E&groupname=offer_stamp_image",
                    "file_mime_type": "image/jpeg"
                },
                "average_weekly_awarded_amount_text": null,
                "long_description": null,
                "no_awards_status_text": null,
                "offer_image": {
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                },
                "offer_background": {
                    "color": null,
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                },
                "offer_small_image": {
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                }
            }
        },
        {
            "award_valid_from": "2019-04-15T13:25:59",
            "alternative_code": "1SU",
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "MU",
                    "group_name": "Main Group",
                    "community_name": "Main Community",
                    "name": "Main Unit",
                    "description": "Main Unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "MU",
                    "group_name": "Main Group",
                    "community_name": "Main Community",
                    "name": "Main Unit",
                    "description": "Main Unit",
                    "id": "1"
                },
                "created_date": "2018-11-28T10:06:03",
                "updated_date": "2019-04-15T11:00:03",
                "updated_by_user": {
                    "person_name": "STAGING DATABASE SYS",
                    "id": "D151F282F81044939F0515C3E16C2FF1",
                    "email": null,
                    "username": "Staging Database"
                },
                "created_by_user": {
                    "person_name": "Josh Ion",
                    "id": "9094CC8E20C44560A17C33C4EBFCA8CA",
                    "email": null,
                    "username": "jioannou"
                }
            },
            "latest_evaluation_date": "2019-04-15 11:00:00.0",
            "offer_valid_to": null,
            "reward_scheme": {
                "alternative_code": "MRS",
                "name": "Main Rewards Scheme",
                "description": null,
                "id": "827918B0190B466FA578B14C080F02B8",
                "life_cycle_state": "EFFECTIVE"
            },
            "owned_by_group": null,
            "custom_field_set": [],
            "description": null,
            "spend_method": "SPEND_ON_REQUEST",
            "award_currency": {
                "suffix_symbol": null,
                "prefix_symbol": "€",
                "decimal_part_name": null,
                "code": "EUR",
                "integer_part_name": null,
                "id": "BC91",
                "life_cycle_state": "EFFECTIVE"
            },
            "offer_valid_from": "2018-11-28T10:06:08",
            "life_cycle_state": "EFFECTIVE",
            "classification": "REWARD_SIGN_UPS",
            "evaluation_method": "BATCH_PROCESS",
            "latest_effective_date": "2018-11-28T10:06:08",
            "number": "ROS11",
            "award_valid_to": null,
            "name": "1st signup",
            "apply_on_top_of_other_applicable_offers": false,
            "id": "C2E3F7DC4FD341818353797C7A862D2E",
            "award_scope": null,
            "category": null,
            "marketing_information": {
                "terms_and_conditions": null,
                "short_description": null,
                "times_awarded_status_text": null,
                "offer_stamp_image": {
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                },
                "average_weekly_awarded_amount_text": null,
                "long_description": null,
                "no_awards_status_text": null,
                "offer_image": {
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                },
                "offer_background": {
                    "color": "#de2525",
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                },
                "offer_small_image": {
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                }
            }
        },
        {
            "award_valid_from": "2019-04-15T13:25:59",
            "alternative_code": "MCO",
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "MU",
                    "group_name": "Main Group",
                    "community_name": "Main Community",
                    "name": "Main Unit",
                    "description": "Main Unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "MU",
                    "group_name": "Main Group",
                    "community_name": "Main Community",
                    "name": "Main Unit",
                    "description": "Main Unit",
                    "id": "1"
                },
                "created_date": "2018-12-11T12:49:39",
                "updated_date": "2018-12-11T12:50:29",
                "updated_by_user": {
                    "person_name": "Administrator Company",
                    "id": "1",
                    "email": "crm@crm.com",
                    "username": "mpadministrator"
                },
                "created_by_user": {
                    "person_name": "Administrator Company",
                    "id": "1",
                    "email": "crm@crm.com",
                    "username": "mpadministrator"
                }
            },
            "latest_evaluation_date": null,
            "offer_valid_to": null,
            "reward_scheme": {
                "alternative_code": "MRS",
                "name": "Main Rewards Scheme",
                "description": null,
                "id": "827918B0190B466FA578B14C080F02B8",
                "life_cycle_state": "EFFECTIVE"
            },
            "owned_by_group": null,
            "custom_field_set": [],
            "description": null,
            "spend_method": "SPEND_ON_REQUEST",
            "award_currency": {
                "suffix_symbol": null,
                "prefix_symbol": "€",
                "decimal_part_name": null,
                "code": "EUR",
                "integer_part_name": null,
                "id": "BC91",
                "life_cycle_state": "EFFECTIVE"
            },
            "offer_valid_from": "2018-12-11T12:50:29",
            "life_cycle_state": "EFFECTIVE",
            "classification": "UTILISE_FREE_CAPACITY",
            "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
            "latest_effective_date": "2018-12-11T12:50:29",
            "number": "ROS13",
            "award_valid_to": null,
            "name": "Merchant C Offer",
            "apply_on_top_of_other_applicable_offers": true,
            "id": "9DE2B75848774F1993789FF332CF7683",
            "award_scope": "APPLY_AWARD_PER_TRANSACTION",
            "category": null,
            "marketing_information": {
                "terms_and_conditions": null,
                "short_description": null,
                "times_awarded_status_text": null,
                "offer_stamp_image": {
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                },
                "average_weekly_awarded_amount_text": null,
                "long_description": null,
                "no_awards_status_text": null,
                "offer_image": {
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                },
                "offer_background": {
                    "color": null,
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                },
                "offer_small_image": {
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                }
            }
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Body:

Response:

Expand

title	Example 2

HTTP Method: POST

Request:

Code Block
{{server}}/crmapi/rest/v2/reward_offers/list

Body

Code Block
{ "token":"{{token}}", "reward_scheme_identifier":{"name":"Global Scheme"}, "number_of_results":5 }

Response

Code Block

language	js

{
    "data": [
        {
            "award_valid_from": "2019-04-15T13:32:08",
            "alternative_code": "1OAP_1",
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Main Community",
                    "name": "Admin Unit",
                    "description": "Admin Unit Description",
                    "id": "B4529D5D06E749B0976A3512EC4AEDE6"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Main Community",
                    "name": "Admin Unit",
                    "description": "Admin Unit Description",
                    "id": "B4529D5D06E749B0976A3512EC4AEDE6"
                },
                "created_date": "2019-01-14T13:45:29",
                "updated_date": "2019-01-29T16:01:14",
                "updated_by_user": {
                    "person_name": "joseph ioannou",
                    "id": "816C8875D4C34F8890B7CDD5B8322DBC",
                    "email": "j_ioannou@crm.com",
                    "username": "j_ioannou"
                },
                "created_by_user": {
                    "createdperson_datename": "2016-05-26T09:15:09joseph ioannou",
        "created_by_unit": {           "community_nameid": "Internal Community816C8875D4C34F8890B7CDD5B8322DBC",
          "id          "email": "48305F8849E3C18B227C5BE3A27BA6DFj_ioannou@crm.com",

         "name": "Admin Unit",           "group_nameusername": "Main Group","j_ioannou"
               "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab." }
            },
            "alternativelatest_evaluation_codedate": "MG"
 null,
      },         "updatedoffer_byvalid_unitto": {null,
            "communityreward_namescheme": "Internal Community", {
                "idalternative_code": "48305F8849E3C18B227C5BE3A27BA6DFGS",
                "name": "AdminGlobal UnitScheme",
          "group_name      "description": "Main Group"null,
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.","id": "EDD7AB96067D44BFB10A2280D1CEA3F3",
                "alternativelife_cycle_codestate": "MGEFFECTIVE"
            },
            "createdowned_by_usergroup": null,
{            "personcustom_field_nameset": "MPAdministrator"[],
            "usernamedescription": "MPAdministrator"null,
            "idspend_method": "1SPEND_ON_REQUEST",
            "emailaward_currency": "sakkascy1986@hotmail.com"{
        },
        "updatedsuffix_by_usersymbol": {null,
                "personprefix_namesymbol": "MPAdministrator€",
          "username": "MPAdministrator",           "id"decimal_part_name": "1"null,
          "email": "sakkascy1986@hotmail.com"     "code": "EUR",
  }       },       "ownedinteger_bypart_groupname": {
  null,
     "community_name": "Internal Community",         "id": "84F33366CB592BAAE7E2044D93611C6ABC91",
        "name": "Main Group",         "description"life_cycle_state": "EFFECTIVE"Main
 Group",         "alternative_code": "MG1" },
     },       "lifeoffer_cyclevalid_statefrom": "EFFECTIVE2019-01-29T16:01:14",
   
  "reward_scheme": {         "life_cycle_state": "EFFECTIVE",
            "idclassification": "EA5CCE98F857F3A928E3AA6891323088UTILISE_FREE_CAPACITY",
  
     "name": "Sales Scheme",         "description"evaluation_method": "Sales Scheme - TC10",BATCH_PROCESS_AND_INTERACTIVELY",
            "alternativelatest_effective_codedate": "SS"
      },
      "type": {2019-01-29T16:01:14",
            "classificationnumber": "UTILISE_FREE_CAPACITYROS20",
        "id    "award_valid_to": "4ADADCD342A55A483E324F63DE4D54E5",null,
            "name": "Utilise1% on Freeall Capacityprod",
        "description": "Utilise Free Capacity",
        "alternative_code": "UFC" "apply_on_top_of_other_applicable_offers": true,
      },       "id": "3064E7C123B64B47B10E8D4802EA10AA42D92B2B58D24DF3A4667623BF6A75E4",
      "spend_conditions_set": {
            "allowed_spend_period_after_award": {award_scope": "APPLY_AWARD_PER_TRANSACTION",
            "time_period_valuecategory": null,
            "timemarketing_period_uotinformation": null{
        },         "productterms_and_conditions_set": [],null,
                "organisational_unit_conditions_setshort_description": []null,
        "time_conditions_set": {       "times_awarded_status_text": null,
  "days_condition_set": [             []
"offer_stamp_image": {
         ],           "hoursfile_condition_setname": []null,
        }       },
      "descriptionfile_alt_text": null,
      "award_percentage": null,       "award_conditions_set": {         "productfile_conditionscontent_seturl": {null,
          "product_set": [           "file_mime_type": null
{               "product_family": { },
                "idaverage_weekly_awarded_amount_text": "63D78575AE1C47513C19765F9AAF857A"null,
                "namelong_description": "Analogue"null,
                "descriptionno_awards_status_text": null,
                "codeoffer_image": null
       {
      },               "productfile_typename": null,
              "product": null     "file_alt_text": null,
      }           ]      "file_content_url": null,
  },         "organisational_unit_conditions_set": [],
        "timefile_conditionsmime_settype": {null
          "days_condition_set": [     },
       [         "offer_background": {
    {                 "day_of_weekcolor": "TUESDAY"null,
              },      "file_name": null,
       {                 "dayfile_ofalt_weektext": "WEDNESDAY"null,
              },           "file_content_url": null,
   {                 "dayfile_ofmime_weektype": null
"THURSDAY"                },
              {  "offer_small_image": {
             "day_of_week": "FRIDAY"      "file_name": null,
       }             ]
"file_alt_text": null,
         ],           "hoursfile_conditioncontent_seturl": [
null,
           {               "fromfile_mime_type": null,
  null
           "to": 23    }
        }    }
      ]  }
    ],
 }   "status": {
  },       "categorycode": null"OK",
        "latest_effective_datedescription": "2016-05-26 09:16:10.0",
        "alternative_codemessage": "UE"
    }
  ]
}

Expand

title	Example 2

HTTP Method: POST

Request:

Code Block

js

Code Block
language

Versions Compared

Old Version 20

New Version Current

Key

Resource URL

Parameters

Response Data

Examples

Response Data

Examples