VOvoucherifyio
Loyalties

List Member Rewards

Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) can get in exchange for loyalty points.

You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card).

Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.

get/v1/loyalties/members/{memberId}/rewards

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/loyalties/members/{memberId}/rewards
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, loyalties

Query parameters

affordable_onlyboolean

Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford.

Response

Returns a list of rewards for the given member_id. Returns a filtered list if the query parameter affordable_only is set to true.

object'list' required

The type of the object represented by JSON.

data_ref'data' required

Identifies the name of the attribute that contains the array of loyalty reward objects.

totalinteger required

Total number of loyalty reward objects.

Example response

{
  "data": [
    {
      "reward": {
        "id": "rew_nIy4gHpQHle2c3pNMwuj7G6j",
        "parameters": {
          "product": {
            "id": "prod_0b7d7dfb05cbe5c616",
            "sku_id": "sku_0b7d7dfb090be5c619"
          }
        },
        "created_at": "2022-08-11T14:49:22.586Z",
        "updated_at": "2022-08-11T16:01:34.885Z"
      },
      "assignment": {
        "id": "rewa_PbIRoMXpwe5QhobW4JKu0VjH",
        "reward_id": "rew_C7wS9eHFDN4CIbXI5PpLSkGY",
        "created_at": "2022-08-11T14:49:22.586Z",
        "updated_at": "2022-08-11T16:01:34.885Z",
        "related_object_id": "camp_wciTvaOfYmAa3EmIIW3QpXXZ"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.