NemoPS » cart rules

Creating welcome coupons for your clients in PrestaShop

Nemo — Mon, 19 Sep 2016 10:46:49 +0000

In this quick tip we will create welcome coupons for our clients, to reward the ones who decide to sign up for an account on our shop.

In order to create a discount code for clients who register new accounts on our store, we must edit the AuthController file. As always, the best practice is to create an override for it, so let’s add a new one inside override/controllers/front/, named AuthController.php
Open it up and add some generic override code inside php tags:

Class AuthController extends AuthControllerCore
{

}

The method we are interested in is sendConfirmationMail. We can get it straight out of the original controller, and I suggest you take it from yours since it might differ from mine (I am using PrestaShop 1.6.1.6):

    protected function sendConfirmationMail(Customer $customer)
    {
        if (!Configuration::get('PS_CUSTOMER_CREATION_EMAIL')) {
            return true;
        }

        return Mail::Send(
            $this->context->language->id,
            'account',
            Mail::l('Welcome!'),
            array(
                '{firstname}' => $customer->firstname,
                '{lastname}' => $customer->lastname,
                '{email}' => $customer->email,
                '{passwd}' => Tools::getValue('passwd'))
            $customer->email,
            $customer->firstname.' '.$customer->lastname
        );
    }

Copy and paste it inside our new override. At this point we can add our code to create the new cart rule, right before it returns the Mail::Send method:

        $cartRuleObj = new CartRule();
        $cartRuleObj->date_from = date('Y-m-d H:i:s');
        $cartRuleObj->date_to = '2046-12-12 00:00:00';
        $cartRuleObj->name[Configuration::get('PS_LANG_DEFAULT')] = 'Welcome coupon';
        $cartRuleObj->quantity = 1;
        $code = Tools::passwdGen();
        while (CartRule::cartRuleExists($code)) { // let's make sure there is no duplicate
            $code = Tools::passwdGen();
        }
        $cartRuleObj->code = $code;
        $cartRuleObj->quantity_per_user = 1;
        $cartRuleObj->reduction_percent = 20;
        $cartRuleObj->reduction_amount = 0;
        $cartRuleObj->free_shipping = 0;
        $cartRuleObj->active = 1;
        $cartRuleObj->minimum_amount = 0;
        $cartRuleObj->id_customer = $customer->id;
        $cartRuleObj->add();

For this example, I am creating a coupon with discount code that will give 20% off the price, that is going to be valid for a virtually indefinite period of time, with a single usage and restricted to this customer.
Make sure you add the following line:


$cartRuleObj->id_customer = $customer->id;

As it is what binds the rule to the current customer instance. Also notice I am generating a random code, and checking if there is any identical one in the database already using a while loop. While there is, we try creating a new one.

At this point, as soon as the customer accesses his account page, he will see the code in the My coupons section. However, as good practice we should really inform him in the account creation email as well. Let’s therefore amend the Mail:Send call as follows, by passing $code to the list of variables:

 return Mail::Send(
            $this->context->language->id,
            'account',
            Mail::l('Welcome!'),
            array(
                '{firstname}' => $customer->firstname,
                '{lastname}' => $customer->lastname,
                '{email}' => $customer->email,
                '{passwd}' => Tools::getValue('passwd')),
                '{coupon}' => $code,
            $customer->email,
            $customer->firstname.' '.$customer->lastname
        );

