Search

editUsedRewardPointRecord

Edit an existing record in reward point usage history (where an amount has been subtracted from customer’s point balance).

The history (and transactionIDs) can be retrieved with getUsedRewardPointRecords.

Under normal circumstances, you should not use this method; this is only for transfering points history from one customer to another, or for correcting errors in points history. To add or remove points, use subtractCustomerRewardPoints and addCustomerRewardPoints instead.

Related API calls for editing the history of earned reward points are getEarnedRewardPointRecords and editEarnedRewardPointRecord.

Input parameters

Parameter nameDescriptionPossible valueRequired
transactionIDRecord ID.Integer yes
customerIDChange customer ID on the record.Integer
invoiceIDChange invoice ID on the record (the sale that subtracted the points).Integer
campaignIDChange promotion ID (the promotion that caused the points to be subtracted).Integer
warehouseIDChange warehouse (store, location) ID (location where the points were subtracted).Integer
salepointIDChange register ID.Integer
salespersonIDChange cashier who applied the reward point-subtracting promotion.Integer
issuedCouponIDChange ID of the issued coupon (if reward points were exchanged for a coupon). Available only if "Reward point extras" module is enabled on your account.Integer
descriptionChange comment. Available only if "Reward point extras" module is enabled on your account.String

Response

Field nameTypeDescription
transactionIDIntegerTransaction ID.