Record a reward redemption for a loyalty program member

Request Information

Headers

NameDescriptionTypeAdditional information
Authentication

Authentication token

string

Required

URI Parameters

NameDescriptionTypeAdditional information
accountid

Your account id

globally unique identifier

Required

Body Parameters

Redemption transaction

ApiLPRedemptionTransaction
NameDescriptionTypeAdditional information
RewardId

integer

None.

MemberId

globally unique identifier

None.

EmployeeId

globally unique identifier

None.

Created

date

None.

Points

integer

None.

Amount

decimal number

None.

StoreNumber

string

None.

Invoice

string

None.

IgnoreWebHook

boolean

None.

Request Formats

application/json

Sample:
{
  "MemberId": "D18879DC-D9CA-490E-A3C2-C21B191186E0",
  "EmployeeId": "6109929A-C482-48AC-9FC2-B3FE73BDCAA5",
  "RewardId": 1,
  "StoreNumber": "StoreNumber",
  "Invoice": "Invoice #",
  "IgnoreWebHook": true
}

Response Information

Resource Description

Redemption transaction object

NameDescriptionTypeAdditional information
Data

ApiLPRedemptionTransaction

None.

Success

boolean

None.

Messages

Collection of ErrorMessage

None.

Response Formats

application/json

Sample:
{
  "Data": {
    "MemberId": "D18879DC-D9CA-490E-A3C2-C21B191186E0",
    "EmployeeId": "6109929A-C482-48AC-9FC2-B3FE73BDCAA5",
    "RewardId": 1,
    "StoreNumber": "StoreNumber",
    "Invoice": "Invoice #"
  },
  "Success": true,
  "Messages": []
}