Great, we are done with php. What we need to do now is edit the corresponding account.html and account.txt emails to reflect the {coupon} variable.
Here is the final php code:

    protected function sendConfirmationMail(Customer $customer)
    {
        if (!Configuration::get('PS_CUSTOMER_CREATION_EMAIL')) {
            return true;
        }

        // nemo tut welcome coupon
        
        $cartRuleObj = new CartRule();
        $cartRuleObj->date_from = date('Y-m-d H:i:s');
        $cartRuleObj->date_to = '2046-12-12 00:00:00';
        $cartRuleObj->name[Configuration::get('PS_LANG_DEFAULT')] = 'Welcome coupon';
        $cartRuleObj->quantity = 1;
        $code = Tools::passwdGen();
        while (CartRule::cartRuleExists($code)) { // let's make sure there is no duplicate
            $code = Tools::passwdGen();
        }
        $cartRuleObj->code = $code;
        $cartRuleObj->quantity_per_user = 1;
        $cartRuleObj->reduction_percent = 20;
        $cartRuleObj->reduction_amount = 0;
        $cartRuleObj->free_shipping = 0;
        $cartRuleObj->active = 1;
        $cartRuleObj->minimum_amount = 0;
        $cartRuleObj->id_customer = $customer->id;
        $cartRuleObj->add();


        return Mail::Send(
            $this->context->language->id,
            'account',
            Mail::l('Welcome!'),
            array(
                '{firstname}' => $customer->firstname,
                '{lastname}' => $customer->lastname,
                '{email}' => $customer->email,
                '{passwd}' => Tools::getValue('passwd')),
                '{coupon}' => $code
            $customer->email,
            $customer->firstname.' '.$customer->lastname
        );
    }

Editing emails in PrestaShop

We have two ways to edit emails in PrestaShop: one is through the back office translations interface, the other is manual. Either will be fine, but I personally usually prefer to modify the html code directly.

Editing PrestaShop emails using the back-office interface

If you choose the first way, you can simply log in to the back office, and reach Localization > Translations. Choose
Email Templates translations from the first dropdown, then your template, and lastly the language, then hit modify.
In the next screen, toggle the Core emails section, and look for one labeled account.

What we want to do is edit the HTML template first, so click on Edit HTML version, and find a good spot where to add the new variable:

Save, then do the same with the text version.

Editing PrestaShop emails’ HTMl directly

The second way is the one I prefer, as the built in editor can often be confusing, when not messy. Once more, we need to make sure we are editing the correct email templates, usually located in the current theme’s folder /mails/ followed by the language ISO.
The files we are interested in are account.html and account.txt. Here is the snippet I added to the html version”


     


    
        
            
                 
                
                    
                        20% off welcome code: {coupon}

Which is basically a copy/paste of the one above, with a modified text. Once again, edit the txt version to add the variable there too.

At this point, make sure the modification is working by creating a new account and seeing if your customer gets the new email template, we are done!

The post Creating welcome coupons for your clients in PrestaShop appeared first on NemoPS.

How to generate PrestaShop Cart Rules in bulk

Nemo — Wed, 24 Aug 2016 10:19:14 +0000

In this quick tip we will see how to create a simple script that generates PrestaShop cart rules with promotional codes in one click

Download Project Files

Watch the Screencast

Subscribe Post Scriptum's Youtube Channel

The post How to generate PrestaShop Cart Rules in bulk appeared first on NemoPS.

Restrict Cart Rules to specific categories in PrestaShop

Nemo — Wed, 22 Jun 2016 09:53:21 +0000

You might want to use discount vouchers on your site, but restrict the usage for certain categories or products. Let’s see how to do it in PrestaShop.

Two cases

In this tutorial, we will see how we can restrict the usage of vouchers for different categories in PrestaShop. There are two ways we can do this, depending on our needs. The first consist of simply restricting the rule to some categories, and apply discounts in the cart to products belonging to them, only.
However, if you really want to exclude the usage of specific vouchers on certain products, there is a more complex procedure to use, which involves coding.

The easy way

If you are happy with having the rule be available on all products, but only affect the ones you want, from a specific category, then the easy way will be enough.
We are assuming you already know How to use Discounts in PrestaShop, so let’s proceed from the Cart Rule configuration page:

Give the rule some generic conditions and a code (so we can test it); then, under restrictions, tick Product selection.
In the “Add a rule concerning” select box, choose categories, then hit add. A new box will appear below, where you can choose the category you want to restrict this voucher to

