Award Points

The API Rate Limiting Category is Write API. This endpoint will create a transaction of the type “award”. Award transactions are points credit transactions.

📘

Please Note:

1. To calculate points for an order, priority is given to the product prices. If product prices are not present, the order subtotal will be used to award points. If there is a discount applied on the order, the product prices should also reflect the discount i.e. the discounted product prices should be sent in the API instead of the full price. The sum of product prices should match the order subtotal - the amount on which points are expected to be awarded. Some systems have limitations in sending the discounted prices of products. To handle such situations, we compare the order subtotal with the sum of product prices. In the event that the order subtotal is lesser, we assume that the order discount doesn't reflect in the product prices. So we prorate the product prices and then use those prorated prices for awarding points.
2. If the calculated value of points to be awarded equals zero, the system will throw an error.
   For example, if the product price is 1.27 and the quantity is 1, and the activity rule awards 0.25 points per dollar spent, the total becomes 0.3175. After rounding, this results in 0 points, which triggers the error.

📘

This is the latest version of the Award API. If you are still using the older version of the Award and Purchase API, click here.