Page Comparison

Tip
Available from CRM.COM R14.3.0 For previous releases check the GET reward_offers/show (legacy) Web API

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

...

Name

Type

Description

token

String

The token retrieved from the login method

group_identifier

(optional)

Group Identifier

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

Include Page

	V4:group_identifier
	V4:group_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

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

Include Page

	V4:reward_offer_category_identifier
	V4:reward_offer_category_identifier

Note
Deprecated from CRM.COM R15.0.0

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

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

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

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

...

Examples

{ "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" } ]

{

"data": [

{

"award_valid_from": "2019-04-15T13:12:46",

"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-03-13T17:49:18",

"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:12:46",

"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": 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

}

},

{

"award_valid_from": "2019-04-15T13:12:46",

"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:12:46",

"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

}

},

{

"award_valid_from": "2019-04-15T13:12:46",

"alternative_code": "STW",

"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-21T11:11:38",

"updated_date": "2018-12-21T11:12:28",

"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-21T11:11:41",

"life_cycle_state": "EFFECTIVE",

"classification": "XTH_TRANSACTION_WINS",

"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",

"latest_effective_date": "2018-12-21T11:11:41",

"number": "ROS17",

"award_valid_to": null,

"name": "second transaction wins",

"apply_on_top_of_other_applicable_offers": true,

"id": "BF40515EAE804E209D4693D0BF70C6A9",

"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

}

},

{

"award_valid_from": "2019-04-15T13:12:46",

"alternative_code": "1OA",

"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:42:11",

"updated_date": "2019-01-14T13:42:16",

"updated_by_user": {

"person_name": "joseph ioannou",

"id": "816C8875D4C34F8890B7CDD5B8322DBC",

"email": "j_ioannou@crm.com",

"username": "j_ioannou"

},

"created_by_user": {

"person_name": "joseph ioannou",

"id": "816C8875D4C34F8890B7CDD5B8322DBC",

"email": "j_ioannou@crm.com",

"username": "j_ioannou"

}

},

"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": "2019-01-14T13:42:16",

"life_cycle_state": "EFFECTIVE",

"classification": "UTILISE_FREE_CAPACITY",

"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",

"latest_effective_date": "2019-01-14T13:42:16",

"number": "ROS19",

"award_valid_to": null,

"name": "1% on all",

"apply_on_top_of_other_applicable_offers": false,

"id": "EBFF7BD28C514946B6D8BA2541639105",

"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

}

},

{

"award_valid_from": "2019-04-15T13:12:46",

"alternative_code": "1COCD",

"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-22T15:04:27",

"updated_date": "2019-01-22T15:04:31",

"updated_by_user": {

"person_name": "joseph ioannou",

"id": "816C8875D4C34F8890B7CDD5B8322DBC",

"email": "j_ioannou@crm.com",

"username": "j_ioannou"

},

"created_by_user": {

"person_name": "joseph ioannou",

"id": "816C8875D4C34F8890B7CDD5B8322DBC",

"email": "j_ioannou@crm.com",

"username": "j_ioannou"

}

},

"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": "2019-01-22T15:04:31",

"life_cycle_state": "EFFECTIVE",

"classification": "UTILISE_FREE_CAPACITY",

"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",

"latest_effective_date": "2019-01-22T15:04:31",

"number": "ROS21",

"award_valid_to": null,

"name": "10% cashback on Cold Drinks",

"apply_on_top_of_other_applicable_offers": false,

"id": "3EE93FC9EE5A4DD497D39107089ED3D6",

"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

}

},

{

"award_valid_from": "2019-04-15T13:12:46",

"alternative_code": "S_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": "MU",

"group_name": "Main Group",

"community_name": "Main Community",

"name": "Main Unit",

"description": "Main Unit",

"id": "1"

},

"created_date": "2019-02-01T13:58:42",

"updated_date": "2019-04-12T14:00:02",

"updated_by_user": {

"person_name": "STAGING DATABASE SYS",

"id": "D151F282F81044939F0515C3E16C2FF1",

"email": null,

"username": "Staging Database"

},

"created_by_user": {

"person_name": "joseph ioannou",

"id": "816C8875D4C34F8890B7CDD5B8322DBC",

"email": "j_ioannou@crm.com",

"username": "j_ioannou"

}

},

"latest_evaluation_date": "2019-04-12 14: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": "2019-02-01T14:04:59",

"life_cycle_state": "EFFECTIVE",

"classification": "REWARD_SIGN_UPS",

"evaluation_method": "BATCH_PROCESS",

"latest_effective_date": "2019-02-01T14:04:59",

"number": "ROS23",

"award_valid_to": null,

"name": "SignUp",

"apply_on_top_of_other_applicable_offers": false,

"id": "4EA340F3ABA345E2BF03F646C2C8B2E1",

"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": 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": ""

}

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

Expand

title	Example 2

HTTP Method: POST

Request:

Code Block

Body:

Code Block

Response:

Code Block

language	js

...

Versions Compared

Old Version 20

New Version 21

Key

Examples