Then, in the action tab, if you select a discount percentage, you must make sure to check the “selected Products” box, under “Apply a discount to”. This will make sure other products are not affected by the price reduction.
This, however, limits us in the case we want to use another rule (cheapest product?) or free shipping on specific categories only. Therefore, if you have more specific needs, read on.

The advanced way

If you are not happy with the above solution, then you might want to code some extra checks in the CartRule class, to make the rule invalid if your cart contains extra products.
Open up CartRule.php, located in the classes folder, or create an override for it.
Locate the checkValidity method, then the following snippet:

...
  // gonna slow the thing down a bit

        /* This loop checks:
            - if the voucher is already in the cart
            - if a non compatible voucher is in the cart
            - if there are products in the cart (gifts excluded)
            Important note: this MUST be the last check, because if the tested cart rule has priority over a non combinable one in the cart, we will switch them
        */
        $nb_products = Cart::getNbProducts($context->cart->id);
        $otherCartRules = array();
        if ($check_carrier) {
            $otherCartRules = $context->cart->getCartRules();
        }

        ...

Right before it, we need to get products, in case the variable is not set yet, and check for our conditions

        if(!isset($products))
            $products = $context->cart->getProducts();

        if($products)
        {
            // first, let's get our current cart rule ID
            if($this->id == 1) // not thought for extensive usage
            {
                // having them hardcoded here, can be expanded
                $valid_categories = array(7); // Blouses category
            }
            
        }

This part is not thought for an extensive usage, so if you want to use more than a couple of special price rules, you might need to find another way. We are hardcoding the cart rule id, so that this condition is only applied when we are adding it. This will also make sure this rule is removed from the cart, in case other invalid products are added afterwards.
Let’s now check if all products are at least belonging to the Blouses category

        if(!isset($products))
            $products = $context->cart->getProducts();

        if($products)
        {
            // first, let's get our current cart rule ID
            if($this->id == 1) // not thought for extensive usage
            {
                // having them hardcoded here, can be expanded
                $valid_categories = array(7); // Blouses category
                foreach ($products as $prod) {
                    $prod_categories = Product::getProductCategories($prod['id_product']);
                    foreach ($valid_categories as $val_cat) {
                        if(!in_array($val_cat, $prod_categories)) // if the blouse category is not among product categories
                           return (!$display_error) ? false : Tools::displayError('One or more products in your cart are not compatible with this discount'); // we deny the voucher's usage
                    }
                }    
            }
            
        }

If the product is not in any of the valid categories (in this case, just Blouses), then we cannot add the rule. Save and refresh, then clear cache if you used an override.
You can now try adding the rule to the cart. First, with a valid product only. Then remove the rule, add an invalid product, and add the rule back again. You should see a message popping up:

If not, the condition is not triggering, and you have to go back and print a debug of the rule/categories.
If you see the error, you can erase the invalid product, add the voucher again (it should be valid this time), then add the product once more. The rule should be automatically removed from your cart, since it becomes invalid. Unfortunately, there is no way to trigger an error message when this happens.

The post Restrict Cart Rules to specific categories in PrestaShop appeared first on NemoPS.

Prestashop 101 Day 11 – Prestashop Discounts (Cart rules)

Nemo — Fri, 21 Aug 2015 09:16:51 +0000

Let’s start rewarding our customers! Today we’ll have a look at the Prestashop discounts system, known as Cart Rules, and also talk about the feature called Catalog Price Rules.

Running time: 14 mins / 20 mins

Prestashop version: 1.6.1 / 1.5.3.1

Watch the screencast – 1.6 version

Subscribe Post Scriptum's Youtube Channel

Watch the screencast

Subscribe Post Scriptum's Youtube Channel

All series’ lessons

Prestashop 1.6

Prestashop 1.5

The post Prestashop 101 Day 11 – Prestashop Discounts (Cart rules) appeared first on NemoPS.