Page Comparison

...

Tip
Available from CRM.COM R10.0.0

Excerpt
This method returns information related with a reward award transaction. A single rewards awards transaction is returned by each call
Tip
Available from CRM.COM R10.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

reward_award_transaction_identifier

(semi-optional)

String

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

Include Page

	V4:award_reward_transaction_identifier
	V4:award_reward_transaction_identifier

Tip
For releases prior to CRM.COM R10.1.0 this information is mandatory

wallet_transaction_identifier

(semi-optional)

Wallet Transaction identifier

The identifier of the wallet transaction related with the reward award transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:

Include Page

	V4:wallet_transaction_identifier
	V4:wallet_transaction_identifier

Tip
Available from CRM.COM R10.1.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

Restrictions

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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "award_expiration_transaction": {
      "life_cycle_state": "POSTED",
      "amount": 16.5,
      "rewards_participant": {
        "accounts_receivable": {
          "life_cycle_state": "ACTIVE",
          "number": "ACR000334",
          "id": "086FB2E9A502EF1C3E023C07AE3D7795",
          "name": "Georgia Rewards"
        },
        "number": "14",
        "id": "B6BA1AD810A52569932F9065A5CA43D9"
      },
      "number": "14",
      "id": "3A6E1BD5D6A74FE58D0A94A78F4766CF"
    },
    "log_information": {
      "updated_date": "2015-12-19T12:59:19",
      "created_date": "2015-12-10T15:11:12",
      "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"
      }
    },
    "life_cycle_state": "POSTED",
    "wallet_transaction": 
      {
        "notes": null,
        "life_cycle_state": "EFFECTIVE",
        "extra_added_amount": null,
        "amount": 16.5,
        "number": "WT001216",
        "wallet": {
          "life_cycle_state": "EFFECTIVE",
          "accounts_receivable": {
            "account_owner": {
              "last_name": "Rewards",
              "middle_name": null,
              "life_cycle_state": "FINANCIAL",
              "company_profile": null,
              "title": null,
              "first_name": "Georgia",
              "type": "PERSON",
              "id": "3C851B5B39C59316D0FF38ABA0FD6A9B",
              "name": null,
              "company_name": null,
              "demographics": {
                "gender": null,
                "passport_issued_by_country": null,
                "social_security_number": null,
                "passport_number": null,
                "industry_sector": null,
                "name_day": {
                  "month": null,
                  "day": null
                },
                "date_of_birth": {
                  "month": null,
                  "day": null,
                  "year": null
                },
                "id_number": null,
                "industry": null,
                "id_issued_by_country": null
              }
            },
            "life_cycle_state": "ACTIVE",
            "number": "ACR000334",
            "id": "086FB2E9A502EF1C3E023C07AE3D7795",
            "name": "Georgia Rewards"
          },
          "number": "WLT000045",
          "id": "28716D0D48984E7FDA3DF2CFA67A3B61"
        },
        "type": {
          "classification": "CREDIT",
          "id": "981E56423160D488A58635847A84CAA3",
          "name": "Normal Credit",
          "description": "normal credit for wallets",
          "alternative_code": "NC"
        },
        "id": "CEDB242737CF4A38AA975764399F986D"
      },
    "rewards_participant": {
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Rewards",
          "middle_name": null,
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": null,
          "first_name": "Georgia",
          "type": "PERSON",
          "id": "3C851B5B39C59316D0FF38ABA0FD6A9B",
          "name": "Rewards Georgia",
          "company_name": null,
          "demographics": {
            "gender": null,
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "USA",
              "two_character_code": "US",
              "id": "127",
              "name": "UNITED STATES",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": null,
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR000334",
        "id": "086FB2E9A502EF1C3E023C07AE3D7795",
        "name": "Georgia Rewards"
      },
      "number": "14",
      "id": "B6BA1AD810A52569932F9065A5CA43D9"
    },
    "amount": 16.5,
    "number": "270",
    "id": "27F990EF70C6495ABB7F12CFBA798268",
    "reward_offer": {
      "life_cycle_state": "NOT_EFFECTIVE",
      "number": "13",
      "id": "3213950603C66B555958B9E482E04F92",
      "name": "10% cashback (on each purchased item) on customers purchasing SedShoes or SedShirts costing over 100 euros each",
      "description": "10% cashback (on each purchased item) on customers purchasing SedShoes or SedShirts costing over 100 euros each",
      "alternative_code": "1C(EPIOCPSOSCO1EE"
    },
    "customer_events_set": [
      {
        "life_cycle_state": "POSTED",
        "classification": null,
        "number": "306",
        "type": "PURCHASE",
        "id": "67BE5F0C77D445F9A5459015E48AED50"
      }
    ],
    "expiration_date": "2015-12-09T00:00:00"
  }
}

