Getting Started

Welcome to the Product Kit documentation.

Whether you are new or an advanced user, you can find some useful information here.

Go ahead, dive in!

Firstly, please check out our extension in the My Downloadable Products section of our store. Learn how to install extension, and proceed with Quick Start, which will guide you to set up your Product Kit service.

How to install the extension

How to install the extension using composer

  1. Back up your store's database and web directory.
  2. Log in to the SSH console on your server and navigate to the root directory of the Magento 2 store.
  3. Copy the installation instructions from the page My Downloadable Products to the SSH console and press ENTER.
  4. Run the command php -f bin/magento module:enable Mirasvit_Core Mirasvit_ProductKit to enable the extension.
  5. Run the command php -f bin/magento setup:upgrade to install the extension.
  6. Run the command php -f bin/magento cache:clean to clean the cache.
  7. Deploy static view files

    rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

How to install the extension manually

  1. Back up your store's database and web directory.
  2. Download the archive from My Downloadable Products.
  3. Unzip the extension locally.
  4. Copy the unzipped folder to the root directory of the Magento store.
  5. Run the command php -f bin/magento module:enable Mirasvit_Core Mirasvit_ProductKit to enable the extension.
  6. Run the command php -f bin/magento setup:upgrade to install the extension.
  7. Run the command php -f bin/magento cache:clean to clean the cache.
  8. Deploy static view files

    rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Quick Start

Our Product Kit extension for Magento 2 is a simple, yet powerful extension that allows you to sell several products or services together as a combined unit - Kits, often for a lower price than each item would cost separately.

When you offer a buy one, get one at a percentage or monetary equivalent off — or maybe free — it gives shoppers the perception that they are getting something free of charge or for a substantial discount.

Product Kits can be defined as one of the following strategies:

  • Predefined Product Kit, which allows for mannually selecting particular products that should be included in the Kit;
  • Smart Product Kit, which allows you to configure rules per each position in the Kit (up to 5 positions) and generate all possible combinations with only one Kit.

Predefined Kit

Predefined Kit allows for manually selecting particular products that need to be included in the Kit.

To create a new Predefined Kit, go to Catalog > Product Kits and press the button Add New Kit.

The Edit page of a product kit contains three sections:

General Information


  • Active - kit status.
  • Internal Name - kit name. Used only for internal purposes.
  • Priority - sort order for appearing on the frontend.
  • Store View - store view where the kit can be applied.
  • Customer Groups - customer groups where the kit can be applied.
  • Is Smart - kit type.

Appearance

  • Title - the title of the kit block. Visible on the frontend.
  • Label - label for the product kit discount. Visible on the shopping cart page.
  • Override Cent Values? - allows for modifying the final price of the kit. For example, the final kit price is $25.67, but you need to make it $25.99, so you set this option to ##.99.

Products

To add products to the kit, click the Add Products button. In the pop-up window, select the required products and press the Add Selected Products button.

Each product has the following options:

  • Is Options - defines a product that must be added in the cart.
  • Is Primary - product kit block will be shown only on the product pages that marked as "primary". Each kit should contains at least one "primary" product. For example, if you want to sell a phone case with a phone and want to display the kit on both product pages(phone page and phone case page), you need to mark both products as Primary. If you need to show the kit only on a phone page, then you need to mark only the phone product as primary.
  • Discount - allows you to set a discount for the product in this kit. Two types of discount are allowed:
    • Fixed - defines a strict amount of discount;
    • Percent - defines a percent from the product price.
  • Qty - product's quantity in the kit.

Smart Kit

Smart Kit allows for creating a kit using rules.

To create a new Smart Kit, go to the Catalog > Product Kits and press the button Add New Kit and select the option Is Smart.

The Edit page of the product kit consists of three sections:

General Information


  • Active - kit status.
  • Internal Name - kit name. Used only for internal purposes.
  • Priority - sort order for appearing on the frontend.
  • Store View - store view where the kit can be applied.
  • Customer Groups - customer groups where the kit can be applied.
  • Is Smart - kit type.
  • Number of products - number of products in the kit.

Appearance

  • Title - the title of the kit block. Visible on the frontend.
  • Label - label for the product kit discount. Visible on the shopping cart page.
  • Override Cent Values? - allows modifying the final price of the kit. For example, the final kit price is $25.67, but you need to make it $25.99, so you set this option to ##.99.

