Page Comparison

Tip
Available from CRM.COM R10.0.0

Excerpt
This method returns information related with reward offers. Multiple reward offers 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 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_post
	V4:accounts_receivable_identifier_post

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 identifier

The 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, SPEND_INSTANTLY or SPEND_INSTANTLY_THROUGH_VOUCHER

Tip
Available from CRM.COM R10.0.0

Tip
Spend instantly on voucher method available from CRM.COM R14.2.0

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

Tip
Available from CRM.COM R14.2.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_product_brand

(optional)

Product Brand identifier

The identifier of the brand 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 brand identifier fields are the following:

Include Page

	V4:product_brand_identifier
	V4:product_brand_identifier

Tip
Available from CRM.COM R15.0.0

purchase_product_category

(optional)

Product Category identifier

The identifier of the category 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 category identifier fields are the following:

Include Page

	V4:product_category_identifier
	V4:product_category_identifier

Tip
Available from CRM.COM R15.0.0

purchase_amount

(optional)

Number

The 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)

Number

The 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

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

...

Expand

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:

Code Block

language	js

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "number": "81",
      "name": "Utilise ET",
      "privacy_level": null,
      "log_information": {
        "updated_date": "2016-05-26T09:23:05",
        "created_date": "2016-05-26T09:15:09",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "owned_by_group": {
        "community_name": "Internal Community",
        "id": "84F33366CB592BAAE7E2044D93611C6A",
        "name": "Main Group",
        "description": "Main Group",
        "alternative_code": "MG1"
      },
      "life_cycle_state": "EFFECTIVE",
      "reward_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "id": "EA5CCE98F857F3A928E3AA6891323088",
        "name": "Sales Scheme",
        "description": "Sales Scheme - TC10",
        "alternative_code": "SS"
      },
      "type": {
        "classification": "UTILISE_FREE_CAPACITY",
        "id": "4ADADCD342A55A483E324F63DE4D54E5",
        "name": "Utilise Free Capacity",
        "description": "Utilise Free Capacity",
        "alternative_code": "UFC"
      },
      "id": "3064E7C123B64B47B10E8D4802EA10AA",
      "spend_conditions_set": {
        "allowed_spend_period_after_award": {
          "time_period_value": null,
          "time_period_uot": null
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        }
      },
      "description": null,
      "award_percentage": null,
      "award_conditions_set": {
        "product_conditions_set": {
          "product_set": [
            {
              "product_family": {
                "id": "63D78575AE1C47513C19765F9AAF857A",
                "name": "Analogue",
                "description": null,
                "code": null
              },
              "product_type": null,
              "product": null
            }
          ]
        },
        "organisational_unit_conditions_set": [],
        "time_conditions_set": {
          "days_condition_set": [
            [
              {
                "day_of_week": "TUESDAY"
              },
              {
                "day_of_week": "WEDNESDAY"
              },
              {
                "day_of_week": "THURSDAY"
              },
              {
                "day_of_week": "FRIDAY"
              }
            ]
          ],
          "hours_condition_set": [
            {
              "from": null,
              "to": 23
            }
          ]
        }
      },
      "category": null,
      "latest_effective_date": "2016-05-26 09:16:10.0",
      "alternative_code": "UE"
    }
  ]
}

...

Versions Compared

Old Version 1

New Version 2

Key

Resource URL

Parameters