Versions Compared

Old Version 9

changes.mady.by.user Evangelos Papadopoulos

Saved on

compared with

New Version 10

changes.mady.by.user Evangelos Papadopoulos

Saved on

Key

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


Tip

 Available from CRM.COM R15.0.0

For previous releases check the GET reward_offers/show (legacy) Web API


Excerpt

This method returns the reward offers that are applicable for a specific rewards participant. Multiple reward offers are returned by each call

...

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

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

...

Expand
titleExample 2

HTTP Method: POST


Request:

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

Body:

Code Block

Response:

js
Code Block
language
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"481"},
"number_of_results":3
}

Response

Code Block
languagejs
{
    "data": [
        {
            "award_valid_from": "2019-04-15T13:39:34",
            "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:39:34",
            "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:39:34",
            "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:39:34",
            "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": ""
    }
}
{
    "data": [
        {
            "award_valid_from": "2019-04-15T13:39:34",
            "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:39:34",
            "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:39:34",
            "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:39:34",
            "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": ""
    }
}