Products

Each product has the following options:

  • Is Options - defines a product that must be added in the cart.
  • Discount - allows you to set a discount for the product in this kit. Two types of discount are allowed:
    • Fixed - defines a strict amount of discount;
    • Percent - defines a percent from the product price.
  • Qty - the number of products in the kit.
  • Apply the rule only for the following products - the section that permits setting conditions used for the kit formatting.

Suggest Kits

Suggest Kits allows you to create kits using statistics from your store.

To create a new Kit, go to the Catalog > Product Kits and press the button Suggest Kits. Modify Selection Criteria for your needs, press the button Find Suggestions, choose a kit from the provided list, and press the button Create Kit.

Suggest Kits allows you to use the following criteria:

  • Number of products for kit - number of products in one suggested kit.
  • Number of orders - select only those products that were used in the provided number of orders.
  • Kit price - suggest only kits that satisfy the price range.
  • Group by - by default, select products based on the order
    • Same Customer - select products based on the customer

How to upgrade extension

To upgrade the extension, follow these steps:

  1. Back up your store's database and web directory.
  2. Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  3. Run the command composer require mirasvit/module-product-kit:* --update-with-dependencies to update current extension with all dependencies.

    Note

    In some cases, the command above is not applicable, or you are unable to update just the current module, and must upgrade all Mirasvit modules in a bundle. In this case, the command above will have no effect.

    Instead, run the composer update mirasvit/* command. It will update all Mirasvit modules installed in your store.

  4. Run the command php -f bin/magento setup:upgrade to install updates.
  5. Run the command php -f bin/magento cache:clean to clean the cache.
  6. Deploy static view files

    rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Disabling the Extension

Temporarily Disable

To temporarily disable the extension, please follow these steps:

  1. Log in to the SSH console on your server and navigate to the root directory of the Magento 2 store.
  2. Run the command php -f bin/magento module:disable Mirasvit_ProductKit to disable the extension.
  3. Log in to the Magento backend and refresh the store cache (if enabled).

Extension Removal

To uninstall the extension, please follow these steps:

  1. Log in to the SSH console on your server and navigate to the root directory of the Magento 2 store.
  2. Run the command php -f bin/magento module:disable Mirasvit_ProductKit to disable the extension.
  3. Run the command composer remove mirasvit/module-product-kit to remove the extension.
  4. Log in to the Magento backend and refresh the store cache (if enabled).

1.0.15

(2020-09-11)

Improvements

  • Small spelling fixes

1.0.14

(2020-08-31)

Improvements

  • Added ability for customers to choose a product for the position.

1.0.13

(2020-08-20)

Improvements

  • Support of Magento 2.4

1.0.11

(2020-07-08)

Fixed

  • Price formatting in the backend
  • Undefined position on m2.2.9
  • Validation of virtual product qty for a product kit

Features

  • Added GraphQL implementation

1.0.9

(2020-06-23)

Fixed

  • Formating of kit prices
  • Validation of product qty for a product kit

1.0.8

(2020-06-19)

Fixed

  • Error "Undefined index: position in Mirasvit/ProductKit/Controller/Adminhtml/Kit/PostDataProcessor.php"
  • Compatibility with m2.2.9

Features

  • Added new discount type "Relative Kit - %, %, %"

1.0.6

(2020-06-09)

Fixed

  • Unable to add grouped product to the cart

1.0.5

(2020-06-05)

Fixed

  • Product kit generation

1.0.4

(2020-06-01)

Features

  • Added options: "Bind product kit block to" and "Bind position"
  • Added new discount type "Relative - %, %, %"
  • Added condition "Product Type"
  • Added configuration option "Maximum number of kits in the block"

1.0.3

(2020-05-13)

Fixed

  • Reindex for products with multiple categories
  • Display of product image in the MGS theme
  • Product price when tax is included
  • Mobile styles
  • Auto redirect to the cart

1.0.2

(2020-05-04)

Features

  • Ability to display kits on the shopping cart page
  • Added "Primary product" functionality

1.0.1

(2020-04-30)

Features

  • Compatibility with Magento 2.3.5

1.0.0

(2020-04-23)

Features

  • Initial release