Versions Compared

Old Version 7

changes.mady.by.user George Rossides

Saved on

compared with

New Version Current

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...


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 a reward offer. A single reward offer is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

reward_offer_identifier

(mandatory)

Reward Offer identifier  

The identifier of the reward offer that should be returned as a result. The allowed reward offer identifier fields are the following:

Include Page
V4:reward_offer_identifier
V4:reward_offer_identifier

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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

HTTP Method: GET

Request: 

Expand
titleExample 1

HTTP Method: GET

Code Block
 

 

Request: 

Code Block
 {{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=9


Response:

Code Block
languagejs
 
Expand
titleExample 2
Code Block
 

Response:

Code Block
languagejs
 
Expand
titleExample 3

HTTP Method: GET

Request: 

Code Block
 

Response:

Code Block
languagejs
 

 

 

 

 

 

 

...

{
    "data": {
        "alternative_code": "RCIO1AS",
        "log_information": {
            "created_by_unit": {
                "name": "Coffee Island",
                "description": null,
                "id": "6AAA640194EA4580B68E271372DDEF18"
            },
            "updated_by_unit": null,
            "created_date": "2019-11-06T14:13:07",
            "updated_date": "2019-11-07T15:03:05",
            "updated_by_user": {
                "id": "A234937DB98646A9BE0E17CE694239EB",
                "username": "coffeeisland"
            },
            "created_by_user": {
                "id": "A234937DB98646A9BE0E17CE694239EB",
                "username": "coffeeisland"
            }
        },
        "latest_evaluation_date": "2019-11-07T15:03:00",
        "reward_scheme": {
            "alternative_code": "R",
            "name": "Coffee Customers",
            "description": "Testing R18",
            "id": "A2007C2BB24B4F9B9AFEC11CE6D8F6BE",
            "life_cycle_state": "EFFECTIVE"
        },
        "owned_by_group": {
            "name": "Coffee Island",
            "description": null,
            "id": "6AAA640194EA4580B68E271372DDEF18"
        },
        "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"
        },
        "life_cycle_state": "EFFECTIVE",
        "classification": "REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED",
        "evaluation_method": "BATCH_PROCESS",
        "latest_effective_date": "2019-11-06T14:13:11",
        "number": "9",
        "award_amount": 2,
        "name": "R18 Coffee Island over 10 amount spend",
        "id": "D9FD143E1C16486B849F49C860504073",
        "category": null,
        "marketing_information": {
            "terms_and_conditions": null,
            "short_description": null,
            "long_description": null,
            "offer_image": {
                "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": ""
    }
}