post https://loyalty.yotpo.com/api/v2/points/adjust
Adjustment use cases
When adjusting a customer's points, you can provide a positive or negative value depending on the reason for the adjustment.
Below is an overview of common adjustment reasons. You can provide different parameters, depending on the reason for the adjustment.
It's important to note that certain adjustments will only affect the customer's current point balance, while others will also affect their lifetime or total points earned.
Adjustment reasons | Description | point_adjustment_amount | apply_adjustment_to_points_earned |
---|---|---|---|
Reward customer | Reward a customer with points. | Positive integer | TRUE |
Refund points deducted by redemption/expiration | Reimburse a customer if they lost points due to a refund or points expiration. | Positive integer | FALSE |
Redeem points for a discount | Use a customer's points in order to redeem a discount on their behalf. | Negative integer | FALSE |
Remove earned points | Deduct points that were not supposed to be earned, for example - points earned for a purchase that was later refunded or cancelled. | Negative integer | TRUE |
Expire points | Bypass the point expiration date set in your Loyalty & Referrals admin and expire them immediately. | Negative integer | FALSE |