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

List Member Rewards

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/loyalties/members/{memberId}/rewards \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "reward": {
        "id": "rew_C7wS9eHFDN4CIbXI5PpLSkGY",
        "name": "Material Reward",
        "type": "MATERIAL",
        "parameters": {
          "product": {
            "id": "prod_0b7d7dfb05cbe5c616",
            "sku_id": "sku_0b7d7dfb090be5c619"
          }
        },
        "stock": 4,
        "redeemed": 1,
        "attributes": {
          "description": "Get a Comic Book in Archie's series."
        },
        "created_at": "2022-08-17T07:46:18.619169+00:00",
        "updated_at": "2022-08-17T08:13:48.30747+00:00",
        "metadata": {},
        "object": "reward"
      },
      "assignment": {
        "id": "rewa_pJYQBXSitK2OVPK3XMXZK76X",
        "reward_id": "rew_C7wS9eHFDN4CIbXI5PpLSkGY",
        "related_object_id": "camp_jcErmtGAOmHUAy0oUgkwKnPZ",
        "related_object_type": "campaign",
        "parameters": {
          "loyalty": {
            "points": 39
          }
        },
        "created_at": "2022-08-24T11:40:22.418972+00:00",
        "updated_at": "2022-08-24T13:23:50.409121+00:00",
        "object": "reward_assignment"
      },
      "object": "loyalty_reward"
    },
    {
      "reward": {
        "id": "rew_31M6Za6zkMRfhxYJz4aDo11h",
        "name": "Pay with Points",
        "type": "COIN",
        "parameters": {
          "coin": {
            "exchange_ratio": 1,
            "points_ratio": 1
          }
        },
        "stock": null,
        "redeemed": null,
        "attributes": {},
        "created_at": "2022-06-23T11:06:06.222736+00:00",
        "updated_at": null,
        "metadata": null,
        "object": "reward"
      },
      "assignment": {
        "id": "rewa_wrVYAfXWolq52gnl15dumPCq",
        "reward_id": "rew_31M6Za6zkMRfhxYJz4aDo11h",
        "related_object_id": "camp_jcErmtGAOmHUAy0oUgkwKnPZ",
        "related_object_type": "campaign",
        "created_at": "2022-08-11T14:13:34.581194+00:00",
        "updated_at": null,
        "object": "reward_assignment"
      },
      "object": "loyalty_reward"
    },
    {
      "reward": {
        "id": "rew_Jhq0ecLGSx8eF4pFdlhFr9P6",
        "name": "20% discount",
        "type": "CAMPAIGN",
        "parameters": {
          "campaign": {
            "id": "camp_4B1jDE63pCeSij3HU7gx3gPT",
            "type": "DISCOUNT_COUPONS"
          }
        },
        "stock": null,
        "redeemed": null,
        "attributes": {},
        "created_at": "2022-08-11T09:52:39.032699+00:00",
        "updated_at": null,
        "metadata": {},
        "object": "reward"
      },
      "assignment": {
        "id": "rewa_nFREw86qh1LiqGPRygahNh8Z",
        "reward_id": "rew_Jhq0ecLGSx8eF4pFdlhFr9P6",
        "related_object_id": "camp_jcErmtGAOmHUAy0oUgkwKnPZ",
        "related_object_type": "campaign",
        "parameters": {
          "loyalty": {
            "points": 100
          }
        },
        "created_at": "2022-08-11T14:13:34.581194+00:00",
        "updated_at": null,
        "object": "reward_assignment"
      },
      "object": "loyalty_reward"
    },
    {
      "reward": {
        "id": "rew_Dev2yQLodRV33UKPKHTUQWk1",
        "name": "Get a product",
        "type": "MATERIAL",
        "parameters": {
          "product": {
            "id": "prod_0b2ac1dab28985cb1e",
            "sku_id": null
          }
        },
        "stock": 1,
        "redeemed": 1,
        "attributes": {
          "description": "Product"
        },
        "created_at": "2022-06-13T10:43:15.929621+00:00",
        "updated_at": "2022-08-11T15:59:30.820937+00:00",
        "metadata": null,
        "object": "reward"
      },
      "assignment": {
        "id": "rewa_SV4gMgPXTXDrsoTyqhY1B2ut",
        "reward_id": "rew_Dev2yQLodRV33UKPKHTUQWk1",
        "related_object_id": "camp_jcErmtGAOmHUAy0oUgkwKnPZ",
        "related_object_type": "campaign",
        "parameters": {
          "loyalty": {
            "points": 4000
          }
        },
        "created_at": "2022-08-11T14:13:34.581194+00:00",
        "updated_at": null,
        "object": "reward_assignment"
      },
      "object": "loyalty_reward"
    },
    {
      "reward": {
        "id": "rew_oQEYtUNYcVe2IdBEUBdLfkCD",
        "name": "Get a comic book",
        "type": "MATERIAL",
        "parameters": {
          "product": {
            "id": "prod_0b7d7dfb05cbe5c616",
            "sku_id": null
          }
        },
        "stock": 1,
        "redeemed": 2,
        "attributes": {
          "image_url": "{{internalVoucherifyURL}}",
          "description": "Archie's Series"
        },
        "created_at": "2022-08-11T14:35:44.694611+00:00",
        "updated_at": "2022-08-17T07:52:56.965366+00:00",
        "metadata": {
          "Type": "GR-2"
        },
        "object": "reward"
      },
      "assignment": {
        "id": "rewa_7HHH6TjN7Q9WDr5ZePeZUg5p",
        "reward_id": "rew_oQEYtUNYcVe2IdBEUBdLfkCD",
        "related_object_id": "camp_jcErmtGAOmHUAy0oUgkwKnPZ",
        "related_object_type": "campaign",
        "parameters": {
          "loyalty": {
            "points": 10
          }
        },
        "created_at": "2022-08-11T15:44:12.789086+00:00",
        "updated_at": null,
        "object": "reward_assignment"
      },
      "object": "loyalty_reward"
    }
  ],
  "total": 5
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

memberId · string · required

Unique loyalty card assigned to a particular customer.

Example:

"MmFAzfDe"

Query Parameters

affordable_only · boolean

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

200 - application/json

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

Response body schema for GET v1/loyalties/members/{memberId}/rewards

object · enum<string> · default: list · required

The type of the object represented by JSON.

Available options: list

data_ref · enum<string> · default: data · required

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

Available options: data

data · Loyalties Members Rewards List Response Body Data Item · object[] · required

Contains array of loyalty reward objects.

Show child attributes

total · integer · required

Total number of loyalty reward objects.

Required range: x >= 0