Rewards History

Gets status-wise (Active, Cancelled, Redeemed, Reversed, etc.) details of all the rewards of a member.
Note: When the profileId query-param is not specified, this endpoint gets all rewards for all members of a company.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

profileId

string

required

Member's unique profileId, generated in the response of the Enroll Member endpoint - POST /v1/members.

limit

integer

Ending number of the record (from the offset number) in the response. When no value is provided, the default value is 20.

offset

integer

Starting number of the record (within the total number of records) in the response. When no value is provided, the default value is 0.

Response

200 - application/json

Metadata of issued rewards

data

object[]

Rewards data, if applicable

Show child attributes

data.activityDate

string

Activity timestamp (UTC format)

data.amountToRedeem

number

Dollar amount to be redeemed. Maximum amount to be redeemed (or the reward limit) is configurable. When a member has $100 in their loyalty account and the store has a reward limit of $50, they can use two rewards certificates to redeem the amount fully.

data.cancelAuditUser

string

Representative who cancelled the rewards.

Maximum length: 200

data.eligibleRevenue

number

Revenue generated from the items in a transaction that are configured as 'eligible' for earning points.

data.expirationDate

string

Reward expiration time

data.issueAuditUser

string

Representative who issued the rewards.

Maximum length: 200

data.merchantId

string

Merchant ID. If configured, it is returned in the response.

Maximum length: 100

data.merchantName

string

Merchant name

Maximum length: 500

data.pointCost

number

Ratio of dollar value of reward to the points being redeemed. For example, a value of 0.5 indicates that 1 dollar redeemed consumed 2 points.

data.pointsToRedeem

number

Number of points to be redeemed.

data.profileId

string

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

data.redeemAuditUser

string

Representative who redeemed the rewards.

Maximum length: 200

data.redeemedTimestamp

string

Date of redemption (in UTC format)

data.redeemLocationExternalReference

string

External reference (ID or name) of the location where the rewards were redeemed.

Maximum length: 100

data.redemptionCode

string

Redemption code to identify and link the rewards used in a specific transaction. This code is generated in the response of the Issue Variable Rewards endpoint - POST /api/v1/redeem/reward/issue.

data.rewardTypeExternalReference

string

For internal usage only.

Maximum length: 100

data.status

string

Reward status such as Active or Redeemed

Minimum length: 1

errors

object

Error details, if applicable

message

string

Message corresponding to the status

status

integer

Status of the call