How to grant User Points equal to the price of a Commerce Product?

Question

I would like to grant User Point to product owner in amount of product price after a product is sold.

For this I defined a rule as below:

• Events: Completing the checkout process

• Actions: Loop (commerce-order:commerce-line-items)

And I defined a Rules Component as below:

• Conditions: Entity has field (Entity: commerce-line-item, Field: commerce_product)

• Actions: Grant points to a user: (User: commerce-line-item:commerce-product:creator, Points: commerce-line-item:commerce-product:commerce-price:amount)

But when I save component it generates this Error message:

Data selector commerce-line-item:commerce-product:commerce-price:amount for parameter points is invalid.

How I can do that?

Answer 1

At first I tried to answer your question using rules and userpoints module, but I saw that while adding Grant points to a user as action there is no such data selector for selecting the user who has created the product. I found the data selector for selecting the user who is the owner of order, but that is not your requirement. (That is why I clarified this in comments).

I found a module solution to your question. The module uses hook_commerce_checkout_complete(). From the hook page:

Allows modules to perform business logic when an order completes checkout.

This hook coincides with the "Customer completes checkout" event. Only business logic should be performed when this is invoked, such as updating the order status, assigning the order to a user account, or sending notification e-mails. Interaction with the user should instead occur through checkout panes on the checkout completion page.

This is the coding of the module I designed:

YOURMODULE.info file:

name = YOURMODULE
description = Module description
dependencies[] = commerce
dependencies[] = commerce_cart
dependencies[] = commerce_checkout
dependencies[] = userpoints
core = 7.x

UPDATE As suggested by Clive, I have changed the module file so that this custom module will also work with multilingual sites.

YOURMODULE.module file:

/**                                                                             
 * Implements hook_commerce_checkout_complete().                                
 */                                                                             
function YOURMODULE_commerce_checkout_complete($order) {
  // Iterate through every commerce line item added in product.
  foreach (field_get_items('commerce_order', $order, 'commerce_line_items') as $line_item_id) {

    // Load commerce line item by line item id.
    $line_item = commerce_line_item_load($line_item_id['line_item_id']);

    // We do not want to include shipping cost in userpoints.
    if ($line_item->type != 'shipping') {
      // Load commerce product by product id.
      $product = commerce_product_load(field_get_items('commerce_line_item', $line_item, 'commerce_product')[0]['product_id']);

      // Create parameters.
      $params = array(
        'uid' => $product->uid,
        'points' => commerce_currency_amount_to_decimal(field_get_items('commerce_line_item', $line_item, 'commerce_total')[0]['amount'], field_get_items('commerce_line_item', $line_item, 'commerce_total')[0]['currency_code']),
      );

      // Grant userpoints programmatically.
      userpoints_userpointsapi($params);
    }
  }
}

Reference links:

userpoints_userpointsapi($params)

commerce_checkout API

commerce_line_item_load($line_item_id)

commerce_product_load($product_id)

Userpoints: deduct points programmatically

commerce_currency_amount_to_decimal()

Answer 2

As an alternative to the previous answer, which requires custom code, you may want to try the alternative described below to get around that error message ...

Your question seems to be a variation (not a duplicate) of the question "How to grant user User Points equal to certain field's value / calculated value?". Similar to the accepted answer to that question, try to adapt your Rules Component like so:

1. Add these extra Rules Actions before the Rules Action in your Rules Component that causes the error:

   • Set a variable that corresponds to "amount of product price" (as in your question), which appears to be commerce-line-item:commerce-product:commerce-price:amount. Let's assume you name that variable price_amount.
   • Convert data type of that price_amount variable to integer. Let's assume you name that conversion result amount_of_points.
2. Adapt your existing Rules Action (in that Rules Component) so that the number of user points to be granted uses this (calculated + converted) amount_of_points.

PS 1: Such "Convert data type" is simply a matter of how Rules works (by design), so it's not to be considered as a bug either ...

PS 2: I assume your question is about D7.