| Tip |
|---|
| 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:
| ||||||||
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:
| ||||||||
category_identifier | 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:
| ||||||||
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:
| ||||||||
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
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ "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", HTTP Method: POST Request:
Body
Response
},
},
"color": null,
},
} } }, {
}, "updated_by_unit": {
},
"person_name": "STAGING DATABASE SYS",
},
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
} },
},
},
"file_content_url": null,
},
},
},
} } } ],
} } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Method: POST Request: Code Block | Body: Code Block | Response:
|