...

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
  "data": {
    "number": "338",
    "amount": 0.27,
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-07-12T06:29:32",
      "updated_date": "2016-07-12T06:29:32",
      "updated_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      }
    },
    "award_expiration_transaction": null,
    "reward_offer": {
      "number": "52",
      "name": "PK_Reward Offer_1",
      "description": null,
      "id": "6644452351BB482483F4A375575D5F73",
      "life_cycle_state": "EFFECTIVE"
    },
    "currency_rate_period": {
      "from_date": "C7D7ED57F21B47028144967E015DCBE5",
      "to_date": 2.3,
      "rate": 2.3,
      "inverse_rate": 0.23000000417232513,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "£",
        "decimal_part_name": null,
        "code": "GBP",
        "integer_part_name": null,
        "id": "9"
      },
      "id": "C7D7ED57F21B47028144967E015DCBE5"
    },
    "id": "3FE3D5E859EA450EA0177BF6849F949B",
    "life_cycle_state": "POSTED",
    "expiration_date": null,
    "wallet_transaction": 
      {
        "number": "711",
        "amount": 0.27,
        "notes": null,
        "wallet": {
          "number": "W0000000159",
          "accounts_receivable": {
            "number": "ACR0000000164",
            "name": "ACR0000000164 Polina Kestora",
            "id": "C6CBAC948E53498F83FF52E6CD8B7221",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
              "company_profile": null,
              "company_name": null,
              "name": null,
              "last_name": "Kestora",
              "id": "F038161F36C845B98CEE7361A8C92157",
              "life_cycle_state": "FINANCIAL",
              "middle_name": null,
              "title": null,
              "type": "PERSON",
              "first_name": "Polina",
              "demographics": {
                "name_day": {
                  "month": null,
                  "day": null
                },
                "id_number": "112233",
                "gender": "FEMALE",
                "date_of_birth": {
                  "month": 3,
                  "year": 1988,
                  "day": 4
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
              }
            }
          },
          "id": "259B796B6DD643D9ADB1ECB24FC8FD45",
          "life_cycle_state": "EFFECTIVE"
        },
        "log_information": {
          "created_by_unit": {
            "alternative_code": "adminunit",
            "name": "Admin Unit",
            "description": "admin unit",
            "id": "1"
          },
          "updated_by_unit": {
            "alternative_code": "adminunit",
            "name": "Admin Unit",
            "description": "admin unit",
            "id": "1"
          },
          "created_date": "2016-07-12T06:29:32",
          "updated_date": "2016-07-12T06:29:32",
          "updated_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "username": "MPAdministrator"
          },
          "created_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "username": "MPAdministrator"
          }
        },
        "id": "F1E7ADC29426454B8FF23652EC3DB98C",
        "life_cycle_state": "EFFECTIVE",
        "extra_added_amount": null,
        "type": {
          "alternative_code": "WC",
          "name": "Wallet Credit",
          "description": "Wallet Credit",
          "id": "CA1B3E67E5A6F899512CEFE24E40875B",
          "classification": "CREDIT"
        }
      },
    "customer_events_set": [
      {
        "number": "160",
        "id": "C8EE5EED95A94A789D728E00C1CD2A1A",
        "life_cycle_state": "POSTED",
        "type": "PURCHASE",
        "classification": null
      }
    ],
    "rewards_participant": {
      "number": "RP0000000019",
      "accounts_receivable": {
        "number": "ACR0000000164",
        "name": "ACR0000000164 Polina Kestora",
        "id": "C6CBAC948E53498F83FF52E6CD8B7221",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Polina Kestora",
          "last_name": "Kestora",
          "id": "F038161F36C845B98CEE7361A8C92157",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Polina",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "112233",
            "gender": "FEMALE",
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": 3,
              "year": 1988,
              "day": 4
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "id": "EA95AA28BE1F4C8B9C983487278210D3"
    }
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Expand

title	Example 3

HTTP Method: GET

Request:

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
  "data": {
    "number": "636",
    "amount": 3.5,
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-07-13T06:44:52",
      "updated_date": "2016-07-13T06:44:52",
      "updated_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      }
    },
    "award_expiration_transaction": null,
    "reward_offer": {
      "number": "48",
      "name": "ET Utilise Free Capacity",
      "description": null,
      "id": "EDC5AF03BD394966B326EE63985928B0",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "currency_rate_period": null,
    "id": "3403576A8F50477493C95FD628FFA9BE",
    "life_cycle_state": "POSTED",
    "expiration_date": null,
    "wallet_transaction": 
      {
        "number": "1000",
        "amount": 3.5,
        "notes": null,
        "wallet": {
          "number": "W0000000063",
          "accounts_receivable": {
            "number": "ACR0000000055",
            "name": "ACR0000000055 Marios Ioannou1",
            "id": "C37CD7044D3B42E4B453B85E2C687B37",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
              "company_profile": null,
              "company_name": null,
              "name": null,
              "last_name": "Ioannou1",
              "id": "35B9443CA25A46DB86B5E45523B4DB9B",
              "life_cycle_state": "FINANCIAL",
              "middle_name": null,
              "title": null,
              "type": "PERSON",
              "first_name": "Marios",
              "demographics": {
                "name_day": {
                  "month": null,
                  "day": null
                },
                "id_number": null,
                "gender": null,
                "date_of_birth": {
                  "month": null,
                  "year": null,
                  "day": null
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
              }
            }
          },
          "id": "0B7D9F949F584D249E8D2F78C9DD4C92",
          "life_cycle_state": "EFFECTIVE"
        },
        "log_information": {
          "created_by_unit": {
            "alternative_code": "adminunit",
            "group_name": "Main Group",
            "community_name": "Community",
            "name": "Admin Unit",
            "description": "admin unit",
            "id": "1"
          },
          "updated_by_unit": {
            "alternative_code": "adminunit",
            "group_name": "Main Group",
            "community_name": "Community",
            "name": "Admin Unit",
            "description": "admin unit",
            "id": "1"
          },
          "created_date": "2016-07-13T06:44:53",
          "updated_date": "2016-07-13T06:44:53",
          "updated_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "email": "dev@crm.com",
            "username": "MPAdministrator"
          },
          "created_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "email": "dev@crm.com",
            "username": "MPAdministrator"
          }
        },
        "id": "4AAD64AA10E74C14974CC953AD679827",
        "life_cycle_state": "EFFECTIVE",
        "extra_added_amount": null,
        "type": {
          "alternative_code": "WC",
          "name": "Wallet Credit",
          "description": "Wallet Credit",
          "id": "CA1B3E67E5A6F899512CEFE24E40875B",
          "classification": "CREDIT"
        }
      },
    "customer_events_set": [
      {
        "number": "73",
        "id": "EECAC60D2CDF42279AD85C85605B5311",
        "life_cycle_state": "POSTED",
        "type": "PURCHASE",
        "classification": {
          "alternative_code": "PC",
          "name": "Purchase Classification",
          "id": "437DED6938054AD5BEC61BB6AF2B1F65"
        },
        "performed_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        }
      }
    ],
    "rewards_participant": {
      "number": "RP0000000012",
      "accounts_receivable": {
        "number": "ACR0000000055",
        "name": "ACR0000000055 Marios Ioannou1",
        "id": "C37CD7044D3B42E4B453B85E2C687B37",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Marios Ioannou1",
          "last_name": "Ioannou1",
          "id": "35B9443CA25A46DB86B5E45523B4DB9B",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Marios",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": null,
            "gender": null,
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "id": "B012091A7B5F4B0A82A545C44C541337"
    }
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Restrictions