As you know Magento 2 provides us with four types of cart rules.<\/p>\n\n\n\n
In this blog,\u00a0We will learn how can we add a custom cart rule (Buy X Get next Y with percent discount)<\/p>\n\n\n\n
Let\u2019s start step by step. Step 1:<\/strong> Create file Webkul\\CartRule\\etc\\adminhtml\\di.xml<\/strong><\/p>\n\n\n\n Step 2: <\/strong>We need to create the ValueProvider plugin file which add a custom cart rule option in the cart rules dropdown. Webkul\\CartRule\\Plugin\\Rule\\Metadata\\ValueProvider.php<\/strong><\/p>\n\n\n\n After adding the above code to your custom module. Deploy the code and see the result<\/strong>.<\/p>\n\n\n\n Step 3:<\/strong> Create Webkul\/CartRule\/view\/adminhtml\/ui_component\/sales_rule_form.xml<\/strong> file to add custom fields in the Cart price rule form.<\/p>\n\n\n\n You will see the result in the cart price rule :<\/p>\n\n\n\n Discount Qty (Buy Y)<\/strong>: Set quantity for Y<\/strong> products eligible for discount.<\/p>\n\n\n\n Promo SKU:<\/strong> This field defines the Y products<\/strong>, Enter Y products SKU separated by comma. Enter All SKU(s) if the product is Customisable.<\/p>\n\n\n\n Note:-<\/strong> Non-Promo products SKU are defined as X products<\/strong>.<\/p>\n\n\n\n Step 4:<\/strong> Create a layout file Webkul\/CartRule\/view\/adminhtml\/layout\/sales_rule_promo_quote_edit.xml<\/strong> to add a template file.<\/p>\n\n\n\n Step 5:<\/strong> Create a template Webkul\/view\/adminhtml\/templates\/promo\/customrulejs.phtml<\/strong> file for managing the custom field’s appearance.<\/p>\n\n\n\n Step 6:<\/strong> Configure declarative schema Webkul\/CartRule\/etc\/db_schema.xml<\/strong> file to save custom field data of the Cart price rule form.<\/p>\n\n\n\n Step 7:<\/strong> For Calculation of the custom cart rule, create Webkul\\CartRule\\etc\\di.xml<\/strong><\/span><\/span> file and pass the class as an argument in class Magento\\SalesRule\\Model\\Rule\\Action\\Discount\\Calculator<\/strong><\/span><\/p>\n\n\n\n Step 8:<\/strong> Create class Webkul\\CartRule\\Model\\Rule\\Action\\Discount\\BuyXGetNextYWithPercent.php<\/strong> file which is passed as an argument in the above file.<\/p>\n\n\n\n The discount will be applicable only if the product, for which the admin defines the Promo SKU is present in the cart as shown in the image below.<\/p>\n\n\n\n SKU 24-MB01<\/strong> is mentioned in the promo SKU so the cart considered this product as a Y<\/strong> product and 24-MB05<\/strong> is a non-promo SKU so the cart considered this product as an X<\/strong> product.<\/p>\n\n\n\n You can also go through the best Magento 2 extensions<\/a> catalog list. <\/p>\n\n\n\n Hope this will be helpful. Thanks \ud83d\ude42<\/p>\n\n\n\n <\/p>\n","protected":false},"excerpt":{"rendered":"
Note:-<\/strong> You must have installed your custom Module on which you are going to implement this.<\/p>\n\n\n\n<?xml version="1.0"?>\n<!-- \n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_CartRule\n * @author Webkul\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n -->\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager\/etc\/config.xsd">\n <type name="Magento\\SalesRule\\Model\\Rule\\Metadata\\ValueProvider">\n <plugin name="salesrule-plugin" type="Webkul\\CartRule\\Plugin\\Rule\\Metadata\\ValueProvider" sortOrder="1" \/>\n <\/type>\n<\/config><\/pre>\n\n\n\n
<?php\n\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_CartRule\n * @author Webkul\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n\nnamespace Webkul\\CartRule\\Plugin\\Rule\\Metadata;\n\nclass ValueProvider\n{\n public function afterGetMetadataValues(\n \\Magento\\SalesRule\\Model\\Rule\\Metadata\\ValueProvider $subject,\n $result\n ) {\n $applyOptions = [\n 'label' => __('Custom'),\n 'value' => [\n [\n 'label' => 'Buy X Get next Y with M% discount',\n 'value' => 'buy_x_get_next_y_with_percent',\n ]\n ],\n ];\n array_push($result['actions']['children']['simple_action']['arguments']['data']['config']['options'], $applyOptions);\n return $result;\n }\n}<\/pre>\n\n\n\n![\"Screenshot-from-2024-02-07-19-14-15\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2024\/02\/Screenshot-from-2024-02-07-19-14-15-1200x610.png\")
<\/figure>\n\n\n\n<?xml version="1.0" encoding="UTF-8"?>\n<!--\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_CartRule\n * @author Webkul\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n-->\n<form xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc\/ui_configuration.xsd">\n <fieldset name="actions" sortOrder="30">\n <field name="custom_step_nqty" formElement="input">\n <argument name="data" xsi:type="array">\n <item name="config" xsi:type="array">\n <item name="source" xsi:type="string">sales_rule<\/item>\n <item name="sortOrder" xsi:type="number">4<\/item>\n <\/item>\n <\/argument>\n <settings>\n <validation>\n <rule name="required-entry" xsi:type="boolean">true<\/rule>\n <rule name="validate-number" xsi:type="boolean">true<\/rule>\n <rule name="validate-zero-or-greater" xsi:type="boolean">true<\/rule>\n <\/validation>\n <dataType>text<\/dataType>\n <label translate="true">Discount Qty (Buy Y)<\/label>\n <dataScope>custom_step_nqty<\/dataScope>\n <\/settings>\n <\/field>\n <field name="promo_skus" formElement="textarea">\n <argument name="data" xsi:type="array">\n <item name="config" xsi:type="array">\n <item name="source" xsi:type="string">sales_rule<\/item>\n <item name="notice" xsi:type="string" translate="true">Enter Y products separated by comma. Enter All SKU(s) if product is Customisable.<\/item>\n <\/item>\n <\/argument>\n <settings>\n <dataType>number<\/dataType>\n <label translate="true">Promo SKU<\/label>\n <dataScope>promo_skus<\/dataScope>\n <\/settings>\n <\/field>\n <\/fieldset>\n<\/form><\/pre>\n\n\n\n
![\"Screenshot-2024-02-07T192850.744\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2024\/02\/Screenshot-2024-02-07T192850.744-1200x619.png\")
<\/figure>\n\n\n\n<?xml version="1.0"?>\n<!--\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_CartRule\n * @author Webkul\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n-->\n<page xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View\/Layout\/etc\/page_configuration.xsd">\n <body>\n <referenceBlock name="head.components">\n <block class="Magento\\Framework\\View\\Element\\Js\\Components" name="sales_custom_rule_form_page_head_components" template="Webkul_CartRule::promo\/customrulejs.phtml"\/>\n <\/referenceBlock>\n <\/body>\n<\/page><\/pre>\n\n\n\n
<?php\n\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_CartRule\n * @author Webkul\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n\n?>\n<script>\n require([\n 'jquery',\n "uiRegistry"\n ], function($, registry) {\n\n $(document).ready(function() {\n $('body').on('click', ".fieldset-wrapper-title", function() {\n $('body select[name=simple_action]').trigger('change');\n });\n $('body').on('change', 'select[name=simple_action]', function() {\n $('body input[name=discount_amount]').parent().parent()\n .find('label span').text("<?= \/* @noEscape *\/ __('Discount Amount'); ?>");\n if ($(this).val() == 'buy_x_get_next_y_with_percent') {\n let discountAmount = Math.min(100, $('body input[name=discount_amount]').val());\n discountAmount = discountAmount ? discountAmount : 1;\n let customRuleElementNode = $('body select[name=simple_action] option[value="buy_x_get_next_y_with_percent"]');\n let customRuleLabel = customRuleElementNode.text().replace('M%', `${discountAmount}%`);\n customRuleElementNode.text(customRuleLabel);\n $('body textarea[name=promo_skus]').parent().parent().show();\n $('body input[name=discount_amount]').parent().parent().find('label span')\n .text("<?= \/* @noEscape *\/ __('Discount Amount (in %)'); ?>");\n $('body input[name=custom_step_nqty]').parent().parent().show();\n } else {\n $('body input[name=custom_step_nqty]').parent().parent().hide();\n $('body textarea[name=promo_skus]').parent().parent().hide();\n }\n });\n });\n });\n<\/script><\/pre>\n\n\n\n<?xml version="1.0"?>\n<!--\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_CartRule\n * @author Webkul\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n-->\n<schema xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Setup\/Declaration\/Schema\/etc\/schema.xsd">\n <table name="salesrule" resource="default">\n <column xsi:type="text" name="custom_step_nqty" nullable="true" comment="N Qty"\/>\n <column xsi:type="text" name="promo_skus" nullable="true" comment="Promotion SKUs"\/>\n <\/table>\n<\/schema><\/pre>\n\n\n\n
<?xml version="1.0"?>\n<!-- \n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_CartRule\n * @author Webkul\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n -->\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager\/etc\/config.xsd">\n <type name="Magento\\SalesRule\\Model\\Rule\\Action\\Discount\\CalculatorFactory">\n <arguments>\n <argument name="discountRules" xsi:type="array">\n <item name="buy_x_get_next_y_with_percent" xsi:type="string">\\Webkul\\CartRule\\Model\\Rule\\Action\\Discount\\BuyXGetNextYWithPercent<\/item>\n <\/argument>\n <\/arguments>\n <\/type>\n<\/config><\/pre>\n\n\n\n
<?php\n\n\/**\n * Webkul Software.\n *\n * @category Webkul\n * @package Webkul_CartRule\n * @author Webkul\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n\nnamespace Webkul\\CartRule\\Model\\Rule\\Action\\Discount;\n\nuse Magento\\SalesRule\\Model\\Rule\\Action\\Discount\\AbstractDiscount;\n\nclass BuyXGetNextYWithPercent extends AbstractDiscount\n{\n \/**\n * Calculate Buy X Get next Y with M% discount amount\n *\n * @param \\Magento\\SalesRule\\Model\\Rule $rule\n * @param \\Magento\\Quote\\Model\\Quote\\Item\\AbstractItem $item\n * @param float $qty\n * @return \\Magento\\SalesRule\\Model\\Rule\\Action\\Discount\\Data\n *\/\n public function calculate($rule, $item, $qty)\n {\n $rulePercent = min(100, $rule->getDiscountAmount());\n $discountData = $this->_calculate($rule, $item, $qty, $rulePercent);\n\n return $discountData;\n }\n\n \/**\n * @param \\Magento\\SalesRule\\Model\\Rule $rule\n * @param \\Magento\\Quote\\Model\\Quote\\Item\\AbstractItem $item\n * @param float $qty\n * @param float $rulePercent\n * @return Data\n *\/\n protected function _calculate($rule, $item, $qty, $rulePercent)\n {\n \/** @var \\Magento\\SalesRule\\Model\\Rule\\Action\\Discount\\Data $discountData *\/\n $discountData = $this->discountFactory->create();\n\n \/**\n * Calculation logic here\n *\/\n $discountStep = $rule->getDiscountStep();\n $maxDiscountQty = $rule->getDiscountQty();\n $currentDiscountAmount = $rulePercent;\n $qty = $item->getQty();\n $cartSKUs = [];\n $promoSkus = $rule->getpromoSkus();\n $totalQuantity = $item->getQuote()->getItemsQty();\n $yProducts = $rule->getData('custom_step_nqty');\n $productPriceSKUWise = [];\n $productQty = [];\n foreach ($item->getQuote()->getAllVisibleItems() as $currentItem) {\n\n if (!$this->validator->canApplyRules($currentItem)) {\n continue;\n }\n $currentItemSku = $currentItem->getSku();\n if ($currentItem->getProductType() == 'bundle') {\n $currentItemSku = $this->getBundleProductSku($currentItem->getId(), $currentItemSku, $item);\n }\n $productQty[$currentItemSku] = $currentItem->getQty();\n $cartSKUs[] = $currentItemSku;\n $productPriceSKUWise[$currentItemSku]['price'] = $this->validator->getItemPrice($currentItem);\n $productPriceSKUWise[$currentItemSku]['base_price'] = $this->validator->getItemBasePrice($currentItem);\n }\n\n $discountAmount = $this->getAmountSkuWise(\n $currentDiscountAmount,\n $qty,\n $maxDiscountQty,\n $discountStep,\n $totalQuantity,\n $yProducts,\n $productQty,\n $item,\n $cartSKUs,\n $promoSkus,\n $productPriceSKUWise\n );\n\n \/** Set the discount price in Price **\/\n $discountData->setAmount($discountAmount['discount']);\n $discountData->setBaseAmount($discountAmount['base_discount']);\n $discountData->setOriginalAmount($discountAmount['discount']);\n $discountData->setBaseOriginalAmount($discountAmount['base_discount']);\n\n return $discountData;\n }\n\n \/**\n * Bundle product SKu\n *\n * @param int $itemId\n * @param string $currentItemSku\n * @param \\Magento\\Quote\\Model\\Quote\\Item $item\n * @return string\n *\/\n public function getBundleProductSku($itemId, $currentItemSku, $item)\n {\n foreach ($item->getQuote()->getAllItems() as $currentItem) {\n if ($currentItem->getParentItemId() == $itemId) {\n $currentItemSku = str_replace("-" . $currentItem->getSku(), "", $currentItemSku);\n }\n }\n return $currentItemSku;\n }\n\n \/**\n * Get discount amount as per promotional SKU\n *\n * @param integer $currentDiscountAmount\n * @param integer $qty\n * @param integer $maxDiscountQty\n * @param integer $discountStep\n * @param integer $totalQuantity\n * @param int $yProducts\n * @param array $productQty\n * @param \\Magento\\Quote\\Model\\Quote\\Item $item\n * @param array $cartSKUs\n * @param string $promoSkus\n * @param array $productPriceSKUWise\n * @return array\n *\/\n private function getAmountSkuWise(\n $currentDiscountAmount,\n $qty,\n $maxDiscountQty,\n $discountStep,\n $totalQuantity,\n $yProducts,\n $productQty,\n $item,\n $cartSKUs,\n $promoSkus,\n $productPriceSKUWise\n ) {\n $discountAmount = ['discount' => 0, 'base_discount' => 0];\n if (empty($yProducts) || $yProducts == 0) {\n $yProducts = 1;\n }\n $maxDiscountQty = $maxDiscountQty ? $maxDiscountQty : 1;\n\n $currentItemSku = $item->getSku();\n if ($item->getProductType() == 'bundle') {\n $currentItemSku = $this->getBundleProductSku($item->getId(), $currentItemSku, $item);\n }\n\n $skus = explode(',', trim($promoSkus) ?? '');\n if (!array_diff($cartSKUs, $skus)) {\n return $discountAmount;\n }\n\n if (in_array($currentItemSku, $cartSKUs) && in_array($currentItemSku, $skus)) {\n foreach ($skus as $sku) {\n if (array_key_exists($sku, $productQty)) {\n $productQtyitem = $productQty[$sku];\n if ($item->getProduct()->getTypeId() == 'bundle') {\n $promoSKUPrice = $this->getBundleProductPrice($sku, $item);\n } else {\n $promoSKUPrice = $this->getProductPrice(\n $sku,\n $productPriceSKUWise\n );\n }\n $qty = $totalQuantity - $productQtyitem;\n if (in_array($sku, $cartSKUs) && $discountStep <= $qty && $yProducts <= $productQtyitem) {\n if ($currentItemSku == $sku) {\n $nDiscountQty = min($qty, $productQtyitem, $maxDiscountQty);\n $discountAmount['discount'] = $discountAmount['discount'] +\n ($promoSKUPrice['price'] * $currentDiscountAmount \/ 100) * $nDiscountQty;\n $discountAmount['base_discount'] = $discountAmount['base_discount'] +\n ($promoSKUPrice['base_price'] * $currentDiscountAmount \/ 100) * $nDiscountQty;\n }\n }\n }\n }\n }\n\n return $discountAmount;\n }\n\n \/**\n * Bundle Product Price\n *\n * @param string $sku\n * @param \\Magento\\Quote\\Model\\Quote\\Item $item\n * @return array\n *\/\n public function getBundleProductPrice($sku, $item)\n {\n $price = 0;\n foreach ($item->getQuote()->getAllItems() as $currentItem) {\n if (\n $currentItem->getProductType() == 'bundle'\n &&\n $currentItem->getProduct()->getData('sku') == $sku\n ) {\n $price = $this->validator->getItemPrice($currentItem);;\n $basePrice = $this->validator->getItemBasePrice($currentItem);\n }\n }\n return ['price' => $price, 'base_price' => $basePrice];\n }\n\n \/**\n * Get Product Price\n *\n * @param string $sku\n * @param array $productPriceSKUWise\n * @return array\n *\/\n public function getProductPrice($sku, $productPriceSKUWise)\n {\n $totalSkuPrice = 0;\n if (isset($productPriceSKUWise[$sku])) {\n $totalSkuPrice = $productPriceSKUWise[$sku];\n }\n return $totalSkuPrice;\n }\n}<\/pre>\n\n\n\n![\"Screenshot-2024-02-07T203639.958\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2024\/02\/Screenshot-2024-02-07T203639.958-1200x622.png\")
<\/figure>\n\n\n\n![\"Screenshot-2024-02-07T204159.278\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2024\/02\/Screenshot-2024-02-07T204159.278-1200x607.png\")
<\/figure>\n\n\n\n