List Member Rewards

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

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the List Member Rewards action (under Loyalties).
Fill in the fields below, then reference the result from later steps as {{listMemberRewards.response.data}}.

Request

Path parameters

memberIdstringrequired

Unique loyalty card assigned to a particular customer.

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 200 with an object. Read it in later steps with {{listMemberRewards.response.data.<field>}}.

objectstring

The type of the object represented by JSON.

One oflistDefault "list"

data_refstring

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

One ofdataDefault "data"

dataarray<object>

Contains array of loyalty reward objects.

rewardany

This is an object representing a reward.

assignmentany

This is an object representing a reward assignment.

objectstring

The type of the object represented by JSON.

One ofloyalty_rewardDefault "loyalty_reward"

totalinteger

Total number of loyalty reward objects.

json

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "reward": null,
      "assignment": null,
      "object": "loyalty_reward"
    }
  ],
  "total": 0
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

Was this page helpful?