Welcome to Mageplaza Docs

Install Magento 2 extension

Installation guide now moved to https://www.mageplaza.com/install-magento-2-extension/

How to Install Magento 2 Extension

1. We recommend you to duplicate your live store on a staging/test site and try installation on it in advance

2. Backup magento files and the store database

   Important

   It’s very important to backup all of themes and extensions in Magento before installation, especially when you are working on a live server. We strongly recommend you to do not omit this step.

3. Download FTP clients Recommend clients: FileZilla, WinSCP, cuteFtp

Step 1: Upload the extension

1. Log into your hosting space via a FTP client
2. Unzip extension package and upload them into Magento root directory.

3. Enter the following at the command line

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

Tip

Logout and Login again to avoid Access denied 404 error when you go to this product configuration.

Step 2: Configuration

Now time to setup it in backend.

Go to Mageplaza > Extension Name > Configuration.

FAQS

Q: “Access denied 404 error”

A: Try to Logout and Login again. Follow this guide for more details

Q: Messy page, no style. What should I do?

A: it because of static content is not generated to pub/ folder. Let’s run command to deploy it.

Run following command:

php bin/magento setup:static-content:deploy

Any other questions, issues please contact Mageplaza:

• Ask Mageplaza: https://www.mageplaza.com/contact.html

Uninstallation

Important

Backup Code, database before doing this.

It is depend on how you installed, we will tell you how to uninstall it. There are 2 main method to install a Magento extension: 1. Composer; 2. Copy-and-paste

1. Uninstall via composer

Go to Magento root folder and run uninstall command

composer remove mageplaza/module-name php bin/magento setup:upgrade php bin/magento setup:static-content:deploy

2. Uninstall (Copy-and-paste method)

Delete the following files, folders::

app/code/Mageplaza/EXTENSION_NAME

Run the following command line::

php bin/magento setup:upgrade

Delete database tables: (Optional)

Open a Mysql mangement such as PHPMyAdmin

Open your database > Find database with prefix: mageplaza_EXTENSION_NAME

Just delete all the database tables related to mageplaza_EXTENSION_NAME

If you have any questions, feel free to contact us at https://www.mageplaza.com/contact.html

One Step Checkout

One Step Checkout extension for Magento 2, developed by Mageplaza, is the best marketing tool which helps you to reduce your store abandonment cart, increase conversion rate and totally grow your store revenue. That extension helps customers checkout quickly and conveniently in one page with all six steps. Many outstanding plugins such as Ajax loading, Google address suggestion, Auto-update order information, Apply coupon on the checkout page, Support multi payment methods will improve your checkout page and make it more powerful and more effective.

Mageplaza One Step Checkout for Magento 2 User Guide will provide the detailed instructions to know How to use on the frontend and How to Config on the backend.

I. How to use

After adding the right products in the cart, the customer will be navigated to the checkout page. The checkout page will be shown with all six steps as the image below.

A one-step checkout will be totally done on one page only by completing information and selecting options.

1.1. Log In / Sign Up

• Proceed the checkout with customer’s existed information by a click on the blue link “Already have an account, click here to login”. A pop-up box will appear to allow buyers to fill in their accounts as below:

• Otherwise, buyers are able to purchase without registering an account
• Buyers can create a new account at the same time when selecting the box Create Account:

1.2. Shipping Address

• Customers enter their personal information into required fields (which are marked by a red *).
• In the box Street Address, One Step Checkout helps displayìng a list of addresses suggested automatically by typing only one letter. Furthermore, Country, City and State/Province will be consequently auto-updated based on the selected street address.

1.3. Billing Address

• Buyers can tick the box My billing and shipping address are the same to have their item(s) delivered to their billing address. Otherwise, the Billing Address section allows buyers to fill in their information to check out.

1.4. Shipping Method

• Depending on the configuration in the backend, the shipping method will be variable to meet customers’ requirements.
• Admin can add more other shipping methods at the backend Sale > Shipping Method. You can refer here for more information.
• Buyers can choose their favourable time to receive delivery at Delivery Time. This extension is entirely compatible with OSC
• Also, buyers can enter their house security code if it’s neccessary.
• Moreover, One Step Checkout module allows buyers to leave their comments about the orders, products in the Comments field

1.5. Payment Method

• One Step Checkout allows customers to quickly select their favorable payment method only by a single click.
• Admin can add more other payment methods at the backend Sale > Payment Method. You can refer here for more information.

1.6. Order Review and Place Order

• In the Order Review section, One Step Checkout allows buyers to easily adjust their item’s quantity by using the minus/plus button. In addition, it allows editing each item:

• Subtotal, shipping fee, tax and grand total are displayed clearly by One Step Checkout.
• One Step Checkout enables customers to apply coupon in the Apply Discount Code box.
• The box Sign up for newsletter can be selected if customers desire to receive information from the online store via email.
• Customers may request the purchased product to be wrapped and send a gift message with that product.

• Terms and conditions will be displayed in a pop-up box and can be accepted by clicking on I agree with terms and conditions.
• Eventually, the one step checkout can be finished by a click on the Place Order button. The whole process is completed in one page only.
• Seal block is displayed to make sure this is the official checkout page of the store, not forged.

1.7. Quickly add Product and Coupon by URL

• Customer can quickly add a certain number of Products by SKU by adding some information at the URL
• Supported Product Types include: Simple Product, Child Configurable Product, Downloadable Product
• Customers can also quickly add Coupon when inserting information to the URL
• Adding Product: For example, adding 2 products whose SKU is MH01 and 3 products whose SKU is WSH12-28-Red to OSC at store with website: www.example.com

www.example.com/onestepcheckout/?sku[MH01]=2&sku[WSH12-28-Red]=3

• Add Coupon: For example, add a coupon with the code COUPON123 to the OSC at the store with a website: www.example.com

www.example.com/onestepcheckout/? coupon = COUPON123

• Add Coupon and Product at the same time: For example, add 2 products with SKU as MH01 and coupon with code CO COONON123 to OSC at store with website: www.example.com

www.example.com/onestepcheckout/?sku [MH01] = 2 & coupon = COUPON123

II. How to configure

Login to Magento Admin, following our given guide below to complete One Step Checkout configuration

• Field Management
• Configuration

• General Configuration
• Display Configuration
• Design Configuration

2.1. Manage Fields

2.1.1. Address Information

From the Admin Panel, go to Stores > One Step Checkout > Manage Fields, choose Address Information. Drag and drop tabs from Available fields to Sorted fields to have them appeared in the checkout page.

Here, admin can configure Required by checking the right corner of each field, changing the frame length by dragging and dropping (length can be dragged: 25%, 50%, 100%), drag and drop tabs from Available fields to Sorted fields to have them appeared in the checkout page:

2.1.2. Shipping Method

• From the Admin Panel, go to Stores > One Step Checkout > Manage Fields, chọn Shipping Method
• Drag and drop tabs from Available fields to Sorted fields to have them appeared in the checkout page.
• Please install Mageplaza Order Attributes to add more custom checkout fields.

2.1.3. Payment Method

• From the Admin Panel, go to Stores > One Step Checkout > Manage Fields, chọn Payment Method
• Drag and drop tabs from Available fields to Sorted fields to have them appeared in the checkout page.
• Please install Mageplaza Order Attributes to add more custom checkout fields.

2.1.4. Order Summary

• From the Admin Panel, go to Stores > One Step Checkout > Manage Fields, select Order Summary
• Drag and drop tabs from Available fields to Sorted fields to have them appeared in the checkout page.
• Please install Mageplaza Order Attributes to add more custom checkout fields.

2.2. Configuration

2.2.1. General Configuration

• Open the Stores > Settings > Configuration > Mageplaza Extensions > One Step Checkout > General Configuration section:

• In the Enable One Step Checkout field: Select “Yes” to enable One Step Checkout extension.
• In the One Step Checkout Page Title field: Enter the page title you want.
• In the One Step Checkout Description field: Enter the short description to describe the One Step Checkout page.
• In the Default Shipping Method field: Set default shipping method in the checkout process.
• In the Default Payment Method field: Set default payment method in the checkout process.
• In the Allow Guest Checkout field:
  • Select “Yes” to allow checking out as a guest. Also, guests can create an account on the checkout page.
  • Select “No (require create account)” : Guest must enter password to create account at checkout
  • Select “No (require login)”: Guest must login before checkout
• In the Auto-redirect to One Step Checkout page field: Select “Yes” to turn this function on
• In the Show Billing Address field: Select “Yes” to allow shipping items to a different address from billing address.
• In the Use Auto Suggestion Technology field: Select one of the following options:
  • No: if you don’t want to use auto-suggestion technology
  • Google: if you select Google option, when the customer fills address fields, it will suggest a list of full addresses.
    • In Google API Key field: Insert the Key. About how to get this key, you can refer this guide.
    • In Restrict the auto suggestion for a specific country field: Select default country for Billing address and Shipping address.
• Enable GeoIP: GeoIP allows you to lookup the approximate location of an IP address. If store owners enable this function, when a customer comes to the checkout page, State, country, city and zip code will be automatically entered based on his current IP address. Ask customers fill less, they will buy yours more! You need install `GeoIP Mageplaza Extension to use this function.
  • Select No: If you don’t want to use GeoIP
  • Select Yes to enable GeoIP Extension.
• Route: Allow admin to modify the URL route of One Step Checkout Page. You can left this field blank if you want to use the default route which is onestepcheckout.

2.2.2. Display Configuration

Make your way to MStores > Settings > Configuration > Mageplaza Extensions > One Step Checkout

• Open the Display Configuration section, and continue with following:

• In the Show Login Link field: Set “Yes” to show the Login link which allows the customer to sign in. Leave “No” to disable this link.
• Show/Hide Footer/Header: Depending on each theme that the checkout page will or will not display the Header/Footer of that page.
  • With themes which display, choose Yes in this section to make it also display in the One Step Checkout page and choose No to hide it
  • With themes which not, you can pass this config
• In the Discount Code Section field:
  • Select “No” to hide Apply Discount Code box on the Checkout page.
  • Select “In Payment Area” to display the Apply Discount Code box in the Payment Methods area.
  • Select “In Review Area” to display the Apply Discount Code box in the Review Order area.
• In the Show Order Comment field: Select “Yes” to show the Order Comment box that allows the customer to enter their comment on the order.
• In the Enable Gift Message on order field: Select “Yes” to show the Gift Message box that allows the customer to enter their gift message.

• In the Enable Gift Messages on item field: This means you will be able to send gift message for each of item. Enable to use this function by choosing “Yes”

• In the Show Terms and Conditions field: You can choose “No” to not display the Terms and Conditions OR select “YES” to display it in two different positions: In Payment Area and In Review Area.
• In the Show Check Out with Multiple Addresses Link field: You can choose “Yes” to display the Check Out with Multiple Addresses Link on the one page checkout step, so that customers can make payments with multiple addresses.

2.2.2.1. Review Cart Section

• In the Show Order Review Section field: The Order Review is enabled by default, if you want to disable to review order, let select “Disabled” option.
• Show Product List Toggle: Choose Yes so customers can shorten the product list before checkout
• In the Show Product Thumbnail Image field: Choose “Yes” to show thumbnail

2.2.2.2. Gift Wrap

• Select “Yes” if you allow the customer to choose Gift Wrap option. After choosing, the change will be applied automatically to the order.If you allow showing Gift Wrap option, two following fields will be shown:
  • Calculate Method field, select Per Order or Per Item to calculate the gift wrap fee based on the item quantity or the order total. Comment box will be shown at the Shipping Method area.
  • Amount field, enter the gift wrap fee. If you leave it blank, Gift wrap fee = 0

2.2.2.3. Newsletter

• Select “Yes” if you want to show Sign up newsletter selection.
• Checked Newsletter by default will be displayed. Select “Yes” to keep this item be checked as always.

2.2.2.4. Survey

• Set “Yes” to allow store owner can issue a survey question to buyers when they placed order successfully, some additional fields will be expanded.
  • Survey Question: The questionnaire is filled in this section
  • Survey Answers: Store owners can offer multiple answer options to their customers. Each of an answer options are displayed as a checkbox, which means that customers can select multiple answers at a time.
  • Allow Customer Add Other Option: Select “Yes” so that customers can make their own answers to survey questions.

2.2.2.5. Seal Block

• Seal Block always displays under Place Order button

• There are 3 display Seal Block options:
• Enable = No: Not display Seal Block in One Step Checkout

• Enable = Select Static Block. When the admin selects this option, the Block option will be displayed to admin select the CMS block that he or she wants to act as Seal Block to show outside the Frontend. We also provide you seal block default which is One Step Checkout Seal Content to refer

• Enable = Use Default Design. When choosing this option, admin can customize the images and contents of Seal Block quickly and easily

2.2.2.6. Static CMS Block

• Choose Yes to insert Static CMS Blocks into Top/Bottom of One Step Checkout page or insert in Success Page. The display order is set in the Sort Order column

2.2.3. Design Configuration

• Open the Design Configuration section, and continue with following:

• In the Checkout Page Layout field: Select one of the following layouts to have your checkout page be shown in four different interfaces
  • 1 column
  • 2 columns
  • 3 columns
  • 3 columns with Colspan
• In the Design Style field, there are 3 design styles for the One Step Checkout page
  • Default Design style

• Flat Design style. If you choose this, you can customize colors of
  • Heading Background
  • Heading Text

• Material Design style: If you choose this style, you’ll be able to change
  • Radio Button
  • Checkbox button
  • Material color

• In the Place Order button color field: Choose the color for the place order button which should be a highlight to attract shoppers the most.
• In the Order Summary Background Color field: Choose the color for the Order Summary section.
• In the One Step Checkout Page Background Color field: Choose the background color for the whole One Step Checkout page.
• In the One Step Checkout Page Title Color field: Choose the color for the title of the One Step Checkout page.
• In the One Step Checkout Description Color field: Choose the color for the description section of the One Step Checkout page.
• In the Text Font field: Select text font for the one step checkout page. You can change among multiple text fonts as you wish.
• In the Custom CSS field: You can add the CSS code to custom your own style.

2.2.4 Custom Fields Configuration

• Open the Custom Fields Configuration section, and continue with the following:

• Add 3 default Custom Field with Custom Field 1 and 2 as Text, Custom Field 3 as Date:

2.3. Other configurations

Sometimes you can’t display some minor fields on the checkout page even you’ve enabled them in the backend configuration. Don’t worry that there’re no serious technical issue here, please follow those below instructions to display them properly.

2.3.1. Terms and Conditions Configuration

Term and Conditions might not appear on the frontend due to:

• Term and Conditions hasn’t been created yet. Follow Admin > Stores > Settings > Terms and Conditions > Add New Condition to create a new form.
• You haven’t turn Term of Magento configuration on`yet. Please go to Stores > Settings > Configuration > Sales > Checkout > Checkout Options`, set Enable Terms and Conditions to “Yes”.
• Then, refer here to learn how to enable the Term and Conditions on the checkout page.

2.3.2. Enable Gift Messages on item

When you enable this option but can’t see its icon on the frontend, you might not have allowed the product to have the message. Please log in to Catalog > Product, choose that product you want it to have gift message, enable this below option and save the product.

2.3.3. Add Shipping Method

In general, Magento just displays two basic shipping methods are Flat Rate and Table Rates. To add another shipping method, go to Stores > Settings > Configuration, enter Sale > Shipping Method and follow this guide.

2.3.4. Compatible One Step Checkout with Paypal

• One Step Checkout Module can be compatible with Paypal Payment Gateway. To know more about Paypal, please visit here
• Moreover, One Step Checkout also support Braintree, a Paypal service. To know more about Braintree, please visit here.
• To configure the Payment methods integrated with One Step Checkout, go to Stores > Settings > Configuration > Sales > Payments Method. Then choose the Payment method you want to configure.

• For Paypal Express Checkout Configuration, please follow the guide here
• For Braintree Configuration, please follow the guide here

2.3.5. Add comment into Order Confirmation Email

To add comment into Order Confirmation Email, please refer the guide here

III. Compatible Order Attribute

IV. Compatible Customer Attribute

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Layered Navigation

Magento 2 Layered Navigation extension is the advanced sitemap you can show on online store. It includes full of product attributes your customer need to filter the desired items and purchase them quickly. Especially, integrating Ajax technology allow showing all search results instantly on the current page without reloading the whole page.

Mageplaza Layered Navigation’s User Guide will provide the detailed instructions to know How to use on the frontend and How to Configure on the backend.

How to Use

Overview

After enabling the module, Layered Navigation is shown with a list of product atributes on the left of the category page.

How to Configure

• Login to Admin panel, Mageplaza > Layered Navigation > Configuration
• In the General Configuration, Choose “Yes” in Module Enable to turn Layered Navigation on. No means the vice versa result.
• Click red button Save Config to save change.

1. Filter by multiple attributes

• Open the product attribute section and choose one option as need.

• Similar to other product attributes.

• Display the matched items via Ajax Loading.

• Add the favorite items to cart.

• You can also filter by multi-choose from multiple categories at the same time

  

2. Price Slider

Price Slider allows sliding flexibly the bar to define price range instead of entering manually.

3. Enable Shop by

Shop by section will list all filter activities for the displayed results.

4. Hide Filter Attributes by Category

From the Admin Panel, go to Catalog > Categories

Hide Filter Attributes on Layered Navigation: allow hiding attributes selected in the filer of the category

For example: Select Price in the Jacket category, on the front end, Price will not appear in the filter part

Note: To apply the filter attributes, you have to turn Anchor to Yes. See guide [here](https://docs.google.com/document/d/1ukn2zCIFkJGnsJI8gRq7BtGMcLPy-yJAvMiS86ksLls/edit).

5. Render Categories Tree

From the Admin Panel, go to Stores > Attributes > Product, choose category_ids > Display Properties

Render Category Tree allows showing category filter tree

• No: does not show Category filter tree

• Full Category Tree: shows full of Category filter tree
• Custom Category Tree: allows users Category filter tree

• Expand Subcategories > Click: Filter is only shown when users click to expand
• Expand Subcategories > Auto: Fitler is automatically fully shown

• Category Tree Depth: Category Tree is shown with the number of selected layers
• Categories Level:
• Root category: Category Tree is shown from the root category

• Current Category: Category Tree is shown from the current category

• Current Category Childrens: Category Tree is shown from the current category children

• Expand Subcategories: If you choose Click, filter is shown when the user clock to expan. If you choose Auto, filter is automatically fully shown.

Compatible with themes:

Mageplaza Layered Navigation is compatible with the following themes:

• Yourstore

• Porto

• Fastor

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Layered Navigation Professional

Mageplaza Layered Navigation is a smart map for your Magento 2 store. It’s the shortest way for the shoppers to find what they want, especially when you have a bunch of items with various prices, attributes or brands.

Overview

After enabling the module, the Layered Navigation will be displayed on the left sidebar on Categories pages.

Layered Navigation Configuration

The Configuration is available under Admin Panel > Mageplaza > Layered Navigation > Configuration.

• General configuration
• Filter configuration
• Design configuration

Here are the details for the settings of each tab.

1. General Configuration tab

• In the Layered Navigation Enable field: You can choose to use the Module Layered Navigation or not. Leave as Yes to enable and No to disable.
• In the Enable Multi-Filters field
  • By enabling this feature, the shoppers are allowed to choose more than 1 filter to find the desired items. You can also filter by multi-choose from multiple categories at the same time. For example: The shopper can choose to filter by Color with Black, White and Size with Small, Large at the same time. This can be also applied with multiple categories.
  • To config this feature, go to Enable Multi-filter field, set “Yes/No” to “Enable/ Disable”

• In the Scroll to Top field
  • This feature allows the shoppers, after filtering, can automatically back to the top of the products list and start to find the desired items.
  • On the Scroll to Top after Filtering field, you will have 2 options:
    • YES : After choosing a filter or click on the Apply Filter button, the site will automatically scroll up to the top-page.
    • NO : After choosing a filter or click on the Apply Filter button, the site still stay at the current position.
• In the Quick Lookup Options field
  • By enabling this feature, in each of the attribute group, there is a search box. The shoppers only need to insert the letters and the filter whose name contains this letter will be displayed.
  • Go to Enable Filter options field to “Enable/ Disable” this feature by setting “Yes/ No”.

• In the Display Out-of-stock option field: There are 2 options to choose
  • Yes: Show all the attributes and options even the product is currently out of stock.
  • No: Hide all the attributes and options of the product which is currently out of stock.
• In the Product Count field: With this feature, there will have a number which is displayed next to the filter. This number allows the shoppers to know how many items which is matched the filter. For example: If the filter is displayed: Cotton(2), that means there are 2 items which are matched the filter Cotton.

• In the Display Product Count field
  • Set Yes to display the number to the left of the filter name.
  • Set No to hide this number.
• In the Expand by default field
  • No : The shoppers need to click on the attribute group name to expand the filters.
  • Expand for desktop or mobile or both: With other options, the attribute set will be expanded for each device type when customers enter the Category page.
• In the Apply Filter button field
  • The Apply Filter button allows the shoppers to choose when to apply the chosen filters. With this button, the shoppers don’t need to wait for the page to reload again and again each time they choose a filter.
  • In Add Apply Filter button field, set “Yes” to show the button and leave “No” to disable.
  • Here is how the Apply Filter button works, you can choose lots of attribute before applying it. Also, SEO friendly URL is compatible with Apply Filter’s search result. As you can the this example chose Insulated and Cold, and name of those attributes appears on the URL as well.

• In the Hide the Single-Select Filter after Selection field:

• Yes: The single-select attribute will be hidden after filtering.
• No: Show all attributes on the navigation bar after filtering, including single-select attributes.

2. Additional Filter

2.1. Product State Filter

The Product State Filterfeature allows the shoppers to filter the items by the New, Sale, and Stock status. Here is how the Product State Filter configuration will be displayed:

• In the Group label field: The name of the group attribute
• In the Position field: Admin set the displaying priority for Product State Filter. The smaller number entered, the higher priority to show first.
• In the Expand by default field: Choose Yes to automatically expand the group attribute Rating when shoppers go to the collection page.
• Enable New Filter, Enable On Sales filter, Enable Stock filter: Choose Yes to enable the filter and leave No to disable.
• New label, On Sales label, Stock label: Add the name for each label filter.
• Exclude Categories: Choose categories to exclude Product State Filter.

2.2. Rating Filter

This feature allows the shoppers can filter the items by the rating follows 5 levels from 1 star to 5 stars. For example: when you choose the option 4 stars and up, the received result will display the items which have the 4-star and 5-star rating.

The Rating Filter configuration is available under the Filter Configuration tab.

• In the Enable Rating Filter field: Choose “Yes” to enable and display the group attribute Rating on the Layered Navigation and leave “No” to disable this feature. When you choose “Yes”, there are 2 more options for the modification
• In the Group Label : Adding the text as the group attribute’s name.
• In the Expand by default : Choose “Yes” to automatically expand the group attribute Rating when shoppers go to the collection page.
• In the Position field: Admin can allow Rating Filter to show at different positions such as Top Sidebar, Bottom Sidebar, Below Category Filter.
• Exclude Categories: Choose categories to exclude Rating Filter.

3. SubCategory Slider

• Enable SubCategory Slider: Slelect Yes to allow showing subcategories as slider on corresponding categories.

• Display Type: Choose displaying type for slider

• Label: Slider only shows subcategory name included in its category.
• Image and Label: Slider shows subcategory name and image included in its category.

• Apply for Category: Admin choose category to be shown in slider.
• Auto Play: Select Yes to allow slider to be auto activated
• Items per Slider: Enter the number of item subcategory allowing to be shown on each slider.

4. Filter by decimal attributes

Layered Navigation Professional edition also allows store owner can set up and visitor can filter decimal attributes.

• In the Attribute Information > Properties > Advanced Attribute Properties > Input Validation for Store Owner, choose Decimal Number or Intergal Number to set your optional attribute.

• Follow Attribute Information > ProductsPage Navigation Properties
  • In the Use in ProductsPage Navigation field choose Filterable (with results)
  • In the Use in Search Results ProductsPage Navigation choose Yes
  • In the Display Style field, choose your preferred style as Slider, Range or Slider and Range

For example with Weight option for which product has weight as 15 lb. In the frontend the search result can be filtered like:

5. Show Tooltip

New version of Mageplaza Layered Navigation Professional allows store admins to set up tooltip for each attribute. Tooltip only apply for attribute types: Multiple Select, Dropdown, Price, Visual Swatch, Text Swatch.

Follow Attribute Information > ProductsPage Navigation Properties

• In the Use in ProductsPage Navigation field choose Filterable (with results)

• Show Tooltip: Choose Yes to show Tooltip on attribute filter.
• Tooltip Thumbnail: Click Choose File, admin choose icon for tooltip. Leaving it blank, icon will be default value.

• Tooltip Content: Enter the content for tooltip.

• If tooltip is left blank, it will be assigned with Admin value.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Layered Navigation Ultimate

In order to advance the Magento 2 store layered navigation as well as to bring the best shopping experience to the visitors, Mageplaza developed the Layered Navigation Ultimate extension. This Ultimate version is the advanced version of the Pro version with many powerful and extra features will surely adapt any user’s expectation and plays an important role to build a successful store.

This Layered Navigation extension is a smart map for your Magento 2 store. It’s the shortest way for the shoppers to find what they want, especially when you have a bunch of items with various prices, attributes or brands.

Overview

After enabling the module, the Layered Navigation will be displayed on the left sidebar on Categories pages.

Layered Navigation Configuration

The Configuration is available under Admin Panel > Mageplaza > Layered Navigation > Configuration.

• General configuration
• Filter configuration
• Design configuration
• Custom Products pages

Here are the details for the settings of each tab.

1. General Configuration tab

• In the Module Enable field: You can choose to use the Module Layered Navigation or not. Leave as Yes to enable and No to disable.
• In the Multi-Filters field
  • By enabling this feature, the shoppers are allowed to choose more than 1 filter to find the desired items. You can also filter by multi-choose from multiple categories at the same time. For example: The shopper can choose to filter by Color with Black, White and Size with Small, Large at the same time. This can be also applied with multiple categories.
  • To config this feature, go to Enable Multi-filter field, set “Yes/No” to “Enable/ Disable”

• In the Scroll to Top field
  • This feature allows the shoppers, after filtering, can automatically back to the top of the products list and start to find the desired items.
  • On the Scroll to Top after Filtering field, you will have 2 options:
    • YES : After choosing a filter or click on the Apply Filter button, the site will automatically scroll up to the top-page.
    • NO : After choosing a filter or click on the Apply Filter button, the site still stay at the current position.
• In the Quick Lookup Options field
  • By enabling this feature, in each of the attribute group, there is a search box. The shoppers only need to insert the letters and the filter whose name contains this letter will be displayed.
  • Go to Enable Filter options field to “Enable/ Disable” this feature by setting “Yes/ No”.

• In the Display Out-of-stock option field: There are 2 options to choose
  • Yes: Show all the attributes and options even the product is currently out of stock.
  • No: Hide all the attributes and options of the product which is currently out of stock.
• In the Product Count field: With this feature, there will have a number which is displayed next to the filter. This number allows the shoppers to know how many items which is matched the filter. For example: If the filter is displayed: Cotton(2), that means there are 2 items which are matched the filter Cotton.

• In the Display Product Count field
  • Set Yes to display the number to the left of the filter name.
  • Set No to hide this number.
• In the Expand by default field
  • No : The shoppers need to click on the attribute group name to expand the filters.
  • Expand for desktop or mobile or both: With other options, the attribute set will be expanded for each device type when customers enter the Category page.
• In the Show type field: In this session, you can choose the way to display the filter attribute group. There are 3 options:
• Normal

• Hidden

• Scroll

• In the Apply Filter button field
  • The Apply Filter button allows the shoppers to choose when to apply the chosen filters. With this button, the shoppers don’t need to wait for the page to reload again and again each time they choose a filter.
  • In Add Apply Filter button field, set “Yes” to show the button and leave “No” to disable.
  • Here is how the Apply Filter button works, you can choose lots of attribute before applying it. Also, SEO friendly URL is compatible with Apply Filter’s search result. As you can the this example chose Insulated and Cold, and name of those attributes appears on the URL as well.

• In the Hide the Single-Select Filter after Selection field:

• Yes: The single-select attribute will be hidden after filtering.
• No: Show all attributes on the navigation bar after filtering, including single-select attributes.

• In the Infinite Scroll field
  • Continue with the next session. Infinite Scroll, or also called the Lazy-scrolling on a website, this feature will help to automatically load the new products in the list when the shoppers scroll to the bottom, without clicking or reloading.
  • In the field Infinite scroll, set “Yes” to enable the feature and “No” to disable.
• In the Show Navigation field
  • By default, the Vertical & Horizontal Navigation feature has 3 display styles so `Mageplaza Layered Navigation`_() can match to any store design with different purposes.
  • In the Show Navigation field, choose 1 of 3 options below :
    • Vertical

• • • Horizontal

• • • Both

• Show Out of Stock products at the end: Select the condition so that the out-of-stock products will be displayed at the bottom of the catalog page.

• Base on Stock Label: Products with the out-of-stock label will be displayed at the bottom of the catalog page.
• Base on qty (<1): Products with quantity lower than 1 will be displayed at the bottom of the catalog page.
• No: Out-of-stock products stay at the current position.

1.1. Highlight Option in Filter

• Show Highlight Option in the Filter: If Yes, selected filtering options will be highlighted in color. Show extra field:

• Text Color: Show colors to highlight the option attributes.

2. Additional Filter

2.1. Product State Filter

The Product State Filterfeature allows the shoppers to filter the items by the New, Sale, and Stock status. Here is how the Product State Filter configuration will be displayed:

• Group label: The name of the group attribute
• Position: Admin set the displaying priority for Product State Filter. The smaller number entered, the higher priority to show first.
• Expand by default: Choose Yes to automatically expand the group attribute Rating when shoppers go to the collection page.
• Enable New Filter, Enable On Sales filter, Enable Stock filter: Choose Yes to enable the filter and leave No to disable.
• New label, On Sales label, Stock label: Add the name for each label filter.
• Exclude Categories: Choose categories to exclude Product State Filter.

2.2. Rating Filter

This feature allows the shoppers can filter the items by the rating follows 5 levels from 1 star to 5 stars. For example: when you choose the option 4 stars and up, the received result will display the items which have the 4-star and 5-star rating.

The Rating Filter configuration is available under the Filter Configuration tab.

• In the Enable Rating Filter field: Choose “Yes” to enable and display the group attribute Rating on the Layered Navigation and leave “No” to disable this feature. When you choose “Yes”, there are 2 more options for the modification:
  • In the Group Label : Adding the text as the group attribute’s name.
  • In the Expand by default : Choose “Yes” to automatically expand the group attribute Rating when shoppers go to the collection page.
  • In the Position field: Admin can allow Rating Filter to show at different positions such as Top Sidebar, Bottom Sidebar, Below Category Filter.
• In the Show as Slider field
  • Choose “Yes” if you want to display Vertical Slider

• Exclude Categories: Choose categories to exclude Rating Filter.

3. SubCategory Slider

• Enable SubCategory Slider: Slelect Yes to allow showing subcategories as slider on corresponding categories.

• Display Type: Choose displaying type for slider

• Label: Slider only shows subcategory name included in its category.
• Image and Label: Slider shows subcategory name and image included in its category.

• Apply for Category: Admin choose category to be shown in slider.
• Auto Play: Select Yes to allow slider to be auto activated
• Items per Slider: Enter the number of item subcategory allowing to be shown on each slider.

4. Design Configuration

The Slider type field allows you to choose the type of the Price Slider. There are 5 options to choose:

• Default

• Flat UI

• HTML5

• Modern

• Nice White

• Simple dark

Note: To make the config on Design Configuration tab works, please make sure you have set the Display type on the Attribute Configuration > Color to be Slider.

5. Custom Products Pages

By enabling Custom products page feature, all of your items will be displayed in only 1 pages with the advanced filtering. That allows the shoppers don’t need to find the exact categories page to filter the desired items.

Besides, Mageplaza also provides the SEO config to improve the page’s ranking on the search engine result pages.

The Custom products page configuration is available under Admin Panel > Mageplaza > Layered Navigation: Custom Products Pages. Choose a product page to edit.

5.1 Page Information

After choosing/creating a specific Product page, choose Page Information scroll down to see some essential information:

• In the Name field: Enter the name of the custom page in the backend.
• In the Page Title field: Enter the name of the custom page in the frontend.
• In the URL key field: Enter the characters you want to display in the URLs. For example: If you insert ‘products’, the All products page’s URL will be: yourstore.com/products
• In the Store View field: Choose specific store views you want to display
• In the Status field: You can enable/disable the custom product page.
• In the Link Position field: Choose the position of the link.
• In the Description field: Enter the description of Custom Product Pages
• In the CMS Block Display Position field: Select the display position of the CMS Block on Custom Product Pages
• In the CMS Block field: Select the CMS Block displayed on Custom Product Pages

In addtion, you can configure the SEO attribute for the all products page to have the best SEO performance. There are 4 fields:

• In the Meta title field: Enter the meta tittle for the custom product page.
• In the Meta keywords field: Enter the meta keyword for the custom product page.
• In the Meta description field: Enter the meta descripton for the custom product page.

5.2 Default Attributes

Default Attributes allows you set the default attribute for the all products page. That means when the shoppers open the all products page, you can decide which products will be displayed first.

For example : If you set the option Cool and Cold of the attribute Climate as the Default Attributes, the items which have Cool and Cold will be displayed first when the shoppers go to the Custom Product Pages

6. Attribute Configuration

Go to Admin Panel > Stores > Attributes: Product, then choose an attribute and go to Layered Navigation Properties tab.

6.1 Attribute Properties

Example of a specific attribution and its configuration in detail

• In the Use in ProductsPage Navigation field: Choose the possibility of being displayed on Layered Navigation or not
• In the Use in Search Results ProductsPage Navigation field: Choose the possibility of being filtered by Layered Navigation or not.
• In the Position field: The attribute has bigger posistion will be placed lower. 0 to set it in default as Magento 2’s principle.
• In the Allow Multiple Filter field: By choose Yes, the shoppers are able to filter by multi-option in this group attribute. For example: You can allow the shoppers to choose more than 1 filter in Color group attribute but only can choose 1 filter in Style group attribute.
• In the Display Style field: Choose the display style of the group attribute. The specific design for each style is mentioned in the next section.
• In the Enable search option field: Choose to enable/ disable the Quick Lookup Option in this attribute group.
• In the Expand by default field: Choose to automatically expand this attribute group or not when the shoppers go to the collection page.

6.2 Filter by decimal attributes

Layered Navigation also allows store owner can set up and visitor can filter decimal attributes.

• In the Attribute Information > Properties > Advanced Attribute Properties > Input Validation for Store Owner, choose Decimal Number or Intergal Number to set your optional attribute.

• Follow Attribute Information > ProductsPage Navigation Properties
  • In the Use in ProductsPage Navigation field choose Filterable (with results)
  • In the Use in Search Results ProductsPage Navigation field choose Yes
  • In the Display Style field choose your preferred style as Slider, Range or Slider and Range

For example with the Weight option for which product has weight as 15 lb. On the frontend, the search result can be filtered like:

6.3 Show Tooltip

New version of Mageplaza Layered Navigation Professional allows store admins to set up tooltip for each attribute. Tooltip only apply for attribute types: Multiple Select, Dropdown, Price, Visual Swatch, Text Swatch.

Follow Attribute Information > ProductsPage Navigation Properties

• In the Use in ProductsPage Navigation field choose Filterable (with results)

• Show Tooltip: Choose Yes to show Tooltip on attribute filter.
• Tooltip Thumbnail: Click Choose File, admin choose icon for tooltip. Leaving it blank, icon will be default value.

• Tooltip Content: Enter the content for tooltip.

• If tooltip is left blank, it will be assigned with Admin value.

7. Shop By Brand’s configuration

Magento 2 Shop by Brand extension is also one of such great tool. Similar to the navigation, Shop by Brand allows filtering by product attributes, but they are neither color or material or any physical features of the product. The plugin bases on brands (manufacturers) the products are made by.

Provided Shop By Brand’s User guide can be found here

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Loyalty Program

Overview

For increasing the demand for shopping, connecting between customers and store owners especially close customers, Mageplaza developed the Loyalty Program extension. This module can create incentive programs for loyal customers who meet certain conditions. Conditions will be based on customer information and customer order information within a certain time. In addition, the module also allows the admin to add/remove certain customers to a loyalty program, create a separate program with statistics of the current status of customers and information about the program (using static blocks). You should intall Mageplaza SMTP to avoid sending your email to spam box. It is fully compatible with Loyalty Program.

How to download and install

• Download Mageplaza Loyalty Program
• How to Install

How to use

Email notification when customer can join certain loyalty program

Email notification of maintaining the loyalty program

Email notification of downgrading loyalty program

Email notification of expiration of the loyalty program

Show order statistics and information about the program

How to Configure

1. Configuration

From the Admin Panel, go to Marketing > Loyalty Program > Configuration

1.1. General

From the Admin Panel, go to Marketing > Loyalty Program > Configuration, select General

• Enable: Select Yes to enable the module.

• Enable Loyalty Page: Select Yes to show the Loyalty page at frontend

• Select Static Block:

  • Select the content displayed on the Loyalty page.
  • You can access Content > Elements > Blocks, click Add New Block to create a new Static Block page, or click Edit to edit the Static page you created.

  

• Order Statistic Row: show the order statistics by row. Click More to add the data, or click the Bin icon to delete the data

  • Row Name: Insert the row name
  • Order Condition: Choose the conditions to show orders. There are 3 options: Number of Order, Total Order Amount, Average Order Amount
  • Order Status: Choose the order status

• Order Statistic Column: show the order statistics by column. Click More to add the data, or click the Bin icon to delete the data

  • Column Name: Add the column name
  • Duration: Choose the time to show statistics. There are four options: Day, Month, Year, Custom
  • Start Time: Starting time to calculate the statistic
  • End Time: Finishing time to get the statistic

• Note: If Day or Month or Year is chosen for Duration, Start Time and End Time must be in numbers only. The numbers indicate the length of time.

Eg: Duration = Month, Start Time = 2, End Time = 0 (or left blank).

=> The result is the statistics of 2 months earlier.

As for Custom duration, Start Time and End Time can be in text which is in relative formats.

Eg: Start Time = first day of the previous month, End Time = first day of this month.

=> The result will be the statistics of last month.

• Add to Schedule: Choose Yes to enable automatic checking on Customer Apply Program. If your website deals with a lot of customer data and orders, applying a schedule helps speed up the automatic checking process.

Note: When you select Yes in the field Add to Schedule, the Apply Program button in the Manage Loyalty Program Grid will be hidden. This is because running both simultaneously can conflict with the system and cause errors on the website. Display more fields:

• Apply Schedule: Set the time for the system to check the apply program automatically. The default value is 0 0 * * *, meaning it will auto-run every day. For more details, please check here.

Note: To check faster, you can also run this command line:

php bin/magento mp-loyaltyprogram:apply

1.2. Email Configuration

From the Admin Panel, go to Marketing > Loyalty Program > Configuration, select Email Configuration

• Enable:
  • Select Yes to allow sending email notifications to customers.
  • Install Mageplaza_SMTP to avoid sending to spam box.
• Sender: Select the representative to send the email notification to customer:

• Enable join program email: Select Yes to allow email notification when customers can join certain loyalty program.
• Join program template:
  • Email notifications are auto-sent when customers gain certain loyalty program.
  • You can access Marketing > Email Templates, select Add New Templates to create a notification email template
  • Instructions on how to create new email templates can be found here
• Enable Maintain Program Email: Select Yes to enable sending email notification of maintaining loyalty program when customers are still satisfy the program’s conditions
• Maintain Program Email Template:
  • Email notifications are auto-sent when customers maintain certain loyalty program.
  • You can access Marketing > Email Templates, select Add New Templates to create a notification email template
  • Instructions on how to create new email templates can be found here
• Enable Downgrade Program Email: Select Yes to enable sending email notification of downgrade loyalty program
• Downgrade Program Email Template:
  • Email notifications are auto-sent when customers are downgraded to certain loyalty program.
  • You can access Marketing > Email Templates, select Add New Templates to create a notification email template
  • Instructions on how to create new email templates can be found here
• Enable leave program email: Select Yes to allow sending email notification when customer account expires a loyalty program.
• Leave program template:
  • Email notifications are pre-installed when the customer’s account expires a loyalty program.
  • You can access Marketing > Email Templates, select Add New Templates to create a notification email template
  • Instructions on how to create new email templates can be found here

2. Grid

2.1. Manage Loyalty Program

From the Admin Panel, go to Marketing > Loyalty Program > Manage Loyalty Program

• This is where the Loyalty Program information is displayed.
• From the Manage Loyalty Program section, the admin can capture basic information of Loyalty Programs such as ID, Name, Status, Number of customers, Number of Rules, Priority, and Action.
• Actions:
  • Delete: Delete information on the Manage Loyalty Program page.
  • Change Status: Change the status of the selected Loyalty Program.
  • Edit: Redirect to the edit page of the previously created Loyalty Program
• In addition, the admin can filter, change store view, hide/show columns.
• Apply Programs: Apply all programs for customers that are set in each program.

2.2. Create/Edit Loyalty Program

From the Admin Panel, go to Marketing > Loyalty Program > Manage Loyalty Program, select Add new/edit

2.2.1. General

• Name: Enter the name of a loyalty program. this is a required field.
• Status: Select Enable so that the loyalty program can be activated
• Duration: Set the active time for the loyalty program. There are four options: Permanent, Day, Month, Yea. In which, Permanent means that Loyalty Program will be active unlimited time
• Description: Enter the description of the loyalty program, the information is displayed under the program name. Admin can add images, change the description to HTML, adit the description types.

• Priority:

  • Enter the priority level to filter conditions for customers satisfied the loyalty program.
  • 0 is the highest priority.

  Note: Choose the cart price rule to apply to your Loyalty Program. Navigate to Marketing > Cart Price Rule, select Add new rule to create a new rule. In each rule, choose a suitable option in the field Loyalty Programs. Customers who meet these Loyalty Programs criteria can use the coupon code created from this rule.

2.2.2. Conditions

Select the conditions to apply customers to each program. The customer information will be shown at table below (2.2.3)

2.2.3. Customers

Only displayed when admin finishes creating the program.

• Click Select, choose one or many customer groups to add to the loyalty program, then Save.

• Click Add Customer to add more customer to the program. The successfully added customers will be display in the grid below.

2.3. Manage Customer

From the Admin Panel, go to Marketing > Loyalty Program > Manage Customer

• Here showing customer information in their Loyalty Program
• From Manage Customer, admin can have basic customer information such as: ID, Customers Name, Email, Customer Group, Loyalty Program, Expired Date, Action.
• In addition, admin can filter, change the storeview, show/hide the column.

3. REST API

Mageplaza Loyalty Program support users in using REST API to perform actions related to Loyalty Program: using admin access to get information of Loyalty Program, add/edit/delete Loyalty Program, add customer to Loyalty Program , using customer access to get information of Customer’s Loyalty Program Dashboard &Change Email Notify

View details of requests supported by Mageplaza Loyalty Program here

View REST API Guidelines of Magento 2 here. View guidelines to create tokens here.

4. GraphQl

1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-loyalty-program-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Note: Magento 2 Loyalty Program GraphQL requires installing Mageplaza Loyalty Program in your Magento installation.

2. How to use

To perform GraphQL queries in Magento, please do the following requirements:

• Use Magento 2.3.x or higher. Set your site to developer mode.
• Set GraphQL endpoint as http://<magento2-server>/graphql in url box, click Set endpoint. (e.g. http://dev.site.com/graphql)
• Mageplaza Loyalty Program GraphQL supports customers to get Loyalty Dashboard information and change email notify
• To view the queries that the Mageplaza Loyalty Program GraphQL extension supports, click here

Ajax Layered Navigation

Overview

Ajax Layered Navigation features are added to filters and paging blocks, which users can select different filters and category pages without reloading the entire page, enhancing the user experience, reducing the response time as well as uploading to the server. This is a new feature of Mageplaza Ajax Layered Navigation extension that is fully compatible with Mageplaza Layered Navigation.

Mageplaza Ajax Layered Navigation tutorial will provide detailed instructions on how to use on User Interface and how to configure it in the backend.

Download & Install

• Download Ajax Layered Navigation
• Download on github
• How to Install

How to configure

From the Admin Panel, go to Mageplaza > Layered Navigation > Configuration

• Ajax Enable:

  • Select Yes to do the filter with Ajax. With the use of Ajax Layered, after each option, the page will not reload itself but running the ajax, and offer products that satisfy the selected conditions.

  

  • In addition, Ajax Layered supports the Add to wishlist feature by Ajax for customers who have already logged in. After adding to wishlist from Category Page, they can still view other products instead of being redirected to the Wishlist page.

  

Reward Points

Overview

In the modern marketing, loyalty programs play an important role that can’t be denied. Online stores put a lot of effort into keeping old customers and increasing sweet engagement scent between customers and stores. Hence, Mageplaza Reward points extension is developed to increase the interaction between customers and store owners to establish the great consumption cycle on your website.

Magento 2 Reward Points extension will allow earning unlimited reward points as well as using them flexibly as payment methods if necessary. By this way, it is not complicated to build the loyal customer network supplying the number of leads for the merchants.

The Reward Points system does not apply for guest customers.
The Product's Earning Point may vary according to a specific Customer Group and Earning Rate set in the backend.

Download & Install

You can download from the following resouces:

• Mageplaza
• Magento Marketplace
• How to Install

How to use

I. For customers

Customers can earn reward point(s) and use them perfectly in these following pages:

1.1. The checkout page

• Customers can use their earned reward point(s) to discount the order.
• This page also displays earning point(s) customers will receive when they place the order.
• You can find more details here.

1.2. View Cart Page (Shopping Cart)

• This is familiar to the checkout page.
• However, Earning Point(s) can’t be shown on this page if admins disable the field Display Earning Points on Shopping Cart in the backend.
• Notice: Earning Point(s) can be different depend on Customer Group and Earning Rate which are configured in the backend.

II. For admins (store owners)

• Admins are able to create and manage Earning Rate, Spending Rate and Transaction as well as to configure the Reward Points extension generally in the backend.
• Admins are able to apply changes to reward point(s) in the customer’s account in the backend.
• Admins are not supported to use reward point(s) when creating a new order at the moment.

How to configure

Log in to your backend, then go to Marketing > Reward Points

and follow the instruction below to configure Reward Points extension

• Earning Rate
• Spending Rate
• Transactions
• Configuration

Earning rate and Spending Rate are stored in the same table inside the database. Therefore, the admin will probably see a slight difference in IDs of rates.

I. Earning Rate

Go to Marketing > Reward Points: Earning Rate

1.1. General Management.

This is the place where admins can store Earning Rates created.

• From the grid view, admins can acknowledge some fundamental information of Earning Rate such as Website, Customer Group(s), Money Spent, Earning Point(s) and Priority. Also, admins are able to Edit Rate:
  • To edit an earning rate, choose “Edit” in the Action column.
• Admins can filter, hide or display Column or export rates.
• To delete rate, go to edit page, choose Delete

1.2. Add/Edit New Earning Rate

After entering the Earning Rate section, click on Add New Rate to create a new earning rate. Then, click Save and Continue Edit, the page will automatically switch to the Edit Rate page.

• In the Website field: Choose website(s) you want to apply the earning rate.
• In the Customer Group(s) field:
  • Only customers who belong to this group can be entitled this earning rate.
  • Customers who belong to different groups can receive different earning rates even when they purchase the same product.
• In the Earning Rate field
  • Define the conversion rate from X (currency) to Y (point)
  • Admins can fill out the appropriate rate in here. However, decimal numbers are not approved at Point section. If admins enter a decimal number, they will be rounded following the rule in configuration part
• In the Priority field:
  • Indicates the priority of this earning rate compared to other earning rates.
  • 0 indicates the highest priority. The higher number, the lower priority.
  • If there’re many earning rates which have similar priorities, rules will apply on the rate which has a smaller ID first.

II. Spending Rate.

Follow the way Marketing > Reward Points: Spending Rate

2.1. General Management.

This is the place where admins can store Spending Rates created.

• From the grid view, admins can acknowledge some fundamental information of an spending rate such as Website, Customer Group(s), Spending Point(s), Discount Received and Priority. Also, admins can edit rate:
  • To edit an spending rate, choose “Edit” in the Action column.
• Admins can filter, hide or display Column or export rates.
• To delete rate, go to edit page, choose Delete

2.2. Add/Edit New Spending Rate.

After entering the Spending Rate interface, select Add New Rate to create a new spending rate. Then, click Save and Continue Edit, the page will automatically switch to the Edit Rate page.

• In the Website field: Choose website(s) you want to apply the spending rate.
• In Customer Group(s) field
  • Only customers who belong to this group can use their point(s) following this spending rate.
  • Customers who belong to different groups use different spending rates even when they purchase the same product.
• In Spending Rate field
  • Indicates the conversion rate from X (point(s)) to Y (currency)
  • Admins can fill out an appropriate rate in here. However, decimal numbers are not approved. If admins enter a decimal number, they will be rounded following the rule >= 0.5 to 1, or < 0.5 to 0.
• In Min Point: set the minimum number of points that can be spent when order
• In Priority field
  • Indicates the priority of this spending rate compared to other spending rates.
  • 0 indicates the highest priority. The higher number, the lower priority.
  • If there are many spending rates which have similar priorities, rules will apply on the rate which has a smaller ID.

III. Transactions.

The right path is Marketing > Reward Points: Transaction.

3.1. General Management.

This is the place where admins can create and manage transactions. By entering this interface, admins can add/minus customer’s reward point(s).

• From the grid view, admins can acknowledge some fundamental information of created transactions such as ID, Customer, Comment, Amount, Status, Store View, Created Date. Also, admins can:
  • View: To review a transaction, choose “View” in the Action column.
  • Cancel: To cancel a created transaction (in case its expiration date hasn’t come yet), select the transaction and choose “Cancel” in the Action box (at the left of the grid).
  • Expired: Admins need to take this action if a transaction isn’t expired automatically. At this point, take the same action when admins view/cancel a transaction, choose “Expired” then process with the OK button.
• Admins can filter, hide/display Column or export transaction.

3.2. Add new transaction.

After entering Transaction tab, choose Add new transaction to generate a new transaction. Next, click Save and Continue Edit, the page will direct to the View Rate page.

• In the Customer field

  • Click this section to display the store’s customer list in the popup form. Admins can only choose 1 from this customer list.
  • Name of the chosen customer will be added reward point(s) to her/his account.
  • If you leave this field blank, there will be an error message.

• In the Point(s) field

  • Enter the number of point(s) you want to add for the chosen customer.
  • If you enter negative numbers or leave it blank, there will be an error message.
  • If you enter a decimal number, it will be rounded down (E.x: 1.8 = 1.1 = 1)

• In the Comment field

  • Enter the comment that will be sent along with the added point(s) to the chosen customer.
  • You can leave this field blank.

• In the Points expire after field

  • The added point(s) of this transaction will be expired after X day(s) from the time you create this transaction.
  • Admins have the right to add higher point(s) than the maximum point of the amount which a customer can accumulate (E.x: max point = 1000, admins can add 1100 points or even more to the customer balance).

  Note: Transaction is allowed adding point only, cannot subtract point. If you want to remove the added points, please click Cancel

3.3. View Transaction.

Admins can review or expire a transaction in the View Transaction page.

IV. Configuration.

Follow in the backend Store > Settings > Configuration. At the left panel, choose Mageplaza > Rewward Points

4.1. General Configuration.

This general configurations can apply for the whole module.

• In the Enable field: Choose “Yes” to active the Reward Point extension from Mageplaza.
• In the Label in My Account Navigation field: Enter the name of Tab Reward Point displayed on the frontend at the My Account > Reward Point section.
• In the Point Label field:
  • This label will be displayed on the frontend.
  • If you leave it blank, there will be an error message.
• In the Plural Point Label field:
  • If the balance is greater than 1, this label will be displayed on the frontend.
  • If you leave it blank, there will be an error message.
• In the Display Point Label field:
  • Select After Amount to display the point label after number (ex: 5 points).
  • Select Before Amount to display the number label before number (ex: points 5).
• In the Zero Point Label field:
  • Enter the label when the customer’s account balance is equal to 0.
  • If you leave it blank, there will be an error message.
• In the Show Point Icon field: Choose “Yes” to display the point icon on the frontend.
• In the Reward Point Icon field:
  • The upload image will be used as the point icon and be shown on the frontend.
  • JPG, PNG or GIF files are accepted. There will be an error message if the input file is invalid.
  • If you leave it blank, the default icon will be used .
• In the Maximum Available Point Balance field
  • Set the maximum number of point(s) that the customer can accumulate by purchasing.
  • If customer’s account balance reaches to this number, there will be no more points awarded to the balance.
  • Admins can add point(s) to an account balance with no awareness of this value.
  • If the field is left blank or 0, there will be no restriction for the maximum points
• In Redirect to My Points and Rewards page after customer login account field: Select Yes to redirect customers to My Points and Rewards page right after customer logs in or creates an account.

Landing Page

• Choose Landing Page: Selct page to show when clicking on the Landing Page link.

• Display Landing Page On Footer Link: Select Yes to show Landing Page Link in the Footer.

• Landing Page Label: Enter the label to show Landing Page link in the Footer.

Highlight Point on Storefront

• Show in Cart: Choose Yes to enable highlight point in Shopping Cart page > Summary Cart
• Show on Checkout Page: Choose Yes to enable highlight point in Checkout page
• Text Color: choose the highlight color

4.2. Earning Configuration.

4.2.1. General

This displays general configurations regarding earning point(s)

• In the Rounding Method field: There are 3 options for rounding
  • Normal: The number of points converted from the currency (USD, EUR, …) will be rounded according to the normal rule. E.x: 10.2 rounded to 10; 10.8 rounded to 11.
  • Rounding Up: The number of points converted from the currency (USD, EUR, …) will be rounded up. E.x: 10.2 or 10.8 is rounded to 11.
  • Rounding Down: The number of points converted from the currency (USD, EUR, …) will be rounded down. Ex: 10.2 or 10.8 is rounded to 10.
• In the Points Earning From Tax field: Select “Yes” so the tax can be converted to earning point(s)
• In the Earn points from shipping fee: Select “Yes” to allow Shipping Fee to be converted to point(s).
• In the Point Refund field: When the customer places an order, they will receive a certain amount of earning points. The shop owner selects “Yes” in this section to retrieve the points when customer refunds the order.
• In the Earning Points from Orders with Spent Points: Select Yes so that when customers spend points in a order, they still can earn points from that order.
• In the Notify reward points for guests: Select Yes to notify customers when they have not registered or logged in to their accounts.
• Message: Enter messages to show customers on frontend.

• In the Type of Maximum Earning Points per Order: Choose how to calculate the maximum allowed points for each order. There are 2 types:
  • Fixed: Set the maximum allowed points as a fixed value set in the Maximum Earning Points per Order field.
  • Percent: Set the maximum allowed points as a percentage of the cart set in the Maximum Earning Points per Order field.
• Maximum Earning Points per Order: Set the maximum allowed points customers can get for each order. If left empty or 0, the maximum point is unlimited.

4.2.2. Sales Earning Process.

• In the Earning Points after Invoice created field:
  • Select “Yes” to allow adding earning point(s) to the customer’s account right after the invoice is created.
  • Select “No” to allow adding earning point(s) after the order is completed.
• In the Points Expired After field
  • The number entered here is expiration day of point(s), it starts to count from the day point(s) is (are) added.
  • If this field is blank, point(s) will be used indefinitely.

4.3. Spending Configuration.

• In the Discount Label field: Discount Label displayed on the frontend will change according to the content of this section.
• In the Minimum balance to Spend Points field
  • Set the minimum number of point(s) that customers must have in their balances as a condition to spend points on discounting orders.
  • If the number of point(s) in the customer’s balance is less than the minimum spending point, the Reward Points slider will not appear on the View Page or Checkout Page.
  • If you leave it blank or 0, the default minimum point is 0.
• In Type Maximum Spending Points per Order: Select how to set the maximum number of points allowed per order:
  • Type Maximum Spending Points per Order = Fixed: the maximum number of points used for each order with a fixed value set in Maximum spending points per order field
  • Type Maximum Spending Points per Order = Percent: the maximum number of points used for each order is set as a percentage of the total shopping cart value, set the maximum value in Maximum spending points per order field
• In the Maximum spending points per order field:
  • Set the maximum number of point(s) that customers can use on an order.
  • If you leave it blank or 0, the maximum number of point(s) customers can spend is unlimited (it can be the maximum number of points they own or the maximum number of points which can be converted by SubTotal of Cart).
• In the Points Spending From Tax: Select “Yes” to allow customers apply points to tax discount
• In the Spending Points on Shipping: Select “Yes” to allow customers to use their point(s) to reduce the shipping cost.
• In the Restore spent points after order refunding field: When customers place an order, they can apply a certain amount of their reward point(s). Admins select “Yes” in this section to return point(s) to customers if their orders are refunded.
• In the Use Max Point By Default field: Select “Yes” to set the customer’s spending point(s) to the maximum number that they can use.

4.4. Display Configuration.

Basic configuration for display of Reward Point and Earning Point:

• In the Display Total Points on Top Links field: Select “Yes” to display the total number of reward point(s) that customer has on Top Link.

• In the Hide Total Points on Top Link if the Reward Points balance is empty or equals to zero: Select Yes to hide the total points of customer on the Top Link if the Reward Points balance is null or equals to zero.
• In the Display Earning Points on Minicart field: Select “Yes” to show the total number of earning point(s) customers can receive when checking out the cart at the Minicart page.

4.5. Email Configuration.

• In the Enable Notification Email field: Select “Yes” to allow notification emails to be sent to customers.
• In the Subscribe customers by default field: When a new customer subscribes to a store, receiving no emails is set as default. Select “Yes” in this section so that when their first transaction is made (by purchasing or by admin), Reward Points Notification will be checked immediately.
• In the Sender Email field: Admins can choose one of the 5 available Magento Senders: General Contact, Sales Representative, Customer Support, Customer Email 1, Customer Email 2

4.5.1. Update Point Balance Email

• Enabled: Choose “Yes” to send email notification to customer when their point balance changes
• In the Update Balance Template field
  • Choose email template to send to customer when their point balance changes
  • To change Email Template, admins can create another one under Marketing > Email Template.
  • The instruction to create a new Email Template can be found here.

4.5.2. Points Expiration Email

• Enabled: Choose “Yes” to send email notification to customer when their points are going to expire
• Send Before:
  • Admin set the days the email will be sent before the expiration date
  • If left blank or = 0, reminder email will not be sent
• In the Points expiration Template field:
  • Choose email template to send when customer points are going to exprire
  • To change the Gift Card Email template, admins can create another one under Marketing > Email Template.
  • The instruction to create a new Email Template can be found here.

V. Manage Reward Point of Customer

Admins can manage Reward Points Balance, Transactions and Notification of customers by going to Customer > Edit Customer > Reward Points.

• Tab Balance Information let admin know:
  • Current Balance: The total Reward Point that Customer is having.
  • Total Earning Points: The total Reward Point that Customer earned when making order.
  • Total Spending Points: The total Reward Point that Customer spent.
• In the Update Balance field: Allows admins to change the balance by filling in Update Point and set its expiration date. Admins can also enter the reason for the change in the Comment field
• In the Email Notification field: Admins can register or cancel the subscribe on behalf of the customer when their balance is updated or point(s) is about to expire.
• In the Transactions: Displays information about reward points of customers including: ID, Title, Action, Amount, Status, Store View, Created On, Expire On.

The information about Balance, Notification and Transaction in the backend will be synchronized with the customer’s frontend at My Account > My Points & Reward.

VI. Refund Spent Points

With orders that can be applied reward points to get discount, when they are refunded, the points used before will be can be refunded by store admin

Click on the checkbox Refund Order to Points to refund points, the field Reward Point Refunded will be displayed

• Reward Point Refund: fill in the points refunded, this value must be smaller than the Spent Points was used before for the order

VII. Customer Frontend.

7.1. My Account > My Points & Reward.

7.1.1. Reward Dashboard

Customers can check the Reward Point information in this section after logging in:

• Available Balance: Show the available points of customers, equal to the Current Balance check at Backend.
• Total Earned: Show the earning points of customers, equal to the Total Earning Points check at Backend.
• Total Spent: Show the spending points of customers, equal to the Total Spending Points check at Backend.
• Reward Information indicates
  • Earning Rate and Spending Rate that customer is entitled (according to his Customer Group and Website set in the backend).
  • The maximum number of points that the customer’s balance can receive from orders.
  • The maximum number of days that point(s) can be used since that customer receives point(s).
• At Recent Transactions: Customer can know the transaction history in details
  • Made transaction(s) and its comments.
  • Number of point(s) changed
  • Date and time of the transaction
  • Expiration Dates of point(s)
  • Transaction status
• They can also sign up to receive updates when their balance changes or point(s) is about to expired.
• All information here is synchronized in the backend Customer > Reward Points

7.1.2.

On the Transaction tab, all the rewarded transaction of customers are shown

7.2. Checkout Page

• Customers can use the slider or text box to select the amount of reward point(s) they want to spend.
• Used reward point(s) can be limited to a range.
  • Customers are only allowed to use their point(s) within this range.
  • If Subtotal has a value less than the minimum value of the limited value range, the Apply Reward Point section will not be displayed.
• Tick the checkbox Maximize my discount with Point to use all available points at once. The amount of points can be
  • The total points that customer has if Total Point(s) < Max Point for per Order and Subtotal.
  • Max Point if Max Point < Total Point and Subtotal.
  • The number of point(s) which is equal to Subtotal if that amount < Max Point and Total Point.
• The Order Summary box will display more sections about reward points to make the calculation easier.
• Spending Point can be used for Tax, Shipping Fee if it’s configured in the backend.
• The conversion rate between Reward Point and Spending Point depends on the Spending Rate configuration in the backend.

6.3. Other additional frontends.

• Top link: Displays the point(s) that customer has.

• MiniCart: Displays the earning point(s) of all products in the cart.

• View Cart Page (Shopping Cart): Displays Apply Reward Point on the checkout page, and also displays the Earning Point, Spending Point and Reward Point.

VIII. REST API

Mageplaza Reward Points Standard supports using REST API to make requests related to Transaction, Customer’s Reward account, Reward rate, get config reward information. Customer can use reward points for order via Rest API.

View details of endpoints of Mageplaza Reward Points Standard here.

View REST API guidelines of Magento 2 here. Guidelines to create tokens here.

XI. GraphQL

9.1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-reward-points-graphql

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

Note: Magento 2 Reward Points GraphQL requires installing Mageplaza Reward Points in your Magento installation.

9.2. How to use

To perform GraphQL queries in Magento, please do the following requirements:

• Use Magento 2.3.x or higher. Set your site to developer mode
• Set GraphQL endpoint as http:///graphql in url box (e.g. http://dev.site.com/graphql)
• View details of queries supported by Mageplaza Reward Points GraphQL extension here

Reward Points Professional

Overview

In the modern marketing, loyalty programs play an important role that can’t be denied. Online stores put a lot of effort into keeping old customers and increasing sweet engagement scent between customers and stores. Hence, Mageplaza Reward points extension is developed to increase the interaction between customers and store owners to establish the great consumption cycle on your website.

Magento 2 Reward Points extension will allow earning unlimited reward points as well as using them flexibly as payment methods if necessary. By this way, it is not complicated to build the loyal customer network supplying the number of leads for the merchants.

The Reward Points system does not apply for guest customers.
The Product's Earning Point may vary according to a specific Customer Group and Earning Rate set in the backend.

Download & Install

You can download from the following resouces:

• Mageplaza Reward Points
• Magento Marketplace
• How to Install

How to use

I. For customers

• Earning Point(s) of the product can be depended on Customer Group, Earning Rate, Catalog Earning Rules, and Shopping Cart Earning Rules which are configured in the backend.
• Spending Point(s) customer use is depended on Spending Rate and Shopping Cart Spending Rule

Customers can earn reward point(s) and use them perfectly in these following pages:

1.1. The checkout page

• Customers can use their earned reward point(s) to discount the order.
• This page also displays earning point(s) customers will receive when they place the order.
• You can find more details here.

1.2. View Cart Page (Shopping Cart)

• This is familiar to the checkout page.
• However, Earning Point(s) can’t be shown on this page if admins disable the field Display Earning Points on Shopping Cart in the backend.
• Notice: Earning Point(s) can be different depend on Customer Group and Earning Rate which are configured in the backend.

II. For admins (store owners)

• Admins are able to create and manage Earning Rate, Spending Rate and Transaction as well as to configure the Reward Points extension generally in the backend.
• Admins are able to apply changes to reward point(s) in the customer’s account in the backend.
• Admins are not supported to use reward point(s) when creating a new order at the moment.

How to configure

Log in to your backend, then go to Marketing > Reward Points and follow the instruction below to configure Reward Points extension

• Earning
• Spending
• Transactions

Earning rate and Spending Rate are stored in the same table inside the database. Therefore, the admin will probably see a slight difference in IDs of rates.

I. Earning

1.1. Earning Rate

Go to Marketing > Reward Points: Earning Rate

1.1.1 General Management

This is the place where admins can store Earning Rates created.

• From the grid view, admins can acknowledge some fundamental information of Earning Rate such as ID, Website, Customer Group, Money Spent, Earning Point and Priority. Also, admins are able to:
  • Delete: Tick the checkbox of the earning rate they want to delete, then choose “Delete” in the Action box (at the left of the grid). Choose “OK” in the confirmation message.
  • To edit an earning rate, choose “Edit” in the Action column.
• Admins can filter, hide or display Column or export rates.

1.1.2. Add/Edit New Earning Rate

After entering the Earning Rate section, click on Add New Rate to create a new earning rate. Then, click Save and Continue Edit, the page will automatically switch to the Edit Rate page.

• In the Website field: Choose website(s) you want to apply the earning rate.
• In the Customer Group(s) field:
  • Only customers who belong to this group can be entitled this earning rate.
  • Customers who belong to different groups can receive different earning rates even when they purchase the same product.
• In the Earning Rate field
  • Define the conversion rate from X (currency) to Y (point)
  • Admins can fill out the appropriate rate in here. However, decimal numbers are not approved. If admins enter a decimal number, they will be rounded following the rule >= 0.5 to 1, or < 0.5 to 0.
• In the Priority field:
  • Indicates the priority of this spending rate compared to other spending rates.
  • 0 indicates the highest priority. The higher number, the lower priority.
  • If there’re many earning rates which have similar priorities, rules will apply on the rate which has a smaller ID first.

1.2. Catalog Earning Rules

1.2.1. General Management

This is the place where admins can store Catalog Earning Rules created.

• From the grid view, admins can acknowledge some fundamental information of an catalog earning rules such as ID, Name, Website, Customer Group, Status, Create On, Expired, and Priority.
• Admins can filter to search for a specific rule.
• After taking some modifications on the rule, click Apply Rule to enable it immediately.

1.2.2. Add New Rule (Edit Rule)

• Admins choose Add New Rule at the right-above corner to create a new catalog rule, after clicking Save and Continue Edit, the page will be directed to the Edit Rate page
• At the Add New Rule page, click on Save and Apply to apply the new rule.
• Add New Rule page has 3 tabs
  • Rule Information
  • Conditions
  • Actions

1.2.2.1. Rule Information

• In the Rule Name field
  • Enter the rule name which will display in the backend.
  • This is required information. There will be an error message if you leave it blank.
• In the Description field: You can note some descriptions of the rule. This field can be left blank.
• In the Status field: Choose “Active” to apply the rule.
• In the Website field: Choose website place(s) you want to apply the rule.
• In the Customer Group field:
  • Choose group(s) of customer you want to apply for them.
  • If the rule applies to Not Logged In customers, they still can learn earning point(s) of each product but point(s) won’t be add unless they sign in or sign up on your store.

• In the From field: You can set up the start time to use the rule, please note about the different of timezones.
• In the To field: You can set up the end time to disable the rule.
• In the Priority field:
  • Identifies the usage priority of this catalog earning Rule compared to others.
  • 0 is the highest priority. The higher number represents the lower priority.
  • If two catalog earning rules has the same priority, the rule with smaller ID will be applied.

1.2.2.2. Conditions

Choose condition to apply the rule. Only Product pages which meets those conditions will be applied.

1.2.2.3. Action

Catalog Earning Rule includes 3 actions:

• Give fixed X points to Customers
  • Customers will receive a fixed X point(s) for a product in their cart.
  • In the Point X field: Enter fixed point(s) you want to set for customers.
  • E.g: If Point X = 5, customer will receive 5 points per product they add to their cart. 2 items will be 10 points, no matter how pricing is.

• Give X points for every Y amount of Price
  • The point(s) will be calculated based on product’s Regular Price (on Special Price if the product has)
  • In the Point X field: Enter X point(s) customer will receive for every Y amount of price.
  • In the Money Step field: Enter the minimum Y amount so that customer can receive X points. Pricing will be rounded following Rounding Method of the configuration.
  • In the Maximum Earning Points field: Set the maximum earning point customer can get from this rule.
  • E.g: Point (X) = 1, Money Step (Y) = 20, and Maximum Earning Point = 5 which mean
    • When the customer purchases a product which costs $40, he will earn 2 points
    • When the customer purchases a product which costs more than $100, he will only earn 5 points
    • On the other hand, A product has Regular Price=$40, Special Price=$20, they will earn 1 point only

• Give X points for every Y amount of Profit
  • Some products that admins enter cost - as the price entered into that product. Profit is calculated by the sale price minus the cost. Action Give X points for every Y amount of Profit will transfer the difference to Point. If the product is not filled Cost, Profit is equal to Price.
  • In the Point X field: Enter X point(s) customer will receive for every Y amount of regular price (profit).
  • In the Money Step Y field: Enter the minimum Y amount so that customer can receive X points. Pricing will be rounded following Rounding Method of the configuration
  • In the Maximum Earning Points field: Set the maximum earning point customer can get from this rule.
  • E.g: Product A has Regular Price = $40, Special Price = 20$, cost = 25$, Point (X) = 1, Money Step (Y) = 20, and Maximum Earning Points = 5 which mean when the customer purchase Product A, point(s) will be based on (40$ - 25$ = 15$) and he will earn 1 points
• Give points according to X% of original price

• Customers will get points according to X% of the original price, not based on the special price or the discounted price.
• Points (X): Enter the X% of the original price that customers can get points
• Maximum Earning Points: Enter the maximum Earning Points that custoimers can get based on this rule
• E.g: Product A has Original Price = $32, Special Price = 20$. When you set Points (x) = 10, Maximum Earning Points = 2, customers can get 32 x 10% = 3.2 point, however, because the Maximum Earning Points = 2, finally customer will only get 2 points.
• Stop further rule processing: Choose “Yes” to restrict the number of catalog earning rules applied to a product.
  • E.g: Let’s say there are 4 Cataloging Earning Rules created in turn, Rule 1, Rule 2, Rule 3, Rule 4, and priorities are 0, 5, 3, 3.
    • All rules choose Stop further rules processing = No: 4 rules will be applied and points are accumulated. The customer will receive points from the summation of 4 rules.
    • Rule 3 has Stop further rules processing = Yes: After applying, rule 1 will be applied (since it has higher priority) and rule 3. Rule 2 and 4 won’t be applied because they have smaller priorities.

1.3. Shopping Cart Earning Rules

1.3.1. General Management

This is the place where admins can store Shopping Cart Earning Rules created

• From the grid view, admins can acknowledge some fundamental information of a Shopping Cart Earning rule such as ID, Name, Status, Create On, Expired, and Priority.
• Admins can filter to search for a specific rule.

1.3.2. Add New Rule (Edit Rule)

• Admins choose Add New Rule at the right-above corner to create a new shopping cart earning rule, after clicking Save and Continue Edit, the page will be directed to the Edit Rate page
• The Add New Rule page has 3 tabs
  • Rule Information
  • Conditions
  • Actions

1.3.2.1. Rule Information

• In the Rule Name field
  • Enter the rule name which will display in the backend.
  • This is required information. There will be an error message if you leave it blank.
• In the Description field: You can note some descriptions of the rule. This field can be left blank.
• In the Status field: Choose “Active” to apply the rule.
• In the Website field: Choose website place(s) you want to apply the rule.
• In the Customer Group field:
  • Choose group(s) of customer you want to apply for them.
  • Shopping Cart Earning Rule doesn’t apply to NOT LOGGED IN CUSTOMER.
• In the From field: You can set up the start time to use the rule, please note about the different of timezones.
• In the To field: You can set up the end time to disable the rule.
• In the Priority field:
  • Identifies the usage priority of this shopping cart earning rule compared to others.
  • 0 is the highest priority. The higher number represents the lower priority.
  • If two shopping cart earning rules has the same priority, the rule with smaller ID will be applied.

1.3.2.2. Conditions

Choose condition to apply the rule. Only the cart which meets those conditions will be applied.

1.3.2.3. Actions

Shopping Cart Earning Rule includes 3 actions:

• Give fixed X points for whole cart:
  • Customer will receive a fixed amount of point(s) based on a purchased cart.
  • In the Point (X) field: Enter point(s) customer can earn. This is the required field.
  • E.x: Point (X) = 5 which means no matter how many products in the customer cart, they will only earn 5 points.

• Give X points for every Y amount of Price
  • The point(s) will be calculated based on the cart’s Subtotal
  • In the Point X field: Enter X point(s) customer will earn for every Y amount of price.
  • In the Money Step field: Enter the minimum Y amount so that customer can receive X points. Pricing will be rounded following Rounding Method of the configuration.
  • In the Maximum Earning Points field: Set the maximum earning point customer can earn from this rule.
  • E.g: Point (X) = 1, Money Step (Y) = 20, and Maximum Earning Point = 5 which mean
    • When the customer purchases a cart which has Subtotal = $40, he will earn 2 points
    • When the customer purchases a cart which has Subtotal more than $100, he will earn only 5 points

• Give X points for every Y amount of Quantity:
  • The point(s) will be calculated based on product’s quantity
  • In the Point (X) field: Enter X point(s) customer will earn for every Y quantity
  • In the Money Step field: Enter the minimum Y amount so that customer can receive X points. Pricing will be rounded following Rounding Method of the configuration.
  • In the Maximum Earning Points field: Set the maximum earning point customer can earn from this rule.
  • E.g: Point (X) = 5, Quantity Step (Y) = 1, and Maximum Earning Points = 5 which mean:
    • When the customer place order a cart which has 6 products, he will earn 6 points.
    • When the customer place order a cart which has more than 15 products, he will earn 5 points only.

• Give fixed X points for every fixed Y amount of Price:
  • When the order value is from $Y (the Order Total will depend on the configuration of including Earn Points from Tax and Shipping or not), customers will earn fixed X points. And when the order value equals the multiples of $Y, the points will be multiplied accordingly.
  • In the Point (X) field: Enter the fixed X point(s) customer will earn for every Y amount of order total.
  • In the Money Step field: Enter the minimum Y amount so that customer can receive fixed X points for every Y amount of price. Pricing will be rounded following Rounding Method of the configuration.
  • In the Maximum Earning Points By This Rule field: Set the maximum earning point customer can earn from this rule.
  • E.g: Point (X) = 10, Money Step (Y) = 100, and Maximum Earning Points = 30 which mean:
    • When the customer places an order that has the Order Total of $100, he will earn 10 points. If the Order Total is $120, he will still get only 10 points, and if the Order Total is from $200, he will earn 20 points, if the Order Total is from $300, he will earn 30 points, etc. The maximum point he can get is 30 points.
    • Note: This Order Total takes into account the fact that you include Earn Points from Tax and Shipping. If you do not configure to include them, Order Total will exclude the tax and shipping fee from the total value for customers to earn points.
• Stop further rule processing: Choose “Yes” to restrict the number of catalog earning rules applied to a product.
  • E.g: Let’s say there are 4 Cataloging Earning Rules created in turn, Rule 1, Rule 2, Rule 3, Rule 4, and priorities are 0, 5, 3, 3.
    • All rules choose Stop further rules processing = No: 4 rules will be applied and points are accumulated. The customer will receive points from the summation of 4 rules.
    • Rule 3 has Stop further rules processing = Yes: After applying, rule 1 will be applied (since it has higher priority) and rule 3. Rule 2 and 4 won’t be applied because they have smaller priorities.
• Apply the rule only to cart items matching the following conditions (leave blank for all items)

Only when product(s) in the cart meet these conditions, rule will be applied.

II. Spending

Follow the way Marketing > Reward Points: Spending Rate

2.1. Spending Rate

2.1.1. General Management.

This is the place where admins can store Spending Rates created.

• From the grid view, admins can acknowledge some fundamental information of an spending rate such as ID, Website, Customer Group, Spending Point, Discount Received and Priority. Also, admins can:
  • Delete: Tick the checkbox of the spending rate they want to delete, then choose “Delete” in the Action box (at the left of the grid). Choose “OK” in the confirmation message.
  • To edit an spending rate, choose “Edit” in the Action column.
• Admins can filter, hide or display Column or export rates.

2.1.2 Add/Edit New Spending Rate.

After entering the Spending Rate interface, select Add New Rate to create a new spending rate. Then, click Save and Continue Edit, the page will automatically switch to the Edit Rate page.

• In the Website field: Choose website(s) you want to apply the spending rate.
• In Customer Group(s) field
  • Only customers who belong to this group can use their point(s) following this spending rate.
  • Customers who belong to different groups use different spending rates even when they purchase the same product.
• In Spending Rate field
  • Indicates the conversion rate from X (point) to Y (currency)
  • Admins can fill out an appropriate rate in here. However, decimal numbers are not approved. If admins enter a decimal number, they will be rounded following the rule >= 0.5 to 1, or < 0.5 to 0.
• In Min Point: set the minimum number of points that can be spent when order
• In Priority field
  • Indicates the priority of this earning rate compared to other earning rates.
  • 0 indicates the highest priority. The higher number, the lower priority.
  • If there are many spending rates which have similar priorities, rules will apply on the rate which has a smaller ID.

2.2. Shopping Cart Spending Rule

2.2.1. General Management

This is the place where admins can save all Shopping Cart Spending rules.

• From the grid view, admins can acknowledge some fundamental information of a Shopping Cart Spending Rule such as ID, Name, Status, Create On, Expired, and Priority.
• Admins can filter to search for a specific rule.

2.2.2. Add New Rule (Edit Rule)

• Admins choose Add New Rule at the right-above corner to create a new shopping cart earning rule, after clicking Save and Continue Edit, the page will be directed to the Edit Rate page
• The Add New Rule page has 4 tabs
  • Rule Information
  • Conditions
  • Actions
  • Labels

2.2.2.1. Rule Information

• In the Rule Name field
  • Enter the rule name which will display in the backend to distinguish with other rules
  • This is required information. There will be an error message if you leave it blank.
• In the Description field: You can note some descriptions of the rule. This field can be left blank.
• In the Status field: Choose “Active” to apply the rule.
• In the Website field: Choose website place(s) you want to apply the rule.
• In the Customer Group field:
  • Choose group(s) of customer you want to apply for them.
  • Shopping Cart Spending Rule doesn’t apply to NOT LOGGED IN CUSTOMER.
• In the From field: You can set up the start time to use the rule, please note about the different of timezones.
• In the To field: You can set up the end time to disable the rule.
• In the Priority field:
  • Identifies the usage priority of this shopping cart spending rule compared to others.
  • 0 is the highest priority. The higher number represents the lower priority.
  • If two shopping cart spending rules has the same priority, the rule with smaller ID will be applied first.

2.2.2.2. Conditions

Conditions of Shopping Cart Spending Rule is divided into 2 parts:

• Conditions: Only cart which meets chosen conditions can be applied.

• Spending Point Action:
  • In the Action field: There’re 2 options:
    • Give discount for fixed X points: Customers can spend a fixed point(s) that admin set in this section.
    • Give discount for every X points: Cusstomer can spend point(s) to use X points to get discount for every Y amount (Y will be set up in the Action tab). The applicable X points cannot be exceeded ** Maximum Redeemable Points**.
  • In the X Point field: Enter the number of point(s) you want to set for the above conditions.

2.2.2.3. Actions

Admins configure Discount Amount corresponding to X Point which is set in the Conditions tab. There’s 2 types of action:

• Give a fixed discount amount for the whole cart: Discount Amount is set fixedly for every X point(s).

• Give a percent discount amount for the whole cart: Discount Amount is calculated based on percent of Order Total.

• E.x: Discount Amount = 10 in the Action tab. In Conditions tab, choose Action = Give discount for every X points and X = 1. When a customer places an order which costs $500:
  • The customer will be discounted $10 for every 1 point spending if in the backend, the admin chooses Action = Give a fixed discount amount for the whole cart. Particularly, he spends 1 point and only needs to pay $490 for the order (which hasn’t been included Shipping Fee and Tax).
  • The customer will be discounted 10% for every 1 point spending if in the backend, the admin chooses Action = Give a percent discount amount for the whole cart. Particularly, he spends 1 point and only needs to pay $450 for the order (which hasn’t been included Shipping Fee and Tax)

Besides, admins can configure more conditions to apply the rule properly.

2.2.2.4. Labels

This is where admins configure the lable for the rule in every Store View of a store. If it’s left blank, default lable will be displayed on the frontend.

III. Transactions.

The right path is Marketing > Reward Points: Transaction.

3.1. General Management.

This is the place where admins can create and manage transactions. By entering this interface, admins can add/minus customer’s reward point(s).

• From the grid view, admins can acknowledge some fundamental information of created transactions such as ID, Customer, Action, Point(s), Expire On, Date, Status. Also, admins can:
  • View: To review a transaction, choose “View” in the Action column.
  • Cancel: To cancel a created transaction (in case its expiration date hasn’t come yet), select the transaction and choose “Cancel” in the Action box (at the left of the grid).
  • Expired: Admins need to take this action if a transaction isn’t expired automatically. At this point, take the same action when admins view/cancel a transaction, choose “Expired” then process with the OK button.
• Admins can filter, hide/display Column or export rates.

3.2. Add new transaction.

After entering Transaction tab, choose Add new transaction to generate a new transaction. Next, click Save and Continue Edit, the page will direct to the View Rate page.

• In the Customer field
  • Click this section to display the store’s customer list in the popup form. Admins can only choose 1 from this customer list.
  • Name of the chosen customer will be added reward point(s) to her/his account.
  • If you leave this field blank, there will be an error message.
• In the Points field
  • Enter the number of point(s) you want to add for the chosen customer.
  • If you enter negative numbers or leave it blank, there will be an error message.
  • If you enter a decimal number, it will be rounded down (E.x: 1.8 = 1.1 = 1)
• In the Comment field
  • Enter the comment that will be sent along with the added point(s) to the chosen customer.
  • You can leave this field blank.
• In the Points expire after field
  • The added point(s) of this transaction will be expired after X day(s) from the time you create this transaction.
  • Admins have the right to add higher point(s) than the maximum point of the amount which a customer can accumulate (E.x: max point = 1000, admins can add 1100 points or even more to the customer balance).

3.3. View Transaction.

Admins can review or expire a transaction in the View Transaction page.

IV. Configuration

Follow in the backend Store > Settings > Configuration. At the left panel, choose Mageplaza > Rewward Points

4.1. General Configuration.

This general configurations can apply for the whole module.

• In the Enable field: Choose “Yes” to active the Reward Point extension from Mageplaza.
• In the Label in My Account Navigation field: Enter the name of Tab Reward Point displayed on the frontend at the My Account > Reward Point section.
• In the Point Label field:
  • This label will be displayed on the frontend.
  • If you leave it blank, there will be an error message.
• In the Plural Point Label field:
  • If the balance is greater than 1, this label will be displayed on the frontend.
  • If you leave it blank, there will be an error message.
• In the Display Point Label field:
  • Select After Amount to display the point label after number (ex: 5 points).
  • Select Before Amount to display the number label before number (ex: points 5).
• In the Zero Point Label field:
  • Enter the label when the customer’s account balance is equal to 0.
  • If you leave it blank, there will be an error message.
• In the Show Point Icon field: Choose “Yes” to display the point icon on the frontend.
• In the Reward Point Icon field:
  • The upload image will be used as the point icon and be shown on the frontend.
  • JPG, PNG or GIF files are accepted. There will be an error message if the input file is invalid.
  • If you leave it blank, the default icon will be used .
• In the Maximum Available Point Balance field
  • Set the maximum number of point(s) that the customer can accumulate by purchasing.
  • If customer’s account balance reaches to this number, there will be no more points awarded to the balance, and reward point(s) indicators will not be shown on the frontend.
  • Admins can add point(s) to an account balance with no awareness of this value.
  • If the field is left blank or 0, there will be no restriction for the maximum points
• In Redirect to My Points and Rewards page after customer login account field: Select Yes to redirect customers to My Points and Rewards page right after customer logs in or creates an account.

Landing Page

• Choose Landing Page: Selct page to show when clicking on the Landing Page link.

• Display Landing Page On Footer Link: Select Yes to show Landing Page Link in the Footer.

• Landing Page Label: Enter the label to show Landing Page link in the Footer.

Highlight Point on Storefront:

• Show in Cart: Choose Yes Yes to enable highlight poitn in Shopping Cart page > summary cart
• Show on Checkout Page: Choose Yes Yes to enable highlight poitn in Checkout page
• Show on Product Pages: Choose Yes Yes to enable highlight poitn in Product Detail page
• Show on Categories Pages: Choose Yes Yes to enable highlight poitn in Category page
• Show highlight for Guests: Choose Yes Yes to enable highlight poitn in for non-login customers
• Text Color: Choose color for highlight point

4.2. Earning Configuration.

4.2.1. General

This displays general configurations regarding earning point(s)

• In the Rounding Method field: There are 3 options for rounding
  • Normal: The number of points converted from the currency (USD, EUR, …) will be rounded according to the normal rule. E.x: 10.2 rounded to 10; 10.8 rounded to 11.
  • Rounding Up: The number of points converted from the currency (USD, EUR, …) will be rounded up. E.x: 10.2 or 10.8 is rounded to 11.
  • Rounding Down: The number of points converted from the currency (USD, EUR, …) will be rounded down. Ex: 10.2 or 10.8 is rounded to 10.
• In the Points Earning From Tax field: Select “Yes” so the tax can be converted to earning point(s)
• In the Earn points from shipping fee: Select “Yes” to allow Shipping Fee to be converted to point(s).
• In the Point Refund field: When the customer places an order, they will receive a certain amount of earning points. The shop owner selects “Yes” in this section to retrieve the points when customer refunds the order.
• In the Earning Points from Orders with Spent Points: Select Yes so that when customers spend points in a order, they still can earn points from that order.
• In the Notify reward points for guests: Select Yes to notify customers when they have not registered or logged in to their accounts.
• Message: Enter messages to show customers on frontend.

• In the Type of Maximum Earning Points per Order: Choose how to calculate the maximum allowed points for each order. There are 2 types:
  • Fixed: Set the maximum allowed points as a fixed value set in the Maximum Earning Points per Order field.
  • Percent: Set the maximum allowed points as a percentage of the cart set in the Maximum Earning Points per Order field.
• Maximum Earning Points per Order: Set the maximum allowed points customers can get for each order. If left empty or 0, the maximum point is unnlimited.

4.2.2. Sales Earning Process.

• In the Earning Points after Invoice created field:
  • Select “Yes” to allow adding earning point(s) to the customer’s account right after the invoice is created.
  • Select “No” to allow adding earning point(s) after the order is completed.
• In the Points Expired After field
  • The number entered here is expiration day of point(s), it starts to count from the day point(s) is (are) added.
  • If this field is blank, point(s) will be used indefinitely.

4.3. Spending Configuration.

• In the Discount Label field: Discount Label displayed on the frontend will change according to the content of this section.
• In the Minimum spending points per order field
  • Set the minimum number of point(s) that customers must have in their balances as a condition to spend points on discounting orders.
  • If the number of point(s) in the customer’s balance is less than the minimum spending point, the Reward Points slider will not appear on the View Page or Checkout Page.
  • If you leave it blank or 0, the default minimum point is 0.
• In Type Maximum Spending Points per Order: Select how to set the maximum number of points allowed per order:
  • Type Maximum Spending Points per Order = Fixed: the maximum number of points used for each order with a fixed value set in Maximum spending points per order field
  • Type Maximum Spending Points per Order = Percent: the maximum number of points used for each order is set as a percentage of the total shopping cart value, set the maximum value in Maximum spending points per order field
• In the Maximum spending points per order field:
  • Set the maximum number of point(s) that customers can use on an order.
  • If you leave it blank or 0, the maximum number of point(s) customers can spend is unlimited (it can be the maximum number of points they own or the maximum number of points which can be converted by SubTotal of Cart).
• In the Points Spending From Tax: Choose “Yes” to enable customers to spend points to get discouted tax fee
• In the Spending Points on Shipping: Select “Yes” to allow customers to use their point(s) to reduce the shipping cost.
• In the Restore spent points after order refunding field: When customers place an order, they can apply a certain amount of their reward point(s). Admins select “Yes” in this section to return point(s) to customers if their orders are refunded.
• In the Use Max Point By Default field: Select “Yes” to set the customer’s spending point(s) to the maximum number that they can use.

4.4. Display Configuration.

• In the Display Total Points on Top Links field: Select “Yes” to display the total number of reward point(s) that customer has on Top Link.

• In the Hide Total Points on Top Link if the Reward Points balance is empty or equals to zero: Select Yes to hide the total points of customer on the Top Link if the Reward Points balance is null or equals to zero.
• In the Display Points Summary on Dashboard Page field: Select “Yes” to display the total number of reward point(s) that customer has in the Reward Point tab.

• In the Display Earning Points on Minicart field: Select “Yes” to show the total number of earning point(s) customers can receive when checking out the cart at the Minicart page.

4.5. Email Configuration.

• In the Enable Notification Email field: Select “Yes” to allow notification emails to be sent to customers.
• In the Subscribe customers by default field: When a new customer subscribes to a store, receiving no emails is set as default. Select “Yes” in this section so that when their first transaction is made (by purchasing or by admin), Reward Points Notification will be checked immediately.
• In the Sender Email field: Admins can choose one of the 5 available Magento Senders: General Contact, Sales Representative, Customer Support, Customer Email 1, Customer Email 2
• In the Update Point Balance Email Template field
  • Pre-installed email configuration that customers can receive the notification mail when there are changes in their balance.
  • To change Email Template, admins can create another one under Marketing > Email Template.
  • The instruction to create a new Email Template can be found here.
• In the Points expiration Email Template field:
  • Pre-installed email configuration that customers can receive the notification mails when their reward point(s) is (are) about to expire.
  • To change the Gift Card Email template, admins can create another one under Marketing > Email Template.
  • The instruction to create a new Email Template can be found here.
• In the Send email reminder before a transaction expires field
  • Set how many day(s) before the expiration date the email can be sent.
  • If you leave the field blank or 0, reminder email will not be sent.

V. Manage Reward Point of Customer

Admins can manage Reward Points Balance, Transactions and Notification of customers by going to Customer > Edit Customer > Reward Points.

• In the Reward Points Balance field: Indicates the total reward point(s) the customer has.
• In the Update Point Update Balance field: Allows admins to change the balance by filling in Update Point and set its expiration date. Admins can also enter the reason for the change in the Comment field
• In the Reward Points Notification field: Admins can register or cancel the subscribe on behalf of the customer when their balance is updated or point(s) is about to expire.
• In the Reward Points History grid: Displays information about all executed transactions: ID, Store View, Point, Point Spend, Date, Date Expired, Comment.

The information about Balance, Notification and Transaction in the backend will be synchronized with the customer’s frontend at My Account > My Points & Reward.

VI. Refund Spent Point

With orders that can be applied reward points to get discount, when they are refunded, the points used before will be can be refunded by store admin

Click on the checkbox Refund Order to Points to refund points, the field Reward Point Refunded will be displayed

• Reward Point Refund: fill in the points refunded, this value must be smaller than the Spent Points was used before for the order

VII. Customer Frontend.

7.1. My Account/My Points & Reward.

7.1.1. Reward Dashboard

Customers can check the Reward Point information in this section after logging in:

• Available Balance: Show current points of customer. This value equals Current Balance in the backend
• Total Earned: Show points that customer get from orders. This value quals Total Earning Points in the backend
• Total Spent: Show points used by customer. This value equals Total Spending Points in the backend
• Reward Information indicates
  • Earning Rate and Spending Rate that customer is entitled (according to his Customer Group and Website set in the backend).
  • The maximum number of points that the customer’s balance can receive from orders.
  • The maximum number of days that point(s) can be used since that customer receives point(s).
• At Recent Transaction: Customer can know the transaction history in details
  • Reason of transaction
  • Number of point(s) changed
  • Date and time of the transaction
  • Expiration Dates of point(s)
  • Transaction status
• They can also sign up to receive updates when their balance changes or point(s) is about to expired.
• All information here is synchronized in the backend Customer > Reward Points

7.1.2

On the Transaction tab, all the rewarded transaction of customers are shown

7.2. Checkout Page

• Customers can use the slider or text box to select the amount of reward point(s) they want to spend.
• Used reward point(s) can be limited to a range.
  • Customers are only allowed to use their point(s) within this range.
  • If Subtotal has a value less than the minimum value of the limited value range, the Apply Reward Point section will not be displayed.
• Tick the checkbox Maximize my discount with Point to use all available points at once. The amount of points can be
  • The total points that customer has if Total Point(s) < Max Point for per Order and Subtotal.
  • Max Point if Max Point < Total Point and Subtotal.
  • The number of point(s) which is equal to Subtotal if that amount < Max Point and Total Point.
• The Order Summary box will display more sections about reward points to make the calculation easier.
• Spending Point can be used for Tax, Shipping Fee if it’s configured in the backend.
• The conversion rate between Reward Point and Spending Point depends on the Spending Rate configuration in the backend.

7.3. Other additional frontends.

• Top link: Displays the point(s) that customer has.

• MiniCart: Displays the earning point(s) of all products in the cart.

• View Cart Page (Shopping Cart): Displays Apply Reward Point on the checkout page, and also displays the Earning Point, Spending Point and Reward Point.

VIII. REST API

Mageplaza Reward Points Standard supports using REST API to make requests related to Transaction, Customer’s Reward account, Reward rate, get config reward information. Customer can use reward points for order via Rest API.

View details of endpoints of Mageplaza Reward Points Professional here.

View REST API guidelines of Magento 2 here. Guidelines to create tokens here.

XI. GraphQL

9.1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-reward-points-graphql

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

Note: Magento 2 Reward Points GraphQL requires installing Mageplaza Reward Points in your Magento installation.

9.2. How to use

To perform GraphQL queries in Magento, please do the following requirements:

• Use Magento 2.3.x or higher. Set your site to developer mode
• Set GraphQL endpoint as http:///graphql in url box (e.g. http://dev.site.com/graphql)
• View details of queries supported by Mageplaza Reward Points GraphQL extension here

Reward Points Ultimate

Overview

In order to improve Magento 2 Reward Points extension as well as bring the most interesting features to the customers, Mageplaza has developed Reward Points Ultimate extension. This is an advanced version of Professional version that comes with tons of powerful functions for admins in managing their online stores.

How to use

I. For customers

• Earning Point(s) of the product can be depended on Customer Group, Earning Rate, Catalog Earning Rules, and Shopping Cart Earning Rules which are configured in the backend.
• Spending Point(s) customer use is depended on Spending Rate and Shopping Cart Spending Rule

Customers can earn reward point(s) and use them perfectly in these following pages:

1.1. The checkout page

• Customers can use their earned reward point(s) to discount the order.
• This page also displays earning point(s) customers will receive when they place the order.
• You can find more details here.

1.2. View Cart Page (Shopping Cart)

• This is familiar to the checkout page.
• However, Earning Point(s) can’t be shown on this page if admins disable the field Display Earning Points on Shopping Cart in the backend.
• Notice: Earning Point(s) can be different depend on Customer Group and Earning Rate which are configured in the backend.

1.3. Purchase the products by points

When you reach the number of specific points, customers can purchase the products by points instead of paying the money as usual. The price of products based on points will display when the Balance of customers has a larger point than the Product’s point price.

Note: If the cart has the products that are sold by points, customers cannot use points to discount for the cart.

1.4. Some ways to earn points

Cusomters can perform some following actions to earn the points:

• Place the order and complete it
• Create a new account
• Subscribe to the newsletter
• Write a review
• Send the email to refer the products to the friends
• Add the birthday
• Like the page by Facebook account
• Share the page by Twitter account
• Share the purchase by Facebook or Twitter account
• Refer to the friends

II. For admins (store owners)

• Admins are able to create and manage Earning Rate, Spending Rate and Transaction as well as to configure the Reward Points extension generally in the backend.
• Admins are able to apply changes to reward point(s) in the customer’s account in the backend.
• Admins are not supported to use reward point(s) when creating a new order at the moment.

How to configure

Log in to your backend, then go to Marketing > Reward Points and follow the instruction below to configure Reward Points extension

• Earning
• Spending
• Transactions

I. Earning

1.1. Earning Rate

Go to Marketing > Reward Points: Earning Rate

1.1.1 General Management

This is the place where admins can store Earning Rates created.

• From the grid view, admins can acknowledge some fundamental information of Earning Rate such as ID, Website, Customer Group, Money Spent, Earning Point and Priority. Also, admins are able to:
  • To edit an earning rate, choose “Edit” in the Action column.
• Admins can filter, hide or display Column or export rates.

1.1.2. Add/Edit New Earning Rate

After entering the Earning Rate section, click on Add New Rate to create a new earning rate. Then, click Save and Continue Edit, the page will automatically switch to the Edit Rate page.

• In the Website field: Choose website(s) you want to apply the earning rate.
• In the Customer Group(s) field:
  • Only customers who belong to this group can be entitled this earning rate.
  • Customers who belong to different groups can receive different earning rates even when they purchase the same product.
• In the Earning Rate field
  • Define the conversion rate from X (currency) to Y (point)
  • Admins can fill out the appropriate rate in here. However, decimal numbers are not approved. If admins enter a decimal number, they will be rounded following the rule >= 0.5 to 1, or < 0.5 to 0.
• In the Priority field:
  • Indicates the priority of this earning rate compared to other earning rates.
  • 0 indicates the highest priority. The higher number, the lower priority.
  • If there’re many earning rates which have similar priorities, rules will apply on the rate which has a smaller ID first.

1.2. Catalog Earning Rules

1.2.1. General Management

This is the place where admins can store Catalog Earning Rules created.

• From the grid view, admins can acknowledge some fundamental information of an catalog earning rules such as ID, Name, Website, Customer Group, Status, Create On, Expired, and Priority.
• Admins can filter to search for a specific rule.
• After taking some modifications on the rule, click Apply Rule to enable it immediately.

1.2.2. Add New Rule (Edit Rule)

• Admins choose Add New Rule at the right-above corner to create a new catalog rule, after clicking Save and Continue Edit, the page will be directed to the Edit Rate page
• At the Add New Rule page, click on Save and Apply to apply the new rule.
• Add New Rule page has 3 tabs
  • Rule Information
  • Conditions
  • Actions

1.2.2.1. Rule Information

• In the Rule Name field
  • Enter the rule name which will display in the backend.
  • This is required information. There will be an error message if you leave it blank.
• In the Description field: You can note some descriptions of the rule. This field can be left blank.
• In the Status field: Choose “Active” to apply the rule.
• In the Website field: Choose website place(s) you want to apply the rule.
• In the Customer Group field:
  • Choose group(s) of customer you want to apply for them.
  • If the rule applies to Not Logged In customers, they still can learn earning point(s) of each product but point(s) won’t be add unless they sign in or sign up on your store.

• In the From field: You can set up the start time to use the rule, please note about the different of timezones.
• In the To field: You can set up the end time to disable the rule.
• In the Priority field:
  • Identifies the usage priority of this catalog earning Rule compared to others.
  • 0 is the highest priority. The higher number represents the lower priority.
  • If two catalog earning rules has the same priority, the rule with smaller ID will be applied.

1.2.2.2. Conditions

Choose condition to apply the rule. Only Product pages which meets those conditions will be applied.

1.2.2.3. Action

Catalog Earning Rule includes 3 actions:

• Give fixed X points to Customers
  • Customers will receive a fixed X point(s) for a product in their cart.
  • In the Point X field: Enter fixed point(s) you want to set for customers.
  • E.g: If Point X = 5, customer will receive 5 points per product they add to their cart. 2 items will be 10 points, no matter how pricing is.

• Give X points for every Y amount of Price
  • The point(s) will be calculated based on product’s Regular Price (on Special Price if the product has)
  • In the Point X field: Enter X point(s) customer will receive for every Y amount of price.
  • In the Money Step field: Enter the minimum Y amount so that customer can receive X points. Pricing will be rounded following Rounding Method of the configuration.
  • In the Maximum Earning Points field: Set the maximum earning point customer can get from this rule.
  • E.g: Point (X) = 1, Money Step (Y) = 20, and Maximum Earning Point = 5 which mean
    • When the customer purchases a product which costs $40, he will earn 2 points
    • When the customer purchases a product which costs more than $100, he will only earn 5 points
    • On the other hand, A product has Regular Price=$40, Special Price=$20, they will earn 1 point only

• Give X points for every Y amount of Profit
  • Some products that admins enter cost - as the price entered into that product. Profit is calculated by the sale price minus the cost. Action Give X points for every Y amount of Profit will transfer the difference to Point. If the product is not filled Cost, Profit is equal to Price.
  • In the Point X field: Enter X point(s) customer will receive for every Y amount of regular price (profit).
  • In the Money Step Y field: Enter the minimum Y amount so that customer can receive X points. Pricing will be rounded following Rounding Method of the configuration
  • In the Maximum Earning Points field: Set the maximum earning point customer can get from this rule.
  • E.g: Product A has Regular Price = $40, Special Price = 20$, cost = 25$, Point (X) = 1, Money Step (Y) = 20, and Maximum Earning Points = 5 which mean when the customer purchase Product A, point(s) will be based on (40$ - 25$ = 15$) and he will earn 1 points
• Stop further rule processing: Choose “Yes” to restrict the number of catalog earning rules applied to a product.
  • E.g: Let’s say there are 4 Cataloging Earning Rules created in turn, Rule 1, Rule 2, Rule 3, Rule 4, and priorities are 0, 5, 3, 3.
    • All rules choose Stop further rules processing = No: 4 rules will be applied and points are accumulated. The customer will receive points from the summation of 4 rules.
    • Rule 3 has Stop further rules processing = Yes: After applying, rule 1 will be applied (since it has higher priority) and rule 3. Rule 2 and 4 won’t be applied because they have smaller priorities.

1.3. Shopping Cart Earning Rules

1.3.1. General Management

This is the place where admins can store Shopping Cart Earning Rules created

• From the grid view, admins can acknowledge some fundamental information of a Shopping Cart Earning rule such as ID, Name, Status, Create On, Expired, and Priority.
• Admins can filter to search for a specific rule.

1.3.2. Add New Rule (Edit Rule)

• Admins choose Add New Rule at the right-above corner to create a new shopping cart earning rule, after clicking Save and Continue Edit, the page will be directed to the Edit Rate page
• The Add New Rule page has 3 tabs
  • Rule Information
  • Conditions
  • Actions

1.3.2.1. Rule Information

• In the Rule Name field
  • Enter the rule name which will display in the backend.
  • This is required information. There will be an error message if you leave it blank.
• In the Description field: You can note some descriptions of the rule. This field can be left blank.
• In the Status field: Choose “Active” to apply the rule.
• In the Website field: Choose website place(s) you want to apply the rule.
• In the Customer Group field:
  • Choose group(s) of customer you want to apply for them.
  • Shopping Cart Earning Rule doesn’t apply to NOT LOGGED IN CUSTOMER.
• In the From field: You can set up the start time to use the rule, please note about the different of timezones.
• In the To field: You can set up the end time to disable the rule.
• In the Priority field:
  • Identifies the usage priority of this shopping cart earning rule compared to others.
  • 0 is the highest priority. The higher number represents the lower priority.
  • If two shopping cart earning rules has the same priority, the rule with smaller ID will be applied.

1.3.2.2. Conditions

Choose condition to apply the rule. Only the cart which meets those conditions will be applied.

1.3.2.3. Actions

Shopping Cart Earning Rule includes 3 actions:

• Give fixed X points for whole cart:
  • Customer will receive a fixed amount of point(s) based on a purchased cart.
  • In the Point (X) field: Enter point(s) customer can earn. This is the required field.
  • E.x: Point (X) = 5 which means no matter how many products in the customer cart, they will only earn 5 points.

• Give X points for every Y amount of Price
  • The point(s) will be calculated based on the cart’s Subtotal
  • In the Point X field: Enter X point(s) customer will earn for every Y amount of price.
  • In the Money Step field: Enter the minimum Y amount so that customer can receive X points. Pricing will be rounded following Rounding Method of the configuration.
  • In the Maximum Earning Points field: Set the maximum earning point customer can earn from this rule.
  • E.g: Point (X) = 1, Money Step (Y) = 20, and Maximum Earning Point = 5 which mean
    • When the customer purchases a cart which has Subtotal = $40, he will earn 2 points
    • When the customer purchases a cart which has Subtotal more than $100, he will earn only 5 points

• Give X points for every Y amount of Quantity:
  • The point(s) will be calculated based on product’s quantity
  • In the Point (X) field: Enter X point(s) customer will earn for every Y quantity
  • In the Money Step field: Enter the minimum Y amount so that customer can receive X points. Pricing will be rounded following Rounding Method of the configuration.
  • In the Maximum Earning Points field: Set the maximum earning point customer can earn from this rule.
  • E.g: Point (X) = 5, Quantity Step (Y) = 1, and Maximum Earning Points = 5 which mean:
    • When the customer place order a cart which has 6 products, he will earn 6 points.
    • When the customer place order a cart which has more than 15 products, he will earn 5 points only.
• Stop further rule processing: Choose “Yes” to restrict the number of catalog earning rules applied to a product.
  • E.g: Let’s say there are 4 Cataloging Earning Rules created in turn, Rule 1, Rule 2, Rule 3, Rule 4, and priorities are 0, 5, 3, 3.
    • All rules choose Stop further rules processing = No: 4 rules will be applied and points are accumulated. The customer will receive points from the summation of 4 rules.
    • Rule 3 has Stop further rules processing = Yes: After applying, rule 1 will be applied (since it has higher priority) and rule 3. Rule 2 and 4 won’t be applied because they have smaller priorities.
• Apply the rule only to cart items matching the following conditions (leave blank for all items)

Only when product(s) in the cart meet these conditions, rule will be applied.

1.4. Behavior Rules

Go to Marketing > Reward Points > Earning > Behavior Rules

1.4.1. Basic management Interface

This is a place storing all Behavior Rules that shop owners have created.

From the Grid, admins can know all basic information of Behavior Rules as ID, Name, Action, Point Amount, Status, Create On, Expired, Priority.

Admins can filter to find the rule on the Grid.

1.4.2. Add New Rule

• After going to the Behavior Rules page, admins can choose Add New Rule to create a new Behavior Rule. After choosing Save and Continue Edit, the page will auto-redirect to the Edit Rate page.
• The Add New Rule page includes 3 main tabs:
  • Rule Information
  • Conditions
  • Actions

1.4.2.1. Rule Information

Rule Information shows the basic information of the rule. These information will be displayed outside the grid.

• Rule Name:
  • This is the name of the rule. This name will only show in the backend, it is used to distinguish with other Behavior Rules
  • This is a required field. It will notify the error if you leave it blank
• Description:
  • This field allows admins to describe about the effect of the rule
  • You can leave this field blank
• Status: Choose Active so that the rule can work
• Website: Choose Website that the rule is applied
• Customer Group:
  • Choose Customer Group that the rule is applied
  • A rule can be applied for many Customer Group
  • Only some Behavior Rules are applied for NOT LOGGED IN CUSTOMER
• From: Set the start day using the Behavior Rule. Please note about the timezone’s difference
• To: Set the finish day using Behavior Rule
• Priority:
  • Indicates the priority used by this Behavior Rule against other Behavior Rules.
  • 0 is the highest priority. The bigger the number, the smaller the priority
  • When two Behavior Rules have the same priority, the rule that has a smaller ID will be prioritized (the rule is created first).

1.4.2.2. Conditions

• After customers perform the action set here, they will receive a certain amount of points that admins set in the Action section

• The actions/events that can be plus points including:

  • Create a new account: The customers receive the point when they register the account
  • Sign up for a newsletter: When the customers subscribe to the newsletter, they will be plused points. Note that only one point is given for this action. After you cancel, then resigter again, you won’t get the point.
  • Write a review: When customers write a review for the product and it is approved, the point will be added. However, the review needs to meet the word count requirement. At the same time, customers may need to purchase the product before reviewing or the number of their paid orders must reach a minimum value for getting the point.

  

  • Send email to friends: Plus the points when customers send an email to refer the products to friends
  • Customer's birthday: Plus points on the customer’s birthday occasion. Admins can set the notification for customers or not, at the same time, admins also can change the Sender and the email template if they want

  

  • Like a page with Facebook: Plus points when customers like a page via Facebook account. To limit the spam, admins can set the minimum time between two likes of an account

  

  • Tweet a page with Twitter: Similar to Like a page with Facebook, but this action is to share the page on Twitter

  

  • Share a purchase on Facebook: When customers place order completely, customers can share the products including in the order on Facebook or Twitter to get the points. For the Facebook, admins need to App Id so that the rule can work well

  

• Get X Points after Y days of Inactivity: After a certain days of being Inactive, customer will receive points

• Points Allocation: Points will be added for customers every week on the start day (Actions tab)

• Lifetime Amount: When reaching a certain Invoice Amount, customers will earn points.

1.4.2.3. Actions

• For the actions as Create a new account, Sign up for a newsletter, Send email to friends, Customer birthday occurs, admins only need to set the amount of points that customers receive when performing each action.
• Expire After: Select the expiration date since receiving points. When customers take actions such as Create a new account, Sign up for a newsletter, Customer birthday occurs, they will get points and these points will expire after the selected time since the receiving date. If left empty, there is no expiration of the points.

• For the remaining actions, admins can limit the number of points that Customers receive in a given time period (per day, per month, per year or lifetime).

II. Spending

Follow the way Marketing > Reward Points: Spending Rate

2.1. Spending Rate

2.1.1. General Management.

This is the place where admins can store Spending Rates created.

• From the grid view, admins can acknowledge some fundamental information of an spending rate such as ID, Website, Customer Group, Spending Point, Discount Received and Priority. Also, admins can:
  • To edit an spending rate, choose “Edit” in the Action column.
• Admins can filter, hide or display Column or export rates.

2.1.2 Add/Edit New Spending Rate.

After entering the Spending Rate interface, select Add New Rate to create a new spending rate. Then, click Save and Continue Edit, the page will automatically switch to the Edit Rate page.

• In the Website field: Choose website(s) you want to apply the spending rate.
• In Customer Group(s) field
  • Only customers who belong to this group can use their point(s) following this spending rate.
  • Customers who belong to different groups use different spending rates even when they purchase the same product.
• In Spending Rate field
  • Indicates the conversion rate from X (point) to Y (currency)
  • Admins can fill out an appropriate rate in here. However, decimal numbers are not approved. If admins enter a decimal number, they will be rounded following the rule >= 0.5 to 1, or < 0.5 to 0.
• In Min Point field: set the minimum point can be spent when order
• In Priority field
  • Indicates the priority of this spending rate compared to other spending rates.
  • 0 indicates the highest priority. The higher number, the lower priority.
  • If there are many spending rates which have similar priorities, rules will apply on the rate which has a smaller ID.

2.2. Shopping Cart Spending Rule

2.2.1. General Management

This is the place where admins can save all Shopping Cart Spending rules.

• From the grid view, admins can acknowledge some fundamental information of a Shopping Cart Spending Rule such as ID, Name, Status, Create On, Expired, and Priority.
• Admins can filter to search for a specific rule.

2.2.2. Add New Rule (Edit Rule)

• Admins choose Add New Rule at the right-above corner to create a new shopping cart earning rule, after clicking Save and Continue Edit, the page will be directed to the Edit Rate page
• The Add New Rule page has 4 tabs
  • Rule Information
  • Conditions
  • Actions
  • Labels

2.2.2.1. Rule Information

• In the Rule Name field
  • Enter the rule name which will display in the backend to distinguish with other rules
  • This is required information. There will be an error message if you leave it blank.
• In the Description field: You can note some descriptions of the rule. This field can be left blank.
• In the Status field: Choose “Active” to apply the rule.
• In the Website field: Choose website place(s) you want to apply the rule.
• In the Customer Group field:
  • Choose group(s) of customer you want to apply for them.
  • Shopping Cart Spending Rule doesn’t apply to NOT LOGGED IN CUSTOMER.
• In the From field: You can set up the start time to use the rule, please note about the different of timezones.
• In the To field: You can set up the end time to disable the rule.
• In the Priority field:
  • Identifies the usage priority of this shopping cart spending rule compared to others.
  • 0 is the highest priority. The higher number represents the lower priority.
  • If two shopping cart spending rules has the same priority, the rule with smaller ID will be applied first.

2.2.2.2. Conditions

Conditions of Shopping Cart Spending Rule is divided into 2 parts:

• Conditions: Only cart which meets chosen conditions can be applied.

• Spending Point Action:
  • In the Action field: There’re 2 options:
    • Give discount for fixed X points: Customers can spend a fixed point(s) that admin set in this section.
    • Give discount for every X points: Cusstomer can spend point(s) to use X points to get discount for every Y amount (Y will be set up in the Action tab). The applicable X points cannot be exceeded ** Maximum Redeemable Points**.
  • In the X Point field: Enter the number of point(s) you want to set for the above conditions.

2.2.2.3. Actions

Admins configure Discount Amount corresponding to X Point which is set in the Conditions tab. There’s 2 types of action:

• Give a fixed discount amount for the whole cart: Discount Amount is set fixedly for every X point(s).

• Give a percent discount amount for the whole cart: Discount Amount is calculated based on percent of Order Total.

• E.x: Discount Amount = 10 in the Action tab. In Conditions tab, choose Action = Give discount for every X points and X = 1. When a customer places an order which costs $500:
  • The customer will be discounted $10 for every 1 point spending if in the backend, the admin chooses Action = Give a fixed discount amount for the whole cart. Particularly, he spends 1 point and only needs to pay $490 for the order (which hasn’t been included Shipping Fee and Tax).
  • The customer will be discounted 10% for every 1 point spending if in the backend, the admin chooses Action = Give a percent discount amount for the whole cart. Particularly, he spends 1 point and only needs to pay $450 for the order (which hasn’t been included Shipping Fee and Tax)

Besides, admins can configure more conditions to apply the rule properly.

2.2.2.4. Labels

This is where admins configure the lable for the rule in every Store View of a store. If it’s left blank, default lable will be displayed on the frontend.

III. Referrals

Go to Marketing > Reward Points > Referrals

3.1. Rules

3.1.1. Basic management interface

It stores all Referrals Rules that store owners have created

• From the Grid, admins can know all basic information of Referrals Rules as ID, Name, Website(s), Customer Group(s), Status, Created On, Expired, Priority
• Admins can also filter to find the rule on the Grid

3.1.2. Add New Rule (Edit Rule)

• After entering the Rules page, admins select Add New Rule to create a new Refer Rule. After the Save and Continue Edit, the page will automatically switch to the Edit Rate page
• The Add New Rule page consists of three main tabs:
  • Rule Information
  • Conditions
  • Actions

3.1.2.1. Rule Information

Rule Information shows the basic information of the rule. These information will be displayed outside the grid.

• Rule Name:
  • This is the name of the rule. This name will only show in the backend, it is used to distinguish with other Refer Rules
  • This is a required field. It will notify the error if you leave it blank
• Description:
  • This field allows admins to describe about the effect of the rule
  • You can leave this field blank
• Status: Choose Active so that the rule can work
• Website: Choose Website that the rule is applied
• Customer Group:
  • Choose Customer Group that the rule is applied
  • A rule can be applied for many Customer Group
  • Only accounts of the selected group are applied for this rule
• Referral Group(s):
  • Choose Customer Group that the rule is applied
  • A rule can be applied for many Customer Group
  • Only the accounts of this group have the Refer code applied the rule

For example: Refer code of the account A is 123, Refer code of account B is abc. A is in General Customer. B is in Retailed Customer. Rule has Customer Group as General, Referral Group as General.

• When A and B send the code at the same time to C as General Customer, only the code of A works.
• When A and B send the code to D as Wholesale Customer, both the code A and B don’t work
• From: Set the start day using the Refer Rule. Please note about the timezone’s difference
• To: Set the finish day using Refer Rule
• Priority:
  • Indicates the priority used by this Refer Rule against other Behavior Rules.
  • 0 is the highest priority. The bigger the number, the smaller the priority
  • When two Refer Rules have the same priority, the rule that has a smaller ID will be prioritized (the rule is created first).

3.1.2.2. Conditions

This section allows admins to choose the conditions for the carts. Only carts that meet the selected conditions, the rule is applied.

3.1.2.3. Actions

• Customer Action:
  • Set the point or discount that customers can get access to refer link to place order for each order
  • There are 4 actions that admins can choose:
    • Give fixed points to Customers: No matter how much Order Total, Customer can get X points
    • Give X points for every Y amount of price: Based on Order Total to calculate the number of points that Customer can receive in a certain proportion.
    • Give a fixed discount to Customer: No matter how much Total Order, Customer can receive a certain amount of discount. Customer will receive discount for whole cart instead of receiving point
    • Give percent discount to Customer: No matter how much Order Total, Customer can receive a percentage discount. Customers will receive the discount for whole cart instead of receiving the point
  • Admins can apply the rule for shipping fee or select Stop further rules processing to limit the number of refer rules applied
• Referral's Action
  • Set the amount of points that Customer - who sent refer - can receive when the customers whom they send refer link to order and complete the order
  • There are 2 actions that admins can choose:
    • Give fixed X points to Referer: Regardless of how much the refer link user order, the referer still receives a fixed amount X point.
    • Give X points for every Y amount of Price: The number of points that referers can receive depends on the total order ordered by the referrer.

Note: Each customer uses one the refer link only. Referral get reward points for referee’s first order only.

3.2. Invitation History

• As soon as Customer uses a referral link to place a successful order, Invitation History will log the basic information such as ID, Referral Email, Invitation Email, Referral Earn, Invited Earn, Invited Discount, Store.
• This information will be synchronized with My referral of the referer.
• The amount of Invited Earn and Invited Discount applies to referral users as soon as they place the order
• The amount of Referral earn are only added to the referers when the order is complete

IV. Transactions.

The right path is Marketing > Reward Points: Transaction.

4.1. General Management.

This is the place where admins can create and manage transactions. By entering this interface, admins can add/minus customer’s reward point(s).

• From the grid view, admins can acknowledge some fundamental information of created transactions such as ID, Customer, Action, Point(s), Expire On, Date, Status. Also, admins can:
  • View: To review a transaction, choose “View” in the Action column.
  • Cancel: To cancel a created transaction (in case its expiration date hasn’t come yet), select the transaction and choose “Cancel” in the Action box (at the left of the grid).
  • Expired: Admins need to take this action if a transaction isn’t expired automatically. At this point, take the same action when admins view/cancel a transaction, choose “Expired” then process with the OK button.
• Admins can filter, hide/display Column or export rates.

4.2. Add new transaction.

After entering Transaction tab, choose Add new transaction to generate a new transaction. Next, click Save and Continue Edit, the page will direct to the View Rate page.

• In the Customer field
  • Click this section to display the store’s customer list in the popup form. Admins can only choose 1 from this customer list.
  • Name of the chosen customer will be added reward point(s) to her/his account.
  • If you leave this field blank, there will be an error message.
• In the Points field
  • Enter the number of point(s) you want to add for the chosen customer.
  • If you enter negative numbers or leave it blank, there will be an error message.
  • If you enter a decimal number, it will be rounded down (E.x: 1.8 = 1.1 = 1)
• In the Comment field
  • Enter the comment that will be sent along with the added point(s) to the chosen customer.
  • You can leave this field blank.
• In the Points expire after field
  • The added point(s) of this transaction will be expired after X day(s) from the time you create this transaction.
  • Admins have the right to add higher point(s) than the maximum point of the amount which a customer can accumulate (E.x: max point = 1000, admins can add 1100 points or even more to the customer balance).

4.3. View Transaction.

Admins can review or expire a transaction in the View Transaction page.

V. Milestones

Go to Marketing > Reward Points > Milestone

5.1 Grid

• In Milestone grid, you will see Milestone Tier information such as ID, Name, Status, Customer Group (s), Website, Number of Customer. Also on the grid, you can use the mass action to change the status or delete the tier you have created
• Click Add Milestone Tier to add a new Tier

5.2 Add Milestone Tier

5.2.1 General Tab

• Tier Name: fill in the name for milestone tier
• Status: set up status for tier. There 2 statuses: Enable and Disable
• Image: click on Choose File button to select image logo for tier
• Customer Group(s): select Customer Groups that can use tier program. You can select multiple groups
• Website: select website to apply tier. You can select multiple websites
• Min Points Value: set the minimum point customer must reach to join Milestone Tier Program
• Number of Orders: the number of orders that customer must buy to join the Milestone Tier
• Description: fill in the description for Milestone Tier

5.2.2 Benefit Tab

• Increase Earning Points: the percentage increase in points applicable to Earn Rate, Catalog Rules, and Shopping Cart Rules when the customer joins the milestone. For example, a customer’s order has a total of $50, with a earning rate of 1 $ for every $ 1 and Increase Earning Points is 10, the number of points the customer will receive will be 50 + 50 * 10% = 55 points
• Fixed Points: the number of points will be added when the milestone customer implements the Behavior Rules. For example: Fixed Points is 1, with the setting at Behavior Rule is Write a Review, the normal customer receives 4 points, the customer of Milestone will receive 4 + 1 = 5 points when writing the review for a product.
• Decrease Spending Points: the percentage of spending points reduced if customer belongs to Milestone.
  • For example: the Spending Rate is $1 per 10 points, the Decrease Spending Points is 20. A customer belongs to Milestone, the spent point will be reduced 10 * 20% = 2, that is, customer using 10-2 = 8 points will get a $1 discount

5.2.3 Customer Tab

This grid shows all Milestone Customers. It contains customer information such as ID, First Name, Last Name, Email, Group, Gender. Besides, you can search for information in the grid.

VI. Report

Go to Reports > Reward Points Reports

• Reward Points Ultimate offers 2 Report dashboards that are compatible with Mageplaza Reports.
• Earned:
  • Record all actions leading to customers being added to the point
  • Shown as a chart if Mageplaza Reports is installed
  • This chart can also be displayed in the Dashboard

• Spent:
  • Record all actions leading to customers being added to the point
  • When installing Mageplaza Reports, the dashboard will display a graph showing the ratio between Spending Point and Earning Point

VII. Configuration

Follow in the backend Store > Settings > Configuration. At the left panel, choose Mageplaza > Rewward Points

7.1. General Configuration.

This general configurations can apply for the whole module.

• In the Enable field: Choose “Yes” to active the Reward Point extension from Mageplaza.
• In the Label in My Account Navigation field: Enter the name of Tab Reward Point displayed on the frontend at the My Account > Reward Point section.
• In the Point Label field:
  • This label will be displayed on the frontend.
  • If you leave it blank, there will be an error message.
• In the Plural Point Label field:
  • If the balance is greater than 1, this label will be displayed on the frontend.
  • If you leave it blank, there will be an error message.
• In the Display Point Label field:
  • Select After Amount to display the point label after number (ex: 5 points).
  • Select Before Amount to display the number label before number (ex: points 5).
• In the Zero Point Label field:
  • Enter the label when the customer’s account balance is equal to 0.
  • If you leave it blank, there will be an error message.
• In the Show Point Icon field: Choose “Yes” to display the point icon on the frontend.
• In the Reward Point Icon field:
  • The upload image will be used as the point icon and be shown on the frontend.
  • JPG, PNG or GIF files are accepted. There will be an error message if the input file is invalid.
  • If you leave it blank, the default icon will be used .
• In the Maximum Available Point Balance field
  • Set the maximum number of point(s) that the customer can accumulate by purchasing.
  • If customer’s account balance reaches to this number, there will be no more points awarded to the balance, and reward point(s) indicators will not be shown on the frontend.
  • Admins can add point(s) to an account balance with no awareness of this value.
  • If the field is left blank or 0, there will be no restriction for the maximum points
• In Redirect to My Points and Rewards page after customer login account field: Select Yes to redirect customers to My Points and Rewards page right after customer logs in or creates an account.

Landing Page

• Choose Landing Page: Selct page to show when clicking on the Landing Page link.

• Display Landing Page On Footer Link: Select Yes to show Landing Page Link in the Footer.

• Landing Page Label: Enter the label to show Landing Page link in the Footer.

Highlight Point on Storefront:

• Show in Cart: Choose Yes to enable highlight poitn in Shopping Cart page > summary cart
• Show on Checkout Page: Choose Yes to enable highlight poitn in Checkout page
• Show on Product Pages: Choose Yes to enable highlight poitn in Product Detail page
• Show on Categories Pages: Choose Yes to enable highlight poitn in Category page
• Show highlight for Guests: Choose Yes to enable highlight poitn in for non-login customers
• Text Color: Choose color for highlight point

7.2. Earning Configuration.

7.2.1. General

This displays general configurations regarding earning point(s)

• In the Rounding Method field: There are 3 options for rounding
  • Normal: The number of points converted from the currency (USD, EUR, …) will be rounded according to the normal rule. E.x: 10.2 rounded to 10; 10.8 rounded to 11.
  • Rounding Up: The number of points converted from the currency (USD, EUR, …) will be rounded up. E.x: 10.2 or 10.8 is rounded to 11.
  • Rounding Down: The number of points converted from the currency (USD, EUR, …) will be rounded down. Ex: 10.2 or 10.8 is rounded to 10.
• In the Points Earning From Tax field: Select “Yes” so the tax can be converted to earning point(s)
• In the Earn points from shipping fee: Select “Yes” to allow Shipping Fee to be converted to point(s).
• In the Point Refund field: When the customer places an order, they will receive a certain amount of earning points. The shop owner selects “Yes” in this section to retrieve the points when customer refunds the order.
• In the Earning Point from Orders with Applied Coupon: If No, when a customer applies a coupon to an order, they will not receive points from this order.
• In the Earning Points from Orders with Spent Points: Select Yes so that when customers spend points in a order, they still can earn points from that order.
• In the Notify reward points for guests: Select Yes to notify customers when they have not registered or logged in to their accounts.
• Message: Enter messages to show customers on frontend.

• In the Type of Maximum Earning Points per Order: Choose how to calculate the maximum allowed points for each order. There are 2 types:
  • Fixed: Set the maximum allowed points as a fixed value set in the Maximum Earning Points per Order field.
  • Percent: Set the maximum allowed points as a percentage of the cart set in the Maximum Earning Points per Order field.
• Maximum Earning Points per Order: Set the maximum allowed points customers can get for each order. If left empty or 0, the maximum point is unnlimited.

7.2.2. Sales Earning Process.

• In the Earning Points after Invoice created field:
  • Select “Yes” to allow adding earning point(s) to the customer’s account right after the invoice is created.
  • Select “No” to allow adding earning point(s) after the order is completed.
• In the Points Expired After field
  • The number entered here is expiration day of point(s), it starts to count from the day point(s) is (are) added.
  • If this field is blank, point(s) will be used indefinitely.

7.3. Spending Configuration.

• In the Discount Label field: Discount Label displayed on the frontend will change according to the content of this section.
• In the Minimum spending points per order field
  • Set the minimum number of point(s) that customers must have in their balances as a condition to spend points on discounting orders.
  • If the number of point(s) in the customer’s balance is less than the minimum spending point, the Reward Points slider will not appear on the View Page or Checkout Page.
  • If you leave it blank or 0, the default minimum point is 0.

• In Type Maximum Spending Points per Order: Select how to set the maximum number of points allowed per order:
  • Type Maximum Spending Points per Order = Fixed: the maximum number of points used for each order with a fixed value set in Maximum spending points per order field
  • Type Maximum Spending Points per Order = Percent: the maximum number of points used for each order is set as a percentage of the total shopping cart value, set the maximum value in Maximum spending points per order field

• In the Maximum spending points per order field:
  • Set the maximum number of point(s) that customers can use on an order.
  • If you leave it blank or 0, the maximum number of point(s) customers can spend is unlimited (it can be the maximum number of points they own or the maximum number of points which can be converted by SubTotal of Cart).
• In the Spending Points on Shipping: Select “Yes” to allow customers to use their point(s) to reduce the shipping cost.
• In the Restore spent points after order refunding field: When customers place an order, they can apply a certain amount of their reward point(s). Admins select “Yes” in this section to return point(s) to customers if their orders are refunded.
• In the Use Max Point By Default field: Select “Yes” to set the customer’s spending point(s) to the maximum number that they can use.

7.4. Display Configuration.

• In the Display Total Points on Top Links field: Select “Yes” to display the total number of reward point(s) that customer has on Top Link.

• In the Hide Total Points on Top Link if the Reward Points balance is empty or equals to zero: Select Yes to hide the total points of customer on the Top Link if the Reward Points balance is null or equals to zero.
• In the Display Points Summary on Dashboard Page field: Select “Yes” to display the total number of reward point(s) that customer has in the Reward Point tab.

• In the Display Earning Points on Minicart field: Select “Yes” to show the total number of earning point(s) customers can receive when checking out the cart at the Minicart page.

7.5. Email Configuration.

• In the Enable Notification Email field: Select “Yes” to allow notification emails to be sent to customers.
• In the Subscribe customers by default field: When a new customer subscribes to a store, receiving no emails is set as default. Select “Yes” in this section so that when their first transaction is made (by purchasing or by admin), Reward Points Notification will be checked immediately.
• In the Sender Email field: Admins can choose one of the 5 available Magento Senders: General Contact, Sales Representative, Customer Support, Customer Email 1, Customer Email 2
• In the Update Point Balance Email Template field
  • Pre-installed email configuration that customers can receive the notification mail when there are changes in their balance.
  • To change Email Template, admins can create another one under Marketing > Email Template.
  • The instruction to create a new Email Template can be found here.
• In the Points expiration Email Template field:
  • Pre-installed email configuration that customers can receive the notification mails when their reward point(s) is (are) about to expire.
  • To change the Gift Card Email template, admins can create another one under Marketing > Email Template.
  • The instruction to create a new Email Template can be found here.
• In the Send email reminder before a transaction expires field
  • Set how many day(s) before the expiration date the email can be sent.
  • If you leave the field blank or 0, reminder email will not be sent.

7.6. Social behavior

7.6.1. Like via Facebook

• Show Facebook like button on frontend: Choose Yes so that the Facebook like button can show on the frontend
• Show Facebook like count on frontend: Select yes to display the total number of Facebook like that the page is received
• Page to display: Select the pages where the admins want the Facebook like button to be displayed

7.6.2. Tweet Via Twitter

• Show Twitter tweet button on frontend: Choose Yes to show the Tweet button of Twitter on the frontend
• Page to display: Choose the pages that admins want the Tweet button to be displayed

7.7. Customer referrals

7.7.1. General

• Invitation Email:
  • The email is sent when customers want to refer to their friends
  • Admins can change the template as they want by go to Marketing > Email Template
  • You can refer how to create a new Email Template here
• Default Refer URL:
  • When customers is referred, click on the refer link, it will be shipped to the page that has the URL filled in here
  • If you leave this field blank, the default is homepage

7.7.2. Url Key

• Use Param:
  • Choose how to encode refer link
  • Url Param: The refer link has the format http://example.com/?code=123
  • Hash: The refer link has the format http://example.com/#code123
• Prefix:
  • Choose the prefix for the refer code
  • Default = code

7.8 Milestones

• Enable Milestone: Select Yes to enable the Milestone function
• Earn Point Source: Select a source for calculating points for Milestone, you can choose many options. For example, choose Admin added and Purchase, the number of points to calculate for milestone will only get the points earned when admin adds points or and the customer purchases to receive points.
• Earning Period: Enter the number of days to calculate earning points for Milestone. Example: Entering Earning Period = 10, the number of points to calculate for milestone will be caculated from activities of previous 10 days from the present time.
• Email Notification: Select Yes so customers can receive email notifications each time they join a certain milestone
• Progress Bar type: Choose how the tier is displayed in the frontend. There are 2 ways to display: Basic and Advanced
  • Basic

• Advanced

• Milestone Tier progress background color: select the color background for the Milestones Progress Bar
• Milestone Tier progress color: select the color for the progress on the bar

VIII. Manage Reward Point in Admin Customer

Admins can manage Reward Points Balance, Transactions and Notification of customers by going to Customer > Edit Customer > Reward Points.

• In the Reward Acount Enable field: tick on the checkbox to activate Reward Account for customer

• In the Milestones field: Show information of the current Milestones Tier of customer and the number of points needed to reach the next-level tier

• Balance Information tab lets admin know:

  • Current Balance: the total number of Reward Points that customer has.
  • Total Earning Points: The total number of Reward Points that customer can order.
  • Total Spending Points: The total number of Reward Points that the customer has used.
  • Update Balance tab: Allow Admin to change the Balance by filling in Update Point and setting the usage time of that amount of Points. Admin can also enter the reason for the change in the Comment field.

• Email Notification tab: Allow Admin to change the customer who register or turn off notification emails when Balance is updated or Point is about to expire.
• Transactions tab: Displays information related to Reward Points of Customer including ID, Title, Action, Amount, Status, Store View, Created On, Expire On.
• Information about Milestones, Balance, Notification and Transaction in Admin will sync with the My Account / My Points & Reward in the frondend

XI. Refund Spent Points

For orders that can be discouted by Reward Points, when refunding, the point can be returned by admin.

Tick on the Refund Order to Points checkbox to refund points. The Reward Point Refund field will be displayed

• Reward Point Refund: Enter the number of points refunded, this value must be less than the Spent Points used for the order

X. Add the price based on points for products

Go to Catalog > Products, admins can see that in the Grid, Reward Points column represent the price by the point of the Product

To set the price by Point for Product, admins need to Edit Product and enter the amount of points converted from the price that you want to sell, then Save Product.

XI. Import

To assist customers in backing up Reward Point data when switching systems, we have added the Import feature of Account and Transaction Reward.

11.1. Import Reward Account`

From the Admin Panel, go to Sytem> Data Tranfer> Import, select Entity Type = Mageplaza Reward Account

• Step 1: Choose Entity Type = Mageplaza Reward Account
• Step 2: Choose import action: Add/Update account or Delete account

• Step 3: Download the file imported from the computer. If you don’t know what the import file format is and what data you need to fill in, you can click on the link Download Sample File to view the sample file
• Step 4: Check Data and import data

11.2 Import Reward Transaction

From the Admin Panel, go to Sytem > Data Tranfer > Import, choose Entity Type = Mageplaza Reward Transaction

• Step 1: Choose Entity Type = Mageplaza Reward Account
• Step 2: Choose import action: Add transaction

• Step 3: Download the file imported from the computer. If you don’t know what the import file format is and what data you need to fill in, you can click on the link Download Sample File to view the sample file
• Step 4: Check Data and import data

XII. Customer Frontend.

12.1. Create New Account

• Mageplaza Reward Point offers the function Refer email or Refer Code to receive incentives
• Customers can get refer code information or the email of refereers, they can completely fill in the Refer Email Or Code, then Create an Account and place order and get point/discount.
• For customers who have an account, they need to have the correct link to access, login and use the refer code

12.2. My Account > My Points & Reward

12.2.1. Reward Dashboard

Customers can check the Reward Point information in this section after logging in:

• Available Balance: the curent available points of customer, equivalent to Current Balance in the backend.
• Total Earned: the number of points that added when place an order, equivalent to Total Earning Points in the backend.
• Total Spent: the number of points that customer has used, equivalent to Total Spending Points check in the backend.
• My Milestones: the customer’s current Milestone information and the number of points needed to earn to achieve the next tier levels.

• Reward Information indicates
  • Earning Rate and Spending Rate that customer is entitled (according to his Customer Group and Website set in the backend).
  • The maximum number of points that the customer’s balance can receive from orders.
  • The maximum number of days that point(s) can be used since that customer receives point(s).

• Recent Transactions: Customer knows the detailed history of transactions that have occurred, including the following information:
  • The reason the transaction happened.
  • Number of points change.
  • The date and time of the transaction.
  • Point expiration date.
  • Transaction status.
• They can also sign up to receive notifications when Balance changes or when Points are about to expire.
• All information here is synchronized in the backend Customer / Reward Points.

12.2.2. Transactions

At Transaction History: Customer can know the transaction history in details

12.2.3. My Referral

• Manage the Referral URL and Code of an account
• When using Send Invitations or referral via Social, Refer URL will be sent in email
• Your Invitee saves the information about the referral action that they did when the referrer performed a successful place order
• When the order is completed, Customers will receive a point equal to the amount of points You Earn

12.2.4. My Milestones

• Customer Milestone details including:
  • The Milestone progress bar, showing the tiers that the customer can reach
  • The customer’s current milestone Tier and the number of points needed to reach the next tier level
  • Information of transactions where points are earned from those transactions

12.3. Checkout Page

• Customers can use the slider or text box to select the amount of reward point(s) they want to spend.
• Used reward point(s) can be limited to a range.
  • Customers are only allowed to use their point(s) within this range.
  • If Subtotal has a value less than the minimum value of the limited value range, the Apply Reward Point section will not be displayed.
• Tick the checkbox Maximize my discount with Point to use all available points at once. The amount of points can be
  • The total points that customer has if Total Point(s) < Max Point for per Order and Subtotal.
  • Max Point if Max Point < Total Point and Subtotal.
  • The number of point(s) which is equal to Subtotal if that amount < Max Point and Total Point.
• The Order Summary box will display more sections about reward points to make the calculation easier.
• Spending Point can be used for Tax, Shipping Fee if it’s configured in the backend.
• The conversion rate between Reward Point and Spending Point depends on the Spending Rate configuration in the backend.

12.4. Other additional frontends.

• Top link: Displays the point(s) that customer has.

• MiniCart: Displays the earning point(s) of all products in the cart.

• View Cart Page (Shopping Cart): Displays Apply Reward Point on the checkout page, and also displays the Earning Point, Spending Point and Reward Point.

XIII. REST API

• Mageplaza Reward Points Ultimate supports the use of REST API to perform requests related to Invitations, Referral Rules, Behavior Rules.
• Details of the Mageplaza Reward Points Ultimate endpoints can be found here
• Mageplaza Reward Points Ultimate fully supports endpoints of Mageplaza Reward Points Standard and Mageplaza Reward Points Pro.
• See the Magento 2 REST API tutorial here. See the token generation instructions here.

XIV. GraphQL

15.1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-reward-points-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

15.2. How to use

To start working with Reward Points GraphQL in Magento, you need to:

• Use Magento 2.3.x. or higher. Return your site to developer mode
• Set GraphpQL endpoints as http:///graphql in url box (e.g. http://dev.site.com/graphql)
• The queries and mutations that Mageplaza support helps to see details of Transaction, Invitation, etc. through customer query, view Spending Point information, create Invite Email, and so on. More details can be found here.

Gift card

Overview

Gift card, also known as gift certificate or gift voucher, is a prepaid stored-value money card usually used in depositing money on a store online’s account of customers. Gift cards are issued as an alternative to cash or credit cards to purchase products within a particular store. The amount of deposited money in the gift card is granted indefinitely and they can not transfer from one account to another or purchase another gift card.

Magento 2 Gift Card extension is a useful extension for online stores. The extension offers magnificent features that allow admins to create unlimited virtual/physical gift cards with a full control over templates; the price of the gift card and the value of purchases; gift codes and discounts; conditions of use; expiration and display locations. Moreover, it’s really flexible for gift card users to create their own card templates, track and manage their sent gift certificates. In addition, buyers can take advantage of the basic and advanced features of gift cards.

Furthermore, Gift Card extension allows store owners can send to their customer via emails, SMS or Post Office.

How to use

I. For customers

Customers are able to manage their gift cards at:

• Account > My Gift Card
  • Ability to Check, Add to list and Redeem gift cards
  • Gift Cards can only be printed if it’s Active, and Method = Print at home, and if the recipient’s email matches the account’s email
  • At this panel, customers can give a quick check on their Balance Gift Card Credit, Save Gift Card List and Transaction History
  • They can also subscribe to receive notifications when a Gift Card or a Gift Credit changes.
  • Click here for more information
• In View Cart Page: Customers can use available Gift Cards, Gift Cards in the Saved List or Gift Credit as a discount on the order total.

• In Checkout Page: Similar to the View Cart, if the customer wants to change the Gift Card or Gift Credit, they can also edit in the last step.

II. For admins

• Admins can use Gift Card or Gift Credit when they create a new order

• Admins can generate a new Gift Card Product, manage Gift Code, Gift Code Pool, Template, History as well as set up the extension’s configuration.

How to configure

Log in to Magento’s backend and follow Mageplaza > Gift Card, follow our given guide below to complete Gift Card configuration

• Configuration
• Gift Card History
• Manage Templates
• Manage Gift Code Pools
• Manage Gift Codes

I. Configuration

1.1. General Configuration

At Mageplaza > Gift Card: Configuration to have an overview look in the extension’s general configuration.

1.1.1. General

Follow the path Mageplaza > Gift Card: Configuration > General Configuration

• In the Module Enable field: choose “Yes” to turn the module on.
• In the Gift Code Pattern field: Is the common pattern of generated codes. When creating a Gift Code or a Gift Code Pool, admins can change this template as their desire.
• In the Allowed maximum times to enter the gift code incorrectly field: Enter the maximum number of times that the wrong code is allowed. If left blank or filled in 0, customers will be allowed to enter the wrong code with unlimmited times. The lock time is 5 minutes, after 5 minutes, the customer can continue to enter the new code.
• In the Enable Gift Card Credit field: Select “Yes” so the customer can use their Gift Card. Then Gift Card Can Be Redeem section will be displayed.
• In the Gift Card Can Be Redeem field:
  • Only visible when admin set Enable Gift Card Credit = Yes.
  • Allows a gift card to be redeemed.
  • The amount of a gift card after being redeemed will be added to the customer’s gift card credit.

1.1.2. Gift Code Hidden Configuration

Expand the General Configuration > Gift Code Hidden Configuration

• This is an additional module of General Configuration
• In the Enable field
  • Choose “Yes” to apply the Hidden Configuration
  • A part of the gift code will be hidden when being displayed on the frontend Hidden Code Configuration will be applied in the Saved List, View Cart Page and Checkout Page of customers, when the admin clicks Apply Code along with Code in the email informing the sender (when the customer buys Gift Card Product for others)
• In the Prefix chars field
  • You are able to set the number of prefix characters in the Gift Code
  • If you leave it blank, nothing will be displayed.
• In the Suffix chars field
  • You are able to set the number of suffix characters in the Gift Code
  • If you leave it blank, nothing will be displayed
• In the Hidden character field
  • This is the hidden symbol covering characters in the Gift Code
  • If you leave it blank, the default symbol will be “*”

An example of a Saved Gift Card List. When customers click on the Hidden Code, the entire code will be displayed

View Cart Page

Checkout page

The email sent to senders

1.2. Gift Card Product configuration

1.2.1. General

This is where you can set up fews of basic configuration for Gift Card Product Mageplaza > Gift Card: Configuration > Gift Card Product Configuration

• In the Gift Card Lifetime field: It’s the place to set the expiration date of a gift card purchased by a customer.
• In the Enable Delivery Time field
  • Select “Yes” to display Delivery Date on the frontend Gift card Product page. This also allows the customer to choose the gift card delivery date as they wish.
  • When you select “Yes”, Customer Can Select Timezone section is displayed.

• In the Customer Can Select Timezone field
  • Will be displayed when admin selects “Yes” in Enable Delivery Date
  • When you select “Yes” in this section, customers can change the timezone according to the choice based on the given List Timezone.
• In the Enable Check Gift Card Code Status on the frontend field: Select Yes to check and view infos of Gift Card code status of customers on the product page.

1.2.2. Buy Gift Card Product Process

It’s an add-on part of Gift Card Product Configuration

• In the Gift Card Fields Show On Item field
  • This section allows admin to setup the display of the components of a Gift Card in the View Page.
  • Allows to select multiple options
  • You have to choose at least 1 option. If you don’t, this won’t be saved.
• In the Create Gift Code(s) When field
  • You can specify when the gift card of a customer is created in the backend
  • At Invoice Created:
    • When Invoice Created is done successfully, a gift card of customer will be generated automatically.
    • If after the invoice created successfully, but the customer wants to cancel gift card, admin will create a Credit Memo. Then, the newly created Gift Card will be eliminated, Gift Code in Manage Gift Code is also canceled
• In the Order Completed line: The gift card of customer will be created as soon as the Order Complete is accomplished. The gift code will be stored in Manage Gift Codes

1.3. Gift Card/Credit Checkout Configuration

1.3.1. General

Follow the path Mageplaza > Gift Card: Configuration > Gift Card/Credit Checkout Configuration

• In the Show As Product Image: Choose Yes, image uplodaed for gift card product will be shown on View Cart Page and Checkout Page instead of default image.
• In the Use Coupon Box To Apply Gift Card field
  • Select “Yes” to apply Gift Code with Magento’s default Coupon Box. So that:
    • Can Used Multiple Gift Cards section will be hidden
    • On the frontend, the customer can apply a single Gift Code only. So does admin when creating New Order in the backend.
    • If there’s only Gift Card Product in the Order, when the Gift Code is applied, there will be an error message.
  • Select “No” to apply Gift Code by Gift Card Box of the extension. So that:
    • Can Used Multiple Gift Card section will be display
    • On the frontend or in the backend, Magento’s default Coupon Box will be used to apply the discount.
    • If there’s only Gift Card Product in the Order, the Gift Code will not be displayed.
• In the Can Use Multiple Gift Cards field
  • If you select “No” in Use Coupon Box To Apply Gift Card part, this section will be displayed.
  • Choose “Yes” to allow customers can use multiple gift cards at the same time.
• In the Show Gift Card Summary On Total Block field
  • Select “Yes” to display the Gift Code in the Summary section of Total Block when the admin take action of View Card or Checkout
  • The Gift Code is displayed entirely depending on whether admins use Hidden Code Configuration or not.
• In the Can Use Gift Credit field
  • Select “Yes” to use the Credit to reduce the order total
  • With the customer who has gift credit balance = 0, this item will not be displayed
  • Neither will it be displayed if there is only Gift Card Product in the order

1.3.2. Checkout Process

This is a supplementary part of Gift Card Product Configuration section

• In the Can Use For Shipping Amount field: Select “Yes” to apply a gift Card and gift credit for the shipping fee. If both gift card and gift credit are having sufficient value and the customer doesn’t purchase Gift Card Product, the order can be considered as a free one.
• In the Can Use For Tax field: Select Yes to apply gift card and gift credit for tax.
• In the Allow Refund Gift Card field: Select “Yes” to be able to refund the amount of a gift card to customer’s gift code balance.

1.4. Gift Card Template Configuration

Expand Mageplaza > Gift Card: Configuration > Gift Card Template Configuration to modify general modules changing template for gift certificates

• In the Logo field: Choose your own store’s logo. If a logo is already included in the Template, then it will be applied on customer’s gift card.
• In the Maximum message character field
  • Set the number of character that customers will enter in Message on the Gift Card Product’s frontend.
  • If admin leave it blank or enter 0, the maximum number of characters will be automatically restricted to only 120.
• In the Default note field
  • Default note can be used to display on gift cards (in case Note is enabled)
  • When admin creates Template in Manage Templates, this can also change Default Note.
• In Maximum Image Upload File Size: fill in the file size that is allowed to be uploaded to the Gift Card Product page in the frontend

1.5. Email Configuration

1.5.1. General

Visit Mageplaza > Gift Card: Configuration > Email Configuration and drop the module down

• In the Enable Email Notification section: Choose “Yes” to enable the function and “No” for the vice versa result. When a gift card arrived to recipients perfectly, an email containing the gift card will be informed back to the sender.
• In the Email sender field: Available 5 Magento’s default email senders for your selection: General Contact, Sales Representative, Customer Support, Custom Email 1, Custom Email 2
• In the Gift Card Email Template field
  • Email notification is pre-installed when customers receive a gift card
  • To change the Gift Card Email Template, admin can create another Email Template under Marketing > Email Template
  • Instruction how to create a new email template can be found here
• In the Send To: Enter emails separated by (,). When a gift card is sent by customer’s email successfully, it will also be sent to these entered emails.

1.5.2. Gift Card Update Notification

Another small extra for the email configuration, is provided for updating email actions.

• In the Enable field: Choose “Yes” to turn the function on.
• In the Gift Card Update Email Template function: Similar to Gift Card Email Template

1.5.3. Before Expired Notification

Another extra module for the email configuration, is provided for notifying the expiration via emails.

• In the Enable field
  • Choose “Yes” to send email to the recipient before the gift card is going to be expired after X day(s)
  • Expiration day will be configured in the below section.
• In the Before Update Email Template function: similar to Gift Card Email Template
• In the Before Expired Day(s) field
  • Specifies day(s) before the expiration of a gift card for email to be sent
  • This expiration day(s) also applies for SMS sending method.

1.5.4. Notify Sender After Gift Card is Sent

Another extra add on for the email configuration, is provided for notifying the recipient after sending gift cards.

• In the Enable field: Choose “Yes” to turn the function on.
• In the Sender Confirmation Email Template function: Similar to Gift Card Email Template

1.5.5. Gift Card Unused Notification

Is a complement function for the email configuration

• In the Enable field
  • Select “Yes” so the senders can receive an email confirmation that the gift card they gave to the recipient has not been used for X day(s) since it was sent.
  • Unused X day(s) will be set up in the below module.
• In the Unused Notification Email Template function: Similar to Gift Card Email Template
• In theAfter Unused Day(s) field
  • Specify the unused gift card day(s) to send email
  • Thereout, emails will be sent if the gift card meets those following rules:
    • The activating gift card is generated from an order.
    • The balance doesn’t change.
    • The unused day(s) = The current day - Delivery Date

1.5.6. Customer Balance Update Notification

Is an add-on function for the email configuration

• In the Enable field: Select “Yes” so that customers can receive emails every time the balance of a gift credit is updated.
• In the Update Balance Email Template field: Similar to Gift Card Email Template

1.6. SMS Configuration

1.6.1. General

• In the Enable SMS Delivery field: Select “Yes” to allow the system to send SMS about the gift card message to customers.
• In the Twilio Account SID: Admin needs to register a Twilio Account, use the SMS sending method to enter the correct SID of his Twilio Account.
• In the Twilio Account Token field: Along with its SID, admin also needs to fill out the correspondent Token Twilio Account
• In the Sender Phone Number: The field to enter a phone number to send. The phone number should be the one purchased from Twilio
• In the SMS Message field: This is where the admin modifies the content of the SMS before sending it to customers. Admin can use premade variables to add a SMS text.

1.6.2. Gift Card Update Notification

After SMS’s general configuration is some bonus mini configurations. First it’s about Gift Card Update Notification

• In the Enable field:
  • Choose “Yes” to receive a gift card SMS message informing how many day(s) left to use their gift card.
  • The remain expiration day(s) is taken from Email Before Expired Day(s) configuration
• In the Gift Card Update Email Template field: Admin can use those one of available email templates

1.6.3. Before Expired Notification

• In the Enabled field:
  • Select “Yes” to let customers receive a SMS message informing how many days to use their gift card.
  • Before Expired Day(s) will be taken from Email Before Expired Day(s)’s configuration
• In the Message field: Admin can use pre-made variables in the above box to change the SMS content.

II. Manage Templates

Go to Mageplaza > Gift Card: Manage Templates

2.1. General Management

• This is the core panel archiving all Gift Card Templates
• From Grid, admin can capture the basic information of the template such as ID, Name, Status, Thumbnail, Created Date and can perform some below actions
  • Delete: check template(s) you want to remove, then choose “Delete” in the Action box (at the left side of the Grid). Click “OK” to confirm the delete action.
  • Change Status: check template(s) you want to apply, in the Action box, select Change Status > Active/Inactive to change selected template(s) status.
  • Edit: To edit a template, select “Edit” in the Action column (the last column to the right of the Grid)
• Moreover, admins can take action to Filter, Change Store View, Column or Export Grid

2.2. Create/Edit Templates

After entering the Manage Template page, you can select the redCreate New Template button to create a new template. After clicking Save and Continue Edit, the page will automatically switch to the Edit Template page.

2.2.1. Template Information

• In the Template Name field
  • Admin is able to name the template. When a gift card product selects this template and its status is Active, Template Name will be displayed on the Gift Card Product Page frontend
  • If you leave it blank, there will be an error message.
• In the Status field: Select “Active” to display the template on the Gift Card Product Page frontend, in case Gift Card Product selects this template.
• In the Allow Upload Image, if the template is displayed on the Gift Card Product frontend
  • By selecting “Yes” in this section, you can allow customers to choose their favourable stock to print on the gift card.
  • In vice versa result for “No” option, admin just limits customers to choose an available image for gift cards.
• In the Gift Card Title field:
  • You can change the gift card’s title at this section.
  • Gift Card Title can be printed on, if the gift card’s design has a title part
  • If you leave it blank, there will be an error message
• In the Font Family field: Admin can change fonts with some pre-installed fonts in this section, including Times-Roman, Helvetica and Courier.
• In the Background Image: Admin change the background image in this section. If it’s blank, gift card will have a white background
• In the Gift Card Note field
  • Take the note from Gift Card Template’s configuration
  • Admins can change the note flexibly.
  • Gift Card Note can be displayed if the gift card’s design has a note part.

2.2.2. Design

Includes two actions:

• Load From Exist Template: Admins can load existing templates to edit quickly by selecting a template in the list box, then select Load Template, the design of the selected template will be displayed in the Design Template section.

• Design template:
  • Admins can design the Gift Card template on this interface easily and quickly by dragging left items and dropping them in the empty box on the right.
  • Admins can also change some CSS in the Custom section of each option

2.2.3. Image

• Admins will select some images as default images of gift cards by uploading or dragging images directly into the Upload Image box.
• When the template is displayed on the Gift Card Product Page frontend, these images will also be displayed. Customers can choose different images to print different gift cards.

III. Manage Gift Codes

By visiting Mageplaza > Gift Card: Manage Gift Code

3.1. General Management

• This is the interface which archives all created gift codes.
• From this grid, admins can collect such fundamental information of a gift code like:
  • ID, Code, Status, Balance, Store View, Expired Date, Created Date
  • Order (indicates the order in which the gift code was created)
  • Pool (indicates which Pool a gift code belongs to)
  • Template (indicates which Template the gift card uses)
  • Delivery (indicates how to send a gift card)
  • Delivery Date (indicates date the sender wants the Gift Card to be sent).
• Admin can take some actions:
  • Delete: check gift code(s) you want to remove, then choose the “Delete” in the Action box (at the left side of the Grid). Click “OK” to confirm the delete action.
  • Change Status: check gift code(s) you want to apply, in the Action box select Change Status > Active/Inactive to change selected gift code(s) status.
  • Print:
    • Check gift code(s) you want to print, then choose the “Print” at the Action box
    • Only gift code(s) which has template can be printed out.
    • After printing, admins will receive a new PDF file which contains the gift card along with its gift code
  • Send
    • Check gift code(s) you want to send, then choose “Send” at the Action box
    • Only gift code(s) which has method can be sent
    • After being sent, the Delivery’s mark color will be changed from red to green.
  • Edit: To edit a gift code, choose “Edit” at the Action column
• In addition, admins can Filter, Change Store View, Columns hay Export Grid

3.2. Create/Edit Gift Code

After accessing the Manage Gift Code(s) page, admins can select Create New Gift Code to create a new template. When click Save and Continue Edit, the page will automatically switch to the Edit Gift Code page, simultaneously display History and some other function buttons (Delete, Print).

3.2.1 Gift Code Information

• In the Code Pattern field
  • Will be taken from the General Configuration. Admins can change Code Pattern flexibly.
  • If you leave it blank, there will be an error message.
• In the Balance field
  • This is where admins assign an amount to a gift card. This amount will be added to the gift credit when it’s redeemed and will be deducted from the order if Apply is setting as Discount.
  • If you leave it blank, there will be an error message.
• In the Description field: Enter the description, to notify admins of created gift code.
• In the Status field
  • Choose “Active” to validate the gift code.
  • The status will be changed to “Used” if the gift code is used.
  • The status will be changed to “Inactive” if Balance is 0.
  • The status will be changed to “Expired” when the gift card is out of date.
  • The status will be change to “Cancelled” if its order is created a Credit Memo.
• In the Is Redeemable field
  • This module is only visible when admins select “Yes” for Gift Card Can Be Redeem in General Configuration
  • Select “Yes” to let customers to redeem gift codes to their gift credit
• In the Store field: The specific store view which a gift code is used. A website can have multiple store views. The gift code can only be used in the Store View which admins choose.
• In the Expires At field: Admin can set the expiration date for a gift code at here. Gift code can not be used if it’s overdue.
• In the Created At section: Only visible when gift code was created. It includes date and time creating.
• In the Created From field: This entry is only visible to gift codes created from the Order that contains the Gift Card Product, including the Order ID and the name of the Gift Card Product.

3.2.3 Gift Code Condition

Set up the cart condition to be able to apply new Gift Code created/edited

Delivery Information Modules in Delivery Information are automatically filled in if the gift code is created from an order that contains a Gift Card Product that the customer has filled out when making a purchase. However, you can also correct this information before sending a gift card to recipients.

Follow these steps if you want to create a new gift code.

3.2.3.1 Sending Information

• In the Template field: The generated templates will be displayed here. When you select the desired template, its image will be displayed (if the Template has image)
• In the Image field: This part is visible when the above Template is selected. Admins can change images to print on the gift card. The image that customers upload when buying Gift Card Product is also shown in this section.
• In the Sender Name field
  • This sender name will be displayed when admins send gift cards, letting the recipient know who gifted this certificate.
  • If the From section is included in gift cards,, this sender’s name will be displayed on the Gift Card
• In the Recipient Name field
  • This recipient name will be used when sending a gift card.
  • If the To section is included in gift cards, the recipient’s name will be displayed on the Gift Card.
• In the Message field
  • This will be visible if the Message is enabled for selected template
  • If Message is included, the sender’s message will be displayed on the Gift Card

3.2.3.2 Delivery Methods

Includes 4 types of Delivery Method: Email, Text Message, Print At Home and Post Office.

• Email: When you select this method, the gift card will be sent to the recipient by email. Admins need to fill in all the details so that the system can send the emails correctly (according to Email Configuration)
• Text Message: The same with Email type, but messages will be sent via SMS
• Print At Home:
  • Is the same with other delivery methods, but only automatically be filled when the order contains Gift Card Product Type = Print at home
  • With gift codes created from these orders, they are automatically added to the Saved Gift Card’s customer and can be printed at home. (Other gift codes in the Saved List are able to be viewed, redeemed and removed.)
  • With the gift code created by admins and has been sent successfully, only the customer whose email is the same as sent email can print the gift card.
• Post Office: you need to fill precise information to avoid losing gift cards in the way.

3.2.4. History

This module is only visible when the gift code has been created (i.e the gift code has been saved). It points out when the code was executed, what actions were done, how much of the remaining balance is, how the amount was changed, if the gift code is still valid

IV. Manage Gift Code Pools

The general path to manage all modules is Mageplaza > Gift Card: Manage Gift Code Pools

4.1. General Management

• Gift Code Pool is a set of gift codes with the same information as Balance, Expiration Date, Template … Admins can create a Pool to issue a series of gift code quickly.
• All Gift Code Pools can be recorded and saved in log there
• From the Grid, admins can acknowledge
  • ID, Name, Status, Balance, Store View, Expired Date, Created Time
  • Available shows for each of Pool contains how many code(s) and the quantity of valid code(s)
• Admins can accomplish those below basic actions
  • Delete: check gift code pool(s) you want to remove, then choose the “Delete” in the Action box (at the left side of the Grid). Click “OK” to confirm the delete action.
  • Change Status: check gift code pool(s) you want to apply, in the Action box select Change Status > Active/Inactive to change selected gift code pool(s) status. All the gift codes within the pool’s will be changed too.
  • Edit: To edit a gift code pool, admin can select “Edit” in the Action column (the last column to the right of the Grid)
• Moreover, admins can filter, change store view, modify columns or export grid

4.2. Create/Edit a Gift Code Pool

4.2.1. Gift Code Information

4.2.1.1 Pool Information

• In the Name field: A friendly note that you need to name the gift code pool to distinguish easily from other pools.
• In the Status field: Choose “Active” to enable the pool .
• In the Can Inherit field: Select “Yes” so that created gift codes will also be changed according to the new alternative of the Pool (except for the Status Attribute)

4.2.1.2 Gift Card Information

• Includes the basic information of the gift card, you just need to fill in this information similarly to when creating a gift code.
• After saving, the created gift card will then have the same information with each others (except the gift card code)

4.2.2. Gift Code Condition

• Set up the condition for applying the new Gift Code Pool created/edited
• If the field Can Inherit = Yes, all Gift Code in Gift Code Pool will auto amatch the Pool conditions.

4.2.3. Generate Gift Cards

• This module is only visible when Pool is created, which provides information about the Code, Balance, Status and Date created by the gift card.
• Generate Type: Select forms to create Gift Code for the Pool. Extension currently supports 3 ways to create:

• Generate Type = Auto Generate: Generates code automatically according to the installed Pattern. When this method is selected, two fields of Code Pattern and Gift Card Qty will be displayed.
• Code Pattern: Admin can change the Code Pattern of the Pool. Gift Cards created will have the same Gift Code form
• Gift Card Qty: Admin just enter the Gift Card number you want to create and click Generate to generate Code quickly

• Generate Type = Import: Generate code by importing csv file. Admin creates a csv file with the format shown below, select the file and click Import to enter the gift code for the pool.

• Generate Type = Manual: Create manual code by manually entering the gift code of the pool. Each line in the Gift Code field (s) will be considered a gift code.

V. Gift Card History

• Gift Card History shows the history log of all Gift Cards, including ID, Code, Action, Balance, Amount Change, Status, Detail and Created Date.
• To delete the history of a gift card, make your way to Manage Gift Code section and delete the gift card, all its history will be also deleted.
• Moreover, admins can Filter, Change Store View or add/remove column(s)

VI. How to create a Gift Card Product

To create a new Gift Card Product, follow this link when you’re in store’s backend Product > Catalog > Add New Product > Gift Card Product

After filling in all required information of a Gift Card Product such as Name, SKU, Qty and Category (Gift Card), admins need to choose Gift Card Information to create a Gift Card Product.

• Gift Code Pattern: admins can change the configured Code Pattern as you wish. When customers buy a gift card product containing this gift code, the product will have the form according to the pattern with the one admin used.
• Gift Card Type has 3 types
  • E-gift:
    • A gift card will be created when purchasing a gift card product, this product will be sent to the customer via email or SMS according to the way that customer selects.
    • The gift card will be sent to the recipient with the same email (or phone number) that the customer entered when purchasing the gift card product.
  • Print At Home:
    • A gift card is created when purchasing a gift card product, which will be sent to the customer via email
    • The gift card will be sent to the recipient with the same email that customer completed when purchasing their gift card product.
    • A gift code generated by a gift card will automatically be added to the Saved Gift Card List of the customer with the same email as the gift card was sent to.
  • Mail:
    • The created gift card when purchasing a gift card product will be sent to customers via post.
    • Charges may be incurred during the sending process
• Gift Card Amount: you can configure Amount and Price of a gift card in this section
• Allow Amount Range: choose “Yes” to allow the customer change Amount of a gift card in the restricted amount set up by the admin.
• Min Amount: can be configurable when Allow Amount Range = Yes. By setting a minimum amount for a gift card, customers can’t enter the lower amount than that Min Amount. If you leave it blank, the default number will be 0.
• Max Amount: can be configurable when Allow Amount Range = Yes. By setting a maximum amount for a gift card, customers can’t enter the higher amount than that Max Amount. If you leave it blank, the default number will the gift card’s price
• Price Percentage: can be configurable when Allow Amount Range = Yes. The price will be displayed in the frontend = Price Percentage x entered Amount by the customer. If you leave it blank, the default Price Percentage = 100%
• Can Redeem: Choose “Yes” to allow the created gift card from a gift card product can be redeem (when in Settings > Configuration, the gift card can be redeem)
• Expire After Day: you can set the duration of the created gift card when purchasing a gift card product
• Template: Templates are automatically added to this section. The selected template will be displayed in the frontend.
• In addition, the admin can set the condition that applies to the Gift Code created from the Gift Card product that Customer purchased at the Gift Code Condition tab.

Example for a gift card which is created when purchasing a gift card product

VII. Manage Gift Card Credit in Customer’s backend

• You can manage Balance Gift Card Credit and Transaction of customer by following Customer > Edit Customer > Gift Card
• The tab Gift Card shows you the day Gift Card Credit changed, its Action, the Balance after changing, the amount of change and changing’s Detail.
• You can add/remove Balance of a customer by entering a number into Change field the click Change.
• Balance and Transction’s information will be synced with the customer’s frontend My Account > My Gift Cards

VIII. Frontend

8.1. Account > Gift Card

• My Current Balance indicates the Balance Gift Card Credit of a customer. Balance of Customer is in sync with the balance in Admin/Customer

• In Check/Redeem Gift Card

  • This is where the customer can check their gift card.
  • After checking, if the gift card is active, Add to List button will be displayed. Customers can click this button to add a gift card to My Saved Gift Card
  • If the gift card is active and Admin > Configuration > Can Redeem = Yes then the Redeem button will be displayed. Customers can click this button to quickly transfer the Balance of Gift Card to their Balance of Gift Card Credit

• In My Saved Gift Card

  • This is the module stores all gift cards that the customer stored, also gives the basic information of a gift card such as Code, * Balance, Status, Expired Date and some other actions.
  • The code can be hidden when admins apply the Hidden Code Config. To see a Code, customers need to click Code
  • View: When a customer click View, a popup that shows the current status of the Gift Card will be displayed

  

  • Print: This button is only displayed when the gift card has Type = Print at home. When the customer clicks this button, they will receive a PDF containing a printed gift card.
  • Redeem: Only visible when Admin > Configuration > Can Redeem = Yes. Customers can click this button to quickly transfer the Balance of Gift Card to their Balance of Gift Card Credit.
  • Remove: Customers click this button to remove a gift card from the Save List

• In Transaction section:

  • Being synced with Admin > Customer > Gift Card > Transaction
  • rchives the history of actions about the changed balance of a Gift Card Credit

• In Notification Setting

  • Check the Gift Card Update Notification so that customers can receive email notification every time their gift card is updated.
  • Check the Update Balance Notification so that Customer can receive email notification every time their balance of Gift Card Credit is updated

8.2. Gift Card Category

This is the place archiving all created Gift Card Products. Admins can create a new Category for storage works conveniently. There’re 2 ways of creating a new Category:

• Go to Product > Category, click New Category, fill required information and don’t forget clicking Save
• Go to Product > Catalog > Edit Gift Card Product (or create new) > Category > New Category``

8.3. Gift Card Product Page

Customers can configure their Gift Card Product in here. Depending on the type of the gift card, the Gift Card Product Page has different interfaces. Gift Card Product Page has 2 main sections: Gift Card Template and Gift Card Information

• In Gift Card Template:
  • This is where all the Active Template Gift Cards ( which admin selected in the Backend) is stored.
  • Customers can select one of the Gift Card Template images to print on their gift card
  • Customers can also upload their photos by dragging their images or clicking the Upload button
  • The images that customer submit but not order products will be deleted weekly on Sunday
  • Upload is only visible when the selected template allows Upload Image
• In Gift Card Information: This is where customers can configure a gift card information. Each type of a Gift Card Product has its own configuration form. Gift Card Product Type = Egift: Gift Card Information includes the following items

• For Amount:
  • Amount of a gift card installed by the admin in the backend. Usually, a gift card has only 1 amount.
  • If a gift card has many amounts in the Backend, then customers has many Amount options.
  • Also, when the admin has se tup Amount with Range settings, customers can change the amount according to its own within the given range.
  • Price of a gift card is calculated in % which is configured in the backend
• In Delivery: With a E-gift card product, there are two delivery methods that the customer can choose:
  • Email: Customers selects Delivery = Email, the gift card will be sent via email which was filled.
  • Text Message: Customers selects Delivery = Text Message, the gift card will be sent via Phone Number which the customer filled
• Email: This module displays when the customer selectsDelivery = Email. Gift Card will be sent to this email when the order completed
• In Phone Num: Which stands for Phone Number, displays when customers select Delivery = Text Message. Their gift card will be sent to this number when the order completed (admins need to configure in SMS Configuration). Change the Locate in Configuration to change the area code of the phone number
• In From/To: These two sections indicate the sender and receiver names of the gift card. They will be displayed in the gift card if the items are available in the template
• Message: The maximum number of characters is 120. This number can be changed by the Admin in Configuration. This item will be displayed in the gift card if it’s available in the template
• Delivery Date: Customers can choose the date the Gift Card is sent. Delivery date is limited to 1 year from the current date. This item is displayed when Admin is installed in Configuration part
• Timezone: Same as Delivery Date, customers can choose their timezone in the given list. This part is only displayed when the admin enabled in Configuration
• Gift Card Product Type = Print At Home: Gift Card Information of Print At Home Gift Card Product is essentially the same as the E-gift card product. The two Gift Card Products have the following differences:
  • Delivery method is Print At Home. When the customer purchases this Gift Card Product type successfully, the gift code will automatically be added to the customer’s Save List
  • No Email / Phone Num. , Delivery Date and Timezone

• Gift Card Product Type = Mail: Gift Card Information of Mail Gift Card The product is essentially the same as E-gift Card Product type. They have different delivery methods. Delivery of a Mail Gift Card Product is Post Office which means the gift card will be sent based on the customer’s address

IX. How to import Gift Card Code(s)

At the admin backend, keep track System > Data Transfer: Import

At the Import page, choose the extension you need to input Gift Code(s). At Import Settings, choose Entity Types = Mageplaza Gift Card Code, Import Behaviour and File to Import will be displayed.

To have a CSV file containing basic information to import Gift Card Code(s), you need to click Download Sample File. Then edit the content in available columns in the Sample File to have a CSV file which has Gift Card Code(s) easily and quickly. A quick note that you shouldn’t change the name of columns, otherwise it will get an error message when Check Data lauches.

A CSV file contains:

• Code: This is the column to fill Gift Card Code(s). The admin can enter any code as his wish. This is a required information.
• Balance: This is where you can enter the corresponding balance of each gift card. This is a required information.
• Status: indicates the status of a gift card. This is a required information. There are 6 statuses:
  • 1: means Active status
  • 2: means Inactive status
  • 3: means Pending status
  • 4: means Used status
  • 5: means Expired status
  • 6: means Canceled status
• Can_redeem: indicates whether the gift card code can be redeem or not. This is a required information. There are 2 Can Redeem’s states:
  • 1: means the gift card code can be redeem
  • 2: means the gift card code can not be redeem
• Store_id: corresponding to the Store View ID in Stores > Settings> All Stores. This is a required information.
• Pool_id: corresponding to the Gift Card Pools ID in Manage Gift Card Pools. If you leave it blank, that gift card does not belong to any Pools
• Template_id: corresponds to the ID of the Gift Card Template contained in Manage Templates. If you leave it blank, Gift Card does not have a template
• Expired_at: indicates the expiration date of a gift card. If you leave it blank, the gift card has no expiration (Permanent)

To the next step, we need to choose an Action for Import. In Import Behaviour, choose “Add/Update” so that gift code(s) will be automatically added to Manage Gift Code

Now you can select a CSV file to import.

• Choose file you want to import.
• The importable CSV file needs to meet the above conditions. To make sure things will be worked well, click the red Check data button. Data in the submitted CSV file will be checked and a message will inform whether it’s valid or not. In case of being invalid, admins need to check the CSV file (specially required columns, column’s name,etc). With the valid case, the Import button will appear along with the message like below

Clicking the Import button is the final steps!

Note:

• You should run the command: “bin/magento giftcard:uninstall” before you uninstall this extension so that your website doesn’t face the error.

X. API Document

Mageplaza Gift Card Extension supports retrieving and pushing data onto the website using the REST API. Please check this document for more details of supported APIs

XI. GraphQL Document

Mageplaza Gift Card Extension supports getting and pushing data on the website with GraphQL.

11.1.

To install, run the following command in Magento 2 root folder:

composer require mageplaza/module-gift-card-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

11.2

To start working with Gift Card GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql). View detailed queiries supported here

Automatic Related Products

Overview

Magento 2 Automatic Related Products (ARP) is a tool that helps admins establish links between new products easily. In brief, ARP is a recommendation tool, similar to Who Bought This Also Bought or Frequently Bought Together, but more additional outstanding features, and give more rules as well as managements in the backend.

Download & Install

You can download from the following resouces:

• Download Mageplaza Automatic Related Product
• Magento Marketplace
• How to Install

How to configue

Login to Magento Admin, choose Marketing > Automatic Related Products

Follow our given guide below to complete Automatic Related Products configuration which includes:

• Configuration
• Manage Rules
  • Manage Rules on Product Page
  • Manage Rules on Category Page
  • Manage Rules Shopping Cart Page
  • Manage Rules Order Success Page
  • Manage Rules CMS Page

1. Configuration

From the Admin Panel, go to Stores > Settings > Configuration > Mageplaza Extensions > Automatic Related Products

• Enable Automatic Related Products: Choose Yes to enable Automatic Related Products extension

2. Manage Rules on Product Page

This section allows you to install the Related Product Block in your desired Product Page. Product pages that meet this rule, the Related Product Block will be displayed.

To create a new Rule on Product Page, go to Marketing  > Automatic Related Products > Manage Rules. In the Add Rule section, select Product Page

A New Related Block Rule form will be appeared.

a. Rule Information

• Statistic : This is where the Rule is applied, the Product selection from the Block of ARP along with the percentage between the Product selection and the Page entry

• Rule Information

• Rule Name: This is where you name the rule. The rule name will be displayed on the Grid in Manage Rules Page and visible only with admins. This is a required field so there will be an error message if you leave it blank.
• Status : Choose “Active” to enable the rule.
• Store View: Select the store view where the Rule applies on. Mutiple stores can be selected.
• Customer Group: Choose customer group from which the Rule applied on. Different customer groups can be selected.
• From: This is where you select the starting date of the Rule applied to the Product Page.
• To: This is where you select the ending date of the Rule applied to the Product Page.
• Priority: Enter a number to set priority for the rule. A lower number represents a higher priority.

b. Products to Meet Conditions:

Setting:

• ARP block will display on eligible products pages
• You can add, remove conditions by clicking on + or x
• You can change the true/false of the condition by clicking the bold text

• Preview Products: You will get a Product List after saving conditions. Click Preview Products to see products which meet conditions. They will be presented in Block.

c. Select the Displayed Products

• Block name: Enter the block’s name. It’s only visible in the frontend
• Product Layout: There are 2 modes to choose how product are displayed
  • Slider: Show products in slider form

• Number of products on the Slider: Type in the number of products you want to show on the slider. The limit is 5. If empty or 0, 5 items will be displayed on the slider by default.
• Product Displayed When Scrolled: Type in the number of products you want to show each time the slider moves. The limit is 5. If empty or 0, after each before/after click on the slider, it will replace the next 2 products displayed on the slider by default.
• Grid: Show products in grid form

• Page Column Layout: Type in the number of products you want to show in the grid. The limit is 5. If empty or 0, 4 items will be displayed on the slider by default.

• Display mode:

  • Display Style: There are 2 Display Style that you can select:
    • Ajax Display: ARP block is loaded after loading page. It will take some times for this block to display in the frontend, which is good for page loading speed.
    • Block Display:
      • ARP block will be always loaded at the same time when loading page and instanly display after the page is loaded. This option is beneficial for SEO improvement.
      • This style does not support A/B testing

• Limit number of products:

  • This is where you limit the number of products to be shown in Block
  • If you leave it blank or set 0, all of products in the Product List will be displayed

• Display “Out-of-stock” products: select “No” to not display Out-of-Stock products in the Auto Related Product block.

• Product order: choose how to sort products in the block

  • Bestseller: more purchased products will be displayed first.
  • Lowest Price: products displaying based on low to high price
  • Highest Price: products displaying based on high to low price
  • Newest: newer products added will be displayed first
  • Random: products are selected randomly from the Product List
  • Most Viewed: products visited the most will be displayed.
  • Note: Enable Reports to allow counting product views, which will be used as data for this Most Viewed block.

  

  • Product Name A-Z: sort products in the ARP block based on Name from A-Z.
  • Product Name Z-A: sort products in the ARP block based on Name from Z-A.

• Show See All in Slider: Select Yes to display See All button next to the slider to allow viewing all products of that Automatic Related Product block.

• Slider Width (px): Enter px to the Slider Width field and the slider width will be changed according to the entered value. Note: You should set the appropriate Slider Width to ensure the displayed products in the slider are not affected.
• Slider Height (px): Enter px to the Slider Height field and the slider height will be changed according to the entered value. Note: You should set the appropriate Slider Height to ensure the displayed products in the slider are not affected.
• Show Next/Prev Buttons: Select Yes to display Next/Prev buttons in the slider.

• Show Dots Navigation: Select Yes to display dots navigation in the slider.

• Auto Play: Select Yes to automatically display the next product in the slider.
• Auto Time-Out: Select the time period to automatically display the next product in the slider.
• Display additional information: choose additional information or/and buttons displayed under products in the block:
  • Price
  • Review Information
  • Add to Cart
  • Add to WishList
  • Add to Compare buttons
• Add Product:
  • Choose an available related type of products to set for the block (Related Products, Up-sell Products, Cross-sell Products)
  • Each of product page can have different related product blocks which is set on product setting by the admin
  • How to configure Related, Up-sell, Cross-sell Product document can be found here
• Do not Display Product in: Remove products which have been added to cart or in the Wishlist from ARP block.

Product to meet Condition

• Setting:
  • Choose products to be displayed in ARP block. Only product pages which match the setup conditions, the new rule will be displayed
  • You can add, remove conditions by clicking on + or x
  • You can change the true/false of the condition by clicking the bold text

• Preview Products: You will get a Product List after saving conditions. Click to Preview Products to see products which meet conditions. They will be presented in Block.
• Apply “Similarity” Condition = Yes: Allow showing products having products attributes that are similar to the product on the current product page. Product attributes are selected via conditions. Similarity is available only on product pages.

d. Where to display Related Products:

This is where you specify the block where the Product Page is located

• Above Content: https://i.imgur.com/rAlorSI.png
• Below Content: Auto Related Product block displayed under the Content of the Product Page.
• Floating Left Bar: Auto Related Product block displayed under the left of Product Page Content.
• Floating Right Bar: Auto Related Product block displayed under the right of Product Page Content.
• Product Tab: Show the Related Product block in the Native tab on the Product page.

• Replace Related Products: The new block will replace the Magento’s default Related Product Block.
• Replace Upsell Products: Auto Related Product block will replace the default Upsell Product Block by Magento.
• Before native Related products: Auto Related Product block displays above the Magento’s Related Product block.
• After native Related products: Auto Related Product block displays below the Magento’s Related Product block.
• Before Upsell Products: Auto Related Product block displays above the Magento’s Related Product Block.
• After Upsell Products: Auto Related Product block displays below the Magento’s Related Product Block.
• Insert Snippet:

Auto Related Product block will be displayed according to Widget, Page and Template after deploying the following command.

e. A/B Testing

• After a parent rule (an original rule) is generated, a child rule can be created by clicking Add A/B Testing.You can edit the this child rule in the same way to set up parent rules.

• When two rules are simultaneously active, these two rules will be applied alternately in Product Page.
• If one of the two rules is inactive, the other rule will work normally
• After the A/B Testing Rule is created, the Statistic section will be changed to sum up the views, clicks, and CTR rates of two rules.

• In the Parent Rule section of the A/B Testing: it will indicate which of the two links is the Parent - Child. From the Parent Rule you can go to this section to quickly switch to the Child Rule by clicking on the Child Rule Link

• Also in the Child Rule there is a Parent button to quickly switch to Parent Rule

3. Manage Rules on Category Page

This section allows you to install the Related Product Block in the Category Page that you desire. For category pages that satisfy this rule, the Related Product Block will be displayed in the selected location

Headings in the Rule Category Page are quite similar to the Rule Product Page, we will only point different places out for you in this guide.

a. Rule Information

All fields are similar to those in the Rule Inforamtion on Product Page. You can check them on the section 2.

b. Products to Meet Conditions

• By Conditions, you can select the Category Page you want the Rule to be applied to, you cannot select as many conditions as the Product Page.
• There’s no Preview Product here

c. Select the Displayed Product

All fields are similar to those in the Product Page except that there is no Similarity field.

d. Where to Displayed Related Product

• Sidebar Top: Related Products Block is displayed at the top of Sidebar
• Sidebar Bottom: Related Products Block is displayed at the bottom of Sidebar
• Above Content: Related Product Block is displayed on top of Content in Category Page
• Below Content: Related Product Block is displayed below Content in Category Page
• Insert Snippet: Tương tự với Insert Snippet tại Product Page.

e. A/B Testing

All fields are similar to those in the Product Page.

4. Manage Rules on Shopping Page

This section allows you to install the Related Product Block in your desired View Cart Page. When the View Cart Page fulfills the Rule, the Related Product Block will be displayed in the selected position.

Headings in the Rule Shopping Page are quite similar to the Rule Product Page. Only the differences will be pointed.

a. Rule Information

All fields are similar to those in the Product Page.

b. Products to Meet Conditions

You can select the same conditions as the Product Page. Furthermore, you can set additional conditions for Total Items in the Cart, Total Price and Total Volume of Products.C

c. Select The Displayed Product

All fields are similar to those in the Product Page except that there is no Similarity field.

d. Where To Display Related Products

• Above Content: Auto Related Product block displays above the Content of the Product Page
• Below Content: Auto Related Product block displayed under the Content of the Product Page
• Floating Left Bar: Auto Related Product block displayed under the left of Product Page Content
• Floating Right Bar: Auto Related Product block displayed under the right of Product Page Content
• Replace Cross-sell Products: Auto Related Product block will replace the default Cross-sell Product Block by Magento
• Before Cross-sell Products: Auto Related Product block displays above the Magento’s Cross-sell Product block
• After Cross-sell Products: Auto Related Product block displays below the Magento’s Cross-sell Product block
• Insert Snippet: Configuration simil y to that in the Product Page

e. A/B Testing:

The configuration is the same with that in the Product Page.

5. Manage Rules on One Page Checkout

One Page Checkout ARP is compatible with Mageplaza One Step Checkout extension. Admins need to install One Step Checkout module to get ARP displayed in the frontend.

The way to set up this rule is quite similar to other rules.

6. Manage Rules on Order Success Page

The configuration is the same with that in other Rules. ARP block is shown in Order Success Page.

7. Manage Rules on CMS Page

a. Rule Information

The configuration is the same with other Rules

b. Select the Displayed Product

The configuration is the same with other Rules

c.Where To Display Related Products

• Insert Snippet: the configuration is similar to that in other rules
• CMS Page: Select pages to display the ARP block with positions of Top or Bottom

8. Exclude Automatic Related Extension in a specific Product Detail

• Choose Catalog > Products > Edit Product that admins do not want to Automatic Related Product extension applies on
• Choose Related Products, Up-Sells, and Cross-Sells
• Enable Manually Setup Auto Related Products
• Save Products

This function makes Automatic Related Products inactive on a certain product. The way that Related Products displays in the frontend will be based on the Related Products themselves with the Core design.

9. How to set the Where to display = (Manually)

First of all, admins need to set Rule which has Where to Display= Manually and return store view to All Store View before starting to custom Automatic Related Products block. If not, both Widget and Rule will appear on the frontend.

a. Create Widget

• Step 1: Choose type

  • Choose Content > Elements > Widgets > Add Widget
  • In the Setting field, choose Type = ARP Product List and select any Design Theme

  

  • Click to Continue button

• Step 2: Install Widget

  • In the Storefront Properties

    • Enter Widget Name and Store View to be displayed
    • In the Layout Update field, choose Page to show the widget on Display on. In the next step, select where the Widget will appear in Page from Container section
    • Choose Display on = Category to custom Category Rule and Display on = Product to custom Product Rule. If you do not choose any of them, Rule will not show.

    

  • In the Widget Option, select your wanted Rule Name.

  

  • Click to Save to finish creating Widget

• Step 3 Check Frontend

b. Insert ARP into CMS Static Block

• Step 1: Insert ARP into CMC Static Block

  • Choose Content > Elements > Blocks > Edit/Add New CMS Static Block that you want to insert ARP

  • In the CMS Statics Block Content, there are two ways to insert ARP

    • Method 1: Choose Insert Widget > Widget Type = ARP Product List > Rule Name >  Insert Widget
    • Method 2: Click to Show/Hide Editor and then paste the following code directly to the content. You can change the rule_id to the Rule ID that you want to insert.

    {{block class="Mageplaza\AutoRelated\Block\Widget\ProductList" rule_id="1"}}

    

  • Click to Save to keep all the changes

• Step 2: Check Frontend

c. Insert the code to file .phtml

Following this method, you can place the code wherever you want, provided that you have already known the position of file .phtml

$objectManager = \Magento\Framework\App\ObjectManager::getInstance(); 
$productList= $objectManager->create("Mageplaza\AutoRelated\Block\Widget\ProductList")->setRuleId(1)->toHtml(); 
echo $productList;

10. API

Automatic Related Product extension by Mageplaza supports the use of Rest API to get information of rules, update statistics of rules (CTR, impressions, clicks) and keep track of activities of module.

Details can be viewed here

Here is the instruction to generate Integration tokens

11. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-auto-related-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Mageplaza’s Automatic Related Products allows admins to get the rule’s information through GraphQL.

To start working with Automatic Related Product GraphQL in Magento, you need to:

• Use Magento 2.3.x, Return your site to developer mode
• Refer to our supported GraphQL requests here

Affiliate

Mageplaza Affiliate extension for Magento 2 is the greater choice than ever if you want to build an Affiliate program that is crazy enough to drive traffic and sales increase promptly, get qualified leads, and also enhance your brand awareness. Our Affiliate program allows you to pay affiliates amount of commissions.

Mageplaza Affiliate User Guide will provide the detailed instructions to know How to use on the frontend and How to Config on the backend.

How to Use

After installing Affiliate module, an Affiliate link is available on the footer of your site. Click on the link and go to Affiliate Home Page.

Affiliate Home Page

Affiliate Home Page is already setup with CMS Block including Welcome Message and How does Affiliate Program work? If you want to change the text, it is possible to edit from the backend. In addition, all of the active Affiliate Program will be displayed on the Affiliate Home Page.

Look at the left panel on the page, customers can sign up to become an affiliate.

My Credit Page

Each affiliate can manage every credit information such as available balance, holding balance, total earned, and total paid and all transactions related to the account are listed in detail.

Refer Friend Page

Affiliate module by Mageplaza allows affiliate refer friends via referral url, code and email.

Just insert friends’ email addresses together with message to send invitation instantly on Refer Friend page.

My Withdrawal Page

Mageplaza Affiliate supports offline payment and Paypal payment for the withdrawal. Each created withdrawal will be saved and managed in Withdraw History. Let follow its status to know where the request is in progress.

Affiliate Settings Page

Mark the box to register Affiliate Subscription.

Refer History Page

Show the list of customers that the affiliate invited via Refer URL or Coupon Code.

How to Configure

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Affiliate > Configuration

1. Configuration

1.1. General

• Enable: Choose Yes to apply the feature of the module
• Cookie Expiration
  • Enter the number of days to store cookies of this program.
  • If skip it, the default (365) is used, that means Lifetime Commissions can be active.
• Allow overriding cookies: Choose Yes to override Affiliate code when a customer is referred by many Affiliates.
• Allow using Afiliate Code as Coupon: Select Yes to allow using Affiliate code for discount. This usgae is available in Shopping Cart Page and Checkout Page
• Enable Banner: If Yes, the banner will be shown on the My Affiliate page on the frontend. Show extra field:
  • Show Report for Banner on Frontend: If Yes, will show the report of Impressions, Clicks of customers to each banner.

• Show Affiliate link on: Choose the display position of the Affiliate link
  • Show Affiliate link on = Footer Link: Display the Affiliate link in the bottom of the page
  • Show Affiliate link on = Top Link: Display the Affiliate link in the top of the page along with the link
• My Account
  • You can choose to display in both positions
  • If admin does not choose the position to display Affiliate link, the link only show on Frontend at My Account Page when customers login.
• Custom CSS
  • Admin can freely customize the display of the Affiliate site
  • Supports HTML, CSS
• Enable Referral History: Select Yes to show Refer History page in My Affiliate. Display information of customers invited using Refer URL or Coupon Code, including columns such as ID, Customer Name, Customer Email Address, Date.
• Enable Affiliate Referral Information: Select Yes to show Parent Affiliate customer information on the My Account page. Note that, the customer account has Sign Up Account Affiliate and the Affiliate account has been active.

1.1.1. Default Page

• Affiliate homepage content
  • Select CMS Block for Affiliate homepage content
  • The default display is: Affiliate Welcome homepage content

1.1.2. Affiliate URL

• URL Style: Choose the type to display URL
  • URL Style = Hash: Display URL as http://example.com#c123
  • URL Style = Parameter: Display URL as http://example.com/?c=123
• Custom parameter
  • Enter the letter for the customization of Affiliate URL. Those parameters here will be inserted in front of the Refer code
  • If this field is left blank, the default value is “u”.

For example: refer code is 123, Custom parameter is abc * Hash: http://example.com#abc123 * Parameter: http://example.com/?abc=123

• Parameter value
  • Parameter value = Affiliate ID: Display the ID of Affiliate account on the Refer URL link in My Account/ My Affiliate/ Refer Friend outside the frontend. For example: ?u=1 or #u1
  • Parameter value = Affiliate Code: Display the code of Affiliate account on the Refer URL link outside the frontend. For example: ?u=b1dc or #ub1dc and display the code of Affiliate account in the Refer Code field in My Account/ My Affiliate/ Refer Friend outside the frontend
• Length of Affiliate code
  • Enter the length of Affiliate code
  • The default length is 6 characters
  • It is recommended to enter a length between 3 and 32 characters to ensure safety

1.2. Account Configuration

1.2.1. Affiliate Sign up

• Default Affiliate Group
  • Choose the default group whenever an account is registered as an Affiliate account
  • The original default group is General
• Require admin’s approval: Choose No so that when registering as an affiliate account, you don’t need to go through the censorship of the store
• Checked “Email notification” by default: Select Yes to automatically check the Receive affiliate email box on the My Account/My Affiliate/Setting tab outside the frontend whenever an account is registered as an Affiliate account.

1.2.2.Terms and Conditions

• Enable Terms and Conditions: Choose Yes to display Terms and Conditions in the Sign Up section which is outside the frontend
• Checkbox Text: Enter the checkbox text that is in the right of Terms and Conditions checkbox.
• Terms and Conditions Title: Enter the title for Terms and Conditions
• Terms and Conditions Content
  • Select CMS Block for Terms and Conditions Content
  • The default content is Affiliate terms & conditions
• Checkbox is checked by default: Choose Yes to tick in the checkbox automatically

1.2.3. Account Balance

• Maximum of Affiliate Balance
  • Enter the Maximum of Affiliate Balance
  • If Affiliate reach the milestone, none of commission is added
  • If the field is left empty or entered as zero, Affiliate Balance will have no limitation
• Allow negative balance: If Affiliate’s account balance is not enough to take back commission, allow the balance to be negative number by choosing Yes in the respective field

1.3. Commission Configuration

• Earn commission from tax: Choose Yes to earn commission from tax
• Earn commission from Shipping: Choose Yes to earn commission from shipping fee

1.3.1. Commission calculation process

• Allow Affiliate receiving commission when Invoice created
  • Allow Affiliate receiving commission when Invoice created = Yes: Commissions received when creating an invoice
  • Allow Affiliate receiving commission when Invoice created = No: Commissions are only received when the order is in the completed state
• Hold commission transactions for
  • Enter the days between commission transaction for accounts. After that period of time, the transaction will no longer be kept
  • If the field is blank or entered as 0, the transaction will not be kept
• Deduct commission from Affiliate’s balance when the order is refunded/canceled
  • Choose Yes to allow deducting the commission from the balance of the branch when the order is refunded or canceled
  • The default allows deducting

1.4 Withdrawal Configuration

• Allow withdrawal request: Select Yes to display the withdrawal request outside the frontend
• Payment Methods
  • There are three withdraw methods which are Offline payment, Bank Transfer and Paypal payment, Store Credit. Affiliate extension is completely compatible with Mageplaza Store Credit (v4.0.4 or above for M2.4 | v1.1.9 or above for M2.3 or below) to support withdrawal with the store credit payment.
  • Enter the withdrawal fee for each form of withdrawal. You can enter the charge as a specific amount or a percentage of the total amount withdrawn
  • To allow displaying a withdraw’s form outside the frontend, select Active = Yes corresponding to that form
• The minimum balance in affiliate account for requesting withdrawal
  • Enter the minimum balance in the linked account to request a withdraw
  • If you leave blank or fill in as 0, you will not be limited when withdrawing
• Minimum withdrawal amount
  • Enter the minimum amount for each withdraws
  • The withdraw fee will be included in here
• Maximum withdrawal amount
  • Enter the maximum amount for each withdraws
  • The withdraw fee will be included in here

1.5 Email Configuration

• Email Sender
  • Select the email sender
  • The default email sender is: General Contact

1.5.1 Admin Email

• Send Emails To: Enter the email address so that admin can receive notifications. You can fill in multiple emails, separate them by commas “,”
• New Affiliate Sign Up: Select Yes to let admin receive notification emails when a customer signs up for affiliate program. This will show the Sign up Template field
• Sign Up Template:
  • Choose email template for email sent when a customer sign up for affiliate program
  • The default content of the template is Sign Up Template (Default)
• New Withdraw Request: Select Yes to let admin receive notification email when a customer requests withdraw. This will show the Withdraw Request Template field.
• Withdraw Request Template:
  • Choose email template for email sent when a customer request withdraw
  • The default content of the template is Withdraw Request Template (Default)

1.5.2. Account Email

• Send Welcome Email: Choose Yes to send the email when an account registered as an Affiliate account
• Welcome Email
  • Choose the email template sending when an account registered as an Affiliate account
  • The default content of the template is Welcome Email (Default)
• Welcome Email After Account Approved
  • Choose the email template sending when the registered account is approved to be an Affiliate account by the store owner
  • The default content of the template is Welcome Email After Account Approved (Default)
• Account Rejection: Select Yes to send email to the customer whose request register for affiliate account is rejected. This shows the Account Rejection Template field
• Account Rejection Template:
  • Choose email template for email sent when the request to register for affiliate account is rejected
  • The default content of the template is Account Rejection Template (Default)
• Account Change Status: Select Yes to email the customer when the status of the affiliate account changes. This shows the Account Change Status Template field
• Account Change Status Template:
  • Select email template for email sent when the status of affiliate account changes
  • The default content of the template is Account Change Status Template (Default)
• Withdraw Cancel Email: Select Yes to email customer when the customer’s withdraw request is canceled. This shows the Withdraw Cancel Template field
• Withdraw Cancel Template:
  • Select email template for email sent to customer when request to withdraw is rejected
  • The default content of the template is Withdraw Cancel Template (Default)

1.5.3. Transaction Email` section

• Send Transaction Email: Select Yes to send a notification email whenever there is a transaction
• Update Balance Email
  • Select the sending email template when there is a change in the balance
  • The default content of the template is Update Balance Email (Default)

1.5.4. Withdrawal Email

• Send Withdrawal Email: Select Yes to send a notification email when you withdraw money
• Withdrawal Complete Email
  • Select the sending email template when there is a change in the balance
  • The default content of the template is Withdraw Complete Email (Default)

1.6. Refer Friends Configuration

• Enable Refer Friends Feature: Choose Yes to activate the introduce to friends function

• Refer Sharing Email

  • Choose the email template which will be sent when introducing with friends through email
  • The default content of the template is Affiliate Sharing Email (Default)

• Default Refer URL

  • Insert the referral link. This link will display in the My Account/My Affiliate/Refer Friend tab
  • If empty, the default homepage url will be used.

• AddThis.com ID

  • Enter the AddThis ID to introduce it to friends through AddThis
  • If empty, default Public AddThis ID ra-56e141d56e895f5c will be used

• AddThis.com Classname: allows to display the social share button in the Referral Via Social Networks outside the frontend. * Enter the class name AddThis. You can go to your AddThis.com account, then click Get the code in the upper right corner, then scroll down to the Setup Inline Tools section, you will see the screenshot as below:

  

• If this field is left blank, the system will use the default value addthis_sharing_toolbox

• Display the social button share at Referral Via Social Networks outside the frontend:

• Use Cloudsponge to retrieve email contacts: Select Yes to allow access contacts from customer’s account such as Gmail, Yahoo, Live, AOL, Outlook, etc.
• Cloudsponge Key
  • Enter the Cloudsponge key
  • The default key used is a473483c2e256bd812bdc9a0bac867ecf1999a54
• Enable Referral via Social Networks on Product Listing Page: If Yes, the Referral via Social Networks will be displayed in the product listing page, helping customers to share and introduce to their friends to join the campaigns and get certain promotions.

• Enable Referral via Social Networks on Product Details Page: If Yes, Referral via Social Networks will be displayed in the product details page.

1.6.1. Sending Email Content

• Default Subject Email
  • Enter a title for the sending email
  • The default title is Good product and services
• Default Email Body
  • Enter the content for the sending email
  • The default content is I’ve been shopping at {{store_name}} and feel really happy. They provide good service and reasonable prices.

2. Manage Accounts

From the Admin panel, go to Marketing > Affiliate > Manage Accounts

2.1. Manage Grid

• Display Affiliate account information: account balance, total earned amount, account activity status, etc. Click the Edit link to see the account details.
• In this panel, admin can delete the account by clicking to the account checkbox, then choose Action > Delete

2.2. Add New Account

• Affiliate Group: Select the group for the created Affiliate account
• Referred By: Enter the ID of the previously registered Affiliate account
• Status
  • Status = Active: The Affiliate account which is just created can start working now
  • Status = Inactive: The Affiliate account which is just created can’t start working yet
  • Status = Need Approved: he Affiliate account which is just created needs to be approved by admin
• Email Notification: Choose Yes to receive notification emails when there is a change in your Affiliate account balance

3. Affiliate Groups

3.1. Manage Grid

• There are five default groups: General, Bronze, Sliver, Gold, Platinum

3.2. Add New Group

• Name
  • Insert the group name
  • This field is compulsorily required

4. Campaigns

With Affiliate Standard, the system creates a Campaign by default, you can edit this campaign’s information to match your store development strategy.

To create multiple Campaigns for your store, you can update your version to Affiliate Pro

• Edit Campaigns
  • Step 1: Fill in the Campaign Information
  • Step 2: Choose the conditions for applying the campaign
  • Step 3: Set up Discount
  • Step 4: Set up Commission
  • Step 5: Set up Coupon Code

Step 1: Fill in the Campaign Information

• Name * Name your campaign * This is a required field
• Description: Fill in the description of your campaign
• Status: Select yes to apply the campaign
• Website IDs
  • Choose the website to conduct the campaign
  • This is also a required field
• Affiliate Groups
  • Choose the group you want to conduct the campaign
  • This is another required field
• Referred Customer Groups:
  • Choose referred customer group that can use the campaign
  • This field is required
• Display
  • Display = Allow Guest: Show the campaign for all visiters
  • Display = Affiliate Member Only: Show the campaign for Affiliate only
• Active From Date: Select the starting day for your campaign
• Active ToDate: Select the finishing day for your campaign
• Sort Order
  • Insert the sort order (or prioritized number) of your campaign
  • The smaller the number, the more prioritized your campaign is, which means that it will be shown and applied first. If the sort orders of different campaigns are the same, the module will then consider their ID numbers.

Step 2: Choose the conditions for applying the campaign

• You can choose the products for a specific campaign by setting the rules for those products
• Or you can also choose the categories for applying the campaign

Step 3: Set up the Discount

• Apply
  • Apply = Percent of cart total: Apply discount for the percentage of cart total
  • Apply = Fixed amount discount for whole cart: Apply a fixed discount for purchasing
• Discount Amount: Insert the amount or the percentage of discount for purchasing
• Apply to Shipping Amount: Choose Yes to apply discount for shipping
• Apply Discount On Tax: Choose Yes to apply discount for taxable payment
• Discount Description: Insert the description for your discount policy

Step 4: Set up the Commission

In this section, allowing to configure the Tier 1 as follow:

• There are two commision types:
  • Percentage of grand total: Commision is calculated based on the percentage of grand cart total
  • Fixed amount: Commission is a fixed amount
• Choose type and value of commission in the 1st order and the next orders. You can set them to the same or separated option depending on your strategy.

Step 5: Set up the Coupon Code

• Code Length: enter the length for the coupon code. Otherwise, it will default to 0.
• Code Format: Choose a format for coupon code. There are 3 formats as follows:
  • Alphanumeric: coupon code will include both alphanumeric characters
  • Alphabetical: coupon code will contain alphanumeric characters
  • Numeric: the coupon code will contain numeric characters
• Coupon Code: You can enter an arbitrary value as a coupon code or click the Generate button below to automatically generate the format coupon code as set in the Code Length and Code Format fields.

Affiliate program is displayed in the frontend:

• Coupon codes for each Affiliate account can be used to receive discounts per Campaign.
• Coupon code includes 2 parts:
  • The prefix part is Refer Code of the affiliate account, which can be changed arbitrarily in the Coupon prefix field
  • The suffix is the coupon code generated in the Coupon Code tab in each Campaign.

5. Withdraws

5.1. Manage Grid

• Allow showing the withdraw history of each Affiliate account including The amount, the status, payment method, etc. Click Edit to see the details of each withdraw.
• Admin can also change the status or delete the withdraw history.

5.2. Add New Withdraws

• Account
  • Click to this field to show the affiliate account that has positive balance which can be withdrawn
  • This field is required

• Amount

  • Insert the withdraw amount which is including the fee of withdrawal
  • This is a required field

• Fee

  • Insert the withdraw fee
  • If you let this field empty, the configuration value will be applied

• Payment Method

  • Choose the payment method for withdrawal
  • There are three payment methods: Offline payment, Bank Transfer, Paypal payment, Store Credit

• Withdraw Description: Fill in the description for withdrawal

• Payment Detail:

  • For Offline payment, you need to insert the Addresses
  
  • For Bank Transfer, insert the Bank account
  
  • For Paypal payment, you need to fill in the Paypal email and Transaction ID
  

• Payment Email: Enter the Paypal email who receive commission
• Paypal transaction Id: Enter Paypal transaction ID

6. Transactions

6.1 Manage Grid

• Show the transaction of each affiliate account including the amount, status, the order that generates commission. Click View to see more details of each transaction.
• Admin can also change the status or delete the transaction records.

Assign to Affiliate Group

After adding the new Affiliate accounts, store admin can manage them in the Accounts Management grid.

• On the grid, find the Affiliate account needed to assign and open the Edit mode
• Choose the Affiliate group to assign. By the default, General is chosen

6.2. Add New Transaction

• Account
  • Click to this field to show the affiliate account and then you can choose the account to add transaction in
  • This is a required field

• Amount
  • Insert the added amount. It can be a negative one
  • This is a required field
• Title: Add the Title of transaction
• Holding Transaction For
  • Add the number of days that you want to keep the transaction records
  • If you leave it empty or insert 0, the transaction will be deleted

7. Email

7.1 Notification emails for successful registration the affiliate account

7.2 Notification emails for Affiliate account approval

7.3 Notification emails for changing the Afiliate account balance

7.4 Notification emails for completion of withdraw request

7.5 Notification emails for admin when there is a request to create Affiliate account

7.6 Notification emails for admin when there is a request to withdraw

7.7 Notification emails for customer when an account creation request is rejected

7.8 Notification emails for customer when status of Affiliate account changes

7.9 Notification emails for customer when withdrawal request is rejected

8 Compatible with Mageplaza Store Credit (Withdraw)

Affiliate is fully compatible with Mageplaza Store Credit extension to support store credit withdrawal conveniently and link accounts together.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Affiliate Pro

Improve the functions for standard Affiliate, Mageplaza introduces the Professional package with awesome added features such as referring friends using banner links, or the Affiliate can get more commission according to their affiliate levels.

Mageplaza Affiliate User Guide will provide the detailed instructions to know How to use on the frontend and How to Config on the backend.

How to Use

After installing Affilliate module, the Affiliate link is available on the footer of your site. Click on the link and go to Affiliate Home Page.

Affiliate Home Page

Affiliate Home Page is already setup with CMS Block including Welcome Message and How does Affiliate Program work? If you want to change the text, it is possible to edit from the backend. In addition, all of active Affiliate Program will be displayed on the Affiliate Home Page.

Look at the left panel on the page, the customer can sign up to become an affiliate.

My Credit Page

Each affiliate can manage every credit information such as available balance, holding balance, total earned, and total paid and all transactions related to the account are listed in detail.

Refer Friend Page

Affiliate module by Mageplaza allows affiliate refer friends via referral url, code and email.

Just insert friends’ email addresses together with message to send invitation instantly on Refer Friend page.

Banners

Click Get banner link to obtain the link and refer it to friends to get purchasing discount.

My Withdrawal Page

Mageplaza Affiliate supports offline payment and Paypal payment for the withdrawal. Each created withdrawal will be saved and managed in Withdraw History. Let follow its status to know where the request is in the progress.

Affiliate Settings Page

Mark the box to register Affiliate Subscription.

Refer History Page

Show the list of customers that the affiliate invited via Refer URL or Coupon Code.

How to Configure

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Affiliate > Configuration

1. Configuration

1.1. General

• Enable: Choose Yes to apply the feature of the module
• Cookie Expiration
  • Enter the number of days to store cookies of this program.
  • If skip it, the default (365) is used, that means Lifetime Commissions can be active.
• Allow overriding cookies: Choose Yes to override Affiliate code when a customer is referred by many Affiliates.
• Allow using Affiliate Code as Coupon: Select Yes to allow using Affiliate code for discount. This usgae is available in Shopping Cart Page and Checkout Page
• Enable Banner: If Yes, the banner will be shown on the My Affiliate page on the frontend. Show extra field:
  • Show Report for Banner on Frontend: If Yes, will show the report of Impressions, Clicks of customers to each banner.

• Show Affiliate link on: Choose the display position of the Affiliate link
  • Show Affiliate link on = Footer Link: Display the Affiliate link in the bottom of the page
  • Show Affiliate link on = Top Link: Display the Affiliate link in the top of the page along with the display of the link
• My Account
  • You can choose to display in both positions
  • The default display setting is in the Top Link
• Custom CSS
  • Admin can freely customize the display of the Affiliate site
  • Supports HTML, CSS
• Enable Referral History: Select Yes to show Refer History page in My Affiliate. Display information of customers invited using Refer URL or Coupon Code, including columns such as ID, Customer Name, Customer Email Address, Date.
• Enable Affiliate Referral Information: Select Yes to show Parent Affiliate customer information on the My Account page. Note that, the customer account has Sign Up Account Affiliate and the Affiliate account has been active.

1.1.1. Default Page

• Affiliate homepage content
  • Select CMS Block for Affiliate homepage content
  • The default display is: Affiliate Welcome homepage content

1.1.2. Affiliate URL

• URL Style: Choose the type to display URL
  • URL Style = Hash: Display URL as http://example.com#c123
  • URL Style = Parameter: Display URL as http://example.com/?c=123
• Custom parameter
  • Enter the letter for the customization of Affiliate URL
  • If this field is left blank, the default value is “u”. For example: ?u=123 or #u123
• Parameter value
  • Parameter value = Affiliate ID: Display the ID of Affiliate account on the Refer URL link in My Account/ My Affiliate/ Refer Friend outside the frontend. For example: ?u=1 or #u1
  • Parameter value = Affiliate Code: Display the code of Affiliate account on the Refer URL link outside the frontend. For example: ?u=b1dc or #ub1dc and display the code of Affiliate account in the Refer Code field in My Account/ My Affiliate/ Refer Friend outside the frontend
• Length of Affiliate code
  • Enter the length of Affiliate code
  • The default length is 6 characters
  • It is recommended to enter a length between 3 and 32 characters to ensure safety

1.2. Account Configuration

1.2.1. Affiliate Sign up

• Default Affiliate Group
  • Choose the default group whenever an account is registered as an Affiliate account
  • The original default group is General
• Require admin’s approval: Choose No so that when registering as an affiliate account, you don’t need to go through the censorship of the store
• Checked “Email notification” by default: Select Yes to automatically check the Receive affiliate email box on the My Account/My Affiliate/Setting tab outside the frontend whenever an account is registered as an Affiliate account.

1.2.2.Terms and Conditions

• Enable Terms and Conditions: Choose Yes to display Terms and Conditions in the Sign Up section which is outside the frontend
• Checkbox Text: Enter the checkbox text that is in the right of Terms and Conditions checkbox.
• Terms and Conditions Title: Enter the title for Terms and Conditions
• Terms and Conditions Content
  • Select CMS Block for Terms and Conditions Content
  • The default content is Affiliate terms & conditions
• Checkbox is checked by default: Choose Yes to automatically tick in the checkbox

1.2.3. Account Balance

• Maximum of Affiliate Balance
  • Enter the Maximum of Affiliate Balance
  • If Affiliate reach the milestone, none of commission is added
  • If the field is left empty or entered as zero, Affiliate Balance will have no limitation
• Allow negative balance: If Affiliate’s account balance is not enough to take back commission, allow the balance to be negative number by choosing Yes in the respective field

1.3. Commission Configuration

• Earn commission from tax: Choose Yes to earn commission from tax
• Earn commission from Shipping: Choose Yes to earn commission from shipping fee

1.3.1. Commission calculation process

• Allow Affiliate receiving commission when Invoice created
  • Allow Affiliate receiving commission when Invoice created = Yes: Commissions received when creating an invoice
  • Allow Affiliate receiving commission when Invoice created = No: Commissions are only received when the order is in the completed state
• Hold commission transactions for
  • Enter the days between commission transaction for accounts. After that period of time, the transaction will no longer be kept
  • If the field is blank or entered as 0, the transaction will not be kept
• Deduct commission from Affiliate’s balance when the order is refunded/cancelled
  • Choose Yes to allow deduct the commission from the balance of the branch when the order is refunded or cancelled
  • The default allows deducting

1.4. Withdrawal Configuration

• Allow withdrawal request: Select Yes to display the withdrawal request outside the frontend
• Payment Methods
  • There are three withdraw methods which are Offline payment, Bank Transfer and Paypal payment
  • Enter the withdrawal fee for each form of withdrawal. You can enter the charge as a specific amount or a percentage of the total amount withdrawn
  • To allow displaying a withdraw’s form outside the frontend, select Active = Yes corresponding to that form
• The minimum balance in affiliate account for requesting withdrawal
  • Enter the minimum balance in the linked account to request a withdraw
  • If you leave blank or fill in as 0, you will not be limited when withdrawing
• Minimum withdrawal amount
  • Enter the minimum amount for each withdraws
  • The withdraw fee will be included in here
• Maximum withdrawal amount
  • Enter the maximum amount for each withdraws
  • The withdraw fee will be included in here

1.5. Email Configuration

• Email Sender
  • Select the email sender
  • The default email sender is: General Contact

1.5.1 Admin Email

• Send Emails To: Enter the email address so that admin can receive notifications. You can fill in multiple emails, separate them by commas “,”
• New Affiliate Sign Up: Select Yes to let admin receive notification emails when a customer signs up for affiliate program. This will show the Sign up Template field
• Sign Up Template:
  • Choose email template for email sent when a customer sign up for affiliate program
  • The default content of the template is Sign Up Template (Default)
• New Withdraw Request: Select Yes to let admin receive notification email when a customer requests withdraw. This will show the Withdraw Request Template field.
• Withdraw Request Template:
  • Choose email template for email sent when a customer request withdraw
  • The default content of the template is Withdraw Request Template (Default)

1.5.2. Account Email

• Send Welcome Email: Choose Yes to send the email when an account registered as an Affiliate account
• Welcome Email
  • Choose the email template sending when an account registered as an Affiliate account
  • The default content of the template is Welcome Email (Default)
• Welcome Email After Account Approved
  • Choose the email template sending when the registered account is approved to be an Affiliate account by the store owner
  • The default content of the template is Welcome Email After Account Approved (Default)
• Account Rejection: Select Yes to send email to the customer whose request register for affiliate account is rejected. This shows the Account Rejection Template field
• Account Rejection Template:
  • Choose email template for email sent when the request to register for affiliate account is rejected
  • The default content of the template is Account Rejection Template (Default)
• Account Change Status: Select Yes to email the customer when the status of the affiliate account changes. This shows the Account Change Status Template field
• Account Change Status Template:
  • Select email template for email sent when the status of affiliate account changes
  • The default content of the template is Account Change Status Template (Default)
• Withdraw Cancel Email: Select Yes to email customer when the customer’s withdraw request is canceled. This shows the Withdraw Cancel Template field
• Withdraw Cancel Template:
  • Select email template for email sent to customer when request to withdraw is rejected
  • The default content of the template is Withdraw Cancel Template (Default)

1.5.3. Transaction Email` section

• Send Transaction Email: Select Yes to send a notification email whenever there is a transaction
• Update Balance Email
  • Select the sending email template when there is a change in the balance
  • The default content of the template is Update Balance Email (Default)

1.5.4. Withdrawal Email

• Send Withdrawal Email: Select Yes to send a notification email when you withdraw money
• Withdrawal Complete Email
  • Select the sending email template when there is a change in the balance
  • The default content of the template is Withdraw Complete Email (Default)

1.6. Refer Friends Configuration

• Enable Refer Friends Feature: Choose Yes to activate the introduce to friends function
• Refer Sharing Email
  • Choose the email template which will be sent when introducing with friends through email
  • The default content of the template is Affiliate Sharing Email (Default)
• Default Refer URL
  • Insert the referral link. This link will display in the My Account/My Affiliate/Refer Friend tab
  • If empty, the default homepage url will be used.
• AddThis.com ID
  • Enter the AddThis ID to introduce it to friends through AddThis
  • If empty, default Public AddThis ID ra-56e141d56e895f5c will be used
• AddThis.com Classname: allows to display the social share button in the Referral Via Social Networks outside the frontend. Enter the class name AddThis. You can go to your AddThis.com account, then click Get the code in the upper right corner, then scroll down to the Setup Inline Tools section, you will see the screenshot as below:

• Use Cloudsponge to retrieve email contacts: Select Yes to allow access contacts from customer’s account such as Gmail, Yahoo, Live, AOL, Outlook, etc.
• Cloudsponge Key
  • Enter the Cloudsponge key
  • The default key used is a473483c2e256bd812bdc9a0bac867ecf1999a54

1.6.1. Sending Email Content

• Default Subject Email
  • Enter a title for the sending email
  • The default title is Good product and services
• Default Email Body
  • Enter the content for the sending email
  • The default content is I’ve been shopping at {{store_name}} and feel really happy. They provide good service and reasonable prices.

2. Manage Accounts

From the Admin panel, go to Marketing > Affiliate > Manage Accounts

2.1. Manage Grid

• Display Affiliate account information: account balance, total earned amount, account activity status,etc. Click the View link to see the account details.
• In this panel, admin can change status or delete the account

2.2. Add New Account

• Affiliate Group
• Referred By: Enter the ID of the previously registered Affiliate account
• Status
  • Status = Active: The Affiliate account which is just created can start working now
  • Status = Inactive: The Affiliate account which is just created can’t start working yet
  • Status = Need Approved: The Affiliate account which is just created needs to be approved by admin
• Email Notification: Choose Yes to receive notification emails when there is a change in your Affiliate account balance

3. Affiliate Groups

3.1. Manage Grid

• There are five default groups: General, Bronze, Silver, Gold, Platinum

3.2. Add New Group

• Name
  • Insert the group name
  • This field is compulsorily required

4. Campaigns

4.1 Edit Campaigns

• Step 1: Fill in the Campaign Information
• Step 2: Choose the conditions for applying the campaign
• Step 3: Set up Discount
• Step 4: Set up Commission
• Step 5: Set up Coupon Code

Step 1: Fill in the Campaign Information

• Name
  • Name your campaign
  • This is a required field
• Description: Fill in the description of your campaign
• Status: Sellect yes to apply the campaign
• Website IDs
  • Choose the website to conduct the campaign
  • This is also a required field
• Affiliate Groups
  • Choose the group you want to conduct the campaign
  • This is another required field
• Display
  • Display = Allow Guest: Show the campaign for all visiters
  • Display = Affiliate Member Only: Show the campaign for Affiliate only
• Active From Date: Select the starting day for your campaign
• Active ToDate: Select the finishing day for your campaign
• Sort Order
  • Insert the sort order (or prioritized number) of your campaign
  • The smaller the number, the more prioritized your campaign is, which means that it will be shown and applied first. If the sort orders of different campaigns are the same, the module will then consider their ID numbers.

Step 2: Choose the conditions for applying the campaign

• You can choose the products for a specific campaign by set the rules for those products
• Or you can also choose the categories for applying the campaign

Step 3: Set up the Discount

• Apply
  • Apply = Percent of cart total: Apply discount for the percentage of cart total
  • Apply = Fixed amount discount for whole cart: Apply a fixed discount for purchasing
• Discount Amount: Insert the amount or the percentage of discount for purchasing
• Apply to Shipping Amount: Choose Yes to apply discount for shipping
• Apply Discount On Tax: Choose Yes to apply discount for taxable payment
• Discount Description: Insert the description for your discount policy

Step 4: Set up the Commission

• There are two commision types:
  • Percentage of grand total: Commision is calculated based on the percentage of grand cart total
  • Fixed amount: Commission is a fixed amount
• Choose type and value of commission in the 1st order and the next orders. You can set them to the same or separated option depending on your strategy.
• Action = Delete: click Delete button at each Tier to delete
• Add button: Click Add button to create new Tier

Step 5: Set up the Coupon Code

• Code Length: enter the length for the coupon code. Otherwise, it will default to 0.
• Code Format: Choose a format for coupon code. There are 3 formats as follows:
  • Alphanumeric: coupon code will include both alphanumeric characters
  • Alphabetical: coupon code will contain alphanumeric characters
  • Numeric: the coupon code will contain numeric characters
• Coupon Code: You can enter an arbitrary value as a coupon code or click the Generate button below to automatically generate the format coupon code as set in the Code Length and Code Format fields.

Affiliate program is displayed in the frontend:

• Coupon codes for each Affiliate account can be used to receive discounts per Campaign.
• Coupon code includes 2 parts:
  • The prefix part is Refer Code of the affiliate account, which can be changed arbitrarily in the Coupon prefix field
  • The suffix is the coupon code generated in the Coupon Code tab in each Campaign.

4.2 Add New Campaigns

• Step 1: Fill in the Campaign Information
• Step 2: Choose the conditions for applying the campaign
• Step 3: Set up Discount
• Step 4: Set up Commission
• Step 5: Set up Coupon Code

Step 1: Fill in the Campaign Information

• Name * Name your campaign * This is a required field
• Description: Fill in the description of your campaign
• Status: Sellect yes to apply the campaign
• Website IDs
  • Choose the website to conduct the campaign
  • This is also a required field
• Affiliate Groups
  • Choose the group you want to conduct the campaign
  • This is another required field
• Display
  • Display = Allow Guest: Show the campaign for all visiters
  • Display = Affiliate Member Only: Show the campaign for Affiliate only
• Active From Date: Select the starting day for your campaign
• Active ToDate: Select the finishing day for your campaign
• Sort Order
  • Insert the sort order (or prioritized number) of your campaign
  • The smaller the number, the more prioritized your campaign is, which means that it will be shown and applied first. If the sort orders of different campaigns are the same, the module will then consider their ID numbers.

Step 2: Choose the conditions for applying the campaign

• You can choose the products for a specific campaign by set the rules for those products
• Or you can also choose the categories for applying the campaign

Step 3: Set up the Discount

• Apply
  • Apply = Percent of cart total: Apply discount for the percentage of cart total
  • Apply = Fixed amount discount for whole cart: Apply a fixed discount for purchasing
• Discount Amount: Insert the amount or the percentage of discount for purchasing
• Apply to Shipping Amount: Choose Yes to apply discount for shipping
• Apply Discount On Tax: Choose Yes to apply discount for taxable payment
• Discount Description: Insert the description for your discount policy

Step 4: Set up the Commission

• There are two commision types:
  • Percentage of grand total: Commision is calculated based on the percentage of garnd cart total
  • Fixed amount: Commission is a fixed amount
• Choose type and value of commission in the 1st order and the next orders. You can set them to the same or separated option depending on your strategy.
• Admin can add, edit, delete tier to apply for multi-level Affiliate account
• Admin can also create various campaigns
• For example: Campaign 1 has two tiers, the discount is 10%; campaign 2 has 2 tiers as well with 5% discount. A is Affiliate referring link to B as another Affiliate. When C buy the products using the link that B refer to, C will get the discount of 15% (10% + 5%). In this case, B will get the commision equal to the sum of tier 1 of campaign 1 and tier 1 of campaign 2. Whereas, A will get the commision of both tier 2 in the campagin 1 and campaign 2.

Step 5: Set up Coupon Code

• Code Length: enter the length for the coupon code. Otherwise, it will default to 0.
• Code Format: Choose a format for coupon code. There are 3 formats as follows:
  • Alphanumeric: coupon code will include both alphanumeric characters
  • Alphabetical: coupon code will contain alphanumeric characters
  • Numeric: the coupon code will contain numeric characters
• Coupon Code: You can enter an arbitrary value as a coupon code or click the Generate button below to automatically generate the format coupon code as set in the Code Length and Code Format fields.

Affiliate program is displayed in the frontend:

• Coupon codes for each Affiliate account can be used to receive discounts per Campaign.
• Coupon code includes 2 parts:
  • The prefix part is Refer Code of the affiliate account, which can be changed arbitrarily in the Coupon prefix field
  • The suffix is the coupon code generated in the Coupon Code tab in each Campaign.

5. Banners

Add New Banner

• Title
• Insert the title for your banner
• This is a required field
• Content
• Click to Insert Image to choose image or upload from your library for your banner. The image link will be shown at the below text box
• You can also insert text or html link in this text box
• Redirect URL
• Insert the URL that admin want customers click on
• If it is left empty, the default displaying place is homepage
• Related Campaign
• Choose the campaign for your banner. If customers buy products using that banner link, they will get the promotion of related campaigns and that banner is only shown for the Affiliate of related campaigns
• You can choose the default campaign
• Rel Nofollow
• Choose Yes to put the attribute rel=”nofollow” into the banner link
• Default setting is No
• Status: Choose Enable to show banner at frontend

6. Withdraws

6.1. Manage Grid

• Allow to show the withdraw history of each Affiliate account including: The amount, the status, payment method, etc. Click View to see the details of each withdraw.
• Admin can also change the status or delete the withdraw history.

6.2. Add New Withdraws

• Account
  • Click to this field to show the affiliate accounts that have positive balance which can be withdrawn
  • This field is required

• Amount
  • Insert the withdraw amount which is including the fee of withdrawal
  • This is a required field
• Fee
  • Insert the withdraw fee
  • If you leave this field empty, the configuration value will be applied
• Payment Method
  • Choose the payment method for withdrawal
  • There are three payment methods: Offline payment, Bank Transfer, Paypal payment
• Withdraw Description: Fill in the description for withdrawal
• Payment Detail:
• For Offline payment, you need to insert the Address

• For Bank Transfer, insert the Bank account

• For Paypal payment, you need to fill in the Paypal email and Transaction ID

• Payment Email: Enter the Paypal email who receive commission
• Paypal transaction Id: Enter Paypal transaction ID

7. Transactions

7.1 Manage Grid

• Show the transaction of each affiliate account including: the amount, status, the order that generates commission. Click View to see more details of each transaction.
• Admin can also change the status or delete the transaction records.

Assign to Affiliate Group

After adding the new Affiliate accounts, store admin can manage them in the Accounts Management grid.

• On the grid, find the Affiliate account needed to assign and open the Edit mode
• Choose the Affiliate group to assign. By the default, Genera is chosen

7.2. Add New Transaction

• Amount
  • Insert the added amount. It can be a negative one
  • This is a compulsorily required field
• Title: Add the Title of transaction
• Holding Transaction For
  • Add the number of days that you want to keep the transaction records
  • If you leave it empty or inseart 0, the transaction will be deleted

8. Email

8.1 Notification emails for successful registration the affiliate account

8.2 Notification emails for Affiliate account aproval

8.3 Notification emails for changing the Affiliate account balance

8.4 Notification emails for completion of withdraw request

8.5 Notification emails for admin when there is a request to create Affiliate account

8.6 Notification emails for admin when there is a request to withdraw

8.7 Notification emails for customer when an account creation request is rejected

8.8 Notification emails for customer when status of Affiliate account changes

8.9 Notification emails for customer when withdrawal request is rejected

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Affiliate Ultimate

After the success of Professional Affiliate extension, Mageplaza continues to introduce the Ultimate version which provides further impressive features such as integrating with Report standard and Professional, Import/Export, API, sending refer code to friends, etc.

Mageplaza Affiliate User Guide will provide the detailed instructions to know How to use on the frontend and How to Config on the backend.

How to Use

After installing Affiliate module, the Affiliate link is available on the footer of your site. Click on the link and go to Affiliate Home Page.

Affiliate Home Page

Affiliate Home Page is already setup with CMS Block including Welcome Message and How does Affiliate Program work? If you want to change the text, it is possible to edit from the backend. In addition, all of active Affiliate Program will be displayed on the Affiliate Home Page.

Look at the left panel on the page, the customer can sign up to become an affiliate.

My Credit Page

Each affiliate can manage every credit information such as available balance, holding balance, total earned, and total paid and all transactions related to the account are listed in detail.

Customer can track the fluctuation of the balance added to his affiliate account through the chart statistic over the months.

Refer Friend Page

Affiliate module by Mageplaza allows affiliate refer friends via referral url, code and email.

Just insert friends’ email addresses together with message to send invitation instantly on Refer Friend page.

Banners

Click Get banner link to obtain the link and refer it to friends to get purchasing discount.

My Withdrawal Page

Mageplaza Affiliate supports offline payment and Paypal payment for the withdrawal. Each created withdrawal will be saved and managed in Withdraw History. Let follow its status to know where the request is in the progress.

Affiliate Settings Page

Mark the box to register Affiliate Subscription.

Refer History Page

Show the list of customers that the affiliate invited via Refer URL or Coupon Code.

How to Configure

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Affiliate > Configuration

1. Configuration

1.1. General

• Enable: Choose Yes to apply the feature of the module
• Cookie Expiration
  • Enter the number of days to store cookies of this program.
  • If skip it, the default (365) is used, that means Lifetime Commissions can be active.
• Allow overriding cookies: Choose Yes to override Affiliate code when a customer is referred by many Affiliates.
• Allow using Affiliate Code as Coupon: Select Yes to allow using Affiliate code for discount. This usgae is available in Shopping Cart Page and Checkout Page
• Enable Banner: If Yes, the banner will be shown on the My Affiliate page on the frontend. Show extra field:

• Show Report for Banner on Frontend: If Yes, will show the report of Impressions, Clicks of customers to each banner.

• Show Affiliate link on: Choose the display position of the Affiliate link
  • Show Affiliate link on = Footer Link: Display the Affiliate link in the bottom of the page
  • Show Affiliate link on = Top Link: Display the Affiliate link in the top of the page along with the display of the link
• My Account
  • You can choose to display in both positions
  • The default display setting is in the Top Link
• Custom CSS
  • Admin can freely customize the display of the Affiliate site
  • Supports HTML, CSS
• Enable Referral History: Select Yes to show Refer History page in My Affiliate. Display information of customers invited using Refer URL or Coupon Code, including columns such as ID, Customer Name, Customer Email Address, Date.
• Enable Affiliate Referral Information: Select Yes to show Parent Affiliate customer information on the My Account page. Note that, the customer account has Sign Up Account Affiliate and the Affiliate account has been active.

1.1.1. Default Page

• Affiliate homepage content
  • Select CMS Block for Affiliate homepage content
  • The default display is: Affiliate Welcome homepage content

1.1.2. Affiliate URL

• URL Style: Choose the type to display URL
  • URL Style = Hash: Display URL as http://example.com#c123
  • URL Style = Parameter: Display URL as http://example.com/?c=123
• Custom parameter
  • Enter the letter for the customization of Affiliate URL
  • If this field is left blank, the default value is “u”. For example: ?u=123 or #u123
• Parameter value
  • Parameter value = Affiliate ID: Display the ID of Affiliate account on the Refer URL link in My Account/ My Affiliate/ Refer Friend outside the frontend. For example: ?u=1 or #u1
  • Parameter value = Affiliate Code: Display the code of Affiliate account on the Refer URL link outside the frontend. For example: ?u=b1dc or #ub1dc and display the code of Affiliate account in the Refer Code field in My Account/ My Affiliate/ Refer Friend outside the frontend
• Length of Affiliate code
  • Enter the length of Affiliate code
  • The default length is 6 characters
  • It is recommended to enter a length between 3 and 32 characters to ensure safety

1.2. Account Configuration

1.2.1. Affiliate Sign up

• Default Affiliate Group
  • Choose the default group whenever an account is registered as an Affiliate account
  • The original default group is General
• Require admin’s approval: Choose No so that when registering as an affiliate account, you don’t need to go through the censorship of the store
• Checked “Email notification” by default: Select Yes to automatically check the Receive affiliate email box on the My Account/My Affiliate/Setting tab outside the frontend whenever an account is registered as an Affiliate account.

1.2.2.Terms and Conditions

• Enable Terms and Conditions: Choose Yes to display Terms and Conditions in the Sign Up section which is outside the frontend
• Checkbox Text: Enter the checkbox text that is in the right of Terms and Conditions checkbox.
• Terms and Conditions Title: Enter the title for Terms and Conditions
• Terms and Conditions Content
  • Select CMS Block for Terms and Conditions Content
  • The default content is Affiliate terms & conditions
• Checkbox is checked by default: Choose Yes to automatically tick in the checkbox

1.2.3. Account Balance

• Maximum of Affiliate Balance
  • Enter the Maximum of Affiliate Balance
  • If Affiliate reach the milestone, none of commission is added
  • If the field is left empty or entered as zero, Affiliate Balance will have no limitation
• Allow negative balance: If Affiliate’s account balance is not enough to take back commission, allow the balance be negative number by choosing Yes in the respective field

1.3. Commission Configuration

• Earn commission from tax: Choose Yes to earn commission from tax
• Earn commission from Shipping: Choose Yes to earn commission from shipping fee

1.3.1. Commission calculation process

• Allow Affiliate receiving commission when Invoice created
  • Allow Affiliate receiving commission when Invoice created = Yes: Commissions received when creating an invoice
  • Allow Affiliate receiving commission when Invoice created = No: Commissions are only received when the order is in the completed state
• Hold commission transactions for
  • Enter the days between commission transaction for accounts. After that period of time, the transaction will no longer be kept
  • If the field is blank or entered as 0, the transaction will not be kept
• Deduct commission from Affiliate’s balance when the order is refunded/canceled
  • Choose Yes to allow deducting the commission from the balance of the branch when the order is refunded or canceled
  • The default allows deducting

1.4. Withdrawal Configuration

• Allow withdrawal request: Select Yes to display the withdrawal request outside the frontend
• Payment Method
  • There are three withdraw methods which are Offline payment, Bank Transfer and Paypal payment, Store Credit. Affiliate extension is completely compatible with Mageplaza Store Credit (v4.0.4 or above for M2.4 | v1.1.9 or above for M2.3 or below) to support withdrawal with the store credit payment.
  • Enter the withdrawal fee for each form of withdrawal. You can enter the charge as a specific amount or a percentage of the total amount withdrawn
  • To allow displaying a withdraw’s form outside the frontend, select Active = Yes corresponding to that form
• The minimum balance in affiliate account for requesting withdrawal
  • Enter the minimum balance in the linked account to request a withdraw
  • If you leave blank or fill in as 0, you will not be limited when withdrawing
• Minimum withdrawal amount
  • Enter the minimum amount for each withdraws
  • The withdraw fee will be included in here
• Maximum withdrawal amount
  • Enter the maximum amount for each withdraws
  • The withdraw fee will be included in here

1.5. Email Configuration

• Email Sender
  • Select the email sender
  • The default email sender is: General Contact

1.5.1 Admin Email

• Send Emails To: Enter the email address so that admin can receive notifications. You can fill in multiple emails, separate them by commas “,”
• New Affiliate Sign Up: Select Yes to let admin receive notification emails when a customer signs up for affiliate program. This will show the Sign up Template field
• Sign Up Template:
  • Choose email template for email sent when a customer sign up for affiliate program
  • The default content of the template is Sign Up Template (Default)
• New Withdraw Request: Select Yes to let admin receive notification email when a customer requests withdraw. This will show the Withdraw Request Template field.
• Withdraw Request Template:
  • Choose email template for email sent when a customer request withdraw
  • The default content of the template is Withdraw Request Template (Default)

1.5.2. Account Email

• Send Welcome Email: Choose Yes to send the email when an account registered as an Affiliate account
• Welcome Email
  • Choose the email template sending when an account registered as an Affiliate account
  • The default content of the template is Welcome Email (Default)
• Welcome Email After Account Approved
  • Choose the email template sending when the registered account is approved to be an Affiliate account by the store owner
  • The default content of the template is Welcome Email After Account Approved (Default)
• Account Rejection: Select Yes to send email to the customer whose request register for affiliate account is rejected. This shows the Account Rejection Template field
• Account Rejection Template:
  • Choose email template for email sent when the request to register for affiliate account is rejected
  • The default content of the template is Account Rejection Template (Default)
• Account Change Status: Select Yes to email the customer when the status of the affiliate account changes. This shows the Account Change Status Template field
• Account Change Status Template:
  • Select email template for email sent when the status of affiliate account changes
  • The default content of the template is Account Change Status Template (Default)
• Withdraw Cancel Email: Select Yes to email customer when the customer’s withdraw request is canceled. This shows the Withdraw Cancel Template field
• Withdraw Cancel Template:
  • Select email template for email sent to customer when request to withdraw is rejected
  • The default content of the template is Withdraw Cancel Template (Default)

1.5.3. Transaction Email` section

• Send Transaction Email: Select Yes to send a notification email whenever there is a transaction
• Update Balance Email
  • Select the sending email template when there is a change in the balance
  • The default content of the template is Update Balance Email (Default)

1.5.4. Withdrawal Email

• Send Withdrawal Email: Select Yes to send a notification email when you withdraw money
• Withdrawal Complete Email
  • Select the sending email template when there is a change in the balance
  • The default content of the template is Withdraw Complete Email (Default)

1.6. Refer Friends Configuration

• Enable Refer Friends Feature: Choose Yes to activate the introduce to friends function
• Refer Sharing Email
  • Choose the email template which will be sent when introducing with friends through email
  • The default content of the template is Affiliate Sharing Email (Default)
• Default Refer URL
  • Insert the referral link. This link will display in the My Account/My Affiliate/Refer Friend tab
  • If empty, the default homepage url will be used.
• AddThis.com ID
  • Enter the AddThis ID to introduce it to friends through AddThis
  • If empty, default Public AddThis ID ra-56e141d56e895f5c will be used
• AddThis.com Classname: allows to display the social share button in the Referral Via Social Networks outside the frontend. Enter the class name AddThis. You can go to your AddThis.com account, then click Get the code in the upper right corner, then scroll down to the Setup Inline Tools section, you will see the screenshot as below:

• Enable Referral via Social Networks on Product Listing Page: If Yes, the Referral via Social Networks will be displayed in the product listing page, helping customers to share and introduce to their friends to join the campaigns and get certain promotions.

• Enable Referral via Social Networks on Product Details Page: If Yes, Referral via Social Networks will be displayed in the product details page.

• Use Cloudsponge to retrieve email contacts: Select Yes to allow access contacts from customer’s account such as Gmail, Yahoo, Live, AOL, Outlook, etc.
• Cloudsponge Key
  • Enter the Cloudsponge key
  • The default key used is a473483c2e256bd812bdc9a0bac867ecf1999a54

1.6.1. Sending Email Content

• Default Subject Email
  • Enter a title for the sending email
  • The default title is Good product and services
• Default Email Body
  • Enter the content for the sending email
  • The default content is I’ve been shopping at {{store_name}} and feel really happy. They provide good service and reasonable prices.

2. Manage Accounts

From the Admin panel, go to Marketing > Affiliate > Manage Accounts

2.1. Manage Grid

• Display Affiliate account information: account balance, total earned amount, account activity status,etc. Click the View link to see the account details.
• In this panel, admin can change status or delete the account

2.2. Add New Account

• Affiliate Group

• Referred By: Enter the ID of the previously registered Affiliate account
• Status
  • Status = Active: The Affiliate account which is just created can start working now
  • Status = Inactive: The Affiliate account which is just created can’t start working yet
  • Status = Need Approved: The Affiliate account which is just created needs to be approved by admin
• Email Notification: Choose Yes to receive notification emails when there is a change in your Affiliate account balance

3. Affiliate Groups

3.1. Manage Grid

• There are five default groups: General, Bronze, Silver, Gold, Platinum

3.2. Add New Group

• Name
  • Insert the group name
  • This field is compulsorily required

4. Campaigns

4.1 Edit Campaigns

• Step 1: Fill in the Campaign Information
• Step 2: Choose the conditions for applying the campaign
• Step 3: Set up Discount
• Step 4: Set up Commission
• Step 5: Set up Coupon Code

Step 1: Fill in the Campaign Information

• Name
  • Name your campaign
  • This is a required field
• Description: Fill in the description of your campaign
• Status: Sellect yes to apply the campaign
• Website IDs
  • Choose the website to conduct the campaign
  • This is also a required field
• Affiliate Groups
  • Choose the group you want to conduct the campaign
  • This is another required field
• Display
  • Display = Allow Guest: Show the campaign for all visiters
  • Display = Affiliate Member Only: Show the campaign for Affiliate only
• Active From Date: Select the starting day for your campaign
• Active ToDate: Select the finishing day for your campaign
• Sort Order
  • Insert the sort order (or prioritized number) of your campaign
  • The smaller the number, the more prioritized your campaign is, which means that it will be shown and applied first. If the sort orders of different campaigns are the same, the module will then consider their ID numbers.

Step 2: Choose the conditions for applying the campaign

• You can choose the products for a specific campaign by setting the rules for those products
• Or you can also choose the categories for applying the campaign

Step 3: Set up the Discount

• Apply
  • Apply = Percent of cart total: Apply discount for the percentage of cart total
  • Apply = Fixed amount discount for whole cart: Apply a fixed discount for purchasing
• Discount Amount: Insert the amount or the percentage of discount for purchasing
• Apply to Shipping Amount: Choose Yes to apply discount for shipping
• Apply Discount On Tax: Choose Yes to apply discount for taxable payment
• Discount Description: Insert the description for your discount policy

Step 4: Set up the Commission

• There are two commision types:
  • Percentage of grand total: Commision is calculated based on the percentage of grand cart total
  • Fixed amount: Commission is a fixed amount
• Choose type and value of commission in the 1st order and the next orders. You can set them to the same or separated option depending on your strategy.
• Action = Delete: click Delete button in each Tier to delete it
• Add button: Click Add button to create new Tier

Step 5: Set up the Coupon Code

• Code Length: enter the length for the coupon code. Otherwise, it will default to 0.
• Code Format: Choose a format for coupon code. There are 3 formats as follows:
  • Alphanumeric: coupon code will include both alphanumeric characters
  • Alphabetical: coupon code will contain alphanumeric characters
  • Numeric: the coupon code will contain numeric characters
• Coupon Code: You can enter an arbitrary value as a coupon code or click the Generate button below to automatically generate the format coupon code as set in the Code Length and Code Format fields.

Affiliate program is displayed in the frontend:

• Coupon codes for each Affiliate account can be used to receive discounts per Campaign.
• Coupon code includes 2 parts:
  • The prefix part is Refer Code of the affiliate account, which can be changed arbitrarily in the Coupon prefix field
  • The suffix is the coupon code generated in the Coupon Code tab in each Campaign.

4.2 Add New Campaigns

• Step 1: Fill in the Campaign Information
• Step 2: Choose the conditions for applying the campaign
• Step 3: Set up Discount
• Step 4: Set up Commission
• Step 5: Set up Coupon Code

Step 1: Fill in the Campaign Information

• Name
  • Name your campaign
  • This is a required field
• Description: Fill in the description of your campaign
• Status: Select yes to apply the campaign
• Website IDs
  • Choose the website to conduct the campaign
  • This is also a required field
• Affiliate Groups
  • Choose the group you want to conduct the campaign
  • This is another required field
• Display
  • Display = Allow Guest: Show the campaign for all visitors
  • Display = Affiliate Member Only: Show the campaign for Affiliate only
• Active From Date: Select the starting day for your campaign
• Active ToDate: Select the finishing day for your campaign
• Sort Order
  • Insert the sort order (or prioritized number) of your campaign
  • The smaller the number, the more prioritized your campaign is, which means that it will be shown and applied first. If the sort orders of different campaigns are the same, the module will then consider their ID numbers.

Step 2: Choose the conditions for applying the campaign

• You can choose the products for a specific campaign by set the rules for those products
• Or you can also choose the categories for applying the campaign

Step 3: Set up the Discount

• Apply
  • Apply = Percent of cart total: Apply discount for the percentage of cart total
  • Apply = Fixed amount discount for whole cart: Apply a fixed discount for purchasing
• Discount Amount: Insert the amount or the percentage of discount for purchasing
• Apply to Shipping Amount: Choose Yes to apply discount for shipping
• Apply Discount On Tax: Choose Yes to apply discount for taxable payment
• Discount Description: Insert the description for your discount policy

Step 4: Set up the Commission

• There are two commision types:
  • Percentage of grand total: Commision is calculated based on the percentage of grand cart total
  • Fixed amount: Commission is a fixed amount
• Choose type and value of commission in the 1st order and the next orders. You can set them to the same or separated option depending on your strategy.
• Admin can add, edit, delete tier to apply for multi-level Affiliate account
• Admin can also create various campaigns
• For example: Campaign 1 has two tiers, the discount is 10%; campaign 2 has 2 tiers as well with 5% discount. A is Affiliate referring link to B as another Affiliate. When C buy the products using the link that B refers to, C will get the discount of 15% (10% + 5%). In this case, B will get the commision equal to the sum of tier 1 of campaign 1 and tier 1 of campaign 2. Whereas, A will get the commision of both tier 2 in the campaign 1 and campaign 2.

Step 5: Set up Coupon Code

• Code Length: enter the length for the coupon code. Otherwise, it will default to 0.
• Code Format: Choose a format for coupon code. There are 3 formats as follows:
  • Alphanumeric: coupon code will include both alphanumeric characters
  • Alphabetical: coupon code will contain alphanumeric characters
  • Numeric: the coupon code will contain numeric characters
• Coupon Code: You can enter an arbitrary value as a coupon code or click the Generate button below to automatically generate the format coupon code as set in the Code Length and Code Format fields.

Affiliate program is displayed in the frontend:

• Coupon codes for each Affiliate account can be used to receive discounts per Campaign.
• Coupon code includes 2 parts:
  • The prefix part is Refer Code of the affiliate account, which can be changed arbitrarily in the Coupon prefix field
  • The suffix is the coupon code generated in the Coupon Code tab in each campaign.

5. Banners

Add New Banner

• Title
  • Insert the title for your banner
  • This is a required field
• Content
  • Click to Insert Image to choose image or upload from your library for your banner. The image link will be shown at the below text box
  • You can also insert text or html link in this text box
• Redirect URL
  • Insert the URL that admin want customers to click on
  • If it is left empty, the default displaying place is homepage
• Related Campaign
  • Choose the campaign for your banner. If customers buy products using that banner link, they will get the promotion of related campaigns and that banner is only shown for the Affiliate of related campaigns
  • You can choose the default campaign
• Rel Nofollow
  • Choose Yes to put the attribute rel=”nofollow” into the banner link
  • Default setting is No
• Status: Choose Yes to show banner at frontend

6. Withdraws

6.1. Manage Grid

• Allow to show the withdraw history of each Affiliate account including: The amount, the status, payment method, etc. Click View to see the details of each withdraw.
• Admin can also change the status or delete the withdraw history.

6.2. Add New Withdraws

• Account
  • Click to this field to show the affiliate accounts that have positive balance which can be withdrawn
  • This field is required

• Amount
  • Insert the withdraw amount which is including the fee of withdrawal
  • This is a required field
• Fee
  • Insert the withdraw fee
  • If you leave this field empty, the configuration value will be applied
• Payment Method
  • Choose the payment method for withdrawal
  • There are three payment methods: Offline payment, Bank Transfer, Paypal payment
• Withdraw Description: Fill in the description for withdrawal
• Payment Detail:
• For Offline payment, you need to insert the Addresses

• For Bank Transfer, insert the Bank account

• For Paypal payment, you need to fill in the Paypal email and Transaction ID

7. Transactions

7.1 Manage Grid

• Show the transaction of each affiliate account including: the amount, status, the order that generates commission. Click View to see more details of each transaction.
• Admin can also change the status or delete the transaction records.

Assign to Affiliate Group

After adding the new Affiliate accounts, store admin can manage them in the Accounts Management grid.

• On the grid, find the Affiliate account needed to assign and open the Edit mode
• Choose the Affiliate group to assign. By the default, Genera is chosen

7.2. Add New Transaction

• Account
  • Click to this field to show the affiliate account and then you can choose the account to add transaction in
  • This is a required field

• Amount
  • Insert the added amount. It can be a negative one
  • This is a compulsorily required field
• Title: Add the Title of transaction
• Holding Transaction For
  • Add the number of days that you want to keep the transaction records
  • If you leave it empty or insert 0, the transaction will be deleted

8. Email

8.1 Notification emails for successful registration the affiliate account

8.2 Notification emails for Affiliate account aproval

8.3 Notification emails for changing the Affiliate account balance

8.4 Notification emails for completion of withdraw request

8.5 Notification emails for admin when there is a request to create Affiliate account

8.6 Notification emails for admin when there is a request to withdraw

8.7 Notification emails for customer when an account creation request is rejected

8.8 Notification emails for customer when status of Affiliate account changes

8.9 Notification emails for customer when withdrawal request is rejected

9. Reports

9.1 Compatible with Mageplaza Reports Standard and Professional

9.1.1 Top Affiliate

• This card will show Top 5 Affiliate account who earn the highest commission in a specific period

9.1.2 New Affiliate

• This card shows the Top 5 Affiliate accounts which have been created most recently and also their time of registration.

9.1.3 Bestsellers Affiliate

• This card show the TOp 5 best seller products by Affiliate links. Click to View Details to see more best sellers

9.1.4 Affiliate Transaction

• This card records all the affiliate transactions with three statuses: On Hold, Completed, Cancelled. It will be shown in Pie chart for better visualization.

9.2 Affiliate Reports

From the Admin Panel, go to Reports > Affiliate Reports

9.2.1 Best sellers

This field allows showing the information for best seller products including: name, SKU, price, number of product sold. Admin not only can filter the products by Magento default but they also can filter by store data, by date with an ease.

9.2.2 Accounts

This field enables showing the information of Affiliate account such as the date receiving the commission, email, number of orders from affiliate link, total cart of order, commission amount. Beside filtering by some available filter options of Magento, admin also can filter by store, day, week, month and year easily.

9.2.3 Sales

In this field, admin can view the sales and the commission of related Affiliate accounts by date. This module beside allows filtering by some available filter options of Magento, admin also can filter by store, day, week, month and year easily.

10. API

• Affiliate Ultimate does support API. The API allows users to get a list with all their offers in the selected format (JSON) with the payout showcased in the selected currency. The list can be filtered by status (pending, approved, or cancel), order, account affiliate, transaction, withdraw and campaign; add new account affiliate, withdraw; delete account affiliate, campaign.
• Moreover, it can be customized to return only the selected fields (transaction, campaign, withdraw, account affiliate, change status of account affiliate, campaign)
• You can see some syntaxes that we list below:

• You can see some syntaxes that we list here . Also, please refer the guide on how to create API right here and creating token-based authentication here.

11. Import/Export

When admins want to change their Magento store system, for backup data purpose, we add the Import/Export function for all the data of Account Affiliate and Transaction of Affiliate.

11.1 Import/Export Affiliate Account

• Import

From the Admin Panel, go to Sytem > Data Tranfer > Import

Step 1: Choose Entity Type = Mageplaza Affiliate Account

Step 2: Select Import behavior: You can Add/Update or Delete account

Step 3: Upload the import file from your computer. If you do not know what the file format is and which data to insert, please click to Download Sample File to see the example.

Step 4: Check and import data

• Export

From the Admin Panel, go to Marketing> Affiliate > Manage Accounts

• Click Export and choose the file format to download the data. Also, you can use this file to import to other system.
• Note: When import file to other system, please check the header to make sure it is compatible with that system.

11.2 Import/Export Affiliate Transaction

• Import

From the Admin Panel, go to Sytem > Data Tranfer > Import

Step 1: Choose Entity Type = Mageplaza Affiliate Transaction

Step 2: Select Import behavior: Add transaction

Step 3: Upload the import file from your computer. If you do not know what the file format is and which data to insert, please click to Download Sample File to see the example.

Step 4: Check and import data

• Export

From the Admin Panel, go to Marketing> Affiliate > Transactions

• Click Export and choose the file format to download the data. Also, you can use this file to import to other system.
• Note: When import file to other system, please check the header to make sure it is compatible with that system. Also be noted that all the data imported to orther system are in log. Therefore, you can not add transaction such as adding commission and withdrawal into these files.
• Below are headers that this module support to import/export data. In which, the header with * is required.
• Affiliate Account

Note: If you do not insert the data in column, it will be set as NULL at the database. If you import the same email twice, the system will record the initial email and ID.

• Transaction

Note: If you do not insert the date or time then the module will automatically get the date and time when you import the data. For the data imported with the actions as in the table above but shown at Transaction Grid, the Action Type = Admin

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Social Login

How to install Social Login

Important:

• We recommend you to duplicate your live store on a staging/test site and try installation on it in advance
• Backup magento files and the store database

It’s very important to backup all of themes and extensions in Magento before installation, especially when you are working on a live server. We strongly recommend you to do not omit this step.

Method 1: Install via composer (recommend)

Run the following command in Magento 2 root folder:

composer require mageplaza/magento-2-social-login
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Method #2: Copy & Paste

1.1 Step 1: Download SFTP clients

Download SFTP clients, we recommend clients: FileZilla, WinSCP. In this case, we are using WinSCP to install the module.

Step 2: Download the Package

After purchasing order from Mageplaza, go to My Downloadable Products page to download the module package. You have to log in (User/Password or Social accounts) before accessing the My Downloadable Products.

Here are the screenshot of My Downloadable Products page.

Now click on extension version link to download the package.

Step 3: Upload files to server

Let’s extract the package and connect to your server using SFTP Clients above. Then upload files, folders to your server, see this video:

Upload the app folder to Magento 2 root folder.

Step 4: Run command line

To complete the installation process, we need to run the following command lines to install Mageplaza Core module:

composer require mageplaza/module-core
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

If you got the error: Mageplaza_Core has been already defined, read this solution

Step 5: Check result

Now time to check result in frontend.

If you get any issues, check FAQs. If you get still get issues, report here.

How to configure Facebook API

Facebook requires that you create an external application linking your website to their API. Application id and secret (also sometimes referred as Consumer key and secret or Client id and secret) are what we call an application credentials. This application will link your website example.com to Facebook API and these credentials are needed in order for Facebook users to access your website.

These credentials may also differ in format, name and content depending on the social network.

To enable authentication with this provider and to register a new Facebook API Application, follow the steps:

Step 1

First go to: https://developers.facebook.com/

Step 2

Login Facebook by click on Login or create a new Facebook account. After that, click on My App from the Apps menu at the top, then click Create Apps to create your new app

Choose the type of app you want to create

Step 3

Then, redirect to the app creation page. Fill out Display name, Email for your app.

Step 4

Next, on the Basic*8 page, enter the url in **App Domains, Site URL and URL Privacy Policy fields. They should match with the current hostname example.com.

Step 5

On the Advanced page, get the Valid OAuth redirect URLs from our Social Login settings in the backend

Step 6

As the Step 5, at Facebook Login > Settings: copy Valid OAuth redirect URLs and paste in the Share Redirect Domain Allow List field.

Step 7

Add Permissions & Verification by going to App Review and select Permissions and Features:

Step 8

Access to the Basic page, get, and insert APIs into API fields in the extension’s settings in the Admin console.

And that’s it!

If for some reason you still can’t manage to create an application for Facebook, you can ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

How to configure Foursquare API

Foursquare requires that you create an external application linking your website to their API. Application id and secret (also sometimes referred as Consumer key and secret or Client id and secret) are what we call an application credentials. This application will link your website example.com to Foursquare API and these credentials are needed in order for Foursquare users to access your website.

These credentials may also differ in format, name and content depending on the social network.

To enable authentication with this provider and to register a new Foursquare API Application, follow the steps:

Step 1

First Go to https://foursquare.com/developers/app

Step 2

Select Create a new app.

Step 3

Fill out App name, page url, Redirect URI …

Step 4

Click Save change to finish.

Step 5

Copy and insert Client Id and Client Secret into API fields in Magento Admin.

Step 6

Copy and insert API into API fields in Magento Admin > Social Login > Settings > Foursquare

And that’s it!

If for some reason you still can’t manage to create an application for Foursquare, you can ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

How to configure GitHub API

GitHub requires that you create an external application linking your website to their API. Application id and secret (also sometimes referred as Consumer key and secret or Client id and secret) are what we call an application credentials. This application will link your website example.com to GitHub API and these credentials are needed in order for GitHub users to access your website.

These credentials may also differ in format, name and content depending on the social network.

To enable authentication with this provider and to register a new GitHub API Application, follow the steps:

Step 1

First go to https://github.com/settings/applications/new.

Step 2

Fill out Application name, Homepage URL, Application description, Authorization callback URL.

Step 3

Click Register application.

Step 4

Get Client ID and Client Secret from DashBoard App

Step 5

Copy and insert Client Id and Client Secret into API fields in Magento Admin.

And that’s it!

If for some reason you still can’t manage to create an application for Github, you can ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

How to configure Google API

Google requires that you create an external application linking your website to their API. Application id and secret (also sometimes referred as Consumer key and secret or Client id and secret) are what we call an application credentials. This application will link your website example.com to Google API and these credentials are needed in order for Google users to access your website.

These credentials may also differ in format, name and content depending on the social network.

To enable authentication with this provider and to register a new Google API Application, follow the steps :

Step 1

First go to: https://console.developers.google.com

Step 2

On the Dashboard sidebar click on the tab Credentials on the left side and click Create Project.

Then, fill out the project name.

Step 3

At the Dashboard page, filter from Library > Social. Choose Google + API.

Click the Enable button.

Step 4

Once the project is created. In the sidebar under API Manager, select Credentials, then select the OAuth consent screen tab. Choose an Email Address, specify a Product Name, and press Save.

Step 5

In the Credentials tab, select the New credentials drop-down list. Then, choose OAuth client ID.

Step 6

On the Create Client ID field :

• Select Web application as your application type.
• Put your website domain in the Authorized JavaScript origins field. This should match with the current hostname example.com.
• Provide URL as the Callback URL for your application (See in Social Login Configuration).

Step 7

Once you have registered, the popup below will be displayed:

Step 8

Copy and insert API into API fields in the extension’s setting under Admin panel. Please check this image.

And that’s it!

If for some reason you still can’t manage to create an application for Google, first try to Google it, then check it on Youtube, and if nothing works ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

How to configure LinkedIn API

LinkedIn requires that you create an external application linking your website to their API. Application id and secret (also sometimes referred as Consumer key and secret or Client id and secret) are what we call an application credentials. This application will link your website example.com to LinkedIn API and these credentials are needed in order for LinkedIn users to access your website.

These credentials may also differ in format, name and content depending on the social network.

To enable authentication with this provider and to register a new LinkedIn API Application, follow the steps:

Step 1

Go to the link: https://www.linkedin.com/secure/developer

Step 2

Select Create Application on LinkedIn Developer page

Step 3

From the register form, fill out required fields such as Company Name, Logo, Email Company,… and click on Sumit button

Step 4

Go to My App option from the top of Dashboard page to see all created applications and get Authentication (App id and secret)

Step 5

Copy and insert API into API fields in Magento Admin > Social Login > Settings > LinkedIn

And that’s it!

If for some reason you still can’t manage to create an application for LinkedIn, you can ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

How to configure Microsoft Live API

Microsoft Live Login requires that you create an external application linking your website to their API. Application id and secret (also sometimes referred as Consumer key and secret or Client id and secret) are what we call an application credentials. This application will link your website example.com to Microsoft Live Login API and these credentials are needed in order for Microsoft Live Login users to access your website.

These credentials may also differ in format, name and content depending on the social network.

To enable authentication with this provider and to register a new Microsoft Live Login API Application, follow the steps:

Step 1

First go to Microsoft Live to create an app

Step 2

Create a new account or login your account if you have already registered

Step 3

Click on Register an application button, set Name and enter the Redirect Url of the website

Step 4

Copy and paste Application ID into the Client ID field on Magento 2 backend

Step 5

To get the Client Secret, log into Certificates & Secrets > New client secret > Add a client secret. Copy and paste Value into the **Client Secret*8 field on Magento 2 backend

If for some reason you still can’t manage to create an application for Microsoft Live Login, you can ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

How to configure Pinterest API

Pinterest requires you to create an external application that links your website to their API. Pinterest’s API Key and Secret APP are what we call app login credentials. This application will link your website to the Pinterest API and these credentials are needed for Pinterest users to access your site.

The credentials may also differ in format, name and content depending on the social network. To enable authentication with this provider and to sign up for the new Pinterest API Application, follow these steps:

Step 1

First, visit website: https://developers.pinterest.com/apps/

Step 2

Click Create app to start creating the app and connect to the Pinterest API.

Step 3

Then, a popup is shown. Please enter the Name and Description information for the app. Click Create button to create the app.

Step 4

After created, it will be redirected to your app. Please copy and paste the link in the Redirect URIs field from the Social Login extension of Mageplaza into the Redirect URIs field of your app to link your website to the Pinterest API.

Next, enter all other necessary information if needed. Click Save to save the information.

Step 5

After completing the above steps, copy and paste the App ID and App Secret fields of the Pinterest API into the API Key field and the APP Secret of the Social Login extension.

How to configure Twitter API

Twitter requires that you create an external application linking your website to their API. Application id and secret (also sometimes referred as Consumer key and secret or Client id and secret) are what we call an application credentials. This application will link your website example.com to Twitter API and these credentials are needed in order for Twitter users to access your website.

These credentials may also differ in format, name and content depending on the social network.

To enable authentication with this provider and to register a new Twitter API Application, follow the steps:

Step 1

First go to: https://dev.twitter.com/apps

Step 2

Create a new application.

Step 3

Fill out any required fields such as the application name and description.

Step 4

Provide URL as the Callback URL for your application (See in Social Login Configuration).

Step 5

Once you have registered, past the created application credentials (Consumer Key and Secret) into the boxes above.

Step 6

Copy and insert API into API fields in Magento Admin > Social Login > Settings > Twitter

And that’s it!

If for some reason you still can’t manage to create an application for Twitter, you can ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

How to configure Vkontakte API

Vkontakte requires that you create an external application linking your website to their API. Application id and secret (also sometimes referred as Consumer key and secret or Client id and secret) are what we call an application credentials. This application will link your website example.com to Vkontakte API and these credentials are needed in order for Vkontakte users to access your website.

These credentials may also differ in format, name and content depending on the social network.

To enable authentication with this provider and to register a new Vkontakte API Application, follow the steps:

Step 1

First go to https://new.vk.com/dev.

Step 2

Select My apps > Create an application.

Step 3

Fill out title , choosen Website , then fill out Site address and Base domain.

Step 4

Click Connect Site.

Step 5

Select tag setting to find Application ID and Secure key.

Step 6

Copy and insert Application ID and Secure Key into API fields in Magento Admin.

And that’s it!

If for some reason you still can’t manage to create an application for Vkontakte, you can ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

How to configure Yahoo API

Yahoo requires that you create an external application linking your website to their API. Application id and secret (also sometimes referred as Consumer key and secret or Client id and secret) are what we call an application credentials. This application will link your website example.com to Yahoo API and these credentials are needed in order for Yahoo users to access your website.

These credentials may also differ in format, name and content depending on the social network.

To enable authentication with this provider and to register a new Yahoo API Application, follow the steps:

Step 1

First go to: https://developer.yahoo.com/apps.

Step 2

Select Create an App.

Step 3

Fill out Application Name, Home Page URl, Callback Domain. In API Permissions (Profiles (Social Directory) choosen Read/Write Public and Private).

Step 4

Click Create App button.

Step 5

Copy and insert Client Id and Client Secret into API fields in Magento Admin.

And that’s it!

If for some reason you still can’t manage to create an application for Yahoo, you can ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

How to configure Zalo API

Step 1

First go to Zalo to create an app. https://developers.zalo.me/apps

Step 2

Create a new account or login your account if you have already registered. After that, click on Add new apps.

Step 3

Then, a popup will be displayed. Fill out Display Name, Category, Description for your app.

Step 4

Enter Domain Authentication to verify Domain for your website.

Step 5

Next, go to the Login section to configure the Callback URL.

Step 6

Finally, go to Setting, copy and enter App ID, Appp Secret Key to API fields in the Magento Admin.

And that’s it! If for some reason you still can’t manage to create an application for Zalo, you can ask for support.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Overview

Customers are not patient enough to fill a lot of required information while those are available in social account as Facebook, LinkedIn, Instagram, etc. With Social Login extension by Mageplaza, your customers only need to click on the social button and all necessary information is completed automatically.That is the main reason why Magento Social Login extension is considered as the great solution for that convenience.

Especially, admin can choose to ask for the extra information of customers after registing social account

How to configure

From Magento Admin, select Store > Settings > Configuration > Mageplaza Extensions > Social Login.

I. General

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Social Login, choose General sections

• In the Enable field: Select “Yes” to allow customers sign in quickly via social networking sites they are using.

• In the Send Password To Customer field: Select “Yes” to activate sending notifications to customers to remind them to change their passwords when signing in via social accounts. They can change their passwords via their emails used to register for that social account.

• In the Show Social Login Buttons on field:

  • Select display page(s) with social login buttons. Show Social Login Buttons on = Customer Login Page will show social login buttons on the login page.
  • Can select more than one option

• In the Use Popup Login field:

  • Choose Popup Login to turn on Popup and Show Social Login Buttons in Login Dialog, Create New Account, and Forgot Passwords.
  • Include Social Login buttons in Customer Authentication Popup page
  • Choose None, popup not show and only show social login buttons at Customer Login page, Create New Account, and Forgot Passwords, Customers Authentication Popup.

• Use Popup Login As Authentication Popup: Select “Yes” to use popup of Social login as Authentication Popup

• In the Popup Links Selector field: Customize any default Login and Create button to be a popup-open button by filling in class name of elements that cover these buttons.

• In the Require More Info field: * Select Always Require for always showing popup of information verification when customers register social account. * Select If social account does not provide E-mail means that only show email confirmation popup when customers register account via the social networks that do not require real email such as Yahoo, Github, etc. * Choosing either two options above will show an extra field:

  • Information Required: Admin can choose to ask additional information of customers after they create social account. The information can be Name, Email, Password. This is a required field and you can choose mutiple iptions here.

• Popup Effect : Admin can select one among popup display effects below

• In the Style Management field: Admin can choose one of the display colors for popup. Style Management = Custom means Admin can select custom the color swatch.
• In the Custom CSS field: You can add CSS code to customize based on your personal preference.

II. Facebook sign in

2.1. How to configure Facebook

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Facebook.

• In the Enable field: Select “Yes” to show Sign in with Facebook button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Facebook API can be found here.

2.2. Login using Facebook

Facebook Login dialog will be shown after clicking on Sign in with Facebook button.

III. Google Sign in

3.1. How to configure Google

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Google.

• In the Enable field: Select “Yes” to show Sign in with Google button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Google API can be found here.

3.2. Login using Google

Google Login dialog will be shown after clicking on Sign in with Google button

IV. Amazon Sign in

4.1. How to configure Amazon

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Amazon.

• In the Enable field: Select “Yes” to show Sign in with Amazon button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.

4.2. Login using Amazon

Amazon Login dialog will be shown after clicking on Sign in with Amazon button.

V. Twitter Sign in

5.1. How to configure Twitter

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Twitter.

• In the Enable field: Select “Yes” to show Sign in with Twitter button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Twitter API can be found here.

5.2. Login using Twitter

Twitter Login dialog will be shown after clicking on Sign in with Twitter button.

VI. LinkedIn Sign in

6.1. How to configure LinkedIn

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Linkedln

• In the Enable field: Select “Yes” to show Sign in with LinkedIn button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create LinkedIn API can be found here.

6.2. Login using LinkedIn

LinkedIn Login dialog will be shown after clicking on Sign in with LinkedIn button.

VII. Yahoo Sign in

7.1. How to configure Yahoo

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Yahoo.

• In the Enable field: Select “Yes” to show Sign in with Yahoo button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Yahoo API can be found here.

7.2. Login using Yahoo

Yahoo Login dialog will be shown after clicking on Sign in with Yahoo button.

VIII. Foursquare Sign in

8.1. How to configure Foursquare

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Foursquare.

• In the Enable field: Select “Yes” to show Sign in with Foursquare button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Foursquare API can be found here.

8.2. Login using Foursquare

Foursquare Login dialog will be shown after clicking on Sign in with Foursquare button.

IX. Vkontakte Sign in

9.1. How to configure Vkontakte

Go to `` Store > Settings > Configuration > Mageplaza Extensions > Social Login > Vkontakte``.

• In the Enable field: Select “Yes” to show Sign in with Vkontakte button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Vkontakte API can be found here.

9.2. Login using Vkontakte

Vkontakte Login dialog will be shown after clicking on Sign in with Vkontakte button.

X. Github Sign in

10.1. How to configure Github

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Github.

• In the Enable field: Select “Yes” to show Sign in with Github button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Github API can be found here.

10.2. Login using Github

Github Login dialog will be shown after clicking on Sign in with Github button.

XI. Live Sign in

11.1. How to configure Live

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Live.

• In the Enable field: Select “Yes” to show Sign in with Live button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instructions to create Live API can be found here.

11.2. Login using Live

Microsoft Live Login dialog will be shown after clicking on Sign in with Live button.

XII. Zalo Sign in

12.1. How to configure Zalo

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Zalo.

• In the Enable field: Select “Yes” to show Sign in with Live button
• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instructions to create Zalo API can be found here.

12.2. Login using Zalo

Zalo Login dialog will be shown after clicking on Sign in with Zalo button or scanning the QR code.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Social Login Professional

• How to Install Social Login
• How to configure Facebook API
• How to configure Foursquare API
• How to configure GitHub API
• How to configure Google API
• How to configure Instagram API
• How to configure LinkedIn API
• How to configure Microsoft Live API
• How to configure Twitter API
• How to configure Vkontakte API
• How to configure Yahoo API
• How to configure Pinterest API
• How to configure Zalo API

Overview

Social Login Professional is an improved version of Social Login Standard. This module supports admin to login via store’ social account at backend. In addition, the module is added two popup templates: Quick Popup and Popup Slide. For the existing Popup Login template, the admin can configure to display the social login button with 4 locations: left, right, top, bottom.

Social Login Pro is fully compatible with Report, Google Recaptcha, Two-Factor Authentication extension of Mageplaza to help authenticate, eliminate spam, avoid fraud and report information when customers log in or register via social accounts.

How to Configure

I. Configuration

1.1. General configuration

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Social Login, choose General sections

• In the Enable field: Select “Yes” to allow customers sign in quickly via social networking sites they are using.
• In the Send Password To Customer field: Select “Yes” to activate sending notifications to customers to remind them to change their passwords when signing in via social accounts. They can change their passwords via their emails used to register for that social account.
• In the Show Social Login Buttons on field:
  • Select display page(s) with social login buttons. Show Social Login Buttons on = Customer Login Page will show social login buttons on the login page.
  • Can select more than one option
• In the Use Popup Login field:
  • Choose Popup Login to turn on Popup and Show Social Login Buttons in Login Dialog, Create New Account, and Forgot Passwords. Show extra field:
    • Social Button Position: Choose posision for showing social login buttons:
      • Left: Show social login button at the left side of popup login.
      • Right: Show social login button at the right side of popup login.
      • Top: Show social login button at the top of popup login.
      • Bottom: Show social login button at the bottom of popup login.
      • Include Social Login buttons in Customer Authentication Popup page
  • Choose None, popup not show and only show social login buttons at Customer Login page, Create New Account, and Forgot Passwords, Customers Authentication Popup.
  • Quick Login: Enable Quick Login Popup and social login buttons when Sign In, Create New Account, and Forgot Passwords.
  • Popup Slide: Enable Popup Slide Popup and social login buttons when Sign In, Create New Account, and Forgot Passwords.
• Use Popup Login As Authentication Popup: Select “Yes” to use popup of Social login as Authentication Popup
• In the Popup Links Selector field: Customize any default Login and Create button to be a popup-open button by filling in class name of elements that cover these buttons.
• In the Require More Info field: * Select Always Require for always showing popup of information verification when customers register social account.
  • Select If social account does not provide E-mail means that only show email confirmation popup when customers register account via the social networks that do not require real email such as Yahoo, Github, etc.
  • Choosing either two options above will show an extra field:
    • Information Required: Admin can choose to ask additional information of customers after they create social account. The information can be Name, Email, Password. This is a required field and you can choose mutiple iptions here.

• Popup Effect: Admin can select one among popup display effects below

• In the Style Management field: Admin can choose one of the display colors for popup. Style Management = Custom means Admin can select custom the color swatch.
• In the Custom CSS field: You can add CSS code to customize based on your personal preference.
• In the Redirect page after successful login field: Enter the URL that you want to redirect to the users after they complete the login:
  • Customer Dashboard: After login successfully, redirect to Customer Dashboard
  • Home page: After login successfully, redirect to Home page
  • CMS Pages: Redirect customers to a specific CMS page after login. Some CMS Pages can be: 404 Not Found, Home Page, Enable Cookies, Privacy Policy, About us, Customer Service, etc.
  • Custom URL: Enter the URL that you want to redirect to the users after they complete the login.
  • This sections only apply when the users login via the social network

Configure Social Accounts

I. Facebook sign in

1.1. How to configure Facebook

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Facebook.

• In the Enable field: Select “Yes” to show Sign in with Facebook button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Facebook

  • After turn on this function, social login button is shown at My Account in backend, click to Facebook button to login Facebook account

  

• After connecting with Facebook, admin logout current account at backend and login by Facebook account.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Facebook API can be found here.

1.2. Login using Facebook

Facebook Login dialog will be shown after clicking on Sign in with Facebook button.

II. Google Sign in

2.1. How to configure Google

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Google.

• In the Enable field: Select “Yes” to show Sign in with Google button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Google

  • After turning on this function, social login button is shown at My Account in backend, click to Google button to login via Google account

  

  • After connecting with Google, admin logout current account at backend and login by Google account.

• Enable One tap sign up and sign in: Select Yes to sign in using the Google account in the browser via the popup.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Google API can be found here.

2.2. Login using Google

Google Login dialog will be shown after clicking on Sign in with Google button

III. Amazon Sign in

3.1. How to configure Amazon

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Amazon.

• In the Enable field: Select “Yes” to show Sign in with Amazon button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Amazon

  • After turn on this function, social login button is shown at My Account in backend, click to Amazon button to login via Amazon account

  

• After connecting with Amazon, admin logout current account at backend and login by Amazon account.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.

3.2. Login using Amazon

Amazon Login dialog will be shown after clicking on Sign in with Amazon button.

IV. Twitter Sign in

4.1. How to configure Twitter

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Twitter.

• In the Enable field: Select “Yes” to show Sign in with Twitter button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Twitter

  • After turn on this function, social login button is shown at My Account in backend, click to Twitter button to login via Twitter account

  

• After connecting with Twitter, admin logout current account at backend and login by Twitter account.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Twitter API can be found here.

4.2. Login using Twitter

Twitter Login dialog will be shown after clicking on Sign in with Twitter button.

V. LinkedIn Sign in

5.1. How to configure LinkedIn

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Linkedln

• In the Enable field: Select “Yes” to show Sign in with LinkedIn button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via LinkedIn

  • After turn on this function, social login button is shown at My Account in backend, click to LinkedIn button to login via LinkedIn account

  

• After connecting with LinkedIn, admin logout current account at backend and login by LinkedIn account.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create LinkedIn API can be found here.

5.2. Login using LinkedIn

LinkedIn Login dialog will be shown after clicking on Sign in with LinkedIn button.

VI. Yahoo Sign in

6.1. How to configure Yahoo

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Yahoo.

• In the Enable field: Select “Yes” to show Sign in with Yahoo button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Yahoo

  • After turn on this function, social login button is shown at My Account in backend, click to Yahoo button to login via Yahoo account

  

• After connecting with Yahoo, admin logout current account at backend and login by Yahoo account.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Yahoo API can be found here.

6.2. Login using Yahoo

Yahoo Login dialog will be shown after clicking on Sign in with Yahoo button.

VII. Foursquare Sign in

7.1. How to configure Foursquare

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Foursquare.

• In the Enable field: Select “Yes” to show Sign in with Foursquare button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Foursquare

  • After turn on this function, social login button is shown at My Account in backend, click to Foursquare button to login via Foursquare account

  

• After connecting with Foursquare, admin logout current account at backend and login by Foursquare account.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Foursquare API can be found here.

7.2. Login using Foursquare

Foursquare Login dialog will be shown after clicking on Sign in with Foursquare button.

VIII. Instagram Sign in

8.1. How to configure Instagram

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Instagram.

• In the Enable field: Select “Yes” to show Sign in with Instagram button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Instagram

  • After turn on this function, social login button is shown at My Account in backend, click to Instagram button to login via Instagram account

  

• After connecting with Instagram, admin logout current account at backend and login by Instagram account.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Instagram API can be found here.

8.2. Login using Instagram

Instagram Login dialog will be shown after clicking on Sign in with Instagram button.

IX. Vkontakte Sign in

9.1. How to configure Vkontakte

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Vkontakte.

• In the Enable field: Select “Yes” to show Sign in with Vkontakte button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Vkontakte

  • After turn on this function, social login button is shown at My Account in backend, click to Vkontakte button to login via Vkontakte account

  

• After connecting with Vkontakte, admin logout current account at backend and login by Vkontakte account.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Vkontakte API can be found here.

9.2. Login using Vkontakte

Vkontakte Login dialog will be shown after clicking on Sign in with Vkontakte button.

X. Github Sign in

10.1. How to configure Github

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Github.

• In the Enable field: Select “Yes” to show Sign in with Github button

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Github

  • After turn on this function, social login button is shown at My Account in backend, click to Github button to login via Github account

  

• After connecting with Github, admin logout current account at backend and login by Github account.

• In the Sort Order field: The order to show social login buttons. Order will be arranged as following: number, special symbol, uppercase, lowercase.
• Instruction to create Github API can be found here.

10.2. Login using Github

Github Login dialog will be shown after clicking on Sign in with Github button.

XI. Disqus Sign in

11.1 How to configure Disqus

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Disqus

• In the Enable field: Choose Yes to display the Signin button with Disqus

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Disqus

  • After turn on this function, social login button is shown at My Account in backend, click to Disqus button to login via Disqus account

  

• After connecting with Disqus, admin logout current account at backend and login by Disqus account.

• In the Sort Order field: This field shows the order to display the social login button. The order will be sorted as the following: number, special characters, uppercase letters, lowercase letters.

11.2 Login using Disqus

• The Disqus login dialog will be displayed after clicking the Login button with Disqus.

XII. Mailru Sign in

12.1 How to configure Mailru

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Mailru

• In the Enable field: Choose Yes to enable the login button with Mailru

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Mailru

  • After turn on this function, social login button is shown at My Account in backend, click to Mailru button to login via Mailru account

  

• After connecting with Mailru, admin logout current account at backend and login by Mailru account.

• In the Sort Order field: This field shows the order to display the social login button. The order will be sorted as the following: number, special characters, uppercase letters, lowercase letters.

12.2 Login using Mailru

• The Mailru login dialog will be displayed after clicking the Login button with Mailru.

XIII. Odnoklassniki Sign in

13.1 How to configure Odnoklassniki

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Odnoklassniki

• In the Enable field: Choose Yes to enable the login button with Odnoklassniki

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Odnoklassniki

  • After turn on this function, social login button is shown at My Account in backend, click to Odnoklassniki button to login via Odnoklassniki account

  

• After connecting with Odnoklassniki, admin logout current account at backend and login by Odnoklassniki account.

• In the Sort Order field: This field shows the order to display the social login button. The order will be sorted as the following: number, special characters, uppercase letters, lowercase letters.

13.2 Login using Odnoklassniki

• The Odnoklassniki login dialog will be displayed after clicking the Login button with Odnoklassniki.

XIV. Steam Sign in

14.1 How to configure Steam

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Steam

• In the Enable field: Choose Yes to enable the login button with Steam

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Steam

  • After turn on this function, social login button is shown at My Account in backend, click to Steam button to login via Steam account

  

• After connecting with Steam, admin logout current account at backend and login by Steam account.

• In the Sort Order field: This field shows the order to display the social login button. The order will be sorted as the following: number, special characters, uppercase letters, lowercase letters.

14.2 Login using Steam

• The Steam login dialog will be displayed after clicking the Login button with Steam.

XV. Live Sign in

15.1. How to configure Live

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Live

• In the Enable field: Choose Yes to enable the login button with Live

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Live

  • After turn on this function, social login button is shown at My Account in backend, click to Live button to login via Live account

  

• After connecting with Live, admin logout current account at backend and login by Live account.

• In the Sort Order field: This field shows the order to display the social login button. The order will be sorted as the following: number, special characters, uppercase letters, lowercase letters.

15.2. Login using Live

The Live login dialog will be displayed after clicking the Login button with Live

XVI. Pinterest Sign in

16.1. How to configure Pinterest

Go to Store > Settings > Configuration > Mageplaza Extensions > Social Login > Pinterest

• In the Enable field: Choose Yes to enable the login button with Pinterest

• Sign In As Admin: Select “Yes” to allow admin to login your website at backend via Pinterest

  • After turn on this function, social login button is shown at My Account in backend, click to Pinterest button to login via Pinterest account

  

• After connecting with Pinterest, admin logout current account at backend and login by Pinterest account.

• In the Sort Order field: This field shows the order to display the social login button. The order will be sorted as the following: number, special characters, uppercase letters, lowercase letters.

16.2. Login using Pinterest

The Pinterest login dialog will be displayed after clicking the Login button with Pinterest

XVII. Compatible with Mageplaza extension

17.1. Compatible with Two-Factor Authentication

Mageplaza’s Social Login extension is fully compatible with Two-Factor Authentication to ensure security for stores backend when logging in via social accounts. This extension supports three commonly used authentication authors: Authy, Duo or Google Authenticator. To learn how to configure for Two-Factor Authentication, refer the guide here.

17.2. Compatible with Report

Mageplaza’s Social Login extension is fully compatible with the Report extension to provide statistics of each social account including information: User, Order, Amount, so on via Social login chart.

17.3. Compatible with Google Recaptcha.

Mageplaza’s Social Login extension is fully compatible with Google Recaptcha which helps process authentication when customers login, register an account, etc on your site to avoid spam or phishing.

SMTP

Mageplaza SMTP will assist you to resolve email sending issues. By available popular email server providers, our extension absolutely would like to help you in sending email with a huge amount of quantity, faster along with high secure authentication. Hence, Mageplaza SMTP will also provide you a log diary which archive all the detail sent emails, makes it easier to keep track and checking problems. Be ready to say goodbye to Spam box issue.

Download & Install

You can download from the following resouces:

• Magento Marketplace
• Github
• How to Install

Install via composer (recommend)

Run the following command in Magento 2 root folder:

composer require mageplaza/module-smtp
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Here we go how to know detail in instructions and configuration in extension’s backend.

How to config

Login to the Magento admin, choose Stores > Settings > Configuration > Mageplaza > SMTP

Follow the guide below to complete SMTP configuration

• Emails Log
• General Configuration
• SMTP Configuration Options
• Developer

1. Email logs

This can be accessed by the following Stores > SMTP > Emails Log. From here you can look back all the sent email from the server to customers.

At here, you can view all information as ID, Subject, From, To, Bcc, Status, Created At as well as allow admins to take some actions for emails that are sent from the server to customers. At the same time, you also delete all emails by clicking on the Clear button.

Some actions can be taken:

• View: To review the content of the email that is saved in the Emails Log. Admin can review by clicking Select > View in the Action column.

Below is the content of an email after you click on the View button

• Resend:

  • In the Action column, choose Select > Resend. This means that the selected email will be resent once and that Email Resend is also logged, which enables admins to know if the Email Resend is sent successfully or failed.

  • The Resend feature can work well even if you disable the module. The Resend Email will apply the Provider of SMTP, however, it won’t be logged in the Emails Log.

  • To resend lots of emails at once, you only need to tick, then choose Action at the upper left of the Grid, and select Resend.

    

• Delete:

  • In the Action column, click Select > Delete: This means that the selected email will be removed from the grid.

  • To Delete many emails at once, you only need to tick, then choose Action at the upper left of the Grid, and choose Delete.

    

2. Configuration

2.2.1 General Configuration

Be sure you’re at Admin Panel, for general configuration Stores > Settings > Configuration > Mageplaza > SMTP. Choose General Configuration sections.

• In the Enable Mageplaza SMTP field, select “Yes” to enable Mageplaza SMTP extension.
• Log Email provides two modes:
  • Yes: Sent emails will be saved in the Emails Log, you can preview it and have it clean up to follow the fixed schedule.
  • No: Sent emails won’t be archived.
• Clean Email Log Every: This field limits the storage time for the email you sent. After that limited number of days, Email will be auto-deleted. If you do not want to delete the emails, leave the field blank.
• Blacklist: Enter the regular expression (regex) for email patern in this field, meaning that emails with the same pattern as the patern here will not receive any mail from the system.
  • Regex is written between two right slashes /../. Basic regex:
    • [0-9]: digits from 0 to 9
    • [a-z]: lowercase letters from a to z
    • [A-Z]: uppercase letters from A to Z
    • abc: letter. For example: /abc/ correspond to “abc” string in the defaut pattern string “abcdefgh”
    • 123: number. For example: /123/ correspond to “123” string in the defaut pattern string “abc123”
    • \d: any number from 0 to 9
    • \w: a letter
    • \s: white space (space, tab, new line, …)
    • \D: non-numeric character
    • \W: non-letter characters
    • \S: character not white space
    • . : any character except the new line. For example: .{3} will correspond to any string with 3 characters
    • + : indecates the element appears >= 1 time
    • * : indicates that the element appears >= 0 times (may not appear)
    • ? : indicates the element appears 0 or 1 time
    • ^ : represents the first element of the string. For example: ^a corresponds to the letter “a” in the string “abc”
    • $ : matches the last character of the string. For example, c$ matches the character “c” in the string “abc”
    • ? : matches 0 or 1 times the character preceding it. For example: a? will be able to match “abc” or “bc” in the target string “abcdbc”
    • a|b : corresponds to a or b.
    • {x} : corresponds to x times. For example: {3} corresponds to 3 characters
    • {x,} : at least x times. For example, {2,} corresponds to at least 2 characters
    • {x,y} : from x to y times. For example, {2,6} corresponds to 2 to 6 characters
    • To use special characters, use the \ before that character. For example: /\.\+\*/ corresponds to. .+*

For example, the pattern of an email is: /^[0-9][a-z0-9\$\%\&]+@[a-z]+\.[a-z]{2,}$/

• ^[0-9] : start with a number between 0 and 9
• [a-z0-9\$\%\&] : the rest of the email may contain multiple digits, letters, characters $, %, &
• @ : ending email address with the @ character
• [a-z]+ : domain names include lowercase characters
• \.[a-z]{2,}$ : End with top-level domain: begins with dot, followed by only lowercase characters, and requires at least 2 characters, $ sign indicates end of string.

2.2.2 SMTP Configuration Options

Still from the same structure with SMTP General Configuration, go to Stores > Settings > Configuration > Mageplaza > SMTP, then choose SMTP Configuration Options sections.

• In the Host field: This is a field that allows you to fill in the Support Host name and ID address. If you click on Load Settings button, a popup about SMTP Providers will be displayed. Admins can choose SMTP Provider that they want and the system will auto-fill some fields as Host, Port, and Protocol.
• In the Port field: This is a specific gate that emails will be sent through. You can also pass this step if you had chosen Load Settings from the first place. In general, there will be 3 kinds of Default Port:
  • Port 25: Emails sent by Protocol other than SSL, TLS will be sent via this portal
  • Port 465: Emails sent by Protocol SSL will be sent via this portal
  • Port 587: Emails sent by Protocol TLS will be sent via this portal
• In the Protocol field: This is a place allowing you to choose the protocol to send the email. If you had click Autofill button, please ignore this field. You can choose one of the providing protocols below:
  • None: When you choose Protocol = None, this means that you accept all risks that can occur with your sent emails
  • SSL stands for Secure Socket Layer. This protocol ensures that all data exchanged between the web server and the browser is secure and stay safe.
  • TLS means Transport Layer Security. This protocol can secure data or messages and validate the integrity of messages through message authentication codes.
• In the Authentication field: This is a field that enables you to choose the authentication method. There are 3 methods:
  • Login: Authentication by login to the account through Username and Password that will be filled in the next field. Most of providers will require this method.
  • Plain
  • CRAM-MD5
• In the Username field: This field allows you to fill in the Account name according to SMTP Provider format that you have selected.
• In the Password field: This field enables you to fill the Password of Username that you have filled. After saving, Password will be encrypted into ******

Note:

• When using Email to fill into Username and Password, the email has to be varified by 2-Step Verification, to do this, click here.
• After clicking on the link, go to Security and choose 2-Step Varification

• Click Turn on to complete this step

• Next, you have to crease Passwords to sign-in Google accounts from app that do not support 2-Step Varification. So, Choose the apps and click on Generate

• In the Return-path email field: Leave it empty if you want to ignore this.
• In the Send Test Email: This is a field for you to test the operation of the extension.
  • Send From: Admins can choose one of the five Email Sender of Magento.
  • Send To: Allow entering the email address that admins want to test the email.
  • To test the email, you need to fill the email address in the Send To field, then click Test Now button.

If the information you filled out is valid, a successful email message will be sent from Username to Email Test. That email has the following content:

2.2.3 Abandoned Carts Grid

From the Admin Panel, go to Sales > Abandoned Carts:

• This is where customer’s abandoned cart information is shown.
• From Abandoned Carts, admins can have information such as ID, Store View, Customer, Customer Email, Customer Group, Status, Created At, Action.
• Action: The View section allows admins to view details of an abandoned cart.
• In addition, admins can filter and change the store views as well as show or hide columns.

View Abandoned Cart:

From the Admin Panel, go to Stores > SMTP > Abandoned Carts, then click View at Action:

Detailed information of an abandoned cart will be displayed:

• Cart Recovery:
  • Cart Recovery Link: Send your customer this link to recover their cart
  • Cart Recovery Status:
    • Wait for send: Have not sent emails to customers
    • Sent: Sent emails to customers
  • Sent Date Logs: Show date and time when emails are sent to the customers
• Cart Details: Show details including Quote ID, Store View, Created Date, Customer Name, Customer Email, Customer Group, Shipping Address, Billing Address.
• Cart Items: Show all products that customers abandoned.
• Cart Total: Show the total of the cart.
• Send Email:

• Sender: Select the email sender
• To: Customers’ emails
• Email Template:
  • Set the email when customers have abandoned carts.
  • Go to Marketing > Email Templates, select Add New Templates to create new email templates.
  • Please find the guide to reate a new template here
• Additional Message: Admins can add extra messages
• Preview: View the email that will be sent to customers.

2.2.4 Developer mode

From the Admin Panel, go to Stores > Settings > Configuration > Mageplaza > SMTP, choose Developer sections.

• Developer Mode:
  • Yes: Magento will not deliver any email to the receiver
  • No: Magento will deliver email to the receiver

Must-have extensions for your Magento stores

• Increase website traffic: SEO
• Build leads
• Increase conversion rates: One Step Checkout, Layered Navigation
• We believe that you can sell more: Gift Cards, Auto Related Products, Frequently Bought Together, Free shipping bar, Daily Deal , Product Feed
• Keep customers return: Reward Points
• Let your customer become raving fans
• Optimize your stores: PDF Invoice, Custom Order Number, Stop return items issue

PDF Invoice

Overview

Mageplaza offers a solution to help customers easily print, download PDF Invoice, PDF Order, PDF Shipment, PDF Credit Memo quickly and easily with just a single click on the customer information page. To enhance user experience, PDF files are included in emails to customers. In addition, Mageplaza also adds the HTML edit feature so shop owners can customize their PDF files, and Preview function also allows them to take an overview look at the newly created design conveniently.

Download & Install

You can download from the following resouces:

• Mageplaza PDF Invoice
• Magento Marketplace
• How to Install

Note: To use the full feature of PDF Invoice, you need to get the full font of the library here. After downloading and unzipping the library, you just need to drag and drop the unzipped folder into the lib directory:

You can also directly download the library here.

How to configure

Log in to your Magento Admin, follow the path Store > Setting > Configuration > Mageplaza Extensions > PDF Invoice

1. Configuration.

1.1. General Configuration

Keep going from Store > Setting > Configuration > Mageplaza Extensions > PDF Invoice > General Configuration, expand the section

• In Enable PDF Invoice field:
  • Uncheck the Use system value to configure the extension. Choose “Yes” to enable it
  • Tick Use system value again to use “Enable PDF Invoice = Yes” as your default.
• Expand Business Information field:
  • In Company Name field:
    • Enter your company/store name, it will be displayed in your PDF invoice.
    • If you leave it blank, the Company Name place won’t have a name.
    • Check Use system value to use it as default.
  • In Black Logo (Color):
    • Choose logo shown on PDF Template 1. Only allow choosing logo for image format: jpeg, gif, png.
    • Use the default logo if you leave this field blank
  • In White Logo
    • Choose logo shown on PDF Template 2. Only allow choosing logo for image format: jpeg, gif, png.
    • Use the default logo if you leave this field blank
  • In Logo Width field:
    • Select the size for your logo (pixel)
    • If you leave it blank, defaul width is 180px
    • Check Use system value to use 180px as default logo width.
  • In Logo Height field:
    • Select the size for your logo (pixel)
    • If you leave it blank, defaul width is 30px
    • Check Use system value to use 30px as default logo width.
  • In Address field:
    • This is the place where you can fill in your company/store’s address, this will be displayed in the PDF invoice file.
    • If you leave it blank, address information won’t be seen.
    • Check Use system value to use it as default.
  • In VAT number field:
    • Enter your company/store’s VAT number to perform it on the PDF file.
    • There won’t be VAT number displayed if you leave it blank.
    • Check Use system value to use it as default.
  • In Phone field:
    • Enter your company/store’s phone numbers.
    • If you leave it blank, phone numbers won’t be seen.
    • Check Use system value to use it as default.
  • In Email field:
    • Enter your company/store’s official email address.
    • There won’t be email displayed if you leave it blank.
    • Check Use system value to use it as default.
  • In Registered Number field:
    • Enter your company/store’s business number in this field.
    • If you leave it blank, PDF invoice file won’t display it.
    • Check Use system value to use it as default.

1.2. Design

• In Heading Color field:

  • You’re able to customized color of heading in the PDF file
  • If you leave it blank, the color of heading will be white.
  • When you print the PDF in the backend, the color of heading will be the selected color in Store View > Default Config. While when you print the PDF in the frontend or send an email with a PDF attachment, the heading Color will display according to the configuration of that store.

• In Show Page Number field:

  • Choose “Yes” to display page numbers at the end of the PDF document.
  • Check Use system value to set “Show Page Number = Yes” as default.
  • Please note that:
    • When you configure it in Store View > Default Config, the page number is displayed/hidden when you print the PDF in the backend and when you preview the template.
    • When you configure the store, the number of pages is displayed/hidden when you print the PDF outside of the frontend and in the PDF attached to the email.
    • Specifically, when you print multiple PDFs at the same time, displaying the page number at the bottom of each PDF is the default.

• In Page Number Display Position field: Select the position to display the page number of the PDF file:

  • Top: Display on the top of each page in the PDF file.

  

  • Bottom: Display at the bottom of each page in the PDF file.

• In Page Size field:

  • There are 4 kinds of paper size you can choose: A4, A5, A6, and A7.

  

  • The design of PDF files works best with a A4 page size.
  • When you print a PDF in the backend or when you create a template, the page size displays in Store View > Default Config section.
  • When you print a PDF in the frontend or send an email with a PDF attachment, the page size will display in the configuration section of the store.

1.3. Order

• In Enable PDF Attachment field:
  • Uncheck the Use system value to configure the extension. Choose “Yes” to send the PDF invoice attached along with the email.
  • Tick Use system value again to use “Enable PDF Attachment = Yes” as your default.
• In Apply for customer groups:
  • Specific Groups: Show Customer Group field. Only selected customers are able to view attachments in emails
  • All Allowed Groups: All customers can view attachments in emails
• In Condition field: Select the condition to display Print PDF Order with each order to download files. Orders that do not satisfy selected conditions will not display Print PDF Order.
• In Label: Set up the Label Print PDF Order in My Order page in the frontend
• PDF File Download Name: Enter the name of the file downloaded when printing PDF Orders with each order. For example, order_%increment_id.
• Multiple Orders PDF File Downloaded Name: Enter the name of the file downloaded when Print PDF Orders with many orders.
• In Select Template field:
  • Uncheck the Use system value to configure the extension. Choose “Template” to display the PDF file as in the selected template.
  • All your created templates will be displayed as a drop-down list in this section.

• Tick Use system value to use Select Template = Template 1 as the default setting.
• If store owners want to use the page size is A5, they should use the template for A5. As this template that we design servers for the page size for A5.
• In Note field: This is the place where you enter your note for the Order. HTML code can be use in here.

• In Show Custom Print Button field:

• Uncheck Use system value to configure this field.
  • Show Custom Print Button = Both: This will display an additional Print PDF Order button in the backend’s Order and the frontend’s My order page. When customers click the Print PDF Order button, the designed PDF template will be downloaded automatically.

Frontend

Order Guest View Frontend

Backend in each of the order

Or in massAction, besides displaying Print PDF Orders button, we also design Print PDF Invoices so that store owners can print Invoices at this place. Print PDF Invoices will display in massAction

• • • Show Custom Print Button = Custom PDF: Show Print PDF Order at massAction This won’t display Print PDF Order button. The button will be combinated with Print button by Magento 2. When the button is clicked, the designed PDF template will be downloaded automatically.

Frontend

Order Guest View Frontend

Backend

• • • Show Custom Print Button = No: This won’t display Print PDF Order button. When the button is clicked at My Order page on the frontend, the file will be downloaded as the Magento 2’s template.
  • Check Use system value to use “Show Custom Print Button = Both” as the default setting.

Frontend

Backend in each of the order

In massAction

• Display Print Button On Top: Select Yes to show the Print button at the top of Order Grid. Choose No, not display the Print button but using default Magento PDF file.

• In Note field: This is the place where you enter your note for the Order. HTML code can be use in here.

1.4. Invoice

• In Enable PDF Attachment field:

  • Uncheck Use system value to configure the extension. Choose “Yes” to send emails along with the attached PDF invoice.
  • Check Use system value to set “Enable PDF Attachment = Yes” as the default setting.

• In Apply for customer groups:

  • Specific Groups: Show Customer Group field. Only selected customers are able to view attachments in emails
  • All Allowed Groups: All customers can view attachments in emails

• In Label: Set up the Label Print PDF Order in My Order page in the frontend

• PDF File Downloaded Name: Enter the name of the file downloaded when Print PDF Invoices with each invoice.

• Multiple Invoices PDF File Downloaded Name: Enter the name of the file downloaded when Print PDF Invoices with many invoices.

• In Select Template field:

  • Uncheck Use system value to configure the extension. Choose “Template” to display the PDF file as selected template.

  

  • Check Use system value to use “Select Template = Template 1” as the default setting.
  • If store owners want to use the page size is A5, they should use the template for A5. As this template that we design servers for the page size for A5.

• In Show Custom Print Button:

• • Uncheck Use system value to configure the extension. Choose Print button to display:
    • Show Custom Print Button = Both: This will display Print PDF Invoice button in the backend’s invoice and on the My Order page of the frontend. When clicking that button, the designed PDF template will be downloaded automatically.

Frontend

Backend in each of the order

In massAction

• • • • Show Custom Print Button = Custom PDF: This won’t display Print PDF Invoice button. The button will be combinated with Print button by Magento 2. When the button is clicked, the designed PDF template will be downloaded automatically.

Frontend

Backend

In each of the order:

Or in massAction:

• • • • Show Custom Print Button = No: This won’t display Print PDF Invoice button. When admins click Print in the backend’s Invoice and customers click Print Invoice in My Order of the frontend, the order file will be downloaded as the Magento’s template.

Frontend

Backend in each of the order

In massAction

• Display Print Button In Order Grid: Select Yes to show the Print PDF Invoices button at the top of Order Grid. Choose No, not display the Print button but using default Magento PDF file.

• In Note field: This is the place where you enter your note for the Order. HTML code can be use in here.

1.5. Shipment

• In Enable PDF Attachment field:
  • Uncheck Use system value to configure the extension. Choose “Yes” to send emails along with the attached PDF invoice.
  • Check Use system value to set “Enable PDF Attachment = Yes” as the default setting.
• In Apply for customer groups:
  • Specific Groups: Show Customer Group field. Only selected customers are able to view attachments in emails
  • All Allowed Groups: All customers can view attachments in emails
• In Label: Set up the Label Print PDF Order in My Order page in the frontend
• PDF File Downloaded Name: Enter the name of the file downloaded when Prin DPF Shipments with each shipment.
• Multiple Shipments PDF File Downloade Name: Enter the name of the file downloaed when Print PDF Shipments with many shipments.
• In Select Template field:
  • Uncheck Use system value to configure the extension. Choose “Template” to display the PDF file as selected template.

• Check Use system value to use “Select Template = Template 1” as the default setting.
• If store owners want to use the page size is A5, they should use the template for A5. As this template that we design servers for the page size for A5.
• In Show Custom Print Button:

• Uncheck Use system value to configure the extension. Choose Print button to display:
  • Show Custom Print Button = Both: This will display an additional Print PDF Shipment button in the backend’s Order and the frontend’s My order page. When customers click the Print PDF Shipment button, the designed PDF template will be downloaded automatically.

Frontend

Backend in each of the order

In massAction

• • • • Show Custom Print Button = Custom PDF: This won’t display Print PDF Order button. The Print PDF Shipment button will be combinated with Print button by Magento 2. When admins click Print of the Shipment (in the backend) or customers click Print Shipment (My account > My Order of the frontend), the designed PDF template will be downloaded automatically.

Frontend: Backend in each of the order

• • • • Show Custom Print Button = No: This won’t display Print PDF Shipment button. When admins click Printof the Shipment in the backend’s or customers click Print Shipment in My Order of the frontend, the file will be downloaded as the Magento 2’s template.

Frontend

Backend in each of the order

In massAction

• In Note field: This is the place where you enter your note for the Order. HTML code can be used in here.
• Display Print Button In Order Grid: Select Yes to show the Print PDF Shipments button at the top of Order Grid. Choose No, not display the Print button but using default Magento PDF file.

1.6. Credit Memo

• In Enable PDF Attachment field:
  • Uncheck Use system value to configure the extension. Choose “Yes” to send emails along with the attached PDF invoice.
  • Check Use system value to set “Enable PDF Attachment = Yes” as the default setting.
• In Apply for customer groups field:
  • Specific Groups: Display the extra Customer Group field, only selected customers can view the attached file in the email.
  • All Allowed Groups: All customers can view the attached file in the email.
• PDF File Downloaded Name: Enter the name of the file downloaded when Print PDF Credit Memos with each credit memno.
• Multiple Credit Memos PDF File Downloaded Name: Enter the name of the file downloaded when Print DPF Credit Memos with many credit memos.
• In Select Template field:
  • Uncheck Use system value to configure the extension. Choose “Template” to display the designed PDF as in the selected template.
  • Check Use system value to set “Select Template = Template 1” as default setting.
  • If store owners want to use the page size is A5, they should use the template for A5. As this template that we design servers for the page size for A5.
• In Show Custom Print Button:
  • Uncheck Use system value to configure the extension. Choose Print button to display:
    • Show Custom Print Button = Both: This will display an additional Print PDF Refund button in the backend’s Credit Memo and the frontend’s My order page. When customers click the Print PDF Refund button, the designed PDF template will be downloaded automatically.

Frontend

Backend in each of the order

In massAction

• • • • Show Custom Print Button = Custom PDF: This won’t display Print PDF Refund button. The Print PDF Refund** button will be combinated with Printbutton by Magento 2. When admins clickPrintof the Credit Memo (in the backend) or customers clickPrint Credit Memo (My account > My Order`` of the frontend), the designed PDF Credit Memo template will be downloaded automatically.

Frontend:

Backend in each of the order

In massAction

• • • • Show Custom Print Button = No: This won’t display Print PDF Refund button. When admins click Printof the Credit Memo section (in the backend) or customers click Print Refund in My Order (of the frontend), the file will be downloaded as the Magento 2’s template.

Frontend

Backend in each of the order

In massAction

• In Note field: This is the place where you enter your note for the Order. HTML code can be use in here. Also, when you print in the massAction, store owners can print all PDF files of many different stores. All this PDF files will display as the configuration of that store and the PDF files are extracted in the zip format.

• Display Print Button In Order Grid: Select Yes to show the Print PDF Credit Memo button at the top of Order Grid. Choose No, not display the Print button but using default Magento PDF file.

2. Manage Templates

From the Admin Panel, go to Store > PDF Invoice > Manage Templates

Click Add New Template Order button and choose the kind of template you want to generate. There will be 4 kinds of template corresponds to 4 kinds of PDF file:

• Order
• Invoice
• Shipment
• Credit Memo

You’re able to freely design template in your own style of use available template in the extension’s configuration.

For example, if you choose to create an “Order” template, the design form will appear like this below image:

• In Load default template field:

  • Template

  

  • You can choose one of available templates. With each template, you can choose to display product images in the PDF file. After having it done, the chosen template will show up right your left side to be previewed.
  • If you don’t choose a template form, the default template will be “Template = Template 1”.
  • Load Template: The selected template’s code will be displayed automatically in the below HTML box.

• In Template Information field:
  • Currently Used for: Click the PDF Invoice link to direct to the configuration section.
  • Template Name
    • This is the place where you name your own template.
    • If you leave it blank, there will be an error message.
  • Insert Variables: Choose a variable to display the value of that variable in the PDF file. Besides that, Mageplaza also supports customers in adding more information such as Order Information, Shipping Information, or Billing Information.

• Edit HTML: This section allows you generate a unique PDF form by your own idea.
• Preview: After editing the PDF form, click here to have an overview glance again.

• Link CSS: This will direct you to a detail CSS support guide that how to learn to design by CSS properly.
• Link HTML Support: Click it to direct to a detail HTML support guide which points out what HTML tags you can use to create a template.
• Template Style: You can add CSS codes at here. Users can set supported fonts such as: Roboto, Lato, Roboto_condensed, Opens_san, Oswald, Montserrat for the whole PDF file. If the fonts are not supported, Mageplaza will convert them into the default DejaVu font.

3. Sale

From the Admin backend, follow Sales > Operation > Orders. In this section, you can output a printable PDF Order. Moreover, PDF Invoice, PDF Shipment or PDF Credit Memo can be had in the same method. Here the detail guide for the Order’s part:

In the Order section, click Print PDF Order button to download the PDF Order.

The downloaded PDF will have your designed template from previous steps you’ve done above.

When you click Send Email, the sending email will be attached that PDF Order if in the 1.2. Order’s configuration, “Enable PDF Attachment = Yes”. Besides, when customers place a new order, stores will send that particular order billing to their emails. Your customers can preview and download to print this PDF Order instantly.

When you create Invoice, Shipment or Credit Memo, if you check the “Email Copy of Invoice”, “Email Copy of Shipment” or “Email Copy of Credit Memo” box, the sent mail will also include the PDF file.

Similar to the Order section, Invoice, Shipment or Credit Memo PDF files will be attached to the sent mail, or when customer click Print button, the PDF file will be downloaded automatically. With the virtual product’s Order, in the PDF Order, PDF Invoice, PDF Credit Memo, there won’t be included Shipping To, Shipping Information or Shipment Method section.

4. API

Mageplaza’s PDF Invoice extension supports the use of the Rest API to view details of the PDf file via order, invoice, shipment, credit memo, etc. created by the admin and customer.

• Details can be viewed here.
• Instructions for creating Integration tokens here.

SEO Standard

Download & Install

You can download from the following resouces:

• Magento Marketplace
• Github
• How to Install

To help you automatically optimize and greatly improve the performance of your Magento-based store in Search Engines, Mageplaza SEO extension will bring your store a great chance to own an amazing speed as well as to gain the higher and higher ranks in the popular and famous search engines such as Google, Bing, or Yahoo

In order to install SEO extension on your store, you can learn and do it by yourself via Installation Guide or use Installation Service Package to request the specialist helps from Mageplaza Team.

I. Configuration

Login to your Magento 2 backend Stores > Settings >Configurations > Mageplaza Extension: SEO, follow our given guide below to complete those SEO configurations

• General
• Duplicate Content
• Structure Data
• Business Information
• Social Profiles
• Verifications

1.1. General Configuration

Choose Enable = “Yes” to turn Mageplaza SEO on generally.

1.2. Duplicate Content

Filtering results (from layered navigation pages, etc) is the main cause of generating many similar URLs, and search crawlers assess them are all the same, in other words, it’s called duplicate content. Therefore, you must have the assist from Canonical tags to reduce the duplication of content on the page, this is an onpage SEO tip to note obviously.

• In the Use Canonical Link Meta Tag For Categories field: Choose “Yes” to display Canonical tags of Category pages which are from Source Category on the frontend.

• In the Use Canonical Link Meta Tag For Products field: Choose “Yes” to display Canonical tags of Source Product on the frontend.

1.3. Structure Data

• In the Enable Product Structured Data field:
  • Select “Yes” to display the basic information of products when they are searched by search engines.
  • By this intuitive design, Product Structured Data will increase click through rate (CTR) drastically. Thus, products from your store will be ranked higher on search results.
  • You can check Product Structure Data at the Page Source of Product Detail Page. Structure Data will mirror exactly as the basic information of that product.
• In the Enable Sitelinks Searchbox field:
  • Select “Yes” to display your store’s Searchbox on the Sitelinks. As soon as your store displays on the search results, your store searchbox will also display with the store’s link.
  • You can test the code in Page Source of Homepage.

1.4. Business Information

• In the Enable Bussiness Information field: Select “Yes to display information about your business in the search result.
• When you leave any field blank, the information for that field will not display.
• You can test the code in Page Source of Homepage.

1.5. Social Profiles

• You can paste your social addresses in here. Make sure that all the accounts have been verified.
• Social Profile will display along with Business Information. If Business Information is not enabled, Social Profile won’t display in search results.
• You can leave unnecessary Social Profiles in blank status.
• When the searcher clicks on one of your social links, they will be redirected to that social page of your store.
• You can test the code in Page Source of Homepage

1.6. Verifications

In the Verification field, you need to enter the verification code to confirm the ownership of your site. Hence, you can use the Web services such as Google Search Console, Bing Webmaster Tools, Pinterest and Yandex Webmaster Tools.

• In the Google Search Console field: Enter the verification code for Google Search Console.
• In the Bing Webmaster Tools field: Enter the verification code for Bing Webmaster Tools.
• In the Pinterest field: Enter the verification code for Pinterest.
• In the Yandex Webmaster Tools field: Enter the verification code for Yandex Webmaster Tools.

II. SEO Tools

This add-on tool will assist SEO extension in assessing and marking which and how to perform the structured data at the best for SEO progress. You can have a general review for the SEO analysis at the Product Page, Category Page and CMS Page.

For example with a product:

• Go to Product > Catalog, choose Edit a random one.
• Choose PageSpeed Insight button at the header

• The page will be directed to PageSpeed Insight page for the check execution.

• PageSpeed Insights will focus on 2 key issues: page loading speed and user friendliness. These factors comply with Google web optimization methods as well as automate adjustment process.

• Apply the same action with Category Page and CMS Page.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

SEO Professional

To help you automatically optimize and greatly improve the performance of your Magento-based store in Search Engines, Mageplaza SEO extension will bring your store a great chance to own an amazing speed as well as to gain the higher and higher ranks in the popular and famous search engines such as Google, Bing, or Yahoo

In order to install SEO extension on your store, you can learn and do it by yourself via Installation Guide or use Installation Service Package to request the specialist helps from Mageplaza Team.

I. Configuration

Login to your Magento 2 backend Stores > Settings > Configurations > Mageplaza Extension: SEO, follow our given guide below to complete those SEO configurations

• General
• Duplicate Content
• Structure Data
• Business Information
• Social Profiles
• Verifications
• HTML Sitemap
• XML Sitemap
• Canonical URLs
• Redirects
• SEO Rules

1.1. General Configuration

Choose Enable = “Yes” to turn Mageplaza SEO on generally.

1.2. Duplicate Content

Filtering results (from layered navigation pages, etc) is the main cause of generating many similar URLs, and search crawlers assess them are all the same, in other words, it’s called duplicate content. Therefore, you must have the assist from Canonical tags to reduce the duplication of content on the page, this is an onpage SEO tip to note obviously.

• In the Use Canonical Link Meta Tag For Categories field: Choose “Yes” to display Canonical tags of Category pages which are from Source Category on the frontend.

• In the Use Canonical Link Meta Tag For Products field: Choose “Yes” to display Canonical tags of Source Product on the frontend.

1.3. Structure Data

• In the Enable Product Structured Data field:
  • Select “Yes” to display the basic information of products when they are searched by search engines.
  • By this intuitive design, Product Structured Data will increase click through rate (CTR) drastically. Thus, products from your store will be ranked higher on search results.
  • You can check Product Structure Data at the Page Source of Product Detail Page. Structure Data will mirror exactly as the basic information of that product.
• In the Enable Sitelinks Searchbox field:
  • Select “Yes” to display your store’s Searchbox on the Sitelinks. As soon as your store displays on the search results, your store searchbox will also display with the store’s link.
  • You can test the code in Page Source of Homepage.

1.4. Business Information

• In the Enable Bussiness Information field: Select “Yes to display information about your business in the search result.
• When you leave any field blank, the information for that field will not display.
• You can test the code in Page Source of Homepage.

1.5. Social Profiles

• You can paste your social addresses in here. Make sure that all the accounts have been verified.
• Social Profile will display along with Business Information. If Business Information is not enabled, Social Profile won’t display in search results.
• You can leave unnecessary Social Profiles in blank status.
• When the searcher clicks on one of your social links, they will be redirected to that social page of your store.
• You can test the code in Page Source of Homepage

1.6. Verifications

In the Verification field, you need to enter the verification code to confirm the ownership of your site. Hence, you can use the Web services such as Google Search Console, Bing Webmaster Tools, Pinterest and Yandex Webmaster Tools.

• In the Google Search Console field: Enter the verification code for Google Search Console.
• In the Bing Webmaster Tools field: Enter the verification code for Bing Webmaster Tools.
• In the Pinterest field: Enter the verification code for Pinterest.
• In the Yandex Webmaster Tools field: Enter the verification code for Yandex Webmaster Tools.

1.7. HTML Sitemap

To use this function, you need to install Mageplaza Sitemap extension

This HTML sitemap configuration contains Categories Sitemap, Pages Sitemap, and Products Sitemap, while all of them can be displayed in the footer of your page. You can see the settings in the following screenshots:

• In the Enable HTML Sitemap: choose “Yes” if you want to enable HTML Sitemap. New related HTML Sitemap modules will be expanded automatically

• In the Enable Categories Sitemap: choose “Yes” if you want to display all pages in categories. * Exclude Category Page: Enter path in the Exclude Category Page to limit those category pages displayed in HTML Sitemap. Separated by a line break. * Display Style: Select style to display categories in HTML sitemap:

  • List:

  

  • Dropdown:

  

• In the Enable Pages Sitemap field: choose “Yes” if you want to display all pages in the website. * Enable Exclude Pages Sitemap: Select Yes to exclude pages in HTML sitemap. Show extra field:

  • Filter Cms Pages: Select one or multiple pages to exclude them from HTML sitemap.

• In the Enable Products Sitemap field: choose “Yes” if you want to display all product pages. * Sort Products in HTML Sitemap by: Select how to display products in HTML Sitemap according to: Product IDs, Product Name, Price.

  • Default Sort Direction: Select the sorting direction: Descending or Ascending.
  • Hide Out Of Stock Products: Select Yes to hide out-of-stock products in HTML sitemap.
  • Limit Product Sitemap: Enter a number in the Limit Product Sitemap field to limit the number of products shown in HTML sitemap.

• In the Enable Additional Links field: if you have a tons of link which can’t be automatically inserted into HTML file, choose “Yes” to enable this permission.

• In the Additional Links box: Paste additional links you want to add.

• In the Add Sitemap Link to Footer field: choose “Yes” if you want to enable the advance HTML Sitemap in the footer of pages.

1.8. XML Sitemap

To use this function, you need to install Mageplaza Sitemap extension

Right under the HTML Sitemap’s configuration is XML Sitemap’s settings

XML Sitemap is a .xml map of your website and the map will show a list of the page that the visitors can access. Under the XML Sitemap section, you can:

• Create Homepage Optimization when choosing “Yes”
• In case you need additional links, it is required to set Enable Additional Links to “Yes”

1.9. Canonical URLs

If the content of your site has the same article with others, search engines will underestimate the quality of your content and thus reduce the ranking of your website. Therefore, you must have a Canonical tags to reduce the duplication of content on the page, this is an onpage SEO tips which should be noted.

Expand Canonical URLs configuration to see basic modules:

• In the Add Canonical URL Meta Header field: Choose “Yes” if you want to add canonical URL for Meta Header Tags
• In the Disable Canonical URL for Pages with NOINDEX robots field: Choose “No” if you want to disable all canonical URL for pages with NOINDEX robots since it’s not good for your SEO procedure (eg Search Pages, 404 Pages, etc)
• In the Don’t use Canonical URL for these pages field: Default option is “No”. Entered pages won’t display Canonical URL.

1.10. Redirects

Scroll until Redirect’s general configuration reaches your eyes.

• In the Enable Redirects field: choose “Yes” to allow this function to work.
• In the Better 404 Page field: choose “Yes” if you want all 404 Pages to be redirected to your Homepage.

An additional user guide for Redirects can be found here

1.11. SEO Rules

Head forward to Mageplaza > SEO: Configuration > SEO Rules in order to take the basic control for Rules generally.

• In the Enable SEO Rules field: Choose “Yes” to enable all set SEO rules
• In the Use H1 Heading for Product Pages field: Select “Yes” if you want to apply H1 Heading for Product Pages.
• In the Use H1 Heading for Category Pages field: Choose “Yes” if you want to apply H1 Heading for Category Pages.
• In the Enable Automatic Alt Image field: The required alt attribute specifies an alternate text for an image, if the image cannot be displayed. Choose “Yes” to enable this function”

II. Manage Rules

To add a new rule, please follow the path Marketing > SEO: Manage Rules, click on Add Rule button, choose one type of page you want to create a new rule apply for:

• Product Pages
• Category Pages
• CMS Pages
• Layered Navigation

Note: There existed Default: Layered Navigation in the Rule Management. This rule’s function is for fixing filtered result’s title like this below screenshot. It can’t be eliminated. However, you can Enable/Disable or modify the rule as your favor.

In this below guide, let’s take a try with the Product Pages

A new rule information page appears. Fill all required information which are divided into 4 parts at the sidebar, please follow those explanation for each field

2.1 Rule Information

• In the Name field: Enter a Rule Name
• In the Status field: Set Status to “Enable” for the active rule
• In the Store view field: Choose Store View where the rule is applied
• In the Priority field: Set Priority number, 0 is the highest level.

2.2 Conditions

It’s pretty easy to add/remove its content

2.3 Actions

• In the Meta Title Template box: Enter the Meta Tile Template
• In the Meta Description Template box: Enter the Meta Tile Template. Use following syntax to add dynamic meta title: {{name}}, {{price}}, {{special_price}}.
• In the Meta Keywords Template field: Enter the Meta Keywords Template. It should be between 3-5 keywords. Use following syntax to add dynamic meta title: {{name}}, {{price}}, {{special_price}}.
• In the Robot Template field: Select Robots Template from one of the options to set the index permission for search engine’s robots: * Index, Follow * NoIndex, Follow * Index, NoFollow * NoIndex, NoFollow
• In the Apply Template field there are two modes: * “Skip if already defined” means if admin manually added meta tag: title, description, so it will not apply this template. * “Force Update” means auto-applying the template for all meta tags

2.4 Preview

This is the final step where you can check the result after setting up a bunch of required information. For example, it will appear like this

The rule form and its action of the rest Category Pages, CMS Pages or Layered Navigation is pretty similar to the Product Page’s form

Editing template rule form is the same with creating a new one. At Marketing > SEO: Manage Rules choose Edit the rule you want to alter. Remember to clicl on ``Apply Rules``every time you edit a rule to apply it properly.

III. SEO Tools

This add-on tool will assist SEO extension in assessing and marking which and how to perform the structured data at the best for SEO progress. You can have a general review for the SEO analysis at the Product Page, Category Page and CMS Page.

For example with a product:

• Go to Product > Catalog, choose Edit a random one.
• Choose PageSpeed Insight button at the header

• The page will be directed to PageSpeed Insight page for the check execution.

• PageSpeed Insights will focus on 2 key issues: page loading speed and user friendliness. These factors comply with Google web optimization methods as well as automate adjustment process.

• Apply the same action with Category Page and CMS Page.

IV. SEO URL

Basically, one of the most important search engine optiomization techniques is using SEO-friendly URL.

• Select Yes to enable SEO URL.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

SEO Ultimate

To help you automatically optimize and greatly improve the performance of your Magento-based store in Search Engines, Mageplaza SEO extension will bring your store a great chance to own an amazing speed as well as to gain the higher and higher ranks in the popular and famous search engines such as Google, Bing, or Yahoo.

In order to install SEO extension on your store, you can learn and do it by yourself via Installation Guide or use Installation Service Package to request the specialist helps from Mageplaza Team.

I. Configuration

Login to your Magento 2 backend Stores > Settings > Configurations > Mageplaza Extension: SEO, follow our given guide below to complete those SEO configurations

• General
• Duplicate Content
• Structure Data
• Business Information
• Social Profiles
• Verifications
• HTML Sitemap
• XML Sitemap
• Canonical URLs
• Redirects
• SEO Rules
• Page Analysis
• Cross Links
• Dashboard Reports
• Hreflang Tags

1.1. General Configuration

Choose Enable = “Yes” to turn Mageplaza SEO on generally.

1.2. Duplicate Content

Filtering results (from layered navigation pages, etc) is the main cause of generating many similar URLs, and search crawlers assess them are all the same, in other words, it’s called duplicate content. Therefore, you must have the assist from Canonical tags to reduce the duplication of content on the page, this is an onpage SEO tip to note obviously.

• In the Use Canonical Link Meta Tag For Categories field: Choose “Yes” to display Canonical tags of Category pages which are from Source Category on the frontend.

• In the Use Canonical Link Meta Tag For Products field: Choose “Yes” to display Canonical tags of Source Product on the frontend.

1.3. Structure Data

• In the Enable Product Structured Data field:
  • Select “Yes” to display the basic information of products when they are searched by search engines.
  • By this intuitive design, Product Structured Data will increase click through rate (CTR) drastically. Thus, products from your store will be ranked higher on search results.
  • You can check Product Structure Data at the Page Source of Product Detail Page. Structure Data will mirror exactly as the basic information of that product.
• In the Enable Sitelinks Searchbox field:
  • Select “Yes” to display your store’s Searchbox on the Sitelinks. As soon as your store displays on the search results, your store searchbox will also display with the store’s link.
  • You can test the code in Page Source of Homepage.

1.4. Business Information

• In the Enable Bussiness Information field: Select “Yes to display information about your business in the search result.
• When you leave any field blank, the information for that field will not display.
• You can test the code in Page Source of Homepage.

1.5. Social Profiles

• You can paste your social addresses in here. Make sure that all the accounts have been verified.
• Social Profile will display along with Business Information. If Business Information is not enabled, Social Profile won’t display in search results.
• You can leave unnecessary Social Profiles in blank status.
• When the searcher clicks on one of your social links, they will be redirected to that social page of your store.
• You can test the code in Page Source of Homepage

1.6. Verifications

In the Verification field, you need to enter the verification code to confirm the ownership of your site. Hence, you can use the Web services such as Google Search Console, Bing Webmaster Tools, Pinterest and Yandex Webmaster Tools.

• In the Google Search Console field: Enter the verification code for Google Search Console.
• In the Bing Webmaster Tools field: Enter the verification code for Bing Webmaster Tools.
• In the Pinterest field: Enter the verification code for Pinterest.
• In the Yandex Webmaster Tools field: Enter the verification code for Yandex Webmaster Tools.

1.7. Canonical URLs

If the content of your site has the same article with others, search engines will underestimate the quality of your content and thus reduce the ranking of your website. Therefore, you must have a Canonical tags to reduce the duplication of content on the page, this is an onpage SEO tips which should be noted.

Expand Canonical URLs configuration to see basic modules:

• In the Add Canonical URL Meta Header field: Choose “Yes” if you want to add canonical URL for Meta Header Tags
• In the Disable Canonical URL for Pages with NOINDEX robots field: Choose “No” if you want to disable all canonical URL for pages with NOINDEX robots since it’s not good for your SEO procedure (eg Search Pages, 404 Pages, etc)
• In the Don’t use Canonical URL for these pages field: Default option is “No”. Entered pages won’t display Canonical URL.

1.8. Redirects

Scroll until Redirect’s general configuration reaches your eyes.

• In the Enable Redirects field: choose “Yes” to allow this function to work.
• In the Better 404 Page field: choose “Yes” if you want all 404 Pages to be redirected to your Homepage.

An additional user guide for Redirects can be found here

1.9. SEO Rules

Head forward to Mageplaza > SEO: Configuration > SEO Rules in order to take the basic control for Rules generally.

• In the Enable SEO Rules field: Choose “Yes” to enable all set SEO rules
• In the Use H1 Heading for Product Pages field: Select “Yes” if you want to apply H1 Heading for Product Pages.
• In the Use H1 Heading for Category Pages field: Choose “Yes” if you want to apply H1 Heading for Category Pages.
• In the Enable Automatic Alt Image field: The required alt attribute specifies an alternate text for an image, if the image cannot be displayed. Choose “Yes” to enable this function”

1.10. Page Analysis

Page Analysis will assist you on marking which and how to perform the structured data is the best for SEO progress. Choose “Yes” to turn the page analysis function on.

Take a look at how it works by this example. Go to Products > Catalog > choose a product.

Then, expand Search Engine Optimization tab.

This field allows the users can edit and see visually how the structured data will be displayed in the Search Engine Result Pages.

• Add the Meta Title.
• Add the URL Key.
• Insert the Meta Description.

Below the Meta Title and Meta Description field, there is a bar which notices the status of the text length.

• Red: The text lengh is not good for SEO.
• Orange: The text length is short and not good for SEO.
• Green: The text length is good for SEO.

After inserting the content on the other Main Keyword field, the system will automatically check and show the analysis. The analysis is based on:

• The Focus keyword.
• The Meta title, URL Key, Meta Description content.
• The Description and Short Description content on the Content tab.
• The Product Image’s description.

1.11. Cross Links

In the Enable/Disable field, select “Yes” to enable cross links work, or “No” if you wish for the vice versa result. For more configuration how to set up crosslinks, please refer to this Part V

1.12. Dashboard Reports

Dashboard Reports will gather and notice you all negative factors are harmful to your sites, which is also decreasing your SEO ranking badly.

• In the Enable SEO Reports field: If you want to enable this function, choose “Yes”.
• In the Show Report on Dashboard field: Choose “Yes” if you want to display the report on the dashboard.
• In the Apply name duplicate report content field: If you enable Dashboard Reports, this module will be added and you can be allowed to configure it now. Select a page you want to apply name duplicate report content (such as Meta, Content, Frontend Identify, Description of products, Category pages or Product View pages)
• Click on Reindex Data button to apply the module for data or configuration changes.

A new report system will be displayed at the dashboard of your admin backend which is obviously useful for daily checkings. This helpful friend will help you keep track of these pages:

• Duplicate Content
• Missing Meta Data
• Low Count Word
• 404 Pages

If Dashboard report is disable, you can check it at Report > Mageplaza: SEO Report.

1.13. Hreflang Tags

• In the Enable Hreflang Url field: Choose “Yes” to enable Hreflang tags for your sites.
• In the Enable For Product field: Choose “Yes” to enable Hreflang for Product pages
• In the Enable For Category field: Choose “Yes” to enable Hreflang for Category pages
• In the Enable For CMS Page field: Choose “Yes” to enable Hreflang for CMS pages
• In the Use Language Code from Default Locale field: Choose “Yes” if you want to use Language Code from Default Locale section.
• In the Language Code field: Choose your preferred Language Code
• In the X-Default field: Choose “Choose “Default Store View” if you want to set the above Language Code” as the default language.

II. Manage Rules

To add a new rule, please follow the path Marketing > SEO: Manage Rules, click on Add Rule button, choose one type of page you want to create a new rule apply for:

• Product Pages
• Category Pages
• CMS Pages
• Layered Navigation

Note: There existed Default: Layered Navigation in the Rule Management. This rule’s function is for fixing filtered result’s title like this below screenshot. It can’t be eliminated. However, you can Enable/Disable or modify the rule as your favor.

In this below guide, let’s take a try with the Product Pages

A new rule information page appears. Fill all required information which are divided into 4 parts at the sidebar, please follow those explanation for each field

2.1 Rule Information

• In the Name field: Enter a Rule Name
• In the Status field: Set Status to “Enable” for the active rule
• In the Store view field: Choose Store View where the rule is applied
• In the Priority field: Set Priority number, 0 is the highest level.

2.2 Conditions

It’s pretty easy to add/remove its content

2.3 Actions

• In the Meta Title Template box: Enter the Meta Tile Template
• In the Meta Description Template box: Enter the Meta Tile Template. Use following syntax to add dynamic meta title: {{name}}, {{price}}, {{special_price}}.
• In the Meta Keywords Template field: Enter the Meta Keywords Template. It should be between 3-5 keywords. Use following syntax to add dynamic meta title: {{name}}, {{price}}, {{special_price}}.
• In the Robot Template field: Select Robots Template from one of the options to set the index permission for search engine’s robots: * Index, Follow * NoIndex, Follow * Index, NoFollow * NoIndex, NoFollow
• In the Apply Template field there are two modes: * “Skip if already defined” means if admin manually added meta tag: title, description, so it will not apply this template. * “Force Update” means auto-applying the template for all meta tags

2.4 Preview

This is the final step where you can check the result after setting up a bunch of required information. For example, it will appear like this

The rule form and its action of the rest Category Pages, CMS Pages or Layered Navigation is pretty similar to the Product Page’s form

Editing template rule form is the same with creating a new one. At Marketing > SEO: Manage Rules choose Edit the rule you want to alter. Remember to clicl on ``Apply Rules``every time you edit a rule to apply it properly.

III. SEO Tools

This add-on tool will assist SEO extension in assessing and marking which and how to perform the structured data at the best for SEO progress. You can have a general review for the SEO analysis at the Product Page, Category Page and CMS Page.

For example with a product:

• Go to Product > Catalog, choose Edit a random one.
• Choose PageSpeed Insight button at the header

• The page will be directed to PageSpeed Insight page for the check execution.

• PageSpeed Insights will focus on 2 key issues: page loading speed and user friendliness. These factors comply with Google web optimization methods as well as automate adjustment process.

• Apply the same action with Category Page and CMS Page.

IV. Checklist

Follow Mageplaza > SEO: Checklist

SEO Checklist includes a list of the notifications: Success, Error, and Warning. Based on this status of the notification, you will know whether your store is optimized and ready for SEO or not.

V. Manage Crosslinks

Our crosslinks feature will work under customizable terms. In the other words, It will retrieve keywords and automatically place a pre-installed internal link that makes it’s possible to associate with other sales pages

E.g Crosslinks will replace all appeared “Luma” words by an internal link. You won’t have to do all the syntax works manually which also can cut down the decorate content time.

Please make sure that the Crosslink’ genenal configuration in Part 1.13 has been enabled.

5.1 How to create a new term

To make a new term for your store, go to Marketing > SEO > Manage Crosslinks. Click red button Add new Term.

Fill up all the required information fields you wish to set up for your new term. Creating a new term’s form will be performed like this.

• In the Keyword field (require information): Enter a new keyword you want to create.
• In the Enable field: Set up the status for the term. Choose “Yes” if you want to apply for this term
• In the Link Alt/Title field: This is for the short description for this keyword. This will be inserted into a title attribute. We suggest that you should add keywords that you want to boost your ranking in SERPs. E.g: Buy iPhone in New York
• In the Link Target field: Target’s attribute of the Internal link.
  • If you want to open a new tab, you should choose: _blank (New tab)
  • If you want to open it in a popup box, choose _self (Current tab)
  • If you want to open it in the current page, choose _top (Full body of the window)
• In the Link to field: Define the form of address that Internal links refer to. There will be 3 kinds of form.
  • Custom Link: URL’s path will be put together with domain of this website. E.g: /iphone.html . This value does not include the domain name.
  • Product stock keeping unit (SKU): Base on SKU link to the product URL. E.g: iphone
  • Category ID: Base on ID link to the category URL. E.g: 23
• In the Store View field: Choose store view(s) you want to apply the term.
• In the Apply for field: Choose section you want to place crosslinks.
  • Product Description
  • Category Description
  • Page Content
• In the Limit Number Of Links Per Page field: Enter a value which limits the number of links per page. Default: 3.
• In the Direction field: Specify direction which Crosslinks function will find and replace the keyword. Random or Top down will be good recommendation.
• In the Rel field: The rel’s attribute of Internal link. There are 2 options: Default or Nofollow.
• In Priority field: Set up value for the priority of this keyword. Higher priority term will be applied first. 0 is the highest.

5.2 How to edit/delete existed terms

Follow Marketing > SEO > Manage Crosslinks. A list of existed terms will appear. Select in the Action button to customize the term you want to edit/delete.

Click Save term after editing.

VI. SEO Checklist

SEO Checklist includes a list of the notifications: Success, Error, and Warning. Based on this status of the notification, you will know whether your store is optimized and ready for SEO or not. Follow Marketing > SEO: Checklist

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Reports

Overview

Having the newest insights of your store will never be easier, Magento 2 Reports is crafted as a reliable analyzing tool which assembles and performs your business operations onto easy-to-understand line charts. Thus, by keeping track precise collected data will definitely help you assess your business/campaign/program and flexibly adapt to new situations quickly.

In this extension, all the reports will use line graphs, which are fond of showing data variables and factors clearly. Advanced reports will be executed after scanning all sales records, display each of a specific variable into a line then perform its movement corresponding scanned records. Besides that, this module also helps store owners manage and follow the growth rate or the decreasing rate compared with the same period last month, last year, etc.

Download & Install

• Mageplaza
• How to install

*Note: Magento 2 Reports can be used with multiple stores. Multiple stores module:
- This extension is applied to multiple stores.
- Stores are set the default as the Default Configuration.
- To change the configuration for each store, need to remove tick at Use Website on the right of each option.
- Config of the extension in each store will be applied in the store itself.
- Config in this store doesn't affect the config in the other store.

How to configure

Login to the Magento admin panel, choose Store > Settings > Configuration > Mageplaza Extensions > Reports

1. General

• In the Module Enable field: Choose Yes to enable this module.
• In the Enable Chart field: Select Yes to show the graph.
• In the Enable Compare field: select Yes to display the comparison.

2. Mobile Dashboard

This function allow mobiles access to admin Dashboard by Access Key. In Mobile Dashboard, there is no Magento menu, header, footer,…minimal the content to enhance the loading speed. Also, at Mobile Dashboard, admin can adjust the date like in Desktop.

Display outside the dashboard

After the configuration is completed, you will get the result displayed as the following image:

Dasboard Displaying

• The charts displayed at Mobile Dashboard include:
  • Default report at Dashboard such as Lifetime Sales, Average Order, Last Orders, Last Search Terms, Top Search Terms, BestSellers, Most View Products, New Customer, Customers, Tax, Shipping.
  • Moreover, Mageplaza provides additional mostly use reports:
    • Orders
    • Sales by Location
    • Repeat Customer
    • Totals
    • Conversion Funnel
• Each Chart displays only 5 results typical for its criteria
• Each chart is represented by 1 card. Admin can adjust dashboard with cards provided by the module

• Admins can also filter the results by the time period they want

Must-have extensions for your Magento stores

• Increase website traffic: SEO
• Build leads
• Increase conversion rates: One Step Checkout, Layered Navigation
• We believe that you can sell more: Gift Cards, Auto Related Products, Frequently Bought Together, Free shipping bar, Daily Deal , Product Feed
• Keep customers return: Reward Points
• Let your customer become raving fans
• Optimize your stores: PDF Invoice, Custom Order Number, Stop return items issue

3. Rest API

Mageplaza’s Report extension supports using the Rest API to view the card information displayed in the dashboard as well as detailed statistics of the tables.

Details can be viewed here.

Instructions for creating Integration tokens here.

4. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza / module-report-graphql
php bin / magento setup: upgrade
php bin / magento setup: static-content: deploy

To start working with Report GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)

View the supported queries here

Reports Professional

Previously, Mageplaza has released Reports module that helps shop owners statistically and more easily manage the number of customers, the number of transactions, or the total amount of money your store earned in a day/year/etc. In order to meet the higher demands of the store manager, we have upgraded this module to a new version to help shop owners manage as well as see clearly the growth or declining rate of sectors that need to be managed, such as the number of best-selling products, countries or provinces with the highest number of purchases.

How to configure

Login to the Magento admin panel, choose Store > Settings > Configuration > Mageplaza Extensions > Reports

1. General

• In the Module Enable field: Choose Yes to enable this module.
• In the Enable Chart field: Select Yes to show the graph.
• In the Enable Compare field: select Yes to display the comparison.

2. Display outside the dashboard

• In addition to the cards available in the Standard version, the Pro version provides additional mostly used cards, including:
  • Abandoned Carts
  • Stock vs Sold
  • Sales by Customer Group
  • Refresh Statistics
• The Report Pro also allows administrators to view the report details of some cards when clicking on View Details of Chart

• Detail Report Pages are displayed in Mageplaza Report:

Bestsellers

Click on the View Details section in the right corner of the card to see the details of the Bestsellers section.

In this field, store owners can view the details of the bestsellers for a period of time to be configured. Also, shop owners can also compare that product with another product when they view the detail of each product.

Store owners can add the SKU of products that they want to compare with the first product they choose, then click on the Apply button to add the product data as well as compare them. Besides, they can also filter according to various fields that aren’t included in the default of Magento.

Sales By Location

Click on the View Details in the right corner of the card to view the detail of Sale By Location section

In this section, shop owners can view which country has the largest number of orders or total. Not only that, when they click on each country, they can view the regions of the country that have the most number of purchases. Then, when they click on the regions, it will display the purchase details of that region.

Sales by Customer Group

Click on the View Details in the right corner of the card to view the details of the Customer Group field

This section shows the groups of customers that have purchased and the number shown on the chart helps the store owner to easily see which group of customers buy the most. From that, they can make useful marketing strategies to improve the revenues for stores.

Customers

Click on View Details section in the right corner of the card to view the detail of the Customers field

Customers card will display customer details of which customer groups buy the most. This will help store owners have policies or incentives for these customers.

Stock & Sold

Click on the View Details in the right corner of the card to see the detail of Stock & Sold field

This field will allow store owners to know what time and how many items were sold so that store owners can easily manage as well as add the items that are about to run out.

Abandoned Carts

Click on the View Details in the right corner of the card to view the detail of Abandoned Carts field

Abandoned Carts says at what time the number of unpaid carts equates to the cost of the loss is how much. This section also tells store owners which time period has the most shopping cart is not paid the most and then, take measures to resolve them.

Refresh Statistics

Instead of waiting for the statistics to be updated update once per day by cron, the admin can refresh them immediately with Massaction in Grid Refresh Statistics. Admin can refresh the following 4 grids:

• Abandoned Carts
• Bestsellers
• Sales By Customer
• Sales By Location

Two supported Massactions are:

• Refresh Lifetime Statistics: refreshes all data from the beginning until the refresh time of the selected grid
• Refresh Statistics for the Last Day: Refresh the data of the selected grid within the last 24 hours

The admin can use the command line to refresh the statistics

php bin/magento mp-reports:reindex --type="lifetime" {id}
php bin/magento mp-reports:reindex --type="recent" {id}

For example:

• Refresh all tables:

php bin/magento mp-reports:reindex --type="recent"

• Refresh the tables by id:

php bin/magento mp-reports:reindex --type="recent" 1 2

Rest API

Mageplaza’s Report Pro extension supports using the Rest API to view the card information displayed in the dashboard as well as detailed statistics of the tables.

Details can be viewed here.

Instructions for creating Integration tokens here.

GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza / module-report-graphql
php bin / magento setup: upgrade
php bin / magento setup: static-content: deploy

To start working with Report GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)

View the supported queries here

Reports Ultimate

Previously, Mageplaza has released Standard and Professional Reports module that helps shop owners statistically and more easily manage the number of customers, the number of transactions, or the revenue earned in a day/year/etc. In order to meet the higher demands of the store manager, we have upgraded this module to the Ultimate Report version to help shop owners have super helpful reports such as Sales by Category, Sales by Attribute Set, Sales by Payment, Sales by Coupon Code and so on.

How to configure

Login to the Magento admin panel, choose Store > Settings > Configuration > Mageplaza Extensions > Reports

1. General

• In the Module Enable field: Choose Yes to enable this module.
• In the Enable Chart field: Select Yes to show the graph.
• In the Enable Compare field: select Yes to display the comparison.

2. Display outside the Dashboard

• In addition to the cards available in Standard and Pro versions, the Ultimate edition continues to provide the admin with some other necessary cards, including:
  • Sales by Category
  • Sales by Attribute Set
  • Sales by Payment
  • Sales by Coupon Code
  • Sales by Postal Code
  • Sales by Hour
  • Sales by Hour Chart
  • Sales by Weekday
  • Sales by Weekday Chart
  • Sales by Tax Rate
  • Customer By Location
  • Wishlist
• Moreover, Report Ultimate supports refreshing some grids at grid Refresh Statistic, including:
  • Stock vs Sold
  • Sales By Category
  • Sales By Payment
  • Sales By Postal Code
  • Sales By Weekday
  • Sales By Hour
  • Sales By Tax Rate
  • Sales By Attribute Set
  • Sales By Coupon Code
  • Sales By Product Attribute

• Multiple Dashboard feature
  • Apply for both Dashboard and Mobile Dashboard
  • The Ultimate version allows admin to create multiple Dashboards. Admin accounts will avoid conflicts when the dashboard has been changed to your liking
  • Any changes to Dashboard, the Save View As line will be displayed. Admin click on the link to save the view
  • To edit the View, click to edit symbol

Sales by Category

• Illustrates sales statistics for any given category within a selected time frame
• To view more details about best seller products of each Category, click to View at Action column to access to Report of Detail Products in Category

Sales by Payment: display sales data grouped by payment methods

Sales by Postal Code: display sales data grouped by ZIP code

Sales by Weekday

In this part, the store owner can view the order amount by the weekday. From there, they find solutions to increase sales in specific weekday with many orders and improve the days that have lower sales.

Sales by Hour

In this part, the store owner can view order quantity by the time frame of the day. From there, they find solutions to increase sales in favorable time frames and improve sales in less-sales time frames.

Customer By Location

• Determine the number of customers who have accounts in each country in the world. From there, give appropriate solutions to increase sales in each country
• Display sales data by country, split by users, orders, items, and financial details

Sales by Tax Rate

Provide statistics on orders sold in different tax areas. Since then there is a reasonable adjustment between regions

Sales by Attribute Set

Provide statistics of orders purchased according to the Attribute Set available in the store

Sales by Coupon

Shows the number of orders and sales details resulting from coupon usage

Sales by Product Attribute

Displays sales statistics for any given attribute or a combination of attributes

New and Returning Customers

Show the number of new and returning customers

Sales By Cart Price Rules

Show descriptive sales statistics of each cart price rules (order count, ordered item quantity, etc.)

User Wishlist

In this section, the store owner can see details of which products are favored by customers that are included in their wishlist

Rest API

Mageplaza’s Report Ultimate extension supports using the Rest API to view the card information displayed in the dashboard as well as detailed statistics of the tables.

Details can be viewed here.

Instructions for creating Integration tokens here.

GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza / module-report-graphql
php bin / magento setup: upgrade
php bin / magento setup: static-content: deploy

To start working with Report GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)

View the supported queries here

Product Feed

Overview

If customers sell their products on a variety of channels such as Google Shopping, Ebay, Amazon, etc and these channels use the same database, then they can automatically update their items by importing the exported data files from the original channels. Thanks to this, store owners can save more time and manage their sales channels with ease. That’s also an awesome feature from Mageplaza Product Feed extension.

Download & Install

• Mageplaza Product Feed
• How to Install

How to use

Google Shopping API:

• Register an account of Google Shopping API and go to this link.
• After your account has been registered, you will see the value in the field Merchant ID. Save that Merchant ID value to connect with your website later.

• Go to this link to get the information of 8Google Shopping API: Client ID and Client Secret connect with your website. Click on Create Credentials > OAuth client ID.

• With the field Application type, you can choose Web application, enter the information like Name. Copy and paste the value of the field Authorized Redirect URLs of your website in the field Authorized Redirect URLs of Google Shopping API. Then click Create button to complete.

• Select Ok to complete creating OAuth client ID. Save the Client ID and Client Secret to connect with your website.

How to configure

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Product Feed > Configuration

Configuration

From the Admin Panel, go to Products > Product Feed > Configuration, choose General section

General

• Enable: Choose “Yes” to use this module
• Categories Path for Product URLs: Create the URL for the product. If select Default, the URl will be generated as the default Magento (Category with the smallest ID).
  • Note: Categories Path is only correct when setting Use Categories Path for Product URLs = Yes

• Enable Product Feed Report: Select Yes to display the Product Feed Report on the Manage Feeds Grid.
• Clean Log Every: Select the number of days to clean the created logss at Feed Log after the selected time. If empty or zero, the log will not be cleaned.

Google Shopping API

• **Enable: Choose Yes to synchronize the value with Google Shopping API
• Send data every: Select the number of days in the Send data ever field. After the selected number of days, the feed data will be synced to Google Shopping API. Note that this feature is only applied to sync via cron.
• Merchant ID, Client ID, Client Secret: Enter the value of the fields you have already saved and set up here.
• Authorized Redirect URLs: Copy and paste the value of this section in URLs of the **Authorized Redirect URLs of Google Shopping API.
• Click Get Access Token button to check the connection with Google Shopping API.

Email Alert

• Enable: Choose “Yes” to enable the email notification for store owners
• Send to:
  • Enter the email to send the notification
  • Allow entering multiple emails. These emails are separated by commas.
• When:
  • Choose the events that when it happens, the email notification will be sent
  • Be able to choose many events at once time

Manage Feeds

Grid

• From the Admin Panel, go to Catalog > Product Feeds > Manage Feeds

• This is where all created feeds are displayed.
• Here admins can have basic information of the feed such as: ID, Name, Status, File Type, Execution Mode, Store, Action, Click, Impression, CTR,…
• Admins can select Action if they want to Delete, Generate, or Change Status Feed.
• Besides that, admins can also Filter, Export, Hide/Show the Columns
• Note: CTR (Click through rate)= (Click/ Impression) * 100%
  • Click: the number of clicks in the product link uploaded to the app or the feed file
  • Impression: the number of views of the product link uploaded to the app or the feed file

Product Feed Revenue Report

The Revenue Report is based on the statistic of the ordered products uploaded to the feed file or the app. The pie chart shown is the result of the Total Revenue field.

Note: Total Revenue and Refunded do not include the shipping fee.

How to create New Feed

• Step 1: Enter full information of General field
• Step 2: Choose Template type
• Step 3: Enter full information of Google Analytics
• Step 4: Choose the condition to export the file
• Step 5: Enter the Category Map for products
• Step 6: Setup the method to send the exported file
• Step 7: Check the update history of the exported file

Step 1: Enter full information of General field

• From the Admin Panel, go to Products > Catalog > Product Feed > Manage Feeds
• In the right corner, choose Add New Feed button
• Enter the display name in the Grid Feed for the export type
• To auto-update the products when running cron, choose Enable in the Status field
• Choose the store to get that store’s product and generate the file
• Enter the export file name to send to the server
• Choose the format to compress the file when downloading
• Generate Config: Choose the export type
  • Generate Config = Manual: Allow generating the file manually
  • Generate Config = Cron: Auto-generate the file
    • Frequency = Daily: Auto-generate the file daily
    • Frequency = Weekly: Auto-generate the file weekly
    • Frequency = Monthly: Auto-generate the file monthly
    • Cron Run Time: Setup the time to auto-generate the file at the time that you have setup. Please note that the time of Cron Job will be the timezone of UTC

Step 2: Choose Template type

• Select the file format. There’re 3 file formats: TXT, CSV, XML, TSV, and XLS

• Select the template format to export the file. There’re 6 template formats. They are: Google Shopping XML, Google Shopping Review XML, Amazon Inventory XML, Amazone Marketplace XML, Facebook CSV, Ebay CSV

• Click on the Load Template button to display the template content

• For the template format is XML:

  • Template Content:The template content is displayed in this field. Admins can edit the template content here.
  • Add the values to the template by clicking on the Insert Variable button

• For the template format is CSV

  • Choose the character separating the fields when exporting the file in the Field Separate field
  • Select the character surrounding the fields when exporting the file in the Field Around field
  • To get the header field when exporting the file, choose “Yes” in the Include Field Header field
  • Allow adding any value you want into the Fields Map field. Please note that: The added values must be standard of Google or Facebook or Ebay, Amazon.

  

Step 3: Enter full information of Google Analytics. These values will be added into URL of the product to know what the search engine is, what analytic keyword is, etc.

• Enter the value for the Campaign Source field
• Enter the value for the Campaign Medium field
• Enter the value for the Campaign Name field
• Enter the value for the Campaign Term field
• Enter the value for the Campaign Content field

Step 4: Choose the condition to export the file. All products meeting the conditions will be exported.

• Here you can select the conditions for the feed. Only apply the rules for products meeting the conditions.
• Maximum Product Displayed on Preview Product: Enter the maximum number of products shown in the Preview Product. If left empty, the number of displayed products when clicking the Preview Products button will not be limited.

Step 5: Enter the Category Map for products. Admins can choose and classific according to the availabe suggestions. For the categories with the same level, it will get the classification type of the top-level category.

Step 6: Setup the method to send the exported file

• Delivery Config: Setup the method to send the exported file to the server
  • To send the exported file to the server, choose “Yes” in the Delivery field
  • Choose the method to send the file in the Protocol field: FTP or SFTP, HTTP Server, API, GraphQL.
    • For the FTP protocol, you can add the selection to use Passive Mode or not. We recommend that you should this mode to avoid being blocked by firewalls/NATs/proxies from sending files to the server.
    • HTTP Server: Send to the HTTP server by sending POST request. For example: https://httpbin.org/post
    • API / GraphQL: Send the feed file to API, GraphQL by sending POST, GET,… requests. For example: http://mageplaza/rest/V1/mpProductfeed/feed/file/, http://mageplaza/graphql,…
  • Enter the host name in the Host Name field
  • Enter the host name in the User Name field
  • Enter the password to access the host in the Password field
  • Private Key: Click […] and choose key file to connect with the server. You can skip choosing key file when your server can connect without key file.
  • If you want to save the file, only enter the path in the Directory Path field. Note: You need to set the name the export file at the end of the path
  • Request URL: Show this field when selecting Protocol as HTTP Server, API, GraphQL. Enter URL to send POST, GET,… request to HTTP Server, API; GraphQL.
  • Headers: Show this field when selecting Protocol as HTTP Server, API, GraphQL. Enter content to send POST, GET,… request. For example: Content-Type: application/json
  • To check whether it is connected to the host, press Test Connection

• Step 7: Check the update history of the exported file. Admins can check the update history of the file in the Logs field.

• Step 8: Synchronize product value with Google Shopping API

Choose the information of the fields in Magento appropriately to send data to Google Shopping API.

• Google Shopping API Field: Display the fields which are managed by Google Shopping API for this module based on the selected Magento fields.
• Magento Fields:-> Fill in the Magento fields to get the data corresponding to the fields of Google Shopping API. -> If you leave this column blank or no value is existing, the Default value will be arquired and push to Google Shopping API.
• Internal Note: Enter the description in the Internal Note section. This is only for admin to notice the information of the synchronization and is invaluable to data processing.
• Insert Variables: Select the Magento Fields corresponding to the fields of Google Shopping API.
• You can sync manually or sync via cron data from attributes of Magento Field to Google Shopping API.

Logs

From the Admin Panel, go to Products > Catalog > Product Feed > Logs

This section will record the change of feeds such as status, type, notification, etc. When you click on any file, it will automatically open the file.

Email notification about the status of the file

Click on the View Logs, it will redirect the email recipients to the Feed Logs page to view the logs details.

How to Run Command to Generate Feed

To generate one or more feed quickly, you can run the following command line:

php bin/magento mp-productfeed:generate {id}

• In which: {id} is the Feed ID. If you do not fill Feed ID, all the feed will be generated.
• Example: Generate some feed that you want, running the command:

php bin/magento mp-productfeed:generate 1 3 4

Note:

• After installing the extension, you need to download Liquid by running the command composer require liquid/liquid or need to install the library
• When the extension is enabled, Manage Feed and Logs will be displayed
• To reload data of Report, you need to run the command: php bin/magento mp-productfeed:report

FAQs

• Question: How to solve the issue of Product URL does not show correctly?
• Answer: Find the solution here.

Must-have extensions for your Magento stores

• Increase website traffic: SEO
• Build leads
• Increase conversion rates: One Step Checkout, Layered Navigation
• We believe that you can sell more: Gift Cards, Auto Related Products, Frequently Bought Together, Free shipping bar, Daily Deal , Product Feed
• Keep customers return: Reward Points
• Let your customer become raving fans
• Optimize your stores: PDF Invoice, Custom Order Number, Stop return items issue

Abandoned Cart Email

Overview

Cart abandonment is an action that consumers leave the website after adding a product to their virtual cart. Discount codes, Exit offers, and Security badges are some of the ways you can keep customers from recovering their carts.

Magento 2 Abandoned Cart Email extension will help you solve this problem. This extension assists you to determine which cart is having forgotten products, from those initial crumbs to send reminders, or be possible to send discounts to help shoppers easily recover their shopping cart and complete the checkout, which will absolutely skyrocket the value of orders, sales, profits for the store

Note:

• Mageplaza Abandoned Cart Email is totally compatible with Mageplaza SMTP extension
• The extension supports and keeps track of logged customers or entered emails by visitors when they’re in the checkout page
• The module will be run depending on the Cronjob configuration

How to configure

Login to Magento Admin, Marketing > Abandoned Cart Email to configure it in general

1. Configuration

1.1 General Configuration

Go to Stores > Settings > Configuration > Mageplaza Extensions > Abandoned Cart Email then click on General Configuration

• Enabled: select “Yes” to enable Mageplaza Abandoned Cart Email extension
• Send Email to Subscribers Only: Select Yes, only sending abandoned cart email to registered and subscribed customers. If select No, sending email to all abandoned carts of registered customers which satisfy the conditions.
• Add Related Products in Email: Set the display of related products of items in the abandoned cart.
• No: There will be no related products in the abandoned cart email
• Related Products: Products shown in the email are related products of the item in the cart.
• Up-sell Products: Products shown in the email are up-sell products of the item in the cart.
• Cros-sell Products: Products shown in the email are cross-sell products of the item in the cart.
• Title: Enter the title of the Related Products block in the abandoned cart email. It is shown when Add Related Products in Email = Related Products/Up-sell Products/Cross-sell Products
• Limit the Number of Products: The maximum number of products shown in the Related Products block in the abandoned cart email. It is shown when Add Related Products in Email = Related Products/Up-sell Products/Cross-sell Products
• Exclude Products Out Of Stock and Disable Products in Email: Select Yes to remove out-of-stock itens and disable Related products, Cross-sell products and Up-sell products from the email.
• Email: This section is for the abandoned cart reminder email settings
  • Click the Add button to add a reminder email
  • Send After to change the email delivery time. The counting will be started from the last updated cart time, a reminder email will be sent to customers.
  • In the Sender to choose senders entitle. You will have 5 choices: General Contact, Sales Representative, Customer Support, Email Custom 1, Custom 2 Email
  • In the Email Template column, you can find some pre-made email templates. Otherwise, you can customize your own template by creating a new one at sidebar Marketing > Email Template. The newly created template will automatically appear in this section
  • Has coupon is an optional selection. Choose “Yes” to submit a discount code. Coupon installation will be instructed later in 1.3 Coupon
  • Click the trash can icon to delete a email
  • Click the Send test icon to send a test email. To send a test mail successfully, admin has to provide at least one email address in the field Send Test Email to. This feature is available for multi-stores also.
• Send Test Email To: This field is required only for the sending test email purpose. To guarantee that customers’ data will not be leaked, only the most recent abandoned cart’s information which belongs to a guest can be sent to this test email.

1.2 Analytics

Google Analytics is integrated with Mageplaza Abandoned Cart extension. Go to Stores > Settings > Configuration > Mageplaza Extensions > Abandoned Cart Email and click on Analytics.

It manifests in this direct link in the frontend like

• In the Enable field: Select “Yes” to use Google Analytics tool. Then, the Campaign Source, Campaign Medium, Campaign Name, Campaign Term, Campaign Content items will be displayed automatically
• In the Campaign Source field: the data of Campaign Source will appear in the Link back to Cart if it’s available. If you leave it blank, Source on frontend won’t be displayed.
• In the Campaign Medium field: the data of Campaign Medium will appear in the Link back to Cart if it’s available. If you leave it blank, Medium on frontend won’t be displayed
• In the Campaign Name field: data of Campaign Name will appear in the Link back to Cart if it’s available. If you leave it blank, Name on frontend won’t be displayed
• In the Campaign Term field: the data of Campaign Term will appear in the Link back to Cart if it’s available. If you leave it blank, Term on frontend won’t be displayed
• In the Campaign Content field: the data of Campaign Content will appear in the Link back to Cart if it’s available. If you leave it blank, Content on frontend won’t be displayed

1.3 Coupon

Go to Stores > Settings > Configuration > Mageplaza Extensions > Abandoned Cart Email and click on Coupon.

• In the Rule field: choose a principle to generate a discount code
  • Only those rules that are activated and generated automatically will be displayed in the configuration
  • How to create rules in Marketing > Cart Price Rules guide can be found here
• In the Valid field: Where to change the expiration date of a discount code
  • The discount code is only used during the time set since the code was created
  • Time will be counted in hour(s)
  • Discount code can’t be applied if this section is blank
• In the Code Length field: set the length of discount code. Code length does not include Prefix, Suffix, and Separators
• In the Code Format field, you can choose 3 formats for code:
  • Alphanumeric: Code consists of letters and numbers
  • Alphabetical: The code consists only of letters of the alphabet
  • Numeric: The code consists of digits from 0 to 9 only
• In the Code Prefix field: Add the prefix of the code in this section. Discount code won’t contain a prefix if the Code Prefix is left blank
• In the Code Suffix field: Add the suffix of the code in this section. Discount code won’t contain a suffix if the Code Suffix is left blank
• In the Dash Every X Character field: Between each X, there will be the number of characters in the Code set in this part.

An example of the Abandoned Cart Email sent to a customer

1.4. Real-time Reports

Go to Stores > Settings > Configuration > Mageplaza Extensions > Abandoned Cart Email, choose Real-time Reports

How to measure Abandoned Cart: Time to define an abandoned cart. The unit is minute. Example: If we enter 30, then after 30 minutes, carts will be considered abandoned. The carts under 30 minutes will be in the Real Time column. Default Date Range: Day limit on Cart Board Page

Ex: Select Default Date Range= 30 days then at Cart Board page, the Cart will be shown in 30 days. See the picture below:

1.5. SMS Notification

• Enable: Select Yes to send SMS to customer when they abandoned cart.
• Enable Abandonment Cart Phone Number Field: Select Yes to show the Abandonment Cart Phone Number field on the Create an account and Edit account page to send SMS to the entered phone number to remind customer if their cart is abandoned.

• Message: Enter the SMS message to send to customer. You can use the following variables for SMS text : {{customer_name}}, {{customer_email}}, {{items}}, {{store_name}}, {{coupon_code}}, {{to_date}}, {{order_total}}.
• Admin Phone Number: Enter the sender’s phone number provided by Twilio. For example: +18454031xxx,…
• Send After(Minutes): Enter the number of minutes to send abandoned cart SMS after that amount of time.
• SMS Service Provider: Select the third party to integrate SMS (Twilio). You can register the Twilio account here
  • Twilio Account SID: Admin enter the Twilio Account SID to integrate the SMS gate. If left empty or wrong, Twilio will not be applied.
  • Twilio Account Token: Admin enter the Twilio Account Token to integrate the SMS gate. If left empty or wrong, Twilio will not be applied.
• Recipient Phone Number: Enter the recipient’s phone number to notify admin and this is also the phone number for you to Send Test SMS.
• Send Test SMS: Click the button to check if SMS has been sent.

2. Overall Reports

Go to Marketing > Abandoned Cart Email > Overall Report

2.1 Reports

This is the place where archives the number of Abandoned Carts, the number of Abandoned Carts sent, the number of failed Abandoned Carts and the number of Abandoned Carts that were recovered in a period of time.

There are two Report Time modes:

• DAY
  • When you select the DAY mode, adjust the From and To entries, the Report Time will be displayed on a daily basis
  • If the distance between From and To is too far apart, the distance between two days in Report Time will be increased
• MONTH: When you select MONTH mode, adjust the From and To entries, the Report Time will be displayed on a monthly basis

2.2 Logs

This is the place archiving abandoned cart emails which have been sent, including their ID, Subject, Receiver, Coupon, Sequent Number, Sent, Status (Sent/ Error) and Action (Preview/ Delete, Send Again)

• Action = Preview: a pop-up window showing the email which has been sent will appear
• Action = Delete: the selected emails will be deleted. You can choose multiple emails at the same time
• Action = Send Again: the selected email will be sent to customers again. This email has the same content as the selected email
• Clear Logs button: Click the Clear Logs button to quickly delete all the emails stored in the logs. The next email’s ID has nothing to do with the deleted one

3. Checkout Abandonment Report

From Admin Panel, go to Marketing > Abandoned Cart Email > Checkout Abandonment Report

• Here will show statistics about Abandoned Cart Checkout
• Display statistics on checkout cart and abandoned cart grid about quantity, rate (%), total revenue ($)
• Display statistics tables about abandoned cart after sending email (ACE):
• Statistics the number of abandoned cart after sending abandoned cart email
  • Number of emails sent
  • The amount can be saved after sending an email
  • Saved revenue
  • Checked out rate of abandoned cart

• Show detailed statistics in period (day/week/month/year/custom) by Grid

4. Abandoned Product Report

From the Admin Panel, select Marketing > Abandoned Cart Email > Abandoned Product Report

• Here listing 5 most abandoned products by time filter + group by. Each product will be shown in one specific color.

• Display information of abandoned products by time filter, sort by = Abandoned Time (number of times to be abandoned). The information includes:
  • Product Name
  • Thumbnails
  • SKU
  • Price
  • Abandoned Time: The number of the abandoned cart containing the product.
  • Qty: The total qty of the product in the abandoned cart.
  • Abandoned Revenue: the total value of the order of abandoned products.

5. Shopping Behavior Analysis

From Admin Panel, select Marketing > Abandoned Cart Email > Shopping Behavior Analysis

• Here showing the times percentage when fields were filled/updated on the checkout page before the cart was abandoned. This feature is compatible with One Step Checkout module, allowing stores to update custom fields as needed.
• Column chart: displays the % value at the beginning and inside of the column. Color is changed by different %:
  • 0-40%: displayed in red.
  • 40-70%: display yellow.
  • 70-100%: displayed in green.
• Admin can choose to hide/ show columns at each statistics table. Clicking on Hide optional fields, the popup will show all the information fields in the table along with the checkbox; Any field that is checked will be displayed, unchecked ones will not display statistics.

6. Cart Board

From the Admin Panel, select Marketing > Abandoned Cart Email > Cart Board

• Here reported all the Cart types:
  • Real-time: cart will be here if abandoned cart time is less than the time to set at How to measure Abandoned Cart field in Configuration.
  • Abandoned Cart: in contrast to the Real-time cart column, cart will be here if the abandoned cart time is greater than the time to install How to measure Abandoned Cart field in Configuration, and this column only displays cart without email.
  • Recoverable: Just like the Abandoned Cart column but it just shows the cart with email address.
  • Converted: Show the ordered cart.

7. API

• Abandoned Cart Email extension by Mageplaza supports using rest API to recover shopping cart. You can see more details here.
• Get instructions for creating Integration tokens here.

ABN AMRO

Overview

ABN AMRO is the most trusted payment service provider in the Netherlands. Mageplaza ABN Amro extension supports quick payment features that make your shopping experience safe and reliable. Mageplaza ABN AMRO extension is fully compatible with Mageplaza One Step Checkout.

How to use

1. Account registration

• ABN AMRO: to register for ABN AMRO’s account, access the following link, fill in the required information below:

• After registration is completed, the system will send a notice to your registration email

• Click on the link in the email to create a password for your account

2. Instructions to get API Key for Sandbox

• After logging in, click My Apps > Add a new App to create new apps

• Enter a name for the app and select certain app then Submit to finish creating the new app.

• Then click on your app, API Key will be shown at the Keys tab

• At API Products, click API Documentation at the App you use to get Client ID and Redirect URL

• In the Sandbox, select Access, this is the area containing the Client ID and Redirect URL for you to use in Configuration in the module

• Note: In case Environment chosen is Production, you need to send a request or contact the hosted bank ABN AMRO to provide API for you. See more details here.

3. Checkout Page

• With Sandbox mode, at checkout page, please click Get Token to select Account Number

Imgur

• In User Consent Page, seleect one Account Number then click Submit to get the token

Imgur

• A new page shown, you need to copy the token code at the end of the URL to fill in checkout page. (see the image below, the token number is on the red line)

Imgur

• Now paste the code to Consent Token at checkout page, click Place Order to complete payment.

Imgur

How to Configure

Login to the Magento Admin, choose Stores > Configuration > Sales > ABN AMRO

At ABN AMRO Payment Method, click Configure

1. Credentials

1.1. Environment = Sandbox

Admin can choose Sandbox environment to test the functions of the ABN AMRO module.

• Client ID: With Sandbox, Client ID is entered by the system and admin cannot change it.
• Sandbox API Key:
  • Copy the API Key provided at the comment below into this field.
  • If left blank or fill in incorrectly, it will not connect to ABN ARMO.
• Consent Token: Click Obtain Token beside this box to fill in.
• Sandbox Merchant Account: Admin chooses his merchant account.
• Payment Scope: Admin select payment area.
  • With SEPA: Store must use the currency of EURO to checkout.
  • With Cross Border: Allows using all currencies to checkout.
• Redirect URI: With Sandbox, Redirect URI is auto-ntered by system and admin cannot change it.
• Consent Token: Admins click to Obtain Token so the token will be auto-filled in the box. Then you should click to Check Credentials right after to verify if your all credentials are valid.

1.2. Environment = Production

When applying for online payment, the admin needs to switch the environment to Production.

• Client ID: Admin needs to contact ABN AMRO provider to get merchant Client ID.
• Public Certificate File: Admin must upload the PSD2 certificate file. See more details about PSD2 here.
• Private Key File: Admin must upload the PSD2 private key file. See more details about PSD2 here.
• Production API Key: Admin enter API key provided by ABN AMRO bank.
• Production Merchant Account: Admin enter his account from the ABN AMRO hosted bank.
• Payment Scope: Admin select payment area.
  • With SEPA: Store must use the currency of EURO to checkout.
  • With Cross Border: Allows using all currencies to checkout.
• Exchange Fee Bearer: Admin chooses who is charged for exchange fee.
• Redirect URI: Admin enter the stores’ URL to be redirected to after customers choosing their cards at ABN AMRO website. Customers can get the consent token from this URL.
• Consent Token: Admins click to Obtain Token so the token will be auto-filled in the box. Then you should click to Check Credentials right after to verify if your all credentials are valid.

2. General

• Enable: Select Yes to using the ABN AMRO payment on your store.
• Title: Set the title for this payment method at checkout page.
• Payment Action:
  • Authorize and Capture: Payment will be captured as soon as customer place orders successfully. At that moment, customer’s card will always pay for the order and invoice will be created.
  • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer’s card.
• New Order Status: Status when customer orders successfully:
  • Processing: Display status with Processing when order is successful. You can change the status in the backend with each order.
• Payment from Applicable Countries:
  • Select All Allowed Countries so the card payment method can be applied in all countries.
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to be able to use this payment method
    • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
• Minimum Order Total:
  • Enter the minimum order amount to display and apply for ABN AMRO payments.
  • If the order amount is less than the value in this field, payment methods will not be shown.
• Maximum Order Total:
  • Enter the maximum amount of order to display and apply for ABN AMRO payments.
  • If the order amount is greater than the value in this field, the payment method will not be shown.
• Sort Order:
  • Specify the display position of this payment method compared to other payment methods
  • 0 is the highest priority. Smaller numbers will be preferred to show first.

3. Admin view order

4. Admin create Credit Memo

• Admin gets the token to make a Refund.
• Note: Admin must choose a different Account Number from the Customer’s Account Number to create backend refund.

5. Customer View Order

• This section stores the payment information that the customer has ordered

6. Compatible with One Step Checkout

Admin Permissions

Overview

With Mageplaza Admin Permissions Extension, you can easily set specific permissions for each admin. The admin users can be authorized to view order list, invoice or shipment by each store. Moreover, they can be allowed to added, view, edit, delete categories, product, customer, product attribute and user role. It is also possible to authorize logging in or not to log in according to the time frames of the day and day of the week.

How to download and install

• Download Mageplaza Admin Permissions
• How to Install

How to Configure

Login to the Admin Magento, choose Stores > Configuration > Mageplaza > Admin Permissions

I. Configuration

1.General Configuration

• Enable: Select Yes to enable the extension

II. Admin Permissions

To configure User Roles, please login to Admin Magento, go to System > Permissions > User Roles > Add new role > Role Resources

You can select Actions tại Role Resources such as Create New, View, Edit, Delete for permission fields including Category, Product, Customer, Attributes, Permission.

• Tab Admin Permissions only apprears when Mageplaza Admin Permissions is turn on. This tab allows:
  • Set admin permission by Sale per Store Views.
  • Set admin permission by specific Categories
  • Set admin permission by specific Products or product creators (product owner).
  • Set admin permission by specific Customers
  • Set admin permission by certain Product Attributes
  • Set admin permission by certain User Roles
  • Set admin permission by Model/Controller with Action New, Load, Save, Delete.

1. Sales

• Enable Restriction: Allow/Disallow restriction for viewing or editing information of Sale (Order, Invoice, Shipment) by Store View.
  • Select “No” to disable restriction
  • Select Allow For Specific Stores: Admin can only view, edit information of sepcific storeviews selected below.
  • Choose Deny For Specific Stores: Admin can not view, edit information of sepcific storeviews selected below.

2. Category

2.1 Tab Role Resources

• At Role Resources tab, go to Catalog > Inventory > Categories > Actions, select permission actions you want. There are 4 permission actions as followings:
  • Create New: Select to allow admin account to create a new Category.
  • View: Admin is only allowed to view authorized Categories (at tab Admin Permissions)
  • Edit: Admin is allowed to edit authorized Category (at tab Admin Permissions). Note: You need to select View permission above to view and edit specific Category page.
  • Delete: Admin is allowed to delete authorized Categories (at tab Admin Permissions). Note:
    • You need to select View permission above to view and delete specific Category page.
    • This admin permision does not allow to delete Category Default Root

2.2 Tab Admin Permissions

• Enable Restriction: Allow/Disallow restriction for viewing or editing information of specific categories
  • Select “No” to disable restriction
  • Select Allow For Specific Stores: Admin can only view, edit information of sepcific categories selected below.
  • Choose Deny For Specific Stores: Admin can not view, edit information of sepcific categories selected below.

• Category: Select the Categories you want to allow/ restrict permissions to view, edit, delete for the admin role. Note:
• For Allow For Specific Categories: If only the Subcategory is selected but not the Root Category, the Subcategories will not be displayed. For example, if you want to set permission of viewing and editing for Category Gear, you must select both Default Category and Gear, otherwise the Gear category will not be displayed and you will not be able to access the edit page.
• With Deny For Specific Categories: If you select the Root Category, the subcategories of the Root Category above will also be restricted.

3. Product

3.1 Tab Role Resources

• At Role Resources tab, go to Catalog > Inventory > Products > Actions, select permission actions you want. There are 4 permission actions as followings:
  • Create New: Select to allow admin account to create a new product.
  • View: Admin is only allowed to view authorized products (at tab Admin Permissions)
  • Edit: Admin is allowed to edit authorized products (at tab Admin Permissions). Note: You need to select View permission above to view and edit specific product pages.
  • Delete: Admin is allowed to delete authorized products (at tab Admin Permissions). Note: You need to select View permission above to view and delete specific product pages.

3.2 Tab Admin Permissions

• Enable Restriction: Allow/Disallow restriction for viewing or editing information of specific products
  • Select “No” to disable restriction
  • Select Allow For Specific Products: Admin can only view, edit information of specific products selected below.
  • Choose Deny For Specific Products: Admin can not view, edit information of specific products selected below.

• Apply For: Set fixed products that admin accounts are permitted/ restricted to view, edit and delete. There are 4 options:
  • All: Apply permission roles to all products.
  • Specific Products: Only apply permission roles to selected products in the table.
  • Products created by this user: The Admin having permission on the Role Users tab will be allowed/ restricted to view, edit and delete products whose the Product Owner field value is their account.
  • Products created by the same-role users: Admin accounts authorized on the Role Users tab will be allowed / restricted to view, edit and delete products whose Product Owner field value is their account and accounts that are also authorized in the tab Role Users.

4. Customer

4.1 Tab Role Resources

• At Role Resources tab, go to Catalog > Customers > Actions, select permission actions you want. There are 4 permission actions as followings:
  • Create New: Select to allow admin account to create a new customers.
  • View: Admin is only allowed to view authorized customers (at tab Admin Permissions)
  • Edit: Admin is allowed to edit authorized customers (at tab Admin Permissions). Note: You need to select View permission above to view and edit specific customers pages.
  • Delete: Admin is allowed to delete authorized customers (at tab Admin Permissions). Note: You need to select View permission above to view and delete specific customers pages.

4.2 Tab Admin Permissions

• Enable Restriction: Allow/Disallow restriction for viewing or editing information of specific customers
  • Select “No” to disable restriction
  • Select Allow For Specific Customers: Admin can only view, edit information of sepcific customers selected below.
  • Choose Deny For Specific Customers: Admin can not view, edit information of sepcific customers selected below.

5. Product Attribute

5.1 Tab Role Resources

• At Role Resources tab, go to Catalog > Attributes > Products > Actions, select permission actions you want. There are 4 permission actions as followings:
  • Create New: Select to allow admin account to create a new attributes.
  • View: Admin is only allowed to view authorized attributes (at tab Admin Permissions)
  • Edit: Admin is allowed to edit authorized attributes (at tab Admin Permissions). Note: You need to select View permission above to view and edit specific attributes pages.
  • Delete: Admin is allowed to delete authorized attributes (at tab Admin Permissions). Note: You need to select View permission above to view and delete specific attributes pages.

5.2 Tab Admin Permissions

• Enable Restriction: Allow/Disallow restriction for viewing or editing information of specific attributes
  • Select “No” to disable restriction
  • Select Allow For Specific Product Attributes: Admin can only view, edit information of sepcific attributes selected below.
  • Choose Deny For Specific Product Attributes: Admin can not view, edit information of sepcific attributes selected below.

6. User Role

6.1 Tab Role Resources

• On the Role Resources tab, under System > Permissions > User Roles, select Mageplaza Admin Permissions to allow the Admin Permissions tab to be displayed with permitted admin accounts.
• At Role Resources tab, go to Catalog > Permissions > User Roles > Actions, select permission actions you want. There are 4 permission actions as followings:
  • Create New: Select to allow admin account to create a new Permissions.
  • View: Admin is only allowed to view authorized Permissions (at tab Admin Permissions)
  • Edit: Admin is allowed to edit authorized Permissions (at tab Admin Permissions). Note: You need to select View permission above to view and edit specific Permissions pages.
  • Delete: Admin is allowed to delete authorized Permissions (at tab Admin Permissions). Note: You need to select View permission above to view and delete specific Permissions pages.

6.2 Tab Admin Permissions

• Enable Restriction: Allow/Disallow restriction for viewing or editing information of specific permissions
  • Select “No” to disable restriction
  • Select Allow For Specific User Roles: Admin can only view, edit information of sepcific permissions selected below.
  • Choose Deny For Specific User Roles: Admin can not view, edit information of sepcific permissions selected below.

7. Time Valid

• Customize Limit Action on the Admin Permissions tab allows to limit the permission of admin accounts by the Model/Controller.
  • Select Enable = Yes to apply the access restriction according to Model/Controller.
  • Models/Controllers can be limited to 4 actions: New, Load, Save, Delete.
  • You can add more classes to limit by clicking the Add button in the Action column corresponding to the desired class; or use Add massaction to add multiple classes at once.
  • When you do not want to apply a limit to a certain class, you can choose Status = Disable or click Delete to completely remove the limit of that class.
  • Classes will be automatically scanned weekly. If your website has new feature updates and you want to update your Model/Controller list, you can click Rescan Classes.
  • Note: You should carefully check the class you want to limit before saving the User Role. In case you mistakenly restrict the class and you cannot access the admin page or you want to remove the class restriction but cannot access the User Role page that you saved earlier, you can run the following command to disable the feature Customize Limit Action:

php bin/magento mageplaza-adminpermissions:custom-limit:disabled

8. Time Valid

• Set the activate/inactivate time of the admin account.
• Type: Select the form of restriction for the admin user:
  • Allow: allows login.
  • Disallow: no login allowed.
  • Choose Day: Choose the days of the week when the admin is permitted to be active/inactive.
  • Apply From Date: Choose the start date of active/inactive permission for the admin account.
  • Apply To Date: Select the date of end of active/inactive permission for the admin accounts.
  • From: Choose the start time of the day that the admin is permitted to be activate/inactive
  • To: Select the end time of the day during which an admin is permitted to be active/inactive.

Note: When there are no changes in Valid time, meaning it remains as the initial default, then admins will automatically have access to your website.

III. Note for uninstalling the extension

To uninstall Mageplaza Admin Permissions Extension, first run the following command:

php bin/magento mageplaza-adminpermissions:uninstall

You then continue to uninstall the extension by following the usual steps.

Age Verification

Overview

In many countries, the law is required to apply a verification process before users can access the content of the website or if the website you are selling has products that are only suitable for certain ages. You want to limit it. With Mageplaza Age Verification extension, you will be able to confirm the age of your customers and grant access to the site only after age verification. And in particular, you can configure the content design for popup to validate the age to improve efficiency and fully capture customer information.

How to download and install

• Download Mageplaza Age Verification
• How to Install

How to use

• Display popup to verify age when clicking on Add to cart button or when accessing to the specific pages in which acquire age verification

  • Checkbox Type:

  

  • Input DOB Type:

  

  • Yes/No Type:

  

How to configure

1. Configuration

Login to the Admin Magento, choose Stores> Configuration> Age Verification.

1.1. General

• Enable: Select “Yes” to turn on the Module.
• Verification Age:
  • Enter the age number to limit website access
  • This is a required field. If you enter the letter, it will display an error message (only number allowed).
• Enable Term & Condition: Select Yes to turn on the display of Term & Condition notifications as a checkbox as I agree with the terms and conditions.
• Link Title: Enter a name to notify Term & Condition. For example: “I agree with the”
• Anchor Text: Enter a click name that will display the information you want to convey to your customers. Example: Term & Condition
• Anchor URL: Enter the page link so that clicking on the name you just entered in the Anchor Text field will redirect to the page you want.

• Cookie life-time:
  • Enter the number of days to save the cookie and apply this period for age verification. When the time runs out, the age verification applied for certain pages will be disabled then. Also, cookie will not save the data for underage verification.
  • If left blank, default period is 365 days.
• Apply for Customer Group (s): Select the Customer Groups group to apply Age Verification. You can select multiple customer groups at once. Customer groups not selected will not be applied Age Verification
• Auto Verify Age If customer has DOB: Select Yes to automatically verify age if the customer has a DOB when they logged in. If No is selected, it will display the popup to Age Verification even if the customer is logged in. For example: In case the customer has registered an account that has updated their date of birth and if the age is enough to access the website, it will automatically verify the age and vice versa if not old enough, it will automatically redirect to targeted pages you choose.
• Re-direct URL:
  • Enter the url to redirect the cútomers to the selected url if they are under age required
  • This is a required field. If you enter false Url, the message is displayed `Please enter a valid URL. Protocol is required (http: //, https: // or ftp: //).”

1.2. Page Verify Configuration

• Apply for:
  • Select the page you want to require Age Verification. You can choose to apply multiple pages at once. Sites not selected will not require Age Verification.
  • You can leave this field blank.
  • Note: With checkout page including default checkout page and checkout page which are compatible with One Step Checkout, you can install One Step Checkout extension to make payment steps more convenient and faster.
• Apply for CMS Page:
  • Select the CMS page you want to apply Age Verification. You can choose to apply multiple CMS pages at the same time. The CMS pages not selected will not require Age Verification.
  • You can leave this field blank.
• Apply for Category Pages:
  • Select Category Pages to apply the Age Verification. Verification popup will be shown when visitors access these category pages. You can select all or multiple category pages at once. Non-selected category pages will not require Age Verification.
    • Note: Enable the field Apply for Category Pages doesn’t mean that all products included in that category are applicable with verification popup. To apply Age Verification for specific products, you can configure at Apply for Product Detail Page(s).
  • You can leave this field blank.
  • Compatible with Mageplaza Product Labels to add Age Verify label for product

• Apply for Product Detail Page(s):
  • Select Yes to show another field to apply Age Verification on the Product Detail Page. Those products that are satisfied will be applied to age verification. If this field is left blank, it will auto-apply age verification for all product detail pages.
  • Select No: Not apply Popup of Age verification for any Product Detail Page.
• Include Custom Page: Enter the Url path which must be separated by a / in the field. Apply Age Verification to all pages with the url selected. For example: / blog, / men / top / t-shirt, …
• Exclude Custom Page:
  • Enter the Url path which must be separated by a / in the field. Apply Age Verification with all pages except the url selected.
  • This field is the highest priority for applying age verification
  • Note: If the rule belongs to both Include Custom Page and Exclude Custom Page, then Age Verification will not be applied.

1.3. Purchase Verify Configuration

• Select Product Condition:

  • Select Yes to show another field to choose the condition for age verification on the product detail page. Those products that are satisfied will be applied age verification. If this field is left blank, it will auto-apply age verification for all product detail pages and other pages when clicking Add to cart
  • Select No, not apply age verification when clicking Add to cart for all pages
  • If the Product condition belongs to both the Page Verify Configuration and Purchase Verify Configuration, it is preferable to consider the Product condition in the Purchase Verify Configuration first.

• Age Notice: Select the type of age notice which is displayed in Product Detail Page with the products requiring age verification when clicking Add to cart

  • Small Image: Apply Purchase Verify Configuration with Small image. Show a Notice Image field.

    • Notice Image: click Choose file to upload the Image. Display the image at the top left of the page. If left blank, default image will be used

    

  • Notice Message: Apply the Purchase Verify Configuration to the Notice Message. Show a Notice Message field.

    • Notice Message: Enter the age notification in the Notice Message field. If left blank, the default is “You must verify your age to buy this product.”

1.4. Design

• Checkbox Type:

  

• Input DOB Type:

  

• Yes/No Type:

  

• Icon: click Choose file button to upload image. This icon is shown at the top of the popup. If left blank, the system will use the default image.

• Title: Enter popup name at the top. If left blank, the default name is AGE VERIFICATION.

• Description: Enter the popup description which is shown under the icon. If left blank, it will default to the number of ages set at the Verification Age field, for example, You must be older than 18 years old to enter this page.

• Confirm button label: Enter the name of the button to Confirm the information added by visitors. If left blank, default label is Enter.

• Cancel button label: Enter the button name for Cancel the age verification filling by visitors. If left blank, default label is Cancel.

• Header Background Color: Choose the color for Header Background on popup.

• Body Background Color: Choose the color for Body Background on popup.

• Button Color: Choose the color for Button at popup.

• Text Color: Choose text color shown at popup.

2. Rest API

Mageplaza Age Verification supports Rest API to get data of Age Varification. You can view and manage information of the extension. View details here

View Guidlines to create Integration tokens here.

Banner Slider

Overview

Magento 2 Banner Slider is a powerful marketing tool that helps you create banner sliders with nice effects. Thanks to Mageplaza Banner Slider, you can customize the banners and sliders as you expect. Admins can easily choose the right place to display your desired banner, which can attract more eye-catching customers and encourage them to view banners as well as get the information you want to share.

Magento 2 Banner Slider Extension supports you to create carousel image slider, image scroll and LightBox video. Also, this extension also supports images. It’s completely responsive on iPhone, iPad, Android, Firefox, Chrome, Safari, Opera and Internet Explorer.

How to configure

1. Configuration

Login to the Magento Admin, choose Store > Configuration > Mageplaza > Banner Sliders

1.1. General

• Enable: Choose Yes to enable this module or choose No to disable it.

1.2. Slider Design Configuration

• Responsive:

  • Choose “No” so that the number of banners displaying on the browser is default (1 banner)

  

  • Select “Yes” so that the number of banners displaying on the sliders can be changed. You can change the Screen size from and Number of items in the Max Items slider field. For example: Screen size max = 1000, Number of item is 3, the user interface will look like this:

  

• Auto Width: Choose “Yes” to use Auto Width

Note: Use width style on elements to get the result you want. If using with infinity loop, add option ‘items’ more than 1. It all depends on the width of your content.

• Auto Height: Choose “Yes” to use Auto Height

• Infinity Loop: Choose “Yes” to re-display sliders after it show in the last item.

• Show Next/Pre buttons:

  • You can choose Yes to show Next/Pre buttons on the user interface when you ant to view the detail product
  • When you click on Next/Pre button, the slider will move the product to be left or right.

  

• Show Dots Navigation: Can choose “Yes” in this field to display the dot that represents for the page number of the sliders.

• Lazy Load Images: Set “Yes” so that Lazy load is displayed when loading images.
• Autoplay: Select “Yes” so that the products on the slider will automatically move to the left for a certain time when installed in the Autoplay TimeOut. The Autoplay TimeOut field will be displayed.

• Autoplay TimeOut: Set the speed at which the product moves to the left.

2. Manage Banner

How to Create New Banner

From the Admin Panel, go to Content > Banner Sliders > Manage Banners, choose Add New button in the right corner

Banner Information

• Enable: Enter a name for Banner. It helps to distinguish from other products.

• Status: Select “Enable” so that the banner works

• Type: Choose the type of banner you want to display:

  • Type = Image: This will display more fields:
    • Upload Image: Click “+” button to upload Image for the banner.
    • Banner title: Fill the title for the banner that will be displayed on the user interface.
    • URL: Enter Url for the banner that will show in the address bar when clicking on banner.
  • Type = advanced: This will show the toolbar so that you can edit the banner image. In this section, you can upload more banners at the same time. Show more Demo template field and choose the demo template as the following:
    • Demo Template 1:

  

  • Demo Template 2:

  

  • Demo Template 3:

  

  • Demo Template 4:

  

  • Demo Template 5:

  

Note:

• Click Load Template button to show the template image
• Choose Show/Hide Editor to display the code or the image of the template
• Insert Image: Ability to add more images for the banner and add more images at the same time. You should add the image when moving Show/Hide Editor into the code format so that it’s convenient and avoids occurring the error.
• Open new tab after click:
  • Select “Yes” so when you click on the banner, it will display a new tab to view the banner information that you want to advertise.
  • Selecting “No”, it will automatically re-upload the page when you want to view the banner information.
• Slider: Select the slider you want the banner to display there.

3. Manage Slider

How to Create New Slider

From the Admin Panel, go to Content > Banner Sliders > Manage Slider, choose Add New button in the right corner

3.1. General

3.1.1. Slider Information

• Name: The name of the slider filled in this section is only displayed in the backend. It helps distinguish from other products.
• Status: Select “Enable” to use the Slider. It helps to view the banner in the most convenient way.
• Position: Select the position to appear the sliders on the user interface.

• Store View: Select the Store View where the Slider is displayed. With unselected store views, the slider will not appear.
• Customer Groups: The slider is only visible on selected customer groups.
• Active from: Allows you to set the start date using Slider. Sliders will not appear on the user interface if the date is not displayed.
• Active to: Allows setting the end date for which the Slider is used. After this date, the slider will be hidden from the user interface.
• Priority:   - Enter the priority for Sliders.
  • The sliders have the smaller priority number, the priority is higher

3.1.2. Snippet code

In this section, for each slider, you can use Widgets to choose the diplay position that you want.

3.2. Banner

This section will record all information of the banner that you have created as Banner, Status, Type, etc. You can choose any banner you want to show on the sliders

3.3. Design

• Annimation Effect: Choose the effect to show on the sliders

• No:

• FadeOut:

• RotateOut:

• FlipOut:

• RollOut:

• ZoomOut:

• SlideOutLeft:

• SlideOutRight

• LightSpeedOut:

• Manually Design: Select the data that is designed from:
  • Select Use config: It will hide the fields below and retrieve the data from the configuration
  • Select “Yes” to display the design for the Sliders. This section allows you to customize your slider’s design. These design functions correspond to the design in Slider Design Configuration, you can refer to our instructions above.

4. Widget

In addition to your existing location, you can let Banner Slider appear anywhere you want. To create a widget, you need to perform the following steps:

• Step 1: From the Admin panel, go to Content > Elements > Widgets, choose Add Widget
• Step 2: Settings > Type =Banner Slider widget, Design Theme = Magento Luma. Click Continue button to move the next step

• Step 3: Enter the required information in the Storefront Properties

• Step 4: Choose the position to display the widget

• Step 5: Choose the slider that you want to show

• Step 6: Save the information and check on the user interface

Backend Tools

Introduction

Magento 2 Backend Tools offer a range of backend management solutions that helps store admins get access to the customer account easily, reindex the backend and flush cache quickly, without any complex technical knowledge. These functionalities help merchants highly reduce their workload and enhance users’ experience in the backend.

How to configure

1. Configuration

Login to Magento Admin, then go to Stores > Configuration > Mageplaza > Backend Tools

• Enable Login as Customer:
  • Select Yes to enable the module, admin can login to customers’ accounts from backend
  • Display the button Login as Customer on Customer Edit and Order View page in the backend

• Enable Quick Flush Cache:
  • Yes (Automatic): automatically clear cache when admin saves information: product, configuration, etc. at backend. After saving the information configured, always notice that the cache was successfully flushed.

• Yes (Manual): Show a message after saving configuration. Instead of clicking Cache Management to move to the Flush Magento Cache, now you only need to click Flush Now link and wait for a few seconds, the cache will be cleared.

• No: Disable auto-flushing cache and keep displaying default Magento’s Flush Cache request message.

• Enable Quick Reindex:
  • Select Yes to automatically reindex by clicking Reindex Now

• After the reindex is completed, you will receive a notification

2. Login as Customer Logs

From Admin panel, go to Report > Customer > Login as Customer Logs

• This allows recording all login transactions as customers of any admin at backend.
• Admin cannot delete or edit the Log
• Admin only can export the specific logs that they want in CSV or XML forms.

3. Index Management

From Admin panel, go to System > Index Management

3.1. Reindex one indexer:

At the Action box, click on Reindex Data to reindex each indexer separately.

3.2. Reindex some indexers:

• Click to select the indexers you need to reindex
• Select Reindex Data
• Click Submit

3.3. Reindex all the indexers

• Click on Mass Actions box, choose Select All
• Select Reindex Data
• Click Submit

3.4. User roles with reindex

Step 1: Go to Admin > System > User role

Step 2: Add a new role resource

Fill in role information at Role Information section

Select index management role at Role Resources section, then click on Save Role

Step 3: Set role users for admin accounts, then click on Save Role to finish.

Barcode

Overview

With Mageplaza Barcode Extension, admin can easily create barcode to manage products in store easily. This extension supports automatically generating barcode with 18 different barcode encryption types. Admin can also design barcode labels, preview before printing and print multiple barcodes for many products at the same time.

How to download and install

• Download Mageplaza Barcode
• How to Install

How to Use

With Barcode extension, admin can perform the following actions:

Automatically generate barcode with the preselected template

Select Product Attribute for barcode printing

Product Attribute = Mageplaza Barcode

Product Attribute = SKU

Product Attribute = Product Name

Design barcode:

Choose Barcode Type, Label Content and Printing Paper by the available templates.

Preview barcode before printing

Print multiple labels of multiple products

How to Configure

From the Admin panel, go to Stores > Settings > Configuration > Mageplaza > Barcode

1. Configuration

1.1. General Configuration

• Enable: Select Yes to activate extension
• Attribute for Barcode: Select the coded attribute to scan barcode. For example: Attribute for Barcode = SKU, module then will use the product SKU to encode into barcode. When scanning the barcode, we get the SKU of the product.
• Barcode number template: Sample format to generate barcode codes, Example: MPBC-[4AN]-[3A]-[5N] => The generated barcode may be MPBC-J34T-OEC-54354
• Auto generate barcode: Click Run to automatically generate barcode for Product without barcode. If you want to create a barcode for a product which has barcode before, please tick Regenerate?. And Save Config before Run. To create barcode faster, you can use this command php bin/magento mpbarcode: autogen command

1.2. Barcode Design

• Barcode Type: Choose the type of encryption code barcode. Currently, the module supports 18 different encryption types.

1.2.1 Printing Paper

• Paper Template: Choose to use the template for available print paper or you can customize the paper size
• Paper Size: Select the paper size to print barcode labels. The paper size will default to the template available in the Paper Template field or edit it when the Paper Template field selects Custom.
• Barcode Label Width: Calculated in Inches. The length setting of a barcode label will appear on the paper. Self-recognition by template or editable.
• Barcode Label Height: Calculated in Inch. The width setting of a barcode label will be displayed on the paper. Self-recognition by template or editable.
• Barcode Label Padding: Calculated in Inches. Set the distance between the barcode labels on a printed paper. Self-recognition by template or editable.
• Paper Margin: Calculated in Millimeter. Set alignment for barcode paper when printing. The order of the upper, right, lower and left margins is separated by a comma.
• Vertical Spacing: Calculated in Millimeter. Set the distance between two barcode labels on the same column (vertically).
• Horizontal Spacing: Calculated in Millimeter. Set the distance between two barcode labels on the same row (horizontally).
• Paper Orientation: Choose a layout method. There are 2 options: Portrait (vertical) and Landscape (horizontal).
• Preview Paper Template: Clicking on this button will display the paper preview that will be printed when the above settings are satisfied.

1.2.2 Label Content

• Logo: Admin can upload the logo/ image you want to display on the barcode label
• Barcode Label Template: choose the template displayed for barcode labels. There are 4 types of templates:

Type 1: Classic 1

Type 2: Classic 2

Type 3: Standard

Type 4: Standard with QR code

• Load Template: After selecting one of the 4 types of templates above, click Load template, the value of the setting fields for the paper will automatically be filled.
• Barcode Width: in Inches. Set the length of the barcode code displayed on a barcode label. Self-recognition by template or editable.
• Barcode Height: in Inch. Set the width of the barcode displayed on a barcode label. Self-recognition by template or editable.
• QR Code Size: in Inches. Set the length/ width of the QR Code displayed on a barcode label. This field is only displayed when the template is selected with Standard with QR code. Self-recognition by template or editable.

• Barcode Label Content: Install content on barcode labels. Support variables can be used to display content such as barcode, barcode content after scanning, product name, SKU, product price, QR code, logo and some other attributes of the product. With the variable {{logo_url}}, you must use the <img> tag to display the selected logo image in the above field: <img src = "{{logo_url}}" alt = "logo"> With variable {{attribute_code}}, you must replace the attribute_code with the code of the attribute you want to display. You can go to Store > Attributes > Product to get the value in the Attribute Code field

• For example: You want to display Activity and Color Attribute, write more:

<div class = "attribute-code">
        <div>
            Activities: {{activity}}
        </div>
        <div>
            Color: {{color}}
        </div>
</div>

Then, your barcode label printed will contain information about the Activity and Color of the product.

• Barcode Label CSS: Display settings (font, color, format) for content on barcode labels.
• Preview Barcode Label: Click this button to see the preview of the barcode label according to the settings above.

1.3. Print Sample File

• Print Sample: Click on the button to print the barcode labels on 1 paper according to the above settings.
• Note: Must Save Config before clicking Print to make sure the printout will print the latest installation correctly.

2. Print Barcode

• To print barcode, we can use 2 ways:
  • Print barcode for each product by clicking the Print Barcode button at their edit page
  • Print for multiple products at the Product Grid page using Mass action Print Barcode Label.

After clicking print, the popup will appear for admin to install barcode printing.

• In Popup:
  • At Qty field, admin select the number of barcode to print it out
  • Admin can reselect the barcode and paper configuration again. Unless you can choose Use Config Settings to use the preset information in Configuration before
  • Admin can also preview the barcode label and paper before printing by clicking to Preview Print Paper Type.

1.2.1 Label Content

Logo: Admin can upload the logo/ image you want to display on the barcode label Barcode Label Template: choose the template displayed for barcode labels. There are 4 types of templates:

Type 1: Classic 1

Type 2: Classic 2

Type 3: Standard

Type 4: Standard with QR code

• Load Template: After selecting one of the 4 types of templates above, click Load template, the value of the setting fields for the paper will automatically be filled.
• Barcode Width: in Inches. Set the length of the barcode code displayed on a barcode label. Self-recognition by template or editable.
• Barcode Height: in Inch. Set the width of the barcode displayed on a barcode label. Self-recognition by template or editable.
• QR Code Size: in Inches. Set the length/ width of the QR Code displayed on a barcode label. This field is only displayed when the template is selected with Standard with QR code. Self-recognition by template or editable.

• Barcode Label Content: Install content on barcode labels. Support variables can be used to display content such as barcode, barcode content after scanning, product name, SKU, product price, QR code, logo and some other attributes of the product. With the variable {{logo_url}}, you must use the <img> tag to display the selected logo image in the above field: <img src = "{{logo_url}}" alt = "logo"> With variable {{attribute_code}}, you must replace the attribute_code with the code of the attribute you want to display. You can go to Store > Attributes > Product to get the value in the Attribute Code field

• For example: You want to display Activity and Color Attribute, write more:

<div class = "attribute-code">
        <div>
            Activities: {{activity}}
        </div>
        <div>
            Color: {{color}}
        </div>
</div>

Then, your barcode label printed will contain information about the Activity and Color of the product.

• Barcode CSS: Display settings (font, color, format) for content on barcode labels.
• Preview Barcode Label Content: Click this button to see the preview of the barcode label according to the settings above.

3. Print Barcode with Import CSV

By 2 ways to print the barcode above, you can only print the same number of barcode for each product in one time. Printing barcode with Import CSV file allows printing multiple barcodes, each barcode has different number.

Visit the Product Grids page, click the Import Barcode button. This will display the popup Print Import Barcode Label.

• Here, you only need to import the CSV file with the SKU and the number of barcode labels you want to print accordingly. Click Check and Show to check the CSV file imported and display the list of products that want to print barcode.
• At Grid,it displays the list of products that can print barcode, you can change the number of barcode you want to print by checking the checkbox before the product name and changing the quantity at the Quantity column.
• After checking products and the number of barcode labels you want to print, click Print button.

4. Import Barcode with CSV

Step 1: Prepare data

Login to the Magento Admin, choose System > Import

In the Import Settings section, select Entity Type = “Mageplaza Barcode” and click Download Sample File to download the file. We support the CSV file can be imported.

Check that the input file size which must not exceed the limit shown in the message is 2M or 5M.

Edit the information you want to import in the template file:

Step 2: Configure Import Behavior

• In the Import Behavior section,
  • Select the action relating to importing data in the Import Behavior field:
    • Add/ Update: For the products in the csv file, only the new add barcode for the product has no barcode before.
    • Replace: Replace the whole barcodes for all products in the csv file whether or not it has a barcode.
    • Delete: Delete the barcode of all the products listed in the csv file.
  • Option Stop on Error or Skip Error Entries are used to stop import when you get an error or ignore the error to continue importing.
• Next, in the Allowed Errors Count field, enter the error limit to pause the import process. The default value is 10.
• Field separator: Enter a separator to separate the field in the column. Default value is a comma (,)
• Multiple value separator: Enter the separator to separate multiple values in the cell of 1 column. Default value is a comma (,)
  • Note: In a CSV file, comma is the default separator. To use a different character, make sure that the data in the CSV file matches the character you choose.
• Two fields Empty attribute value constant and Field Enclosure are in default value so that you do not need to change them.

Step 3: Select File to Import

• In the Select File to Import section, click Choose File to choose the file to import your categories.
  • Note: If Entity File = “Mageplaza Categories Import” then your input file must match the fields inside and the file format must be CSV.

Step 4: Check data and finish importing

• After entering the above information, click Check Data at the top right to check if the data you entered is correct.

  • If the file is valid, click Import is displayed in the Validation Results section.

  

  • Otherwise, if the upload file is invalid or your process is wrong, please correct the error reported in the message and try again.
  • Examples of displaying error messages when entering data incorrectly:

  

• When the import process is complete, the system displays successful importing message.

Barclaycard

Overview

Barclays is the UK’s most trusted multinational banking and financial services company headquartered in London. Mageplaza Barclaycard extension will help you use Barclays to support online payment by card. Your customers can pay by Visa, Mastercard, Maestro, Amex Credit by default and can pay with Diners Club and JCB after being activated by Barclays. Mageplaza Barclaycard extension is fully compatible with Mageplaza One Step Checkout.

How to use

1. Account registration instructions

• Barclaycard: to register for a Barclaycard account, access the this link, complete the required information below:

• After registration, the system will send password information via email that you have registered.

• Open your registration email and get the login password information

• Access the this link to Login

• Barclaycard’s interface after successful login

2. Hash algorithm

Hash algorithm needs to be same with Hash algorithm in barclay.

At the Barclaycard interface, click Configuration > Technical information > Global security parameters.

3. Instructions for getting User ID, e-Commerce SHA-in pass phrase, e-Commerce SHA-out pass phrase

• The user ID corresponds to the PSPID you used to log in
• To get the e-Commerce SHA-in pass phrase, at the Barclaycard interface, click Configuration > Technical Information > Data and origin verification.

• To get the e-Commerce SHA-out pass phrase key, at the Barclaycard interface, click Configuration > Technical Information > Transaction feedback. You go to Security for request parameters to get the key.

• Click Configuration > Technical Information > Transaction feedback, at HTTP redirection in the browser. Select the checkbox below to get feedback parameters of the transaction on the URL when redirecting.

4. Instructions for getting API User ID, API User Password, DirectLink SHA-in pass phrase, 3D Secure

• API User ID / API User Password: You need to create user for direct link method.
• At the interface of Barclaycard, click Configuration > Users > New User
• In Create user form, after filling out your information, click Related FAQ then click Create button.

• To get the DirectLink SHA-in pass phrase, at the Barclaycard interface, click Configuration > Technical Information > Data and origin verification.

• To display authentication with 3D Secure, at the Barclaycard interface, click Advanced > Fraud detection

• Click on Edit at Credit Card to configure 3D Secure for the card. After configuration is complete, click Submit

5. Checkout page

Checkout page: choose a payment method with Barclaycard. Fill out the credit card information including: Credit Card Number, Expiration Date, Card Verification Number. Including 2 payment methods of Barclaycard: Barclaycard ePDQ e-Commerce, Barclaycard ePDQ DirectLink.

Barclaycard ePDQ e-Commerce

Barclaycard ePDQ DirectLink

• You can check the checkout process with the following Cards:

Use any of the card details below to process your test transactions. There may be scenarios where you need to perform different testing depending on the country of issue of a certain card scheme. To that end, we have provided both UK and international maestro test card numbers.

 

Credit Card	Number
Amex Credit	374691000000004, 374691000000012
Maestro	675914000000000004, 675914000000000012
Maestro (International)	679999000000000004, 679999000000000012
Mastercard Credit	5101110000000020
Mastercard Debit	5573750000000022
UK Visa Electron	4001150000000012, 4001150000000038
Visa Credit	4008800000000007, 4008800000000015
Visa Debit	4094000000000017, 4094000000000025

• You can check the checkout process using 3D Secure with the following cards:

 

Description	VISA	MASTERCARD	AMEX
Authentication/ Account Verification Successful	4874970686672022 4012007153923001	5130257474533310 5200003143732874	379764422997381 378069803818698
Not Authenticated /Account Not Verified; Transaction denied	4253955490718757 4012007161850527	5199768787888942 5200006177946005	374706031281041 346455459929781
Authentication/ Account Verification Could Not Be Performed; Technical or other problem.	4282713011953451	5148904639667695	371674415569022
Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided.	4839645466321180	5168693992589936	379943305931143
Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and request that authorisation not be attempted	4450022237973103	5144144373781246	376632086941180

To find out more cases, please visit here

How to Configure

Login to the Magento Admin, choose Stores > Configuration > Sale > Payment Methods

At Barclaycard Payment Method, click Configure

1.Credentials

At Barcylaycard click Configure > Credentials:

• Environment:
  • Admin can choose Sandbox environment to check the payment features of the methods.
  • When applying for online payment, the admin needs to switch the environment to Production.
• PSPID:
  • Copy the above PSPID and paste it here.
  • If left blank or entered incorrectly, the payment method will not be connected.
• Hash Algorithm: Depends on your choice in the Configuration Barclaycard above
• User ID:
  • Copy the User ID above and paste it here.
  • If left blank or entered incorrectly, the payment method will not be connected.
• e-Commerce SHA-in pass Phrase:
  • Copy the e-Commerce SHA-in pass Phrase got above into this field.
  • If left blank or entered incorrectly, the payment method will not be connected.
• e-Commerce SHA-out pass Phrase:
  • Copy the e-Commerce SHA-out pass Phrase got above into this field.
  • If left blank or entered incorrectly, the payment method will not be connected.
• User ID API:
  • Copy the API User ID above and paste it here.
  • If left blank or entered incorrectly, the payment method will not be connected.
• API User Password:
  • Copy API User Password above and paste it here.
  • If left blank or entered incorrectly, the payment method will not be connected.
• DirectLink SHA-in pass Phrase:
  • Copy the DirectLink SHA-in pass Phrase above and paste it here.
  • If left blank or entered incorrectly, the payment method will not be connected.

2. Barclaycard ePDQ e-Commerce

• Enable: Select Yes to using the Barclaycard ePDQ e-Commerce payment feature.
• Language Code: Select the language of the Barclaycard payment page that is redirected to after customer place order at store checkout page.
• Title: Set the title for this payment method at checkout page.
• Payment Action:
  • Authorize and Capture: Payment will be captured as soon as customer place orders successfully. At that moment, customer’s card will always pay for the order and invoice will be created.
  • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer’s card.
• New Order Status: Select status when customer orders successfully:
  • Processing: Display status with Processing when order is successful. You can change the status in the backend with each order.
  • Suspected Fraud: Displays status with Suspected Fraud when order is successful. You can change the status in the backend with each order. With this status admin can accept payment or reject payment and then transfer status to Processing.
• Card Types:
  • Choose 1 or more cards to be used with this payment method.
  • Cards will be verified when customer completes card number when checking out. For cards not selected in this section, there will be invalid notice shown for customers. For cards that are not selected, they will not appear in Checkout page.
• Accepted Currencies: Admin can choose which currencies on the website are allowed to use this payment method
• Payment from Applicable Countries:
  • Select All Allowed Countries so the card payment method can be applied in all countries.
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to be able to use this payment method
    • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
• Show Logo: Click Choose File to download the logo for the payment method on the Checkout page.
• Minimum Order Total:
  • Enter the minimum order amount to display and apply for Barclaycard ePDQ e-Commerce payments.
  • If the order amount is less than the value in this field, payment methods will not be shown.
• Maximum Order Total:
  • Enter the maximum amount of order to display and apply for Barclaycard ePDQ e-Commerce payments.
  • If the order amount is greater than the value in this field, the payment method will not be shown.
• Debug Mode:
  • If Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Specify the display position of this payment method compared to other payment methods
  • 0 is the highest priority. Smaller numbers will be preferred to show first.

3. Barclaycard ePDQ DirectLink

• Enable: Select Yes to using the Barclaycard ePDQ e-Commerce payment feature.
• Title: Set the title for this payment method at checkout page.
• Payment Action:
  • Authorize and Capture: Payment will be captured as soon as customer place orders successfully. At that moment, customer’s card will always pay for the order and invoice will be created.
  • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer’s card.
• New Order Status: Select status when customer orders successfully:
  • Processing: Display status with Processing when order is successful. You can change the status in the backend with each order.
  • Suspected Fraud: Displays status with Suspected Fraud when order is successful. You can change the status in the backend with each order. With this status admin can accept payment or reject payment and then transfer status to Processing.
• Card Types:
  • Choose 1 or more cards to be used with this payment method.
  • Cards will be verified when customer completes card number when checking out. For cards not selected in this section, there will be invalid notice shown for customers. For cards that are not selected, they will not appear in Checkout page.
• 3D Secure: Select Yes to apply 3D Secure for card verification each time customers checkout.

• Enable Admin Order (MOTO): Select Yes to allow admin to create order at backend
• Accepted Currencies: Admin can choose which currencies on the website are allowed to use this payment method
• Payment from Applicable Countries:
  • Select All Allowed Countries so the card payment method can be applied in all countries.
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to be able to use this payment method
    • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
• Show Logo: Click Choose File to download the logo for the payment method on the Checkout page.
• Minimum Order Total:
  • Enter the minimum order amount to display and apply Barclaycard ePDQ DirectLink payments.
  • If the order amount is less than the value in this field, payment methods will not be shown.
• Maximum Order Total:
  • Enter the maximum amount of order to display and apply Barclaycard ePDQ DirectLink payments.
  • If the order amount is greater than the value in this field, the payment method will not be shown.
• Debug Mode:
  • If Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Specify the display position of this payment method compared to other payment methods
  • 0 is the highest priority. Smaller numbers will be preferred to show first.

4. Admin Order

4.1. Admin Order

Admin can crrate order using Barclaycard ePDQ DirectLink payment method

4.2. Admin View Order

This section at backend records the Credit Card information (Barclaycard) that customers have ordered and paid:

5. Customer View Order

This section at fontend saves card information that customers have ordered:

6. Compatible with One Step Checkout

Better Coupon

Overview

Let’s picture this scenario: Store owners desire to generate a one-time use coupon for a customer, but it takes at least 5 minutes to make it manually? Or take another look at this case: the coupon codes generated in Magento 2 do not with the current discount program, either they can’t import their pre-made coupon codes into Magento 2 system. Time-consuming tasks are coming up more, you have no idea how to give the applied coupon checkout link to customers so that they don’t need to ask and enter the coupon every time they come to your store?

All disturbing issues now can be remedied by only one proficient plugin. Magento 2 Better Coupon extension, supplied by Mageplaza, is designed to craft many coupons and send them over customers via emails just by one click. And the configurations cannot be easier if you can follow this documentation carefully.

How to download and install

• Download Mageplaza Better Coupon
• How to Install

How to configure

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions: Better Coupon

I. Configuration

1.1. General configuration

After entering the module’s configuration, you will find the General configuration to turn the module on/off generally.

• Choose “Yes” to enable the Better Coupon extension.
• If you choose “No”, you will be able to generate and send coupon(s) by Generator.

1.2. Generate Coupon

1.2.1. Generator

• In the Rule field:
  • Choose the rule you want to apply for the coupon generator (Rule can be created from Marketing > Promotions > Cart Price Rules)
  • All generated coupons by this module will follow this choosen rule.
• In the Qty field:
  • Enter the quantity of coupon code you want to generate.
  • If you leave it blank or enter 0, the default quantity will be 1.
• In the Coupon Code Pattern field: Enter your favorable pattern for coupon code(s).
• In the Send Email field: Select “Yes” to activate sending coupon(s) via email.
• In the Send Email From field:
  • Choose the store you want to send coupon code(s) from.
  • Store’s name will be displayed in the email sending to the customer.
• In the Email Address field:
  • Enter email(s) you want to send coupon code(s).
  • You can enter multiple emails seperated with a commas ,
  • All generated coupons by this module will be sent to entered email(s), so remember to change them every time you generate a new series of coupon codes for different customers.
• In the Email Template field:
  • Choose the template for the sending email.
  • You can edit/customize the email content at Marketing > Email Template.
• The Generate button:
  • Clicking on this button to generate and send configured coupon code(s).
  • The number of success generated coupon code(s) will be informed after clicking.

This is an example of the email for informing generated coupon code(s).

1.2.2. Quick Coupon Link Generator

• At the Pattern column:
  • Follow this rule to create a pattern: [4A] - 4 alpha, [4N] - 4 numeric, [4AN] - 4 alphanumeric. For example: GIFT-[4AN]-[3A]-[5N] => GIFT-J34T-OEC-54354.
  • If you leave the field blank, the default coupon code pattern will be [12AN]. If the coupon link has default pattern, coupon code(s) will be generated automatically when they reload the link.
  • You can enter a pattern optionally. A new coupon will be generated automatically when you reload the link which has that optional pattern coupon. If you enter the coupon code in this field, the coupon link will be generated only that code.
• At the Access Key column:
  • You can look at the access key dislaying at URL to learn which rule it belongs to.
  • Access Key will be generated randomly. Once the key is changed, that coupon link isn’t valid anymore.
• At the Action column:
  • Copy and load the link, there will be inform message when the coupon code has been generated successfully. Give this coupon to customer for the checkout process.
  • Otherwise, store ownners can insert this /email/{email} variable into the URL, copy and send the link to customers via email. For example: http://mageplaza.com/mpcoupon/generate/index/key/o1qwunlj94zy74z0kri/email/mageplaza.test@gmail.com
• At the Delete column: Clicking on the bin icon to delete that coupon link.

Note: Every time the quick coupon link is rereshed, a new coupon code is generated automatically. If your customers have this link, they will always have different coupon codes to use (or at least until that coupon code validation is expired) so we would highly recommend that the quick coupon link should be shared for internal use only.

1.3. Coupon link builder

• In the URL field: Enter the URL which can be accessed and used to have coupon codes auto-applied by customers.
• In the URL Style field: There are 2 available options
  • Parameter: The URL will look like http://example.com/?c=123
  • Hash: The URL will look like: http://example.com#c=123
• In the Prefix field:
  • You can enter a prefix optionally
  • Don’t forget saving config and clear cache after changing prefix. Othewise, the coupon link cannot be valid.
• In the Coupon field: Enter the coupon code you have created in Generator or from Marketing > Promotions > Cart Price Rules.
• Generate button: Click to generate the coupon link that when customers access the link, coupon code is applied to the order total already, they don’t need to re-enter the coupon again.

II. Import Coupon Code

From the Admin Panel, go to Marketing > Promotions > Cart Price Rules > Add New Rule

2.1. Import by CSV file

You can import a CSV file type which contains coupon code in this section. After selecting and importing the file, coupon code will be added in Manage Coupon Code.

2.2. Import by Text Area

Similar to Importing by CSV file, coupon codes after being imported can be used normally in Manage Coupon Code as well.

• If you do not know how to create a coupon code list in a CSV file, you can click on the Download Sample File link to download the sample file.
• Coupons that are entered in the Coupons field or available coupons in the CSV file must be separated by a break line or a commas.
• Whereas the current imported coupon list contains some coupon codes identical to the coupon previously created, duplicated codes will not be added anymore and there will be a message telling the store owner how many coupon codes have been coincident.

III. API Integration

Better Coupon extention supports API Integration which means store owners can generate coupon code(s) via Magento 2’s API by following this syntax domain.com/rest/V1/bettercoupon/rule/id. For example:

domain.com/rest/V1/mpcoupon/generate/{key}

For example:

http://mageplaza.com/rest/V1/mpcoupon/generate/ixolofk9q8f4slxggq.

The created coupon link is similar to The quick coupon link, every time the page is refreshed, a new coupon following the [12AN] pattern will be generated. Enter the rule ID to decide which rule that coupon code is based on. You can choose key from Access Key to decide its rule and pattern.

You can learn how to create an API and token-based authentication here.

Better Popup

Overview

Are you ready to revolutionize your e-commerce store? It’s easier than ever to turn your customers into potential customers thanks to an advanced extension from Mageplaza - Better Popup.

Better Popup is released to retain visitors when they leave the website and then, turn them into subscribers or customers on your website. In addition, it also helps to increase the number of customers, increase the number of sign-ups as well as help SEO your site effectively.

Download & Install

• Mageplaza Better Popup
• How to install

How to Configure

Log into the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Better Popup

Configuration

General Configuration

• Enable: Choose Yes to enable the module

What to Show

• Template

• Allow choosing the popup template displaying in the frontend
• Use the “Default Template”
• After clicking on Load HTML, the code of the template will display under the Content field
• Admins can configure the template or customize the template as you like
• Content
  • Enter the content to show the popup outside the frontend
  • If leaving the blank this field, it will be duplicated with the default content
  • Support HTML content. Admins can design the popup displaying on their website.
• Responsive Design

• Responsive design = Center Popup: The popup will display in the center of the screen and display with the moderate size
• Responsive design = FullScreen Popup: The popup will show full screen. The content of the popup will show in the center of the screen
• Background Color
  • Allow choosing the background color for the popup
  • The default background color depends on the selected template
• Text Color
  • Choose the text color for the popup’s display content
  • The default text color depends on the selected template
• Popup Success

• Coupon code
  • Enter the coupon code
  • The coupon code will display after visitors sign up successfully, and this coupon code will be used when purchasing the products.
• Content
  • After choosing the template to display as well as clicking on Load HTML, the selected template’s code will display in the content of this section.
  • The successful registration popup will have the same content as the selected template
  • Support HTML content. Admins can design the popup display on their website.
• Show congratulation fireworks * Choose Yes to display fireworks when visitors register the email successfully.

Where to Show

• Page(s) to show

• Page(s) to show = All Pages: This means that it will display the popup on all pages.
• Page(s) to show = Manually Insert: Show the popup on the pages that are inserted the code at the Manually Insert.

• Insert manually this snippet to your page: Display the code so that admins can copy and insert into the pages they wish to display the popup
  • Insert manually this snippet to your page
    • CMS Page/Static Block: Copy the code and insert it into the pages at the Content > Page
    • Template .phtml file: Copy the code and insert it into .phtml file of Magento or the other extensions that you want to display the popup
    • Layout file: Copy the code and insert it into the .xml file of Magento or the other extensions you want to display the popup
• Page(s) to show = Specific Page: Display the popup on some selected pages

• Include Pages:
  • Enter the pages that you want to show the popup
  • The pages are separated line by line
  • For example:
    • Want to show the popup only on the homepage, you need to enter: cms_index_index
    • Want to show the popup on the Shopping Cart page, you need to enter: checkout_cart_index
    • Want to show the popup on the Checkout page, you need to enter: checkout_index_index
    • Want to show the popup on the Category page, you need to enter: catalog_category_view
    • Want to show the popup on the Product page, you need to enter: catalog_product_view
• Include Page with URL contains:
  • The popup will display on the pages that contain the URL path entered
  • The URL path is separated by downlines
  • For example:
    • When you enter in this field: /gear/bags, /women/tops-women/jackets-women, the popup will display on the pages containing the URL above.
• Exclude pages:
  • Enter the pages that you don’t want to display the popup
  • The pages are separated by commas
• Exclude Page with URL contains:
  • The poopup won’t display on the pages that contain the URL path entered
  • The URL path is separated by downlines

Note: The priority of Exclude section is greater than the Include section. Include Pages and Include Page with URL contains are two fields that need to enter a value to display the popup. If left blank, an error message will be displayed.

When to Show

• When the popup appears

• When the popup appears = Exit Intent: This means that the popup will appear when hovering away from the current page. It does not support Exit Intent Popup on Mobile.
• When the popup appears = After page loaded: The popup will appear when loading the page
• When the popup appears = After X seconds: The popup will appear after x seconds

• After x seconds
  • Enter the number of seconds to display the popup
  • After the number of seconds configured since loading the page, the popup will appear
  • If you choose this configuration and select to show Show Float Button, the popup will display after loading the page x seconds and then, this button will also display.
• When the popup appears = After scrolling down X% of page: The popup will appear when scrolling the page down x% configured

• After scroll down
  • Enter the percentage after scrolling down to show the popup
  • The popup will appear after scrolling down the percentage configured
• The popup will show again later
  • Enter the number of days that the popup will reappear
  • If it is 0, the popup will display each time the mouse is moved out of the screen or when the page load or after how many seconds will display again or when scrolling how many percents will display
  • If leaving the blank this field, the popup will display after 30 days. The popup displayed depends on the cookie of the browser
• Show floating button: Choose Yes to display the gift button

• Floating button position

  

  • Floating button position = Left: The gift button will display below, the left corner of the screen
  • Floating button position = Right: The gift button will display below, the right corner of the screen

• Button label

  • Enter a label for the gift button displayed at the bottom of the page
  • The default label is: Subscribe

• Send Email

• Enable Send Email: Choose Yes to use the email notification feature
• Send Email To:
  • Enter the email to send the notification
  • Send Email includes the number of subscribers as well as the list of the last 8 email subscribers
  • The email will be sent every Saturday
  • When you click on “Send Now”, an email notification will be sent immediately.
  • If the website has multiple stores, it will send email reports for each email separately. For example, your website has 3 stores, it will send 3 emails for each store.

Better Popup

Email Reports

Email’s content

Must-have extensions for your Magento stores

• Increase website traffic: SEO
• Build leads
• Increase conversion rates: One Step Checkout, Layered Navigation
• We believe that you can sell more: Gift Cards, Auto Related Products, Frequently Bought Together, Free shipping bar, Daily Deal , Product Feed
• Keep customers return: Reward Points
• Let your customer become raving fans
• Optimize your stores: PDF Invoice, Custom Order Number, Stop return items issue

Better Change Qty

Overview

For the convenience of customers when purchasing multiple products with various discount options, Mageplaza integrates the ability to display Magento tier price notifications into the Better Change Qty module. Customers can easily choose different options at different prices. With only one select option and Add To Cart, customers have added products to the cart conveniently, quickly without entering the number of products corresponding to Magento’s announcement to receive the same discount.

Download & Install

• Mageplaza Better Change Qty
• How to Install

How to use

1. Display on Product View Page

1.1 Option Template

1.2 Open Quantity

2. Display on Product List Page

2.1 Option Template

2.2 Open Quantity

3. Display on Wish List Page

How to Configure

From the Admin Panel, go to Store > Settings > Configuration > MAGEPLAZA EXTENSIONS > Better Change Qty

Configuration

General

• Enable: Select Yes to activate the module
• Change Qty Step (number of items increase per option)

1. Change Qty Step = Product Qty Increment: Display step increasing by the number configured in Magento products

For example: If Qty Increments = 3 as in Magento product configuration; Step 1 is 1 product, Step 2 is 4 products, Step 3 is 7 products and so on. The difference in product quantity is 3.

• Limit Number of Options
  • Enter the limits for displaying options
  • The default display is 10 options
  • If left blank or filled as 0, there will be no limit to the display of options

1. Change Qty Step = Fixed Value: Display step as similar as in Qty Step Value configuration

• Qty Step Value:
  • Enter the number of products for each time adding products to your cart. The number of products for each step will be increased by arithmetic progression
  • For example: If Qty Step Value = 2, every time you add product to the cart, you must add 2 products
• Limit Number of Options
  • Enter the limits for displaying options
  • The default display is 10 options
  • If left blank or filled as 0, there will be no limit to the display of options

1. Change Qty Step = Custom Value: Display step increasing by the number configured in Custom Step field - Custom Step
   • Enter the number of products for each step
   • You can enter multiple steps with different product numbers, steps must be separated by a commas
   • For example: Qty Step Value = 3,5,9, means that Step 1 is 3 product, Step 2 is 5 products and Step 3 is 9 products

• Max Qty Step (Set the maximum number of steps)

• Max Qty Step = Stock Quantity: Display the product number of each step until the product is out of stock. For example: Quantity = 20 (as in product configuration), Custom Step = 5,15,19,21 then it will so only three steps which are 5,15,19
• Max Qty Step = Fixed Value: Displays the maximum number of products for each time adding product to the cart.
  • Max Qty Value: Enter the maximum number of products to display the corresponding steps. For example: Qty Step Value = 5, Max Qty Value = 25 then there are 5 steps is: 5,10,15,20,25
• Max Qty Step = Both: Display the product number of each step until the number of products is equal to the configured value in Max Qty Value field or until the product runs out of stock (prioritize the smaller value). For example: Stock Quantity = 50, Max Qty Value = 70 then step will stop at 50 products.
  • Max Qty Value: Enter the maximum number of products. For example: Qty Step Value = 5, Max Qty Value = 25 and Stock Qty = 30 then there are 5 steps is: 5,10,15,20,25
• Allow Open Qty: Select Yes to show text box which allows customer to add quantity
• Option Template
  • Template Buy {{qty}} is applied when product quantity is 1
  • If you leave this field blank, the default template will be used
• Option Template for Multiple Qty
  • Template Buy {{qty}} for {{price}} each is applied when product quantity is more than 1
  • If you leave this field blank, the default template will be used
• Option Template with tier price
  • Template Buy {{qty}} for {{price}} each and save {{percent}} is applied when tier price is applied as well
  • If you leave this field blank, the default template will be used
  • The Options Template will be displayed at the frontend as selecting type
  • You can use some variables that we support (all values of these variables are taken according to tier price configuration of Magento):
    • {{qty}}: Quantity of products
    • {{price}}: Product price
    • {{total}}: The total amount of the order with the chosen quantity
    • {{percent}}: Discount percentage
• Apply for Categories
  • Select category to apply Qty step display
  • You can choose to display in multiple categories
• Apply for Product Types
  • Select the product type to apply Qty step display
  • Can choose to display in many different types of products
• Apply on
  • Select the page for applying Qty step display
  • You can select multiple pages to apply at once. There are 3 pages to choose from: Product List page, Product View page, Wish List page
• Hide Tier price notice: Select Yes to hide tier price notice from Magento

Note:

• All the products with checkbox applied to Better Change Qty must satisfy 3 fields: Apply for Categories, Apply for Product Types, Apply on
• For Configurable products, Grouped products, Bundle products and Gift Card products, the checkbox will not be displayed on the Wish List page
• For Grouped products, Bundle products and Gift Card products, they will not be displayed as the checkbox on the Product List page

Better Maintenance

Overview

With Mageplaza Better Maintenance, instead of seeing each error page every time store maintains, visitors will see the page is attractively and not boring at all. You can insert useful information on pages such as countdown timer, subscribe forms, and social sharing buttons that allow customers to share with their friends. This gives customers many interesting benefits in the process of waiting for the page. This is a great way to bring satisfaction to fastidious customers.

We also support Coming Soon Page with similar features in this module.

How to download and install

• Download Mageplaza Better Maintenance
• How to Install

How to Use

Display Maintenance Page during maintenance time

Show Coming Soon Page for New Products or Services

How to Configure

From the Admin Panel, go to Stores > Settings > Configuration, at the Mageplaza Extension tab select Better Maintenance

1. General Configuration

• Enable: Select Yes to use the module’s feature
• Real Time of Website:
  • Displays the current time according to the Timezone of the Website
  • Admin can check Timezone at Configuration, Locale Options in General Options of General tab
• End Date Time:
  • Select the end date of Maintenance mode
  • Countdown Timer will rely on End Date to count down
  • Time is calculated from the Save Configuration time to the End Date
• Redirect To Page
  • Select page to redirect customers to during maintenance/ waiting time
  • Admin can choose any CMS Page or design by yourself follow Mageplaza’s Maintenance Page or Coming Soon Page templates
  • When it comes to End Date Time, any store’s link will be redirected to the selected page (except Whitelist IPs and Whitelist Page Links).
• Auto Switch to Live Site Mode:
  • Select Yes to automatically switch to Live Site Mode when it comes to End Date Time
  • If No, Maintenance is always applied until the admin turn off the module or switches the Auto Switch to Yes
• Whitelist IP(s):
  • Only IP addresses filled in this section can access the page without being redirected to Maintenance Page
  • It is possible to allow 1 IP address, multiple IP addresses, 1 range of IP addresses or multiple IP address ranges, IP addresses are separated by commas.
  • Store owners can also allow IP addresses as follows:
    • 10.0.0.10, 10.0.0.*, 10.0.*.*, 10.0.0.* - 123.0.0.*, 12.3.*.* - 222.0.*.*
    • Symbol “*” in range 0 - 255
• Whitelist Page link(s):
  • With the pages filled in this section, customers still can access them without being redirected to Maintenance Page.
  • The pages are separated by a line. Each page link is on one line

2. Display Setting

The settings here will apply to both Better Maintenance Page and Coming Soon Page

2.1. Clock Setting

• Enable Clock: Select Yes to display Countdown Timer in Frontend
• Countdown Clock Style:
  • We offer 5 types of Clock Style: Simple, Circle, Square, Stack, Modern
  • Admin needs to select 1 of 5 types to display at Frontend
• Clock Background Color:
  • The setting allows changing the background color of the clock
  • Not displayed with Style = Simple
  • After loading the template, if you don’t like the background color, admin can choose the background color for the clock you want
• Clock Inner Background Color:
  • Allows changing the 2nd background color (internal color) of the clock
  • Only displayed with Style = Stack
• Clock Number Color:
  • You can choose the color of the numbers in the clock
  • After loading the template, if you don’t like the color of the numbers, admin can choose the color of the number for the clock you want.

2.2. Subscribe Setting

• Subscription Type: 3 options can be selected:
  • None: Subscription form will not be displayed in Frontend
  • Newsletter Subscription: Subscribe form only includes Email field and Subscribe button. Admin can check the customer who subscribed by going to Marketing > Communications > Newsletter Subscribers
  • Account Registration: Display the form to register an account with the checkbox subscribe. Customers need to create an account to receive email newsletter
• Subscription Description:
  • Enter description of the Subscribe form.
  • If left blank, there is no description
• Description Text Color:
  • Change the text color of Description
  • If left blank, description will not be displayed in Frontend
• Label Button:
  • Set Label for Submit form button. Admin can customize in different languages
  • If left blank, Default = Subscribe
• Button Text Color:
  • Change the text color of Label
  • If left blank, default = #FFFFFF
• Button Background Color:
  • Change the background color of the button
  • If left blank, there is no default

2.3. Footer Block

• Select CMS Block to be the Footer at Frontend.
• The selected CMS Block is the footer of Maintenance/ Coming Soon Page. Therefore, it is recommended to select CMS Block Link on the Whitelist Page Link(s) list for customers to access.

2.4. Social Contact

• Enable: Select Yes to display social contacts at Frontend
• Label: Set Label for Social Contact field
• Label Color: Change the text color of Label
• Social Page Link:
  • Admin can fill the links of the social page according to the corresponding fields
  • We offer 6 basic social pages: Facebook, Twitter, Instagram, Google+, Youtube, Pinterest
  • Each field is filled with links, their icons will be displayed in Frontend

3. Maintenance Page Setting

• Select Layout: we provide 3 types of layout for the page
  • Single-column
  • Double-column
  • Double-column with Left-side content
• Page Title:
  • Set the Title of the Page
  • If left blank, default = Under Maintenance
• Page Description:
  • Enter Page Description
  • If left blank, default = We're currently down for maintenance. Be right back!
• Text Color: Change the text color of Page Title and Description
• Logo:
  • Admin can upload the store Logo to Maintenance Page
  • Logo supports image files
• Background Type: 3 types of Background admin can be selected as follows:
  • Image: Background is a fixed image uploaded by admin
  • Video: Background is a fixed video uploaded by admin
  • Multi-image: Background is displayed as a photo slide uploaded by admin.
• Upload File:
  • Depending on the background type, the type file is changed.
  • Only upload image files if background type is Image/ Multi Image
  • Only upload mp4 files if background type is Video
• Show Progress Bar:
  • Select Yes to display the Progress Bar in Maintenance Page
  • This will help customer estimate the maintenance progress of the page
  • Progress Value: Enter the maintenance percentage that the page has made.
  • Label: Enter the label for Progress bar
  • Label Color: Change the font color for Label
  • Progress Bar Color: Change the background color of Progress bar
• Preview button: Admin can click Preview to quickly see the edited page. The Preview page has the same content as Frontend. If uploading files, need to save the configuration before previewing

4. Coming Soon Page Setting

• Select Layout: we provide 3 types of layout for the page
  • Single-column
  • Double-column
  • Double-column with Left-side content
• Page Title:
  • Set the Title of the Page
  • If left blank, default = Coming Soon
• Page Description:
  • Enter Page Description
  • If left blank, default = Our new site is coming soon. Stay tuned!
• Text Color: Change the text color of Page Title and Description
• Logo:
  • Admin can upload the store Logo to Coming Soon Page
  • Logo supports image files
• Background Type: 3 types of Background admin can be selected as follows:
  • Image: Background is a fixed image uploaded by admin
  • Video: Background is a fixed video uploaded by admin
  • Multi-image: Background is displayed as a photo slide uploaded by admin.
• Upload File:
  • Depending on the background type, the type file is changed.
  • Only upload image files if background type is Image/ Multi Image
  • Only upload mp4 files if background type is Video
• Meta Title: Enter the Meta Title for Coming Soon Page. This helps improve your SEO
• Meta Description: Enter Meta Description for Coming Soon Page. This will support better SEO
• Meta Keywords: Enter Meta Keyword for Coming Soon Page. This will support better SEO
• Preview button: Admin can click Preview to quickly see the edited page. The Preview page has the same content as Frontend. If the admin uploads files, need to save the configuration before previewing.

5. API

Mageplaza’s Better Maintenance extension supports the use of the Rest API to view a list of configuration details. View details can be here. View guidelines for creating Integration tokens here.

6. GraphQL

To start working with Better Maintenance GraphQL in Magento, please do the following requirements:

• Use Magento 2.3.x. Return your site to developer mode: php bin/magento deploy:mode:set developer.
• Set GraphQL endpoint as http:///graphql in url box.
• Create Integration Token

Details can be viewed here

Better Order Grid

How can admin change or allow showing order information in the most convenient way? With Mageplaza Order Grid extension you can do that with ease. This module allow admins to add columns of customers, shipping, and billing, so you can track and manage all orders at the grid easily. In addition, you can change or create custom grid orders that meet your business requirements using this module.

How to download and install

• Download Mageplaza Order Grid
• How to Install

How to Configure

I. Configuration

Login to the Magento Admin, go to Stores > Configuration > Mageplaza > Better Order Grid.

1. General

• Select Enable = Yes to enable the module.
• Select Change Columns Header = Yes to change the header of the column.
• Select Status to Hide Orders: Admin selects status
  • The orders with the selected status will be hidden from the grid.
  • Admin can select multiple statuses.

II. Grid

Login to the Magento Admin, choose Sales > Orders to view order grid.

1. Columns

Admin selects Columns from the Orders menu to hide/show columns on the product grid.

In the Columns menu, there are 4 order attributes tabs:

1.1 Group Default

• Admin ticks to the checkboxes to allow showing corresponding columns at the grid.
• At Column Header, admin can changes column names and clicks Save.
• Reset: The system will display the default columns again.
• Cancel: Cancel the action.

1.2 Group Billing

• Admin ticks to the checkboxes to allow showing corresponding columns at the grid.
• At Column Header, admin can changes column names and clicks Save.
• Reset: The system will display the default columns again.
• Cancel: Cancel the action.

1.3 Group Shipping

• Admin ticks to the checkboxes to allow showing corresponding columns at the grid.
• At Column Header, admin can changes column names and clicks Save.
• Reset: The system will display the default columns again.
• Cancel: Cancel the action.

1.4 Group Product

• Admin ticks to the checkboxes to allow showing corresponding columns at the grid. The columns selected at Group Product** will be displayed in the Item Details column of the Group Default.
• At Column Header, admin changes column names and clicks Save.
• Cancel: Cancel the action.

2. Default View

With this extension, admin can create multiple order forms and switch between them to quickly access information related to different orders.

To create a new view, admin enters the Order menu area, click Default View, and click Save View As. Then, enter a name for the template and click the arrow icon. To delete a template, admin selects the form and clicks the trash can icon.

3. Filters

The selected order attributes are shown in Filter as well. Admin can sort the specific order by those attributes.

Admin insert the data to sort the specific order information and click Apply Filters.

4. Export

• Admin can retrieve order grid data from the file by going to the menu area and clicking Export. Then, admin select the desired file and click Export to export the file.
• The data in the exported file show the fully as in the Order Grid.

Better Product Reviews

Overview

Customers are more likely to make purchasing decisions when they see a product that has good reviews from other customers. Mageplaza Better Product Reviews extension helps new customers to quickly capture the number of reviews, average number of stars, recommend percentage, rating star chart at the top of the review block of each Product Detail Page. In addition, customers can also write reviews for products purchased quickly when entering My Account> My Product Reviews. Another great function of the module is that admin can not only browse or approve reviews, but also can reply customer reviews. Review apply will be displayed right below that review without drifting away. Thereby bringing a great experience to customers, increasing attraction, and increasing revenue for store owners

Download & Install

• Mageplaza Better Product Reviews
• How to Install

How to use

1. Customer

1.1. Product Details

On the Product Detail Page, customers can:

• See Review Summary including: review number, average number of stars, recommend percentage, rating star chart at the top of the review block

• Reorder the reviews to show the Newest Review, High Rating, Helpfulness reviews and Date

• Evaluate Helpful Review. Share any review on social network by Social Share button

• Write Review: In addition to filling the Review summary and content, customers can also Add image, Recommend product, Agree with Term of Conditions

• Customer can also can see admin reply Review (if any)

1.2. My Account> My Product Reviews

• In My Product Reviews, the module allows displaying the products that customers have purchased but not yet left reviews
• Customers can quickly find the product that they bought to write a review for that product

2. Admin

In addition to settings at Configuration, admin can also:

• Control, edit and reply customers’ reviews: Choose Marketing> User Content> Reviews

• Get the report of reviews by products or by customers, thereby understanding upcoming sales trends

  • Product Reviews Report: Select Report> Reviews> By Products

  

  • Customer Reviews Report: Select Report> Reviews> By Customers

  

How to Configure

1. Configuration

From the Admin panel, go to Stores> Configuration> Mageplaza> Better Product Reviews

1.1. General Configuration

• Select Enable = Yes to enable the module
• Remind Review on Customer Dashboard:
  • Select Yes to display Remind Review block in My Account> My Product Reviews of customers
  • With Remind Review block, customers can see the products they have purchased but have not yet leave review for it
  • Only products in the completed orders are displayed at Remind Review Block
• Enable Review Summary:
  • Select Yes to display the Review Summary at the Review tab of the Product Detail Page
  • Review Summary includes: review number, average number of stars, recommend percentage, rating star chart
• Report Review status:
  • Filter statistics by selected options
  • Admins need to go to Report> By Customers / By Products to check thr status. On these 2 pages only show the number of option reviews selected
  • There are 3 review statuses that can be selected:
    • Approved: Display the approved review number by Customer/Product
    • Pending: Displays the pending review number by Customer/Product
    • Both: Displays the number of approve reviews and pending reviews by Customer/Product

1.2. Write Review Configuration

• Enable:
  • Select Yes to enable customers to write reviews for the products
  • Select No to turn off the Write a Review function
  • Select For Purchase Only to display the Write Review field with the Customer who completed the order containing this product
• Customer Group: Only customers belonging to the selected Group can see the Review Form
• Customer Create Order To Write Review: If Yes, a customer can only write a review for a product when they create an order for that product and satisfy the Order Status. Note: this feature will not apply to customers whose customer group is Not Logged In.
• Order Status: When a customer places an order with a certain product, if the selected Order State is satisfied, they are be able to write a review for that product
• Notice Message: Insert notice for Customer who are not allowed to write reviews
• Use Ajax: Select Yes to enable AJAX loading. When a customer submit 1 product review, that Product Detail page will not be reloaded
• Allow recommending products:
  • Select Yes to display a comment indicating that the reviewer has introduced this product to their friends, and displayed the check box at Write a Review form.
  • Select No to hide checkboxes and comments
  • Select For Purchase Only to display the checkbox and comment with the customers who completed the order containing this product
• Allow Upload Images:
  • Select Yes to allow customers to upload photos when writing reviews
  • With the backend Review section, admins can upload photos even if Disable Allow Upload Images = No
• Image Upload Qty Limit:
  • Limit the number of photos that customers can upload in comments
  • If left blank or 0, there is no limit to the number of images uploaded
  • With the Review section at the backend, admin is not limited to upload images

1.2.1 Terms and Conditions

• Enable: Select Yes to display the Term and Condition feature in the Review form
• Link Title:
  • Enter a title for the Terms and Conditions section
  • If you use the {{anchor}} variable in this field, the text entered at the Anchor Text field will be followed by the Title field’s text.
• Anchor Text
  • Enter the content displayed for this field
  • Content in this field will be paired with the Title field
• Anchor URL:
  • Enter the URL where the store owner wants to redirect the user until clicking on the filled content at the Anchor field
  • If you leave this field blank then the field, the Anchor Text field will not have a link to click and is a regular text
  • For example, in Title field: I agree with the {{anchor}} of Services, the Anchor field is filled with Terms and Conditions and the URL is filled with https://domain.com/tos.html, the results displayed outside the frontend will be:

I agree with the Terms and Conditions of Services

• Checked by default: Select Yes to automatically check the checkbox (always agree to store terms and conditions)

1.3. Review Listing Configuration

• Enable Helpful Voting: Select Yes to display the Helpful button in each Review. Customer can click on the button to evaluate the usefulness of the Review
• Show Store Reply: Select Yes to display admin answers (if any) at under each Review
• Enable Social Share: Select Yes to display Share via Social buttons in each Review. Customer can click on the Social button to share that review on their social page
• Show Verified Buyer Mark: Select Yes to display a distinguishing sign that Customer reviews have purchased products with Customer’s reivew not yet purchased this product
• Show Nickname: Show customer nickname at Review
• Show Review Date: Show the date the review was created
• Default Item Qty per Page:
  • Limit the number of reviews displayed in each Product Detail Page
  • When the number of reviews is more than the limited quantity, the Load More button will be displayed

1.3.1. Sorting

• Enable Sorting On Frontend: Select Yes for the customer to change the way the reviews are sorted
• Select Type:
  • Select the sorting options that may be displayed in Frontend
  • Note: Helpfulness Type is only visible when admin select Enable Helpful Voting = Yes
• Default Sorting: Choose the default arrangement when the new Customer opens the Review tab
• Default Sort Direction: Choose Ascending or Descending to sort the values in a certain order

2. Edit Review of Customer

Whenever Customer submit 1 review, that review will be logged in Pending status at Marketing> User Content> Reviews

When admin edit 1 review, in addition to the available Magento fields, the Mageplaza Better Product Reviews module also adds some other useful fields.

• Approve and Next button: in order for admin to approve a review and move to the next review quickly

• Review Details: Add fields

  • Review Image:

    • Display the images that the Customer uploaded with Review
    • Admin can add edit delete image without effect of settings in Configuration

  • Recommendation Display:

    • Let admin know whether Customer wrote this review or not, will introduce product to their friends.
    • Admin can also change the status of Recommend Product

  • Verified Buyer:

    • Let admin know if the reviewer has purchased this product
    • Admin cannot edit this field

    

• Admin Reply:

  • Admin user: displays the username of the administrator who is logged in

  • Write a Reply: Select Yes so the admin can add answers to customer reviews

    • Nickname: the name that the admin wants to display outside Frontend
    • Comment: The content of the answer to the review

    

3. Statistics Quality Review

3.1. Report by Customers

Customer reviews are listed according to Report Review Status which has been installed at Configuration. With each status selected, the report will be different

3.2. Report by Products

Product reviews are listed according to Report Review Status installed at Configuration. With each status selected, the report will be different

4. API

Mageplaza’s Better Product Review extension supports the use of the Rest API to view a detailed list reviews that customers have left for your products and through the Rest API can create reviews or update customer reviews for the product.

• Details can be viewed here.
• Instructions for creating Integration tokens here.

5. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-better-product-reviews-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

To start working with Better Product Reviews GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• Perform a query in the left cell then click the Run button or Ctrl + Enter to see the result in the right cell
• To see the supported queries for Better Product Reviews GraphQL of Mageplaza, you can look in Docs > Query > mpBprGetReview in the right corner

• In addition, you can create reviews from products and to see if mutations are supported to create reviews from Mageplaza’s Better Product Reviews GraphQL, you can look at the top right corner of Docs > Mutation > Create a new Review.

You can view details here.

Better Product Options

Overview

Adding custom product options is one of the great ways to make stores more profitable and can serve customers on your store in a better way. With Mageplaza Better Product Options Extension, you can create more options for any product via Customize Option. This extension allows the admin to easily create Customize Options Template for options such as Quantity, Advanced Pricing, Weight, Image, Tooltips Description, Depend Option for products while the current Core Magento only allows setting Title, Price and SKU for the product. Also, you can perform Assign Customize Option at the template with Product ID/ SKU.

This extension is compatible with Mass Product Action, Mageplaza Quick View and Configurable Products Preselect.

How to download and install

• Download Mageplaza Better Product Options
• How to Install

How to Configure

From the Admin Panel, go to Stores > Configuration > Mageplaza > Better Product Options > Configuration

1. General Configuration

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Better Product Options > General Configuration

• Enable: Select Yes to enable the Better Product Options module
• Link Options by Default:
  • If Yes is selected, the options will be default linked to the template. Admin can only change the option on the template, then it will apply to all products assigned with those options.
  • If No is selected, by default the options will not link to the template.
• Result after removing template:
  • If Delete the linked products options is selected, when the template is deleted, the options in the products linked to this template are also deleted
  • If you select Unlink the current linked products options, when the template is deleted, the options in the products linked to this template before will not be linked with that template anymore.

2. Product Option Templates Grid

From Admin Panel, go to Stores > Product Options > Manage Product Options Templates

• Here shown all the Product Options Templates
• From Product Options Templates Grid, admin can capture basic information of Product Options Templates such as ID, Name, Status, Number of Products, Number of Options, Created Date, Action
• Action:
  • Delete: Delete Product Options Templates created
  • Change Status: Change the Status of Product Options Template. There are 2 template states that are Enable and Disable
  • Edit: Navigate to the Product Options Templates information page created earlier.
  • Also, admin can Filter, Sort, Search for Product Options Templates.

3. Create New/ Edit Template

From Admin Panel, go to Stores > Product Options > Manage Product Options Templates > Create New Template/ Edit Template

3.1. General Tab

• Name: Set a name for template. This is a required field.
• Description: Add a description for the template.
• Status:
  • Yes: Active the template
  • No: Disable the template, then the options for this template will be hidden at the frontend/ cart.

3.2. Customizable Tab Options

• Admin can create multiple Options in the same template by selecting Add Option
• Option Title: Enter a title for the Option. This is a required field.
• Option Type: Select Option Type. This is a required field. There are many different Option Types as shown below:

• Option Type = Text (Field/ Area)

• Option Type = File

• Option Type = Date (Date & Time/ Date/ Time)

• Option Type = Select (Drop-down/ Radio Buttons/ Multiple Select/ Checkbox/ Visual Swatch/Text Swatch)

• Sort Order: Present the priority of options showing of a product. Option with smaller sort order will be displayed first. This is a required field.
• Required: Tick this checkbox so that this option is required. Otherwise, do not select.
• Disable:
  • Tick Disable, the option will be disabled and not displayed at the frontend/ cart.
  • If not tick Disable, the option is used and displayed normally.
• Default Value: Only apply for Option Type = Select, used to choose the default value for this option when loading product detail page. Each option has one default value only.
• Title: Set the title for the values in each option.
• Price: Set price for each value. There are 2 price types as Fixed and Percent. This price will be added to the original price when adding product to cart.
• SKU: Set the SKU for each option/ value of the option.
• Qty: Set the limit number for each value in the option.
• Weight: Set the weight for each value in the option.

• Visual Swatch: You can choose a color or an image to represent the value in the option. This field only applies for Option Type = Visual Swatch.

• Text Swatch: This field only applies for Option Type = Text Swatch. You can choose text label to represent the option value under swatch style at frontent.
• After completing the fields above, click on the icon at the right of each option to open Popup Configuration, this popup contains all the information you need to configure for that option.
  • Visibility Tab:
    • Customer Group (s): Only selected customer groups can see this option.
    • Store View (s): Only Store View(s) selected can display this option.
  • Title Tab:
    • This tab only appears when the popup template is turned on.
    • Set title for option in each Store View. If left blank, the default title will be displayed.
  • Tooltip Description Tab:
    • Tooltips Description: This is the tool for admin to enter the description for Tooltip of this option.
    • Store View: Select “Yes” to set the Tooltips Description for certain storeview. Select “No”, it will display Tooltips Description by default.
  • Dependency Tab:
    • Dependency Type: Select the dependency type for this option. There are two choices:
      • OR Filter: Allow showing option if one of the conditions is satisfied
      • AND Filter: Allow showing option if all the conditions are satisfied
    • Dependency Options: The display of this option will depend on the Options, Operation and Values configured.
• For options with Type = Select Option (Drop-down/ Radio Buttons/ Multiple Select/ Checkbox/ Visual Swatch/ Text Swatch), you can click on the icon at the right of each option to open Popup Configuration which contains all the information you need to configure for that option.

• Title Tab: Set title by each Store View for each option. If left blank, it will display the default title of this option.
• Image Tab: This is the place to customize images for each option.
  • Alt Text: Enter Alt Text for the image
  • Update Product Preview Image: Select “Yes” to update the image of the product when selecting this option. If you dont’ want to pdate images, select “No”.
  • Display along with Option Value: Select the display position of the image associated with Option Value. This field is only displayed when Option Type = Radio Buttons/ Checkbox.
  • Display Tooltip when hover Option: Select Yes to show the tooltip image when hovering over this option. This field only appears when Option Type = Radio Buttons/ Checkbox/ Visual Swatch/ Text Swatch.
• Advanced Pricing: This tab is for advanced price settings of this sub-option. Here admin can give a special price for the option, and set the applying date as well as set the option price for specific customer group.
• Option Dependency: This tab is used to configure the dependency of this sub-option on other options. The display of this Option will depend on the Options, Operation and Values configured. It is similar to the Option Dependency section of the Father Option.

3.3. Manage Assign Products Tab

• Assign By: Select one of two assignment types: Product SKUs or Product IDs
• Product SKUs/ Product IDs: The name of this field depends on the Assign By field. Enter one or more Product SKUs/ IDs, separated by commas. Then click Preview to see the list of products to assign.

3.4. Edit Product Form

• From the Admin Panel, go to Products > Catalog > choose a Product> Customizable Tab Options

• Import Options: Clicking on this link, you are redirected to a new page to import options from other products into the current product.

• Add Option: When you click here, you will see a form to create a new option.

• Add Option From Template: Clicking here will appear a popup to add options from the product options template chosen into this product.

  • In the options are taken from Product Options Template, there are some differences compared with the options created at the Product page as follows:

    

    • Template: This is name of the template which will be assigned to this option.
    • Link Template: Link this option to the template taken from Better Options Template.
      • If the template has many options, all options will be linked to template and vice versa.
      • If ticked this Link Template checkbox, all field of this option(s) will be disabled and unedited.
      • Unticked, it can be edited normally.

• SKU Display Type: Select the display type of the product SKU when viewing order details. There are 3 options as shown below.

• Parent SKU: Only display the SKU of the product, not the SKU of the option.
• Custom Option SKU: Display only SKUs configured for each option.
• Both: Display the selected SKUs of the product and the selected SKUs of the option.

3.5. Mass action at the Product Grid

• In addition to assigning the Product Options Template to products right after editing/ create template, we can perform the assignment of templates for the product at the Product Grid as follows:
• From the Admin Panel, go to Products > Catalog then select one or more Product then choose Actions> Assign Product Options Templates

4. Import/Export Template

4.1. Import

At Manage Templates page, click Import to upload templates in XML file

In the Import Option Template section:

Step 1: Select File to Import

• File Type: XML. This extension only supports importing templates via XML files.
• Select File to Import: Select XML file to import template. You can refer to the standard format in the sample file by clicking Download Sample File.

Note: Make sure that the file size imported does not exceed 2M (if yes, showing error message)

• Images File Directory: If your template contains images (Visual Swatch option or Image Display of the Select option type), please enter the path to the folder containing the image in this field. If left blank, put your image in the directory with the path pub/ media/ import (if the forlder is unavailable, please create a new one)

For example, your import file contains the following image:

When importing, if you leave the Images File Directory field blank, you must copy the i and m directory containing the images.png file to the pub/ media/ import directory:

Imgur

Imgur

Step 2: Check the data from the selected file and import

After selecting the file to import in Step 1, click Check Data to check the data and the format in the file if it is eligible before import.

If the file does not eligible for import, the module will display a specific error message, please edit the import file according to the reported error. For example, the error message below is because the image could not be found, please check the pub/ media/ import directory to see if there are enough folders and images that the template requires.

If the file can be imported, the Import button will be shown, please click to it to begin importing template.

4.2. Export

You can export all available template options at the Template Management page: Go to Store management page > Manage Product Options Templates

The extension supports exporting templates to XML files. This exported XML file can be used for import according to the instructions in section 4.1 above.

Frontend

• Image of Option Type = Text on Product View Detail page

• Image of Option Type = File on Product View Detail page

• Image of Option Type = Select on Product View Detail page

• Image of Option Type = Date Time on Product View Detail page

• Show image with option value

Better Sorting

Overview

Better Sorting by Mageplaza will help customers to have a compelling shopping experience, increase the ability to access and search easily and be friendly with customers. By supporting customers to arrange products by Bestseller, Most Viewed, Discount, Reviews count, Top Rated, New, Added to wishlist, Stock (quantity), etc, Better Sorting extension will boost your site traffic dramatically.

Download & Install

• Mageplaza Better Sorting
• How to Install

How to use

Better Soring supports showing product by:

How to configure

1. Configuration

Login to the Magento Admin, choose Stores > Configuration > Better Sorting.

1.1. General

• Enable: Select Yes to activate the Module and you can sort product as the product types you want.
• Show Out of Stock at the End: Here are the options

• Base on stock label: Display the Out of Stock products at the page bottom based on stock label. You can access to Catalog > Products, then change Stock Status field into Out of stock for any products shown at bottom page even though it still remains in inventory.

• No: Not display the Out of Stock product at the page bottom.
• Base on qty (<1): Display the Out of Stock products at page bottom based on product quantity (<1). Please go to Catalog> Products to change Quantity, if the product quantity is smaller than 1, those products will be shown at page bottom, otherwise, they will not be applied Sorting and hence display products as usual.

• Default Sort by on Search Page: Default sorting product on the search page. If the first sorting type is not enabled, the second one will be applied. For example, if the Discount Sorting type is not enabled, then the module will show product by Bestseller

1.1.1. Discount

• Enable:

  • Selecting Yes to allow sorting products by Discount items.
  • If No, not apply Discount product on Sorting but will apply the next enable product type as in Default Sort By On Search Page.

• Label:

  • Enter a name for product sorting by Discount.
  • This is a required field.

• Base on: Select product sorting with Discount by:

  • Percent: Display products based on its percentage discount. Which one has more discount will be shown first.
  • Amount: Display products based on it’s fixed discount amount. Which one has more discount will be shown first.

• Apply On: Select to show product sorting by Discount in:

  • Category Page:

  

  • Search Page:

  

• Default Sort Direction: Select the default sort direction with Discount:

  • Ascending: arrange discount products in the direction of increasing
  • Descending: arrange discount products in the direction of decreasing

• Sort Order:

  • Enter the number for the Sort Order field. Smaller numbers will prioritize the default display on Sort by
  • This is a required field. If left blank, a message shown: Please enter a valid number in this field

Note: With Sort By Discount, you can run this command to update the newest discount products data:

php bin/magento indexer:reindex

1.1.2. Bestseller

• Enable:

  • Selecting Yes to allow sorting products by Bestseller
  • If No, not apply Bestseller product on Sorting but will apply the next enable product type as in Default Sort By On Search Page

• Label:

  • Enter a name for product sorting by Bestseller
  • This is a required field

• Time base (days):

  • Enter the number of days to sort the bestsellers. For example, you enter 10 days means that the best sellers product in 10 days most recently will be shown. Otherwise, you can access to Dashboard, click to Reload Data to see Bestseller Product.

  

  • If this field is left blank, the default is the entire time

• Apply On: Select to show product sorting by Bestseller in:

  • Category Page
  • Search Page

• Default Sort Direction: Select the default sort direction with Bestseller:

  • Ascending: arrange Bestseller products in the direction of increasing
  • Descending: arrange Bestseller products in the direction of decreasing

• Sort Order:

  • Enter the number for the Sort Order field. Smaller numbers will prioritize the default display on Sort by
  • This is a required field. If left blank, a message shown: Please enter a valid number in this field

Note: With Sort By Bestsellers, you can run this command to update the newest bestseller products data:

php bin/magento indexer:reindex

1.1.3. Most Viewed

• Enable:

  • Selecting Yes to allow sorting products by Most Viewed
  • If No, not apply Most Viewed product on Sorting but will apply the next enable product type as in Default Sort By On Search Page

• Label:

  • Enter a name for product sorting by Most Viewed
  • This is a required field

• Time base (days):

  • Enter the number of days to arrange the Most Viewed. For example: You enter 10 days means that the Most Viewed product in 10 days most recently will be shown. Otherwise, you can access to Dashboard, click to Reload Data to see Most Viewed Product.

  

  • If this field is left blank, the default is the entire time

• Apply On: Select to show product sorting by Most Viewed in:

  • Category Page
  • Search Page

• Default Sort Direction: Select the default sort direction with Most Viewed:

  • Ascending: arrange Most Viewed products in the direction of increasing
  • Descending: arrange Most Viewed products in the direction of decreasing

• Sort Order:

  • Enter the number for the Sort Order field. Smaller numbers will prioritize the default display on Sort by
  • This is a required field. If left blank, a message shown: Please enter a valid number in this field

Note: With Sort By Most Viewed, you can run this command to update the newest most viewed products data:

php bin/magento indexer:reindex

1.1.4. Top Rated

• Enable:
  • Selecting Yes to allow sorting products by Top Rated
  • If No, not apply Top Rated product on Sorting but will apply the next enable product type as in Default Sort By On Search Page
• Label:
  • Enter a name for product sorting by Top Rated
  • This is a required field
• Apply On: Select to show product sorting by Top Rated in:
  • Category Page
  • Search Page
• Default Sort Direction: Select the default sort direction with Top Rated:
  • Ascending: arrange Top Rated products in the direction of increasing
  • Descending: arrange Top Rated products in the direction of decreasing
• Sort Order:
  • Enter the number for the Sort Order field. Smaller numbers will prioritize the default display on Sort by
  • This is a required field. If left blank, a message shown: Please enter a valid number in this field

1.1.5. Reviews Count

• Enable:
  • Selecting Yes to allow sorting products by Reviews Count
  • If No, not apply Reviews Count product on Sorting but will apply the next enable product type as in Default Sort By On Search Page
• Label:
  • Enter a name for product sorting by Reviews Count
  • This is a required field
• Apply On: Select to show product sorting by Reviews Count in:
  • Category Page
  • Search Page
• Default Sort Direction: Select the default sort direction with Reviews Count:
  • Ascending: arrange Reviews Count products in the direction of increasing
  • Descending: arrange Reviews Count products in the direction of decreasing
• Sort Order:
  • Enter the number for the Sort Order field. Smaller numbers will prioritize the default display on Sort by
  • This is a required field. If left blank, a message shown: Please enter a valid number in this field

1.1.6. New Arrivals, Stock Quantity, Wishlist, Product Name, Price

• Enable:
  • Selecting Yes to allow sorting products by selected sorting type
  • If No, not apply this product type on Sorting but will apply the next enable product type as in Default Sort By On Search Page
• Label:
  • Enter a name for product sorting by selected sorting type
  • This is a required field
• Apply On: Select to show product sorting by selected sorting type in:
  • Category Page
  • Search Page
• Default Sort Direction: Select the default sort direction with selected sorting type:
  • Ascending: arrange selected sorting products in the direction of increasing
  • Descending: arrange selected sorting products in the direction of decreasing
• Sort Order:
  • Enter the number for the Sort Order field. Smaller numbers will prioritize the default display on Sort by
  • This is a required field. If left blank, a message shown: Please enter a valid number in this field

Note: With New Arrivals, products only be applied to this Sorting type when admin set the field Set Product as New From for them. The products which is in-stock most recently will be displayed first then come sooner in-stock products. For products which is not choosen in this Sorting type or not be set up the time at Set Product as New From field, will not be considered as New Arrivals. Please access to Catalog > Product, then choose to edit any product and go to Set Product as New From to set the New Arrivals.

1.1.7. Position, Relevance

• Enable:
  • Selecting Yes to allow sorting products by Position/Relevance. With Sort by Position, only apply for Category Page, And for Sort by Relevance, only apply for Search page.
  • If No, not apply this product type on Sorting but will apply the next enable product type as in *Default Sort By On Search Page
• Label:
  • Enter a name for product sorting by Position/Relevance
  • This is a required field
• Default Sort Direction: Select the default sort direction with selected sorting type:
  • Ascending: arrange selected sorting products in the direction of increasing
  • Descending: arrange selected sorting products in the direction of decreasing
• Sort Order:
  • Enter the number for the Sort Order field. Smaller numbers will prioritize the default display on Sort by
  • This is a required field. If left blank, a message shown: Please enter a valid number in this field

Note: With Position, Sort By Position when accessing Catalog > Categories, you can choose the to apply any category for Sort By Position then click to Products tab in Category to see their Positions.

• For example with Bags folder:

Notation

When you install the module, you should run the following command to update the newest product data:

php bin/magento indexer:reindex

When you want to uninstall the module, please go to database to delete it. Please access to Views table, et Table column, find and delete the old data.

GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-better-sorting

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

Better Sorting extension by Mageplaza supports getting data in Configuration and searching products based on product attributes to help you find the desired items quickly.

To start working with Better Sorting GraphQL in Magento, you need to:

• Use Magento 2.3.x or 2.4.x. Take site back to the developer mode.
• Learn more on request GraphQL we support here

Better Wishlist

Overview

Customers tend to save their favorite products into Wishlist to review and buy later. However, it is difficult to manage your favorite products when they are focused on one wish list and cannot be categorized, thereby making customer experience worse. Mageplaza Better Wishlist will solve this problem. This module will help customers easily create and update various WishList in accordance with different purchase needs. Thanks to this extension, customers can apply a range of actions to their wishlists such as delete/ move/ share them. Moreover, the module reports the most concerned and most recently added products in Wishlists, which helps help stores improve sales and increase loyal customers quickly by capturing the needs and shopping trends of them.

How to download and install

• Download Mageplaza Better Wishlist
• How to Install Better Wishlish

How to use

1. Customer

• Customers can create/update multiple Wish Lists
• Also, they can copy/move products between Wish Lists

• Add one product to different Wish Lists (Quick View compatible)

2. Admin

• Admin can view and edit the Wish List of each customer
• Have statistics of products quantiy added to Wish List (compatible with Mageplaza Reports)

How to Configure

1. Configuration

From the Admin panel, go to Stores> Configuration> Mageplaza> Better Wishlist

1.1 General Configuration

• Enable: Select Yes to turn on the module.
• Remove Products after Add to Cart: Select Yes to automatically delete the product from the Wishlist after Add to cart.
• Enable Multiple Wishlists:
  • Choose Yes so the admin can configure some settings on multiple wishlist, including Show All Item Tab, Default Wishlist(s), Allow customers to create Wishlists.
  • Show All Item Tab: SelectYe to display a tab containing all Products of the Wishlists.
• Default Wishlist(s):
  • Add and delete the Wishlist Categories displayed by default in Wishlists.
  • Customer cannot change the names of these Wishlist Categories
• Allow customers to create Wishlists:
  • Select Yes to allow customers to create a Wishlist Category.
  • Show more Limit Number fields of Wishlists created by customer to limit the number of wishlist categories created by customers.
  • If you leave it blank or enter 0 then the default number of wishlist customers created is 5.
  • For admins, they can create numerous Wishlists without being affected by Limit Number of Wishlists created by customers.

2. Edit Wishlist of Customer

• Each Wishlist Category and each Product added to the wishlist is saved in the Wishlist tab at the backend Customer details page. To edit them, admins can go to Customers> All Customers

• Admin can do the following actions:
  • Create or rename the Wishlist Category
  • Add products to any Wishlist Category
  • Make a copy, move one product from this Wishlist Category to another Wishlist Category
  • Remove Product from Wishlist Category
  • Change the color and size of Configurable products

3. Report on number of customers who have added wishlist for each Product

• From the Admin panel, go to Reports> Better Wishlist> Wishlist Report

4. API

Mageplaza Better Wishlist supports using REST API to perform certain actions: getting wishlist categories, creating new wishlist categories, adding items to categories, etc. Find more details of available requests in this page.

Blog

How to install Blog

Important:

• We recommend you to duplicate your live store on a staging/test site and try installation on it in advance
• Backup magento files and the store database

It’s very important to backup all of themes and extensions in Magento before installation, especially when you are working on a live server. We strongly recommend you to do not omit this step.

Method 1: Install via composer (recommend)

Run the following command in Magento 2 root folder:

composer require mageplaza/magento-2-blog-extension
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Method #2: Copy & Paste

1.1 Step 1: Download SFTP clients

Download SFTP clients, we recommend clients: FileZilla, WinSCP. In this case, we are using WinSCP to install the module.

Step 2: Download the Package

After purchasing order from Mageplaza, go to My Downloadable Products page to download the module package. You have to log in (User/Password or Social accounts) before accessing the My Downloadable Products.

Here are the screenshot of My Downloadable Products page.

Now click on extension version link to download the package.

Step 3: Upload files to server

Let’s extract the package and connect to your server using SFTP Clients above. Then upload files, folders to your server, see this video:

Upload the app folder to Magento 2 root folder.

Step 4: Run command line

To complete the installation process, we need to run the following command lines to install Mageplaza Core module:

composer require mageplaza/module-core
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

If you got the error: Mageplaza_Core has been already defined, read this solution

Step 5: Check result

Now time to check result in frontend.

If you get any issues, check FAQs. If you get still get issues, report here.

How to add custom CMS Static Block in Blog Post

In this guide, we will show you how to add a custom content in Blog post such as: Call to action, promoted banner …

There are few hidden tricks in Mageplza Blog for Magento 2. Here are hidden CMS Static Block:

• mageplaza_blog_view_under_content : Under Content section
• mageplaza_blog_view_above_comment : Above Comment section
• mageplaza_blog_sidebar_above_popular_widget : Above Popular/Recent posts widgets
• mageplaza_blog_sidebar_above_categories_widget : Above Categories widgets
• mageplaza_blog_sidebar_above_tags_widget : Above Tags widgets
• mageplaza_blog_sidebar_under_tags_widget : Under Tags wigets

See this photo:

How to create CMS static block in Magento 2

From Admin panel > Content > Blocks > Add New Block

Then fill the content of block such as Name, idenity, content …

then click on Save and continue

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Updating Blog regularly is one of the effective content marketing strategy in the present eCommerce marketplace. This activity will draw the more interactive website and drive your website more attractive to the visitors. Magento 2 Blog extension by Mageplaza, you will get an impressive chance to provide the latest news about your store, upcoming products, promotions, and get customers’ feedback in easy and simple way.

Download & Install

You can download from the following resouces:

• Mageplaza
• Magento Marketplace
• Github

Install via composer (recommend)

Run the following command in Magento 2 root folder:

composer require mageplaza/magento-2-blog-extension php bin/magento setup:upgrade php bin/magento setup:static-content:deploy

Here we go how to know detail in instructions and configuration in extension’s backend.

How to Configure

I. Configuration

1.1. General Configuration

Login to Magento Admin, Content > Better Blog: Configuration. Open General section

• In the Enable field: Choose “Yes” to turn the extension on.
• In the Blog Name field: Set name for the new blog
• In the Route Name field: Enter the route name which appears on the URL. If you leave it blank, the default Route name is blog. E.x https://domain.com/blog. You can change to news, docs.
• In the URL Suffix: Enter the Url Suffix. There won’t be no suffix if you leave it blank.
• In the Show Blog Link in Top Menu field: Choose “Yes” if you want to show blog links in the top of the menu.
• In the Show Blog in Footer Links field: To make the blog link visible on footer links on your site, set “Yes”.
• In the Display Author field: Select “Yes” to display name of post’s author on the frontend.

• In the Display Sitemap field: Choose “Yes” to display sitemap at the footer links.

• In the Date Format field: Choose the date format to display. We have 12 types of date format.

• In the Limit Related Post field:
  • Related Post is defined posts have the same Topic.
  • You’re able to limit the related posts in this section.
  • If you leave it blank, all the related posts will display on Post View page.
• In the Display Related Posts Mode: Set the Related Post at view post page shown in grid or slider.

• In the Display Blogs Mode field: You can configure to display posts at post listing page under Grid View or List View.
• In the Blogs per Page Allowed Values field: The number of post per page will be set in this field.

• In the Choose Blog’s Color field: Pick up a color for your blog’s text.
• Allows customers to register as an author: Select Yes to allow customers to register as an author for the store blog
• Automatically approve requests: Select Yes to allow auto-approving request of customer author’s registration.
• Automatically approve customer’s posts: Select Yes to allow auto-approving customer posts when creating new posts outside the frontend
• Limit of Posts History: Maximum number of history records in the Edit History of posts section at the backend. Once the number of history records has reached maximum, the oldest one will be auto-deleted if creating new ones. The default is 5.
• Allow Voting for Helpfulness: Select Yes to allow Like/Dislike below each post
• Restrict Rating for: Select the customer group that is allowed to vote (Like/Dislike). You can select multiple groups.

1.2. Related Products Content

When open the Related Products Content section, there will be two sub-section parts.

1.2.1. Product Detail Page

Product Detail Page contain posts can be added to Related Products to display in Post View Page. The selected products will recognize those posts are Related Posts and display them on the Product Detail Page.

• In the Enable Related Post field: Choose “Yes” to show related posts on Product Detail Page.
• In the Limit of Related Post field: Enter the number of related posts can display. If you leave it blank, the default number is 1 post.

1.2.2. Post View Page

• In the Enable Related Product field: Choose “Yes” to show related products on Post View Page.
• In the Display Related Products Mode: Set the Related Post at Post View Page shown in grid or slider.
• In the Limit of Related Products field: Enter the number of related products can display. If you leave it blank, the default number is 12.
• In the Title of Related Products field: Name the title of the block which contains related products. If you leave it blank, the default name is “Related Products”

1.3. Sidebar

Expand the Sidebar section, there will be two sub-section parts.

1.3.1. Sidebar

• In the Number of Recent Post field: Enter the number of recent posts that display on the sidebar. If you leave it blank, the default number is 4.
• In the Number of most view posts field: Enter the number of most view posts that display on the sidebar. If you leave it blank, the default number is 4.
• In the Sidebar Location: Select Left/Right for the location of the sidebar.

1.3.2. Search

• In the Enable Search Box field: Choose “Yes” to active the search box at the sidebar.
• In the Maximum Query Result field: Enter the maximum number of posts that the search box will search. Without setting the limitation, the search box will search all posts that match the search character.
• In the Min Chars field: Search results will only be displayed if the customer enters in the search box with enough configured characters in this section.
• In the Visible Image: Select “Yes” to display the thumbnail of the post when the post is found in the search box.
• In the Description length field: Limit the length of the short description can show along with found posts. If you leave it blank, the short description will not display.

1.4. Monthly Archive

Monthly Archive helps to summary the number of post published for each month. Open Monthly Archive section.

• In the Enable Monthly Archive field: Select “Yes” to display the monthly archive on the frontend.
• In the Number of records field: Set the number of months to display on the frontend. If you leave it blank, the default number is 5 (the last 5 months statistic).
• In the Type of Datetime field: Choose your favourite format of the date. We offer 4 types of month/year displays.

1.5. Comments

Open Comments section, set a comment type with one of the following options.

• Default Comment: Customers need to login a new account to be able to comment, admins can manage those comments in the backend. Choose ‘No’ at the Need for Approval field to disable the comment management feature. After that, those comments will be shown on the frontend as soon as customers comment.

• Disqus Comment: Admin needs to create a Disqus unique name and fill it in the configuration. This also requires the customer have a Disqus account to be able to comment.

• Facebook Comment: If you choose this type of comment, some add-on fields will display like the below:

• • In the AppID field: Admins need to create a Facebook App to get the AppID to fill this field. You can refer more in here
  • In the Facebook: Number of Comment field: This limits the number of comment displaying on the Post View Page. If you leave it blank, it will show all available comments.
  • In the Facebook: Color Scheme field: Choose the color which display commenter’s information.
  • In the Facebook: Order by field: Choose the arrangement for comment displaying. * Social: The comment which has more like(s) will display from the top. * Reverse Time: The comment which is published first will display from the bottom. * Time: The comment which is published first will display from the top.
• Disable Completely: choose this type if you don’t want to display comments.

1.6. SEO

Open SEO section, there will be 2 additional sub section in this part.

1.6.1. SEO

You can configure the meta that is useful for your better SEO

• Meta Title: Set Meta title for posts list page (Blog Page)
• Meta Description: Set Meta description for posts list page
• Meta Keyword: Set Meta keywords for posts list page
• Meta Robots: Set Meta Robots for posts list page

1.6.2. Article Snippet

• In the Enable field: Choose “Yes” to enable Article Snippet.
• In the Organize or Website Name field: Enter your organize or website name.
• In the Logo field: Upload your logo.

1.7. Social Sharing

Open the Social section: * In the Enable field: Enable social buttons on the blog page * In the PubId field, insert ID for Share buttons that get from https://addthis.com.

In Social share session, we use Addthis.com to add more than 200 share buttons, and display only 4 most popular share buttons. You can custom these buttons by add your own Addthis Pub-id

Click on Save Config when complete.

II. Manage Post

2.1. Create new post

Step 1: Complete the post information

• Login to Magento Admin, follow Content > Better Blog: Manage Posts.
• On the upper-right corner, tap Add New Posts button

• Set Name for the new post
• Select author for the post. This is a required field.
• To display the new post, choose “Enable” in the Status field
• Enter Short Description if it’s necessary.
• Use WYSIWYG Mode to insert the post content that allows showing right as on the frontend. If you want to show the content under code, tap Show/Hide Editor button.
• Choose the Store View where you want to display the post.
• Upload image from your browser in the Image option.
• Choose Topic, Tag, Category for the post. Also, you can create a new Topic, Tag, Sub Category in this section.
• Choose In RSS = Yes to display the post information in the file rss.xml
• To allow the readers leave comments on your post, choose “Yes” in the Allow Comment field (Make sure that in the 1.5. Comments, the comment type IS NOT Disable Completely*)
• Publish Date: Configure the displaying of the post date
• Enter the URL Key that the visitor can access the blog post
• Complete Meta Title, Meta Description, and Meta Keywords for your better SEO.
• Set Meta Robots to one of the following options:
  • Index, Follow
  • NoIndex, NoFollow
  • NoIndex, Follow
  • Index, NoFollow
• Set the layout for posts based on 5 following options:
  • Empty
  • 1 column
  • 2 columns with left bar
  • 2 columns with right bar
  • 3 columns
• Tap Save and Continue Edit at the header

Step 2: Assign Products to the post

• You can do it when you create a new post in the Products tab, or go to Posts tab
• In the list of the available posts, mark the checkbox that is next to the products you want to assign

• Tap Save and Continue Edit, then hit Save Post to finish.
• Edit History Tab: When performing Edit Post then Save as Draft/Save & add History, the data for that edit will be saved as a record on the Edit History tab.
• Save as Draft: Post data will be saved as a draft on the Edit History tab
• Save & add History: the post’s data is saved, the post is displayed in the frontend according to the saved data.

• Grid Edit History: includes information: Name, Short Description, Store View, Categories, Topics, Tags, Modified by, Modified At and some Action such as Edit, Preview, Restore, Delete

• Action = Edit: You can edit information for each post

2.2. Duplicate Post

• With Mageplaza Better Blog extension, you can duplicate the available post to create the new one.
• Login to Magento Admin > Content > Better Blog > Manage Posts, click Edit to the post you want to duplicate

• At detailed post page, click Duplicate on menu tab, a new post will be created which is the same as the previous one. Admins can modify the post information and content.

III. Create New Tag

• Login to Magento Admin, follow Mageplaza > Better Blog: Manage Tags
• To active the new tag, set Status to “Yes”
• Set Name for the new tag
• Choose Store View where you want to display tags
• Enter the URL Key that the visitor can access the tag
• Complete Meta Title, Meta Description, and Meta Keywords for your better SEO.
• Set Meta Robots to one of the following option:
  • Index, Follow
  • NoIndex, NoFollow
  • NoIndex, Follow
  • Index, NoFollow

• If necessary, you can assign the new tag to a specific post.
• Click on Save Tag when complete.

IV. Create New Topic

• Login to Magento Admin, follow Content > Better Blog: Manage Topics
• To active the new topic, set Status to “Enable”
• Set Name for the new topic
• Enter Description if you need
• Choose Store View where you want to display the topic
• Enter the URL Key that the visitor can access the topic
• Complete Meta Title, Meta Description,and Meta Keywords for your better SEO.
• Set Meta Robots to one of the following options:
  • Index, Follow
  • NoIndex, NoFollow
  • NoIndex, Follow
  • Index, NoFollow

• If necessary, you can assign the new topic to a specific post.
• Click on Save Topic when complete.

V. Category

5.1. Create new category

• Login to Magento Admin, follow Content > Better Blog: Categories
• To active the new category, set Status to “enable”
• Set Name for the new topic
• Choose Store View where you want to display the category
• Enter the URL Key that the visitor can access the category
• Complete Meta Title, Meta Description,and Meta Keywords for your better SEO.
• Set Meta Robots to one of the following options:
  • Index, Follow
  • NoIndex, NoFollow
  • NoIndex, Follow
  • Index, NoFollow

• If necessary, you can assign the new category to a specific post.
• Click on Save Category when complete.

5.2. Duplicate Category

• With Mageplaza Better Blog extension, you can duplicate the available category to create the new one.
• Login to Magento Admin > Content > Better Blog > Categories, choose category you want to duplicate. Choose Duplicate at menu tab.

• A new category is created. You can modify it’s information.

VI. Manage Authors

• Login to Magento Admin, Content > Better Blog > Manage Authors

6.1. Create New Author

• Login to Magento Admin, Content > Better Blog > Manage Authors > click the Create New Author button
• Author Info Tab:

• Customer: Select customer as author
• Display Name: This name will be displayed on frontend. This is a required field
• Status: Author’s status, there are 3 author’s status: Pending, Approved and Disapproved

• Enter Short Description if you need to
• Upload image from your browser in the Avatar option.
• Enter the URL Key that the visitor can access the list post of author
• Full URL: after saving here will display the full URL link to access the list of author posts
• Enter Facebook link and Twitter if you want
• Post tab: grid of author posts

VII. Manage Comments

• Only being able to manage Default Comment when choosing “Yes”” at Need for Approval field at the Content/Better Blog//Configuration/Comment
• When choosing “No”, the status of the default comment is Approved and it will display as soon as customers comment.
• After the customer comments a post, the comment will be sent to the admin with the status Pending.
• The comment is displayed if the admin switches the comment status into Approve, and in vice versa result if Status is Spam or Pending.

• when editing a comment, admin need to note as the following:
  • Post: The post title which is linked to Edit Post of Manage Post in the backend.
  • Customer: The commenter, who is linked to Edit Customer in the backend
  • Status: Admins only need to select Status = Approved to allow those comments showing in the frontend.
  • Content: Admins can edit the content of the comment at this field. The comment at the frontend will change as the backend. In the comment management grid, admins only see up to 150 characters of the content.
  • View on Frontend: link of the post on the frontend.

VIII. Import

• Login to the Magento Admin, choose Content > better Blog > Import
• Choose import source is “Wordpress” or “AheadWork Blog extension” [Magento 1] or “MageFan Blog” [Magento 2]

• How to import in details can be found here

IX. Create new Widget

Widget is an awesome functionality you can insert to the CMS page from Magento 2 Configuration because it can be considered as a predefined set of configuration options. In the widget, you can add links that navigate directly to any content page, category, or product as you need.

In Magento 2 Better Blog extension, you can add a widget in which shows Related blog posts, Lastest blog post, etc. Follow this instruction to learn how to create a new widget to enrich your content immdiately.

• Choose the page you want to add a new widget by following Mageplaza > Better Blog: Post. You can add the widget by two methods
  • Option 1: Click on the widget icon in the Content’s edit

• Option 2: Switch the content’ mode into HTML mode, then choose Insert widget

• Choose the widget’s type: We created an available blog widget. In Widget Type, choose Mageplaza Blog to use this widget for adding posts in the content of any optional pages.

• Setup the widget: in the Insert widget… information:

• In the Tittle field:
  • Choose the widget’s tittle you want to display it in the frontend
  • This title will be inserted an internal link to your blog post
  • If you leave it blank, the widget won’t have a title.
• In the Number of Post Display field:
  • This is the field where you can limit the number of post in the widget
  • The default number is 5.
  • If you leave it blank, there will be an error message.
• In the Show Type field, there’re two options:
  • New type: The newest posts will be displayed in the widget. The number of newest posts won’t exceed the entered number in Number of Post Display
  • Category type:
    • The Category ID will be expanded when you choose this option, then enter the Category ID you want to display in the blog.
    • The default number is 2.
    • You have to ensure that the Category you entered is valid. If it isn’t, there will be an error message at the frontend.
    • You can check the Category ID in Mageplaza > Bettter Blog: Categories click the Category name to see its ID.

• In the Template field:

  • We created a new default template and this is the only one you can use.
  • If you want to create a new template, please contact with our Support Department by submit a ticket to https://www.mageplaza.com/contact.html or via the email support@mageplaza.com

• Finally, click Insert widget button to add the widget into the content.

• Don’t forget to click the Save button at the top of the backend.

• Check the frontend to see the final result.

X. API

• Mageplaza’s Blog Extension supports the use of REST APIs for Post, Categories, Tags, Topic, Author, Comment, Likes
• Details see more here
• Instructions for creating tokens see here

XI. GraphQL

11.1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-blog-graphql

php bin/magento setup:upgrade

php bin/magento setup: static-content:deploy

11.2. How to use

To perform GraphQL queries in Magento, the following requirements are required:

• Install the ChromeiQL extension for the Chrome browser (currently does not support other browsers)
• Use Magento 2.3.x. Return your site to developer mode
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint.

(e.g. http://develop.mageplaza.com/graphql/ce232/graphql)

• Perform a query in the left pane, click the Run button or Ctrl + Enter to see the result in the right cell
• To view the queries that the Mageplaza Blog GraphQL extension supports, you can look in Docs > Query in the right corner

• See Mageplaza supported GraphQL requests here

XII. Author in Frontend

12.1. Sign up for author

Method 1: Sign up for an author when Create New Customer Account

Tick Sign up to be an Author, then click Save

Go to My account > My Better Blog to view registered author information, which can change your author information

Method 2: Sign up for an author when you have a customer account

• Go to My account > My Better Blog, here you will see the Signup Author, complete the fields in the registration form then click Submit button to complete the registration

• Display Name: the author’s name is displayed in the frontend, this is a required field
• Short Description: short description for author
• Avatar: choose a picture to represent the author
• URL Key: Enter the URL Key that the visitor can access the list post of author
• Full URL: This will display the full URL link to access the list of author posts
• Enter Facebook Link and Twitter Link if you want

12.2. Create New Post

Go to My account > My Better Blog > Post List > click Add New Post button

• Post Name: The name of the post, this is a required field
• Short Description: short description for the post
• Post Content: post content
• Image: Insert image for post
• Select Category: select category for post, can select multiple categories
• Select Topic: select the topic assigned to the post, can select multiple topics
• Select Tag: select the tag assigned to the post, can select multiple tags
• Allow Comment: Choose “Yes” to allow comments for the post
• Publish Date: Select the date for publishing the post

After creating the post, the author can Duplicate/ Edit/ Delete post

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Canada Post

Overview

Mageplaza Canada Post extension allows Magento websites to offer Canada Post shipping method. Customers will be able to select this shipping method at checkout page to receive their product via Canada Post Shipping. This shipping method can be used to deliver and receive packages/orders within Canada and from Canada to other countries.

This extension is fully compatible with Mageplaza One Step Checkout, Mageplaza Shipping Rules, Mageplaza Shipping Restrictions and Mageplaza Shipping Cost.

How to use

Displays the Canada Post shipping method at frontend with expected delivery time when customer create orders

Admin can create orders using the Canada Post shipping methods

Create and print Shipping Labels for Orders

How to configure

I. Instructions for getting the API Key

Create Canada Post Account

• If you already have a Canada Post account, you can skip this guide.
• Visit Canada Post homepage, click Sign In

• When the Popup Sign In is displayed, click Register now

• Click Create business profile

• Fill in the information in the Profile Information section and select Continue

• Select Profile Type as Small Business and then click Select and Continue button. If you would like to register the Profile Type as Enterprise, please contact the Canadian Post support team for more details.

• Fill in the Contact information, select Continue

• You will be redirected to the section providing more information “Tell us about your business”. You can fill in the information or click Ask me later to update later.

• Finally you will be moved to the Confirmation section. You have finished creating your account. Here you will be provided with Customer Number information that will be used to connect to the API later.

Instructions for obtaining the API Key

• To get API Key you need to log in to your Dashboard page. In case you created a new account, you can access this page by clicking Continue in the Confirmation section when creating the account. Or if you already have an account, simply visit the Canada Post homepage, select Sign In and log in with your registered account.
• After successful login, on Dashboard, select Business > E-commerce > Integrate with our APIs

• Then continue to select Go to Developer Program on the next page

• Click Join NOW

• Click Join NOW again.

• After reading the Agreement, click AGREE AND CONTINUE

• After joining the program successfully, you will see the Developer Program home page, where you will get the Customer Number and API Key of Development and Production corresponding to Sandbox and Production environments at Configuration in Part III.

II. Required Configuration

In order to use the Canada Post shipping methods on the website, the admin needs to set the following configuration:

1. Setup Store Information

• Login to the Magento Admin, choose Stores > Configuration > General > Store Information.
• It is required to fill in the Store Name and Store Phone Number fields, other fields are not required.

2. Setup Origin

• Login to the Magento Admin, choose Stores > Configuration > Sales Shipping Settings > Origin.
• Here, please fill in your store address in Canada. The fields Country, Region/State, ZIP/Postal Code, City, Street Address are required, and the Street Address Line 2 field is optional.

3. Setup Currency

• Your store needs to allow using Canadian Dollar
• Login to the Magento Admin, choose Stores > Configuration > General > Currency Setup > Currency Options
• Choose Canadian Dollar at Allowed Currencies field

If the Base Currency field is different from the Canadian Dollar, then you must set the exchange rate between Base Currency and Canadian Dollar. To do that, login to the Magento Admin, choose Stores > Currency > Currency Rates, enter the exchange rate in the CAD column

III. General Configuration

Login to the Magento Admin, choose Stores > Configuration > Sales > Shipping Methods > Canada Post by Mageplaza

• Enable: Select Yes to make the extension active
• Carrier Title: Enter the Carrier Title you want to display in the frontend checkout. The default is Canada Post
• Environment: Select the corresponding environment you want to apply on the store. The sandbox environment is a copy of the Production and includes valid test data and feedback so you can check if the extension is working properly on your site before going live (switch to the Production environment).
• API Username: Enter the API Username corresponding to the environment selected above. How to obtain API Username, please see the instructions in Part I.
• API Password: Enter the API Password corresponding to the environment selected above. How to get API Password please see instructions in Part I.
• Customer Number: Enter your Customer Number value. How to create an account and get a Customer Number please see the instructions in Part I
• Agreement Type: Select Contract if you have a Commercial (Enterprise) account. Learn more about Contract for Commercial here.
• Contract ID: Depends on Agreement Type = Contract. Enter the Contract ID value corresponding to your Canadian Post Commercial (Enterprise) account here. Language: Set the display language for the shipping method title and error messages in the frontend. Supports 2 types of languages: English and French

• Display Estimated Delivery Time: Displays the estimated delivery date for the Canada Post shipment options.
• Delivery Time Offset: The amount of time calculated in days added/subtracted from the estimated delivery time. Admin can adjust the estimated delivery time range using this field.
• Allowed Shipping Methods: Choose the shipping methods allowed for the store. Only shipping methods selected in this field and satisfying each shipping address will be displayed in the frontend.
• Enable Free Shipping: Select Yes to install Free Shipping with Canada Post for the countries.

• Minimum Order Amount: Depends on Enable Free Shipping = Yes. Enter the lowest value of orders allowed to apply Free Shipping.
• Free Method For Canada: Depend on Enable Free Shipping = Yes. Choose the shipping method applied Free Shipping in Canada.
• Free Method For US: Depend on Enable Free Shipping = Yes. Choose the shipping method applied Free Shipping in the US.
• Free Method For International: Depend on Enable Free Shipping = Yes. Choose shipping methods that apply Free Shipping in other countries where Canada Post supports shipping.

• Quote Type: Select the Quote Type that corresponds to your account’s Profile Type. Select Commercial** if you have a Commercial (Enterprise) account.
• Print Output Format: Select the print format for shipping label. Supports 2 types of formats are 8.5x11 and 4x6.
• Reason For Export: Enter the code presenting the Reason For Export listed on the shipping label.
• Other Reason: Dependend on Reason For Export = Other. Enter a value for the Reason For Export section displayed on the shipping label. Minimum of 4 characters, maximum of 44 characters.
• Max Package Weight: Unit in kg(s). Fill the maximum weight for 1 item in the cart. Use this weight to divide the shopping cart into different packages. The maximum value to be filled is 30 (- kgs).
• Calculate Handling Fee: Choose how to calculate Handling Fee: Fixed value or Percentage.
• Handling Applied: Select the object to be applied to calculate Handling Fee: either by order or by order package. The package number of the order will be calculated based on the Max - Package Weight and the weight of the products in the Cart.
• Handling Fee: Enter the value of Handling Fee. If left blank or fill in 0 means do not apply Handling Fee. For example, if Calculate Handling Fee = Percentage, Handling Applied = Per Package and Handling Fee = 10, the order has 2 packages, the Handling Fee of order = Shipping Fee * 10% * 2

• Ship to Applicable Countries: Set the country that you want to apply to ship in the table rate. There are 2 options:
  • All Allowed Countries: Customers in any country can also apply for Canada Post shipping.
  • Specific Countries: Customers in certain countries are eligible for Canadian Post shipping. When selecting this option, the Ship to Specific Countries field will appear for you to select desired countries.
• Show Method if Not Applicable: Choose Yes to still display the table rate shipping method on the View Cart and Checkout page when the order does not meet the conditions for using this ship form. At that time, the message in the Displayed Error Message field will be displayed to the customer.
• Show Method only for Admin: Select Yes to only show Canada Post shipping when creating orders at admin, customers who order at the frontend will not see Canada Post’s shipping option.
• Debug: If Yes, diagnostic information is stored in log files on the Magento web server. So that, admin can check the shipment results via Canada Post.
• Sort Order: Specify the position of the Canada Post shipping method in the list of ship methods that satisfy the order, with 0 being the first position.

IV. Create Shipping Label

On order with Shipping Method as Canada Post, select Ship to create Shipment

On the Create Shipment page, select Create Shipping Label and choose Submit Shipment

The Create Packages popup appears, select Product to add to the package and fill in information related to the package and Save package.

The shipping label will automatically be saved when the package is successfully created. You can view shipment details of the order to print Shipping label. The shipping label format will be printed following the configuration section.

If you did not create a shipping label when creating a new shipment, you can go to the shipment details page of the order, click Create Shipping Label to create a shipping label for the order. Then you just need to create the same package as above, the shipping label will be created when the package is successfully created.

In addition, you can track deliveries on the Canada Post system with your package number. You only need to click on the Number corresponding to Carrier Canada Post to track the shipment.

Frontend

Displayed on the View Cart page with English Language

Displayed on the View Cart page with French Language

Shown at the Default Checkout page

Shown on the One Step Checkout page

Displayed at the Checkout with Multiple Addresses page

Display compatible with Mageplaza Shipping Cost extension

Call for Price

Overview

Nowadays, some stores or distributors don’t want to display the price of the product on the website, they want to display the information only so that customers must contact the shop owners to ask the price or may bargain the price of the product; however, Magento doesn’t support this feature currently. To resolve this problem, therefore, Mageplaza provides Call for Price that can meet the needs of store owners.

How to use

Display on the Product Listing

• Display on the popup

• Hide Add to Cart button

Display on the Product Page

• Hide Add to Cart button

Email when customers send a request quote

Email of admins to notice product price

How to configure

From the Admin Panel, go to Sales > Call For Price > Configuration

Configuration

From the Admin Panel, go to Sales Call ForPrice  > Configuration, choose General sections

General Configuration

• Enable: Choose Yes to use the functions of this module
• Available Country Codes: Select countries whose phone codes are available
• Default Phone Code: Select the country whose phone codes you want to display as default for the Phone Number section in the call for price popup
• Request status:
  • There’re 4 available statuses of this extension: To Do, Doing, To review, Done
  • When there’s a request sent to, the default status of the request is To Do
  • Admins can add, edit, or delete the request status to mange requests that they receive easily
  • Admins can set the default status for the requests they receive

Terms and Conditions

• Check by default: Choose Yes to auto-tick on the checkbox (always agree with the terms and conditions of the store)
• Is Required: Choose Yes to display this required field
• Title:
  • Enter the title for the Terms and Conditions
  • If you use “%anchor” variable in this field, the text entering into Anchor Text will match with the ext of Title field
• Anchor Text:
  • Enter the content displaying for this field
  • The content of this field will merge with the Title field
• Anchor URL:
  • Enter the URL that store owners want to redirect the customers when clicking in the content filled in the Anchor field
  • If you leave this field blank, the Anchor Text field doesn’t have the link to click and it will be a text description as usual.
  • For instance: In the Title field, you fill is that I agree with the %anchor of Services, in the Anchor field, you fill is that Terms and Conditions and the URL field is that https://domain.com/tos.html, then the result displaying on the frontend is that I agree with the Terms and Conditions of Services
• Return to previous page after login:
  • If Yes: The page will be redirected to the page before when customers sign in (Example: Customers go to the Bag product page, then sign in, they will be redirected to that Bag product page).
  • If No: The page will be redirected to the default Magento page when customers sign in (My Account page).

Disable Default Functions

• Disable Add to compare, Wishlist: Choose Yes to hide the Add to compare and Add to Wishlist buttons on the product on the frontend
• Disable Register Customer Account: Choose Yes to hide the Create an Account button after customers checkout by their guest account
• Disable Shopping cart by Customer groups:
  • The selected customer groups cannot access on Shopping cart page
  • Allow choosing many customer groups simultaneously
  • The default is that no group is selected
• Disable Checkout page by Customer groups:
  • The selected customer groups cannot access on the Checkout page
  • Allow choosing many customer groups simultaneously
  • The default is that no group is selected

Admin Email Notification

• Enable: Choose Yes to send the email notification to the store owner when there’re requests from customers
• Sender Email: Choose the sender to send the email notification
• Email Template:
  • An email will be sent to admins when there is a call-for-price request.
  • To change Gift Card Email Template, admins can create a new Email Template in the Marketing > Email Template section.
  • Please view how to create a new Email Template here
• Send to:
  • Fill the email to get the notification when there’re requests from customers
  • Allow filling in many emails to get the notification simultaneously, the emails are separated by commas

Reply Email To Customer Request

• Enable: Select Yes to send email to customers to reply to their requests.
• Email Template To Respond To Customer Requests:
  • Select the available templates to send emails.
  • To change the Email Template, admins can create a new Email Template in the Marketing > Email Template section.
  • Please view how to create a new Email Template here
• Time Email Reply To Customer(Minutes):
  • Time to send the reply to customers is in minutes.
  • If empty or zero, an email will be sent immediately after the customer sends the request.

Rules Management

Add new rule

• Step 1: Enter the full information in the General section
• Step 2: Design the display of the rule on the frontend in the What to Show section
• Step 3: Set the condition applying the rule for products in the Where to Show section

Admin SMS Notification

• Enable: Select Yes to inform admins via SMS when there is a call for price request from customers.
• Message:
  • Enter messages
  • You can use the following variables for SMS text : {{customer_name}}, {{customer_email}}, {{phone}}, {{customer_note}}, {{product_name}}, {{product_price}}, {{store_name}}.

• Mageplaza supports sending SMS to admins via the registered phone number at Twilio. Stores need to register and enter required information to activate the messages.
• Create a Twilio account at: https://www.twilio.com/try-twilio

Reply SMS To Customer Request

• Enable: Select Yes to inform admins via SMS when there is a call for price request from customers.
• Message:
  • Enter messages
  • You can use the following variables for SMS text : {{customer_name}}, {{customer_email}}, {{phone}}, {{customer_note}}, {{product_name}}, {{product_price}}, {{store_name}}.
• SMS Time To Reply To Customers (Minutes)
  • Enter the time SMS will be sent after customers send requests.
  • If empty or zero, an SMS message will be sent immediately after the customer sends the call for price request.

Step 1: Enter the full information in the General section

• Name: Fill in the name of the rule
• Status: Choose Enable to apply for the rule
• Store View:
  • Only selected products on the store can be applied for the rule
  • Allow choosing many store views simultaneously
• Customer Groups:
  • Only the selected customer groups can see the products applied the rule
  • Allow choosing many groups simultaneously
• Do not Apply Rule with Customer ID: Do not apply Call For Price with particular CustomerID entered here and show prices to them.
• From Date: Choose the start day applying the rule on the product
• To Date: Choose the finish applying the rule on the product
• Priority:
  • Enter priority for synchronizing objects
  • The smaller the input number, the higher the priority.
  • Items have the equal priority, the priority will be based on what item is created first.

Step 2: Design the display of the rule on the frontend in the What to Show section

• Button label: Enter the label for the button to replace the Add to Cart button

• Action:

  • Action = Popup a quote form: Display the popup to login or as a note of customers so that they can send the requests to the store owner

    • Quote Heading: Enter the title for the popup
    • Show Fields: Choose the fields displaying the popup, including Name, Email, Phone, Company, Street Address, State/Province, Country, Attach a document/image, Contact Time, Note.
    • Required Fields: Choose the field displaying the default on the popup, including Name, Email, Phone, Company, Street Address, State/Province, Country, Attach a document/image, Contact Time, Note.
    • Enable Terms and Conditions: Choose Yes to show Terms and Condition

  • Action = Redirect to an URL: Redirect the customers to the desired admin page when clicking on the button to replace the Add to cart button

    • Redirect URL: Enter the URL that you want to redirect the customers for accessing to

  • Action = Login to See Price: Customers need to login to the website to view the price of the product

  • Action = Hidden Add to Cart button:

    • Hide the Add to cart button on the product
    • This section is usually for reference products or non-selling products

  • Action = Custom CSS:

    • Add custom CSS.
    • Product SKU = {{sku}}, Product ID = {{id}}. The {{sku}} and {{id}} will be replaced automatically with the specific SKU and ID you’ve set in the rule’s condition.
    • Some commonly-used elements:
    1. Button Add to Cart: form[data-product-sku=”{{sku}}”] .action.tocart{ Your custom CSS !important}
    2. Product Prices: .price-box[data-product-id=”{{id}}”] .price{ Your custom CSS !important}
    3. Product SKU: .product-info-stock-sku{ Your custom CSS !important} Example: form[data-product-sku=”{{sku}}”] .action.tocart{ color:red;background-color:yellow }

Step 3: Set the condition applying the rule for products in the Where to Show section

• Choose the condition to apply the rule
• You can customize label products by setting the conditions for the product or selecting which products of the category will be displayed labels. You can find products that meet the conditions in the PREVIEW PRODUCTS section

Requests Management

Display all customer requests sending to the store.

• Click Add New Request: Admin can create Call For Price Request. Affter creating request successfully, admin can send replies to customer’s requests via the Conversation in each request.

Mageplaza Call For Price supports saving IP Address Customer and Contact Time - the time when admin can contact with their customers.

When you click on View, store owners can view the details of the request, such as the date of the request, the name and email of the customers, the product the customers are interested in and store owners can change the status of the request to manage requirements with ease. At the same time, they can also annotate on customer requirements.

Product

From the Admin Panel, go to Catalog > Products > Add Product or Edit Product

• Call for Price: The product will be applied based on the selected rule in this field
  • Call for Price = Inherit from Rule: The product that complies with the created rule in Rules section will continue to apply that rule
  • Inherit from Rule = Disable: Not apply any rule for the product
  • For example: Your store has 3 rules applied as Rule 1, Rule 2, and Rule 3. The product A includes category Bags applied Rule 1, but you want the product A assign to apply with rule 2, you need to choose Inherit from Rule = Rule 2

Compatible with Reports standard extension

If you have installed Mageplaza Reports Standard extension on your site, in the Dashboard of the admin panel will be displayed 2 different boards: Call for price: Requests and Top Requested Product.

Call for price dashboard: Requests will show the top 5 customers and products requested recently. Simultaneously, it also displays the comparison with the previous period time and the number of requests got. When clicking on View Details, admins can view the details all requests.

Top Requested Products dashboard will display the top 5 products that are requested the most and the number of requests respectively with that products.

When You click on the View Details link in the Call for Requests card, Requests page will show all information of the request sent to the website.

API

Mageplaza’s Call For Price extension allows using the Rest API to view the rule information, create and delete rules, view the list of price requesters and support to create customer requests.

Details can be viewed here.

Instructions for creating Integration tokens here.

GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza / module-call-for-price-graphql
php bin / magento setup: upgrade
php bin / magento setup: static-content: deploy

To start working with Call For Price GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• The mutation Mageplaza supports is creating customer requests,etc. Details can be viewed here.

Catalog Permissions

Overview

Currently, for websites that have some pages you want to create their own promotion or restrict some customer groups to visit these pages. With the Mageplaza Catalog Permissions extension, admin can restrict access to catalogs with Category, Product Detail, and Static Page/Block pages by customer groups and IP addresses. In particular, you can redirect customers to another page when accessing restricted pages or hiding restricted pages at the frontend.

How to download and install:

• Download Mageplaza Catalog Permissions
• Intall Catalog Permissions

How to configure

1. Configuration

Login to the Admin Magento, choose Stores> Configuration> Catalog Permissions

1.1. General

• Enable: Select Yes to enable the module. You can install Call for Price extension of Mageplaza to contact the store to ask for price or product information or ask for the restricted page you want to access.

• Disable Catalog Search for: Selecting customers from whom you want to restrict Catalog Search at all the pages having the search tab. You can choose to restrict multiple customer groups at the same time. The customer group that is not selected can use Catalog Search normally. If you do not want to restrict any customer group, you can leave this option blank. You can disable catelog search for the following customer groups:

  • NOT LOGGED IN
  • General
  • Wholesale
  • Retail

  

• WhitelistIP(s):

  • Enter the IP address you don’t want to restrict them to specific pages. You can fill in multiple or one range of IP addresses separated by lines. For example: 123.16.32.1, 192.168.1., 192.168..*,…
  • For other IP addresses not included in this field, it will be restricted to choosen pages.
  • If left blank, it is restricted to all IP addresses when accessing the restricted site.

1.1.1. Restrict Category

• Enable: Select Yes to enable Restrict Category and will display a new field Customer Group Restriction under the Content tab when accessing the Catalog> Categories.

• Redirect To: Select the page you want to redirect to after accessing to the restricted category:

  • CMS Page: Display the Select CMS Page field to select CMS Page to be redirected to when access to the restricted category.

    • Select CMS Page: Select CMS page. You can access Content > Page, click Add New Page to create more pages you want to redirect to.

    

  • Select Specific URL: Display the Specific URL field allow you to choose specific URL to be redirected to when accessing the restricted category

    • Specific URL: Enter Url for the Specific URL field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default

• Show Redirect Message From Category Page: Display the message to notify redirecting from the Category Page.

• Hide menu on Frontend:

  • If Yes is selected, it will hide the Category outside the Frontend.
  • And vice versa, selecting No will not hide the Category outside the Frontend

1.1.2. Restrict Product

• Enable: Select Yes to enable Restrict Product and will display a new field Customer Group Restriction under the Content tab when accessing the Catalog> Products.

• Redirect To: Select the page you want to redirect to after accessing to the restricted Product:

  • CMS Page: Display the Select CMS Page field to select CMS Page to be redirected to when access to the restricted Product.

    • Select CMS Page: Select CMS page. You can access Content > Page, click Add New Page to create more pages you want to redirect to.

    

  • Select Specific URL: Display the Specific URL field allow you to choose specific URL to be redirected to when accessing the restricted Product

    • Specific URL: Enter Url for the Specific URL field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default

• Show Redirect Message From Product Page: Display the message to notify redirecting from the Product Page.

• Hide on Category Page & widget:

  • If Yes is selected, it will hide the product on the category page and widget.
  • If No is selected, it will not hide Product on category page and widget and will display product as usual.

1.1.3. Restrict Static Page

• Enable: Select Yes to enable Restrict Static Page and will display a new field Customer Group Restriction under the Content tab when accessing the Catalog> Page.

• Redirect To: Select the page you want to redirect to after accessing to the restricted Static Page:

  • CMS Page: Display the Select CMS Page field to select CMS Page to be redirected to when access to the restricted Product.

    • Select CMS Page: Select CMS page. You can access Content > Page, click Add New Page to create more pages you want to redirect to.

    

  • Select Specific URL: Display the Specific URL field allow you to choose specific URL to be redirected to when accessing the restricted page

    • Specific URL: Enter Url for the Specific URL field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default

• Show Redirect Message From Static Page: Display the message to notify redirecting from the Static Page.

1.1.4. Restrict Static Block

• Enable: select Yes to enable Restrict Static Block and will display a new field Customer Group Restriction when accessing Content > Blocks.

2. Edit Category

• Login to the Magento Admin, choose Catalog> Categories, select new/edit with a restricted category you want
• This section applies the configuration when choosing new/edit for each Category.
• Note: If the Restrict Category in the Configuration section and for each Category here are different, priorities will be given to each category first.

• Enable:

  • Default is No if Enable Restrict Category is enabled.
  • If Yes is selected, it will enable Restrict Category with the category you choose. Show more fields: Restriction Customers Group(s), Redirect To fields, Also Hide Menu, Start Date, End Date.
  • Selecting No will turn off Restrict Category with the category you do not want to restrict it to customers.

• Customer Group: Select the group of customers to apply Restrict Category. Those groups that are not selected will not apply Restrict Category to that category. You can select multiple customer groups at the same time. With the following customer groups:

  • NOT LOGGED IN
  • General
  • Wholesale
  • Retail

• Redirect To: Select the page you want to redirect to after accessing to the restricted category:

  • CMS Page: Display the Select CMS Page field to select CMS Page to be redirected to when access to the restricted category.

    • Select CMS Page: Select CMS page. You can access Content > Page, click Add New Page to create more pages you want to redirect to.

    

  • Select Specific URL: Display the Specific URL field allow you to choose specific URL to be redirected to when accessing the restricted category

    • Specific URL: Enter Url for the Specific URL field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default

  • You can choose Use Config Settings to redirect to the default URL or CMS page that you set in Configuration Restrict Category, at Redirect To field.

• Show Redirect Message From Category Page: Display the message to notify redirecting from the Category Page. If you put a tick on the Use Config Settings field, then the system will display the message set in the Module Configuration.

• Also Hide Menu:

  • Select Yes to hide that category in Frontend. Otherwise, selecting No will display that category in Frontend.
  • You can select Use Config Settings to default to use the configured value at Configuration Restrict Category with Hide menu on Frontend field.

• Start Date:

  • Click the Calendar box to select the start date for Restrict Category.   - If you leave it blank, then applying Restrict Category will start from the date you anable until End Date.

• End Date:

  • Click the Calendar box to select the end date for Restrict Category.
  • If left blank in this field, it will start applying Restrict Category by the date selected in the Status Date field and will not end up applying Restrict Category until it is disabled for that category.

3. Edit Product

• Login to the Magento Admin, choose Catalog S> Products, select new/edit with a restricted Products you want
• This section applies the configuration when choose new/edit for each Product.
• Note: If the Restrict Products in the Configuration section and for each Product here are different, priorities will be given to each Product first.

• Enable:

  • Default is No if Enable Restrict Product is enabled.
  • If Yes is selected, it will enable Restrict Product with the Product you choose. Show more fields: Restriction Customers Group(s), Redirect To fields, Also Hide Menu, Start Date, End Date.
  • Selecting No will turn off Restrict Product with the Product you do not want to restrict it to customers.

• Customer Group: Select the group of customers to apply Restrict Product. Those groups that are not selected will not apply Restrict Product to that Product. You can select multiple customer groups at the same time. With the following customer groups:

  • NOT LOGGED IN
  • General
  • Wholesale
  • Retail

• Redirect To: Select the page you want to redirect to after accessing to the restricted Product

  • CMS Page: Display the Select CMS Page field to select CMS Page to be redirected to when access to the restricted Product.

    • Select CMS Page: Select CMS page. You can access Content > Page, click Add New Page to create more pages you want to redirect to.

    

  • Select Specific URL: Display the Specific URL field allow you to choose specific URL to be redirected to when accessing the restricted Product

    • Specific URL: Enter Url for the Specific URL field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default

  • You can choose Use Config Settings to redirect to the default URL or CMS page that you set in Configuration Restrict Product, at Redirect To field.

• Also Hide Menu:

  • Select Yes to hide that Product in Frontend. Otherwise, selecting No will display that Product in Frontend.
  • You can select Use Config Settings to default to use the configured value at Configuration Restrict Product with Hide menu on Frontend field.

• Start Date:

  • Click the Calendar box to select the start date for Restrict Product.   - If you leave it blank, then applying Restrict Product will start from the date you anable until End Date.

• End Date:

  • Click the Calendar box to select the end date for Restrict Product.
  • If left blank in this field, it will start applying Restrict Product by the date selected in the Status Date field and will not end up applying Restrict Product until it is disabled for that Product.
  • Show Redirect Message From Product Page: Display the message to notify redirecting from the Product page. If you put a tick on the Use Config Settings field, then the system will display the message set in the Module Configuration.

4. Edit Pages/Block

• Login to the Magento Admin, choose Content > Elements > Pages/Blocks, select new/edit with a Restrict Static Page/Restrict Static Block you want.
• This section applies the configuration when choose new/edit for each Page/Block.
• Note: If the Restrict Static Page/Restrict Static Block in the Configuration section and for each Page/Block here are different, priorities will be given to each Page/Block first.

Page

Block

• Enable:

  • Default is No if Enable Restrict Product is enabled.
  • If Yes is selected, it will enable Restrict Product with the Product you choose. Show more fields: Restriction Customers Group(s), Redirect To fields, Also Hide Menu, Start Date, End Date.
  • Selecting No will turn off Restrict Product with the Product you do not want to restrict it to customers.

• Customer Group: Select the group of customers to apply Restrict Product. Those groups that are not selected will not apply Restrict Product to that Product. You can select multiple customer groups at the same time. With the following customer groups:

  • NOT LOGGED IN
  • General
  • Wholesale
  • Retail

• Start Date:

  • Click the Calendar box to select the start date for Restrict Product.   - If you leave it blank, then applying Restrict Product will start from the date you anable until End Date.

• End Date:

  • Click the Calendar box to select the end date for Restrict Product.
  • If left blank in this field, it will start applying Restrict Product by the date selected in the Status Date field and will not end up applying Restrict Product until it is disabled for that Product.

• With Page

• Redirect To: Select the page you want to redirect to after accessing to the restricted Product:

• CMS Page: Display the Select CMS Page field to select CMS Page to be redirected to when access to the restricted Product.

  • Select CMS Page: Select CMS page. You can access Content > Page, click Add New Page to create more pages you want to redirect to.

  

• Select Specific URL: Display the Specific URL field allow you to choose specific URL to be redirected to when accessing the restricted Product

  • Specific URL: Enter Url for the Specific URL field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default

• With Block:

  • Replace By: Will be replaced by the Show/Hide Editor button. Here, it is possible to configure the block page and when accessing the restricted Block page will be replaced by the block page you have configured.
  • If left blank, Replace By will default to the Replace By content above.

5. Rest API

Mageplaza Catalog Permission extension supports Rest API to limit or redirect when accessing the Category page, Product page, Static Page, and Static Block.

For more details, please visit here.

Learn how to create Integration tokens here.

6. GraphQL

To start working with Catalog Permission GraphQL for Magento, you need to meet the following requirements:

• Utilize Magento 2.3.x or 2.4.x. Return the site to the developer mode.
• Set GraphQL endpoint as http:///graphql in the URL field, click Set endpoint. (Ex: http://develop.mageplaza.com/graphql)
• The mutations that Mageplaza supports are setting restrictions or redirects when accessing pages, blocks, etc. For more details, please visit here.

Notation

• When you want to remove the extension, you should use composer to run the command: bin/magento module:uninstall Mageplaza_ CatalogPermissions

• If you delete the extension manually, you need to delete mpcp_isactive, mpcp_customergroup, mpcp_redirectto, mpcp_usecf_redirectto, mpcp_hideaction, mpcp_usecf_hideaction, mpcp_startdate, mpcp_enddate attribute in the database.

  • Access the database to delete: Access to eav_attribute table. In the attribute_code column, find and delete the mpcp_isactive, mpcp_customergroup, mpcp_redirectto attribute, mpcp_usecf_redirectto, mpcp_hideaction, mpcp_usecf_hideaction, mpcp_startdate, mpcp_enddate.

  

Checkout Flow Pro

Overview

Mageplaza Checkout Flow Pro is an effective solution for accelarating checkout process:

• Speed up the shopping journey with Quick View popups and Ajax cart
• Attach free gifts to multiple places on your store
• Streamline the checkout process with a simplified interface
• Auto-send abandonment cart emails to follow-up
• Keep customers coming back to store by coupon codes auto-generated in the Thank You Page
• Boost sales and reduce abandonment cart rate ultimately

Download & Install

• Download Mageplaza Checkout Flow Pro
• How to Install

How to use

This solution contains 3 extensions. Please click on each link to see the User Guide of each extension:

• Mageplaza Ajax Cart - User Guide
• Mageplaza Free Gifts - User Guide
• Mageplaza One Step Checkout Ultimate - User Guide
• Mageplaza Thank You Page - User Guide

CommWeb

Overview

Commonwealth Bank of Australia is a multinational bank, offering many of Australia’s leading financial services. Mageplaza CommWeb extension will allow you to allow payment via Commonwealth Bank on the store of Magento 2. With CommWeb, you can make online payments quickly and reliably.

Mageplaza CommWeb extension allows customers to make payments with MasterCard, Visa, Discover, American Express, Diners, JBC. It also is compatible with Mageplaza One Step Checkout extension and Payment Restriction extension.

Download and Install

• Download CommWeb extension
• Installation guide

How to use

1. Commonwealth Bank

• To be able to configure CommWeb you need a Commonwealth Bank account.
• Go to this link to login to Commonwealth Bank. After login sucessfully, from the left sidebar, select Account Settings > Account Settings > Account Details > Select API Keys to get Public Key and Private Key

2. Make payments with CommWeb

• Checkout page: select CommWeb payment method. Enter credit card information including: Credit Card Number, Expiration Date, Card Verification Number.

• Magento Default: Displays CommWeb payment by default of Magento

• Popup Checkout: Displays CommWeb payment when clicking the Place Order button

• Iframe Checkout: CommWeb payment method is displayed as iframes

Note: To be able to make payments with CommWeb, the currency on the Magento site needs to match the currency of Commonwealth Bank.

• To set currency for the Commonwealth Bank, log in to your Commonwealth Bank account. Then from the left sidebar, select Account Settings > Account Settings > Developer, at the droplist, select the appropriate currency.

Test card numbers

 

Card Number	Card Type	Payment Status	Refund Status
2222 4053 4324 8877	MasterCard	APPROVED	APPROVED
2222 9909 0525 7051	MasterCard	APPROVED	APPROVED
2223 0076 4872 6984	MasterCard	APPROVED	APPROVED
2223 5771 2001 7656	MasterCard	APPROVED	APPROVED
5105 1051 0510 5100	MasterCard	APPROVED	APPROVED
5111 0100 3017 5156	MasterCard	APPROVED	APPROVED
5185 5408 1000 0019	MasterCard	APPROVED	APPROVED
5200 8282 8282 8210	MasterCard	APPROVED	APPROVED
5204 2300 8000 0017	MasterCard	APPROVED	APPROVED
5204 7400 0990 0014	MasterCard	APPROVED	APPROVED
5420 9238 7872 4339	MasterCard	APPROVED	APPROVED
5455 3307 6000 0018	MasterCard	APPROVED	APPROVED
5506 9004 9000 0436	MasterCard	APPROVED	APPROVED
5506 9004 9000 0444	MasterCard	APPROVED	APPROVED
5506 9005 1000 0234	MasterCard	APPROVED	APPROVED
5506 9208 0924 3667	MasterCard	APPROVED	APPROVED
5506 9224 0063 4930	MasterCard	APPROVED	APPROVED
5506 9274 2731 7625	MasterCard	APPROVED	APPROVED
5553 0422 4198 4105	MasterCard	APPROVED	APPROVED
5555 5537 5304 8194	MasterCard	APPROVED	APPROVED
5555 5555 5555 4444	MasterCard	APPROVED	APPROVED
4012 8888 8888 1881	Visa	APPROVED	APPROVED
4111 1111 1111 1111	Visa	APPROVED	APPROVED
6011 0009 9013 9424	Discover	APPROVED	APPROVED
6011 1111 1111 1117	Discover	APPROVED	APPROVED
3714 496353 98431	American Express	APPROVED	APPROVED
3782 822463 10005	American Express	APPROVED	APPROVED
3056 9309 0259 04	Diners	APPROVED	APPROVED
3852 0000 0232 37	Diners	APPROVED	APPROVED
3530 1113 3330 0000	JCB	APPROVED	APPROVED
3566 0020 2036 0505	JCB	APPROVED	APPROVED

Card Verification Number (CVC):

• Card Verification Number (CVC) = 123 for Card Types are MasterCard, Visa, Discover. Diners, JBC
• Card Verification Number (CVC) = 1234 for Card Type is American Express

How to Configure

1. Configuration

Login to the Magento Admin, choose Sales > Payment Settings > Payment Method > CommWeb Payment by Mageplaza > Configure

1.1. Credentials

• Environment:
  • Admin can choose Sandbox environment to check CommWeb functions.
  • When you want to apply for online payment, admin needs to change the environment to Production.
• Public Key:
  • Enter the Public Key get from the instructions above
  • If left blank or incorrectly entered, the system will not connect to CommBank and display an error message
• Private Key:
  • Enter the Private Key get from the instructions above
  • If left blank or incorrectly entered, the system will not connect to CommBank and display an error message
• Test Credential button: Admin can check the connection with CommBank by clicking the Test Credential button.

1.2. Card

• Enable: Select Yes to enable the use of payment features with CommWeb
• Title: Enter the title for the card, the name of the card will be displayed at the Checkout page, Order Information at the frontend and Payment Information in the backend.
• Displayed at the checkout page

• Displayed in Order Information

• Display at Payment Information in backend

• Payment Action:
  • Authorize: Payment will only be captured when admin creates an invoice for customer’s order. When the invoice is successfully created, admin can receive money from customer’s card
  • Authorize and Capture: Payment will be captured immediately after the customer place order successfully. At that moment, the customer’s card will pay for the order and the invoice will be created
• New Order Status: status of order when creating new payment with CommWeb.

• Processing: Status of order is Processing when order is completed. You can change the status in the backend with each order.
• Suspected Fraud: The order’s status is Suspected Fraud when the order is completed. You can change the status in the backend with each order. With this status admin can accept payment or reject payment and then transfer status to Processing.

• Show Logo: Choose Yes to allow the CommWeb logo to be displayed at the frontend
• Display Checkout: Choose displaying style when checking out with CommWeb. There are several ways, as follows:

• Magento Default: Displays the payment method at Magento’s default checkout page

• Popup Checkout: CommWeb payment method display when checkout as popup. When you click the Place Order button, the popup will appear.
  • To use Popup Checkout, you must not use IP adress in the Magento domain.

• Iframe Checkout: CommWeb method payment display at the checkout page as CommWeb iframe insertion

• Card Types: Select the type of card that allows checkout, can select multiple types at once.

• Cards will be authenticated when customer completes the card number when checking out. For cards not selected in this section, there will be an invalid message for the customer. With the card not selected, it will not be displayed on the Checkout page and Backend order.
• Payment from Applicable Countries: Select a country to apply the payment method
  • All Countries: Applies to all countries
  • Specific Countries: Only applicable for the countries selected in the Payment from Specific Countries field.
  • To restrict this payment with more conditions, see Payment Restrictions module.
    • Payment from Specific Countries: Select countries that are allowed to display and pay using CommWeb
• Maximum Order Total: Enter the maximum value of order to display and pay with CommWeb
  • If the value of the order is greater than the information of this school will not display CommWeb payment method when checkout
  • If left blank, there is no limit to the value of the order
• Debug Mode: If Yes is selected, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Specify the display position of payment method via CommWeb compared to other payment methods
  • 0 is the number with the highest display position. The smaller the number, the more priority will be displayed in the first position.

2. Admin Order

At Magento Admin, access Sales> Orders > Action > View > Payment Information, you can view payment information via CommWeb

3. Order Frontend

Go to My Account > My Orders > View Order, you can view payment information with the CommWeb card saved at the Payment Method section of the order.

NOTE: Install the library for Mageplaza CommWeb extension

When installing Mageplaza CommWeb extension you need to install its library:

• Please visit the link then click on the Download link
• From the Magento site, go to the /lib/internal directory, then create a new folder called Mageplaza
• Unzip the downloaded file, add the lib folder in the downloaded file to the Mageplaza folder created above, change the lib name to CommWeb
• Add the php file called registration.php with the following command:

Company Accounts

Introduce

Mageplaza’s Company Account Extension is a useful tool that allows you to create and manage company customers easily. With Mageplaza Company Account, store admin and customers can create company accounts, in which, each company will have a company admin and multiple sub-accounts with different roles. Each role will be assigned certain access permission with the company. Mageplaza Company Account extension is fully compatible with Mageplaza One Step Checkout extension and Mageplaza PDF Invoice extension.

How to use

Customers create the Company Account request on the front end

Once the request is approved, users can take multiple actions with the company

• View/ Edit Company

• Manage Users

• Manage Orders

• Manage Company Downloadable Products

• Manage User Roles

• Admin can manage all company accounts in the backend with a grid: add/ edit/ remove companies

How to configure

1. Configuration

1.1 General Configuration

• Enable: Choose “Yes” to use the module
• Allow Customer Group(s) to Request Company Creation : Choose customer groups that are allowed to request the company creation
• Auto Approve Company: Choose “Yes” if the you allow company creation request to be auto-approved
• Action with Sub-account after Being Removed from Company: Choose the actions for any sub-account after it’s removed from the company

• Do Nothing: remove the account from the company completely but still keep it in the customer list of the store
• Inactive account: keep the account in the customer list of the store but inactive it
• Completely delete: remove the user from both the company and the customer list of the store
• Unassign all company orders: remove the user from the company and all orders that have been placed by this user will also be removed from the company orders
• Auto Add Default Address for New Users:
  • Choose No if you don’t want to auto-add the default addressed for new users
  • Company Admin Address: auto-add the address of the company admin user for new users
  • Company Legal Address: auto-add the company legal address for new users

1.2 Email configuration

1.2.1 Admin Notification

• Enable New Company Request Notification: Choose Yes to enable notification for the store admin when there is a new company account creation request
• Sender: Choose the sender for the email. There are five values to choose from the dropdown.

• Receiver: Choose the receiver for the email. There are five values to choose from the dropdown.

• Template for New Company Request Notification: Choose the template for the email. You can create a new template in Marketing > Communications > Email Templates > Add New Template.

1.2.2. Company Admin Notification

• Sender: Choose the sender for the email. There are five values to choose from the dropdown

• Enable Company Status Change Notification: Choose Yes to allow Company Admin to receive an email notification when there is a change in Company Status. If you choose Yes, the field Template for Status Change Notification will show up.
  • Template for Status Change Notification: Choose the template for the email. You can create a new - template in Marketing > Communications > Email Templates > Add New Template.
• Enable User Update Notification: Choose Yes to allow Company Admin to receive email notifications when there are updates of company users
  • Template for User Update Notification: Choose the template for the email. You can create a new template in Marketing > Communications > Email Templates > Add New Template
• Enable New Order Notification: Choose Yes to allow Company Admin to receive email notifications when new company orders are placed
  • Template for New Order Notification: Choose the template for the email. You can create a new template in Marketing > Communications > Email Templates > Add New Template
• Enable Role Notification: Choose Yes to allow Company Admin to receive email notifications when there are company user role updates
  • Template for Role Update Notification: Choose the template for the email. You can create a new template in Marketing > Communications > Email Templates > Add New Template

1.2.3. Company User Notification

• Sender: Choose the sender for the email. There are five values to choose from the dropdown

Choose the template for all email notifications as following. You can create a new template in Marketing > Communications > Email Templates > Add New Template

• Template for Company Update Notification
• Template for User Update Notification
• Template for New Order Notification
• Template for Role Update Notification

2. Manage Companies

2.1 Grid

From the Admin Panel, go to Customers > Company Accounts > Manage Companies

• The grid shows information about all Companies including ID, Company Name, Status, Email, Phone Number, Admin, Customer, Address, Created, Modified
• Action:
  • Delete: Delete company
  • Change Status: Change the status of the company
• You can edit each company in the grid by hit button Edit
• You can sort/ filter companies, show/ hide column in the grid and export the grid into csv or xml files

2.2 Create/Edit Company

From the Admin Panel, go to Customers > Company Accounts > Manage Companies > Add New Company/Edit Company

2.2.1 Company Information tab

• Name: fill in the Company name
• Status:
  • Active Company: Allow the company to take actions
  • Inactive Company: Stop the company from taking actions
• Reject Company:
• Company Legal Name
• Company Email
• Vat/Tax ID
• Reseller ID
• Company Administrator: click to choose an admin for the company from the user list
• Customer Group: Choose the customer group for the company and its users
• Sales Representative: Select the Sales Representative for the company. You can configure Sale Presentative in System > Permissions > All users

2.2.2. Company Legal Address tab

• Street: Fill in the street where the company address is
• City: Fill in the city where the company address is
• Country: Choose the country where the company address
• State/Province
• Zip/Postal Code
• Phone Number

2.2.3. Company Users tab

After creating new company, go to Edit Company* you will see Company Users tab. Here there are information of company users including ID, First Name, Last Name, Status, Email, Role and Remove action.

Note

• When removing an user, you cannot remove the admin user
• Users after being removed from the company will be treated due to the setting in General Configuration
• Add New User: After you click on the button Add New User, a pop up will show up to let you add multiple users to the company at once

3. Add company for each customer

Go to Admin panel > Customer > All Customer > edit Customer > Company tab

• Is Active: Choose Yes to activate the user
• Company: Choose the company for the customer
• Role : Choose the user role for the customer
• Job Title: Fill in the Job title for the customer vPhone Number: Fill in the contact number
• Frontend settings

4.1. Register Company

• Company Information:
  • Fill in all required fields: Company Name, Company Email
  • Fill in optional fields: Company Legal Name, Vat/Tax ID, Reseller ID
• Company Legal Address: Fill in all fields
• Click on Submit button to finish to creating company request

4.2 Edit Company info

After the company is activated, users can edit the company information by clicking the link Edit and change the information.

4.3. Manage Users

• Manage all company users
• Add New User: Click on Add New User button to edit the new user information in the pop up

• User Information: Fill in First Name, Last Name, Email for the user
• Company Role:
  • This user is: Active or Inactive
  • User Role: Select a role for the user from the dropdown
  • Job Title
  • Phone Number
• Current User Identity Verification: fill in the password of the account that you are using to add the new user
• Click on Save button
• Edit user
  • Click on Edit to change the user information

• Remove user
  • Click on link Remove, you will see the confirmation pop-up requiring a password > fill in the password of the current account that you are using > click on Delete button

4.4. Manage Orders

• Manage all orders of the company
• Company users/sub-accounts can take actions such as ** View order** Reorder and other actions if allowed by the admin

4.5 Company Downloadable Products

All Downloadable products ordered by the company will show up here.

4.6 User Roles

Manage all company roles

• Add New Role: click on Add New Role button to open the editing pop-up
  • Info tab:

- Role Information: Fill in the Role Name
- Current User Identity Verification: Fill in the Current Password of the account that you are using to create the new role 

• Role Resource tab:

- Resource Access: there are two option which is **All** and **Custom** 
  - All: allow full permission 
  - Custom: the role can only have selected permission 

• Additional Permissions tab:

- Order Quantity Limit per User: The maximum number of orders can be placed (the role cannot place more orders if until the admin or authorized users increase this number) 
- Amount Limit Per Order: The maximum amount can be placed **per order** 

• Click Save to finish
• Edit Role:
  • Click on the Edit link

- All fields will be the same as when Add New Role
- Click Save button to finish 

• Remove Role
  • Click on the Remove link
  • In the pop-up > Fill in Current Password of the account your are using

- Click on Remove button to finish deleting the role

5. Email

• Email for the store admin when there is a new company creation request

• Company Status Change Notification

• New User Notification

• User Update Notification

• User Deleted Notification

• New Order Notification

• New Role Notification

• Role Update Notification

• Role Deleted Notification

• User Invited Notification

6. How to add Company Name to sales emails?

6.1 Create an email template

• Go to Marketing > Communications > Email Template > Add New Template or Edit Template
• Load the Email Template which you want to add the company name to

• Add this variable to any position that you wish to: {{var order.mpca_company_name}}

For example: If you want to add the company name to Order Confirmation emails, just add the variable to the template New Order emails:

6.2. Apply new email templates

Go to Stores > Settings > Configuration > Sales > Sales Emails

• On tabs Order/ Invoice/ Shipment/ Credit Memo, select the corresponding “just-created” Email Templates

6.3 Check the display of the company name

• Place a test order on the frontend
• Check the automatic email sent to the customer

7. REST API

Mageplaza Company Account extension supports the use of API Rest to view company information. The extension also supports adding, modifying and deleting user roles, user companies directly through API request.

Details can be found here.

Instructions for creating integrated tokens are here.

8. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-company-accounts-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

To start working with Company Account GraphQL in Magento need the following requirements:

• Use Magento 2.3.x.
• Return the site to developer mode
• Set the GraphQL endpoint to http://<magento2-3-server>/graphql in the URL box, click Set endpoint. (for example: http://develop.mageplaza.com/graphql)
• Details of the supported queries can be found here.

Configurable Products Preselect

Overview

When customers access a page of any configurable product, it is hard for them to review and choose the attributes if no options are available. Configurable Products Preselect of Mageplaza supports displaying certain combinations of a Configurable product, helping to orient and save time for customers. With this extension, you can set the selections you like and display them by default at the Product View Detail Page. This extension also supports 4 types of Preselect: The First Option of Each Attribute Option, Default Product, The Cheapest Product and The Most Expensive Product. It is fully compatible with Mageplaza Quick View & AJAX Cart, Mageplaza Seo and Layered Navigation.

How to download and install

• Download Mageplaza Configurable Products Preselect
• How to Install

How to Configure

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Configurable Products Preselect > Configuration

1. Configuration

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Configurable Products Preselect > General Configuration

• Enable: Select Yes to turn on the module Configurable Products Preselect.
• Preselect Type: There are 4 types of Preselect as follows:

• First-option Preselect: This type will default to taking the product with the first attributes set for Configurable Products
• Cheapest-option Preselect: This type will choose to display the product with the lowest price
• Most Expensive-option Preselect: This will choose to display the highest priced product.
• Default-option Preselect: This is the default pre-selected product. If you choose this type, go to the Edit page of each Configurable Product to select the Default option for that product at the Configuration tab. (details instruction at Part 2)
• Preselect on Category Page: If the child product has Swatch Attribute, it can be applied on Category page. To understand the Swatch Attribute you can refer it here.
  • Select Yes to enable this feature
  • Select No to disable this feature

2. Edit Configurable Product to select Default Preselect Option

When Preselect Type = Default-option Preselect, you can follow these steps to select Default Preselect Option for each product:

• Step 1: From Admin Panel, go to Products > Catalog
• Step 2: Filter products by Type = Configurable Product
• Step 3: Choose a product. Go to Tab Configurations and tick to select a product to set it as the Default Preselect Option.

Frontend

1. Category Page

2. Product View Details

Configurable Product Grid View

Overview

Normally, if customers want to buy some child products of configurable products, they must constantly add each child product (simple product) to cart separately, which making the purchase process extremely complicated. But with Mageplaza Configurable Product Grid View, it becomes easier than ever.

The module allows adding to cart multiple children products of a configurable product at the same time by displaying all of the available children products in table/grid, with different displaying formats for tablets and mobile. In addition, the module allows admins to turn on/off the Configurable Product Grid by each product.

Mageplaza Configurable Product Grid View is fully compatible with Mageplaza Quick View to help customers save the most time.

How to download and install

• Download Mageplaza Configurable Product Grid View
• How to Install

How to use

Show all the available simple products of the configurable product as a table:

Show Total Summary when selecting child products:

Shown on Configurable Products Grid View:

How to Configure

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Configurable Product Grid View

1.Configuration

1.1. General

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Configurable Product Grid View, select General

• Enable: Select Yes to activate the module.
• Allow Customer Group(s):
  • Select the customer group who can view all available Simple Products of the Configurable Product in a table.
  • You can choose multiple customer groups.

1.2. Display

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Configurable Product Grid View, select Display

• Display Information on Mobile: Select the information column to display at mobile frontend with all available child products in table form.
• Display Information on Tablet: Select the information column to display at tablet frontend with all available child products in table form.
• Display Information on Desktop: Select the information column to display at desktop frontend with all available child products in table form.

• Show Out Of Stock Products: Select Yes to show out of stock products
• Total Summary:
  • Select Yes to display the list of selected products.
  • Click Reset if you want to remove previous options and add new products quickly.

2. Configurable Product Edit Page

From the Admin Panel, go to Catalog > Products > Edit/Add Product

• Active Grid View:
• Choose Active to allow configurable product to show as table.
• Inactive: turn off the display of the table for the product.

3. Product Attribute Detail

From the Admin Panel, go to Stores > Attributes > Product > Edit/ Add new Attribute

• Mageplaza Grid View:
  • Choose Active to allow the attribute to be shown on Configurable Products Grid View.
  • If you select Inactive, other attributes will be displayed along with each option of a specific attribute

Ex: In the color attribute, if you select Mageplaza Grid View = Inactive, then when you click on each color, other attributes like size, SKU, etc. will show accordingly:

4. Compatible with Quick View

When installing Quick View module, at each Simple Product will display the search button.

Click on Search button will display popup allowing to select multiple chield products of a parent product at the same time:

Countdown Timer

Overview

In order to increase the accessibility of customers and demand for products, Mageplaza developed the Countdown Timer extension. This module allows admin to add countdown timer displayed on the website for new products or promotional products. There are 2 types of countdown timer which are before the promotion sale and while running the promotion sale. In addition, there are 5 countdown timer templates available for admin to easily select and edit in accordance with the website design.

How to download and install

• Download Mageplaza Countdown Timer
• How to Install

How to use

Display the countdown for the catalog

Display countdown timer for none product

Support 5 clock types

How to Configuration

From the Admin Panel, go to Content > Countdown Timer > Configuration

1. Configuration

From the Admin Panel, go to Content> Countdown Timer> Configuration, select General

• Enable: Select Yes to turn on the module

2. Countdown Timer

From the Admin Panel, go to Content> Countdown Timer> Manage Rules

• This is where the discount list is displayed.
• From Countdown Timer, admin can capture basic information of Countdown Timer such as ID, Name, Status, Customer Groups, Store View, Priority, Action.
• Action:
  • Delete: Delete the information on the Countdown Timer page.
  • Change Status: Change the status of the selected Countdown Timer.
  • Edit: Navigate to the previous Countdown Timer Infomation page.
  • In addition, admin can Filter, Change Store View, Hide / Display Columns.

3. New/Edit Countdown Timer

From the Admin Panel, go to Content> Countdown Timer> Manage Rules> Add new

3.1. General

From the Admin Panel, go to Content> Countdown Timer> Manage Rules> Add new, select General

• Name: Enter a name for Countdown Timer, this is a required field

• Status: Select Enable to display Countdown Timer in Frontend.

• Store View(s): Select the store in which Countdown Timer is displayed, you can select multiple stores

• Customer Group(s): Select the customer group for which Countdown Timer will be visible, you can select multiple customer groups.

• Apply for: Countdown Timer applies to each option:

  • None Product Base: not applicable based on product, the position to show clock will depend on where you put widget (instruction in point 4)
    • Displays two more field Start countdown date and End countdown dates.
  • All Products with Special Price: Countdown Timer displayed on all products with special price at Frontend.

  

  • Specific Products with Special Price: Choose to apply to each product with special price.

    • Show more item information Conditions
    • You can also choose the catalog to apply Countdown Timer

    

  • Inherit condition from Catalog Rules: inherit conditions from the catalog rule

    • Show additional Select Catalog Price Rule field

    

• Priority: default value is 0. Countdown Timer has smaller Priority numbers will be displayed first at Frontend.

3.2. Display

From the Admin Panel, go to Content> Countdown Timer> Manage Rules> Add new, select Display

• Display on:

  • Select position to display the Countdown Timer in Frontend.
  • Only show the Product View option when Apply for = Apply for product base.

• Snippet Code: display the code segment.

  • CMS Page/Static Block: Copy and paste the code into the page in which you want to display the Countdown Timer
  • Phtml file file: Copy and paste the code into the .phtml file in which you want to display Countdown Timer
  • Layout file: Copy the code and insert it into Magento’s .xml file or other extensions you want to display Countdown Timer.

• Before Starting Countdown:

  

  • Enable: Select Yes to display Countdown Timer before product promotion start.
  • Clock Style: choose 1 of 5 available timer types.
  • Template on Product View: Insert the variables {{clock}}, {{save_amount}} & {{save_percent}}, allow showing countdown timer at Product View before sales with the default template:

  <div class="mp-countdown-title">This product is discounting {{save_percent}}</div>
                            {{clock}}
                            <div class="mp-countdown-message">Hurry up!</div>
  

  • Template on Category View: Insert the variables {{clock}}, {{save_amount}} & {{save_percent}} allow showing countdown timer at Category View before sales with the default template:

  <div class="mp-countdown-title">Discounting {{save_percent}}. Hurry up!</div>
                            {{clock}}
  

  • In which:
    • {{clock}}: Show clock
    • {{save_amount}}: Show discounted amount
    • {{save_percent}}: Show discounted percentage
  • Title Color: Choose title color displayed above the clock.
  • Message Color: Select the color for the message displayed below the clock.
  • Clock Background Color: Select the inside background color of the clock.
  • Number Color: Select the number of colors displayed.
  • Text Color: Select the color for the text inside the clock

  

• Time Remaining Countdown:

• Enable: Select Yes to display Countdown Timer while product is on discount program
• Clock Style: choose 1 of 5 available clock types.
• Template on Product View: Insert the variables {{clock}}, {{save_amount}} & {{save_percent}}, allow showing countdown timer at Product View while running sales with the default template:

<div class="mp-countdown-title">This product is discounting {{save_percent}}</div>
                          {{clock}}
                          <div class="mp-countdown-message">Hurry up!</div>
<div class="mp-countdown-title">This product is discounting {{save_amount}}</div>
{{clock}}
<div class="mp-countdown-message">Hurry up!</div> .

- **Template on Category View**: Insert the variables `{{clock}}, {{save_amount}} & {{save_percent}}` allow showing countdown timer at **Category View** while running sales with the default template:

<div class="mp-countdown-title">Discounting {{save_percent}}. Hurry up!</div>
                          {{clock}}

• In which:
  • {{clock}}: Show clock
  • {{save_amount}}: Show discounted amount
  • {{save_percent}}: Show discounted percentage
• Title Color: Choose title color displayed above the clock.
• Message Color: Select the color for the message displayed below the clock.
• Clock Background Color: Select the inside background color of the clock.
• Number Color: Select the number of colors displayed.
• Text Color: Select the color for the text inside the clock

4. Widget

You can put Countdown Timer anywhere by creating a widget. To generate widget, please do the following steps:

Step 1:

From the Admin Panel, go to Content > Elements > Widget, select Add new Widget

Step 2: Select Type = Mageplaza Countdown Timer, choose the current theme at Design Theme, then click to Continue

Step 3: Fill in the required information

Step 4: Select the position to display widget

Step 5: Select rule applying to widget

Step 6: Save widget and check the store frontend

5. Rest API

Mageplaza Coutdown Timer extension supports Rest API to add data to Countdown Timer. This enables store owers to create, edit, view, delete, manage information of the extension. Chi tiết có thể xem tại đây.

View guildlines to create tokens here.

Note: Get Products Guest vs Get Products Mine

• The field Date will be plused 1 day in comparison with the date in admin setting For example: To date in admin is 2020/09/30 23:59:59; API is 00:00:00. So this equals that the due date is 01/10/2020
• There are 2 keys: type và id, in which, type has value = 0 and 1. This means Display On = Category and Product Page.

For example: type= 1, id= 14 (product id). Countdown Timer of that product is displayed.

Cron Schedule

Overview

Mageplaza Cron Schedule assists Magento admin control and report Cron related tasks. Admins can set up, check any Cron Jobs they quickly and easily. And whenever any Cron Job is found that has problems such as Error or Missed, you will always be notified via email.

You should install Mageplaza SMTP to avoid your email being sent to the spam box. It is fully compatible with the Cron Schedule extension.

How to download and install

• Download Mageplaza Cron Schedule
• How to Install

How to use

Admin can receive notification message when running cron job gets error:

Email admin when running cron jobs, Missed and Error:

Show detail Cron Job when hovering on green bars - Crons run successfully

Show detail Cron Job when hovering on blue bars - Crons are waiting for approval to run

Show detail Cron Job when hovering on red bars - Crons run failed

Show detail Cron Job when hovering on red bars - Crons are miss run

Show detail Cron Job when hovering on purple bars - Crons are running

How to Configure

From the Admin Panel, go to System > Cron Schedule > Configuration

1. Configuration

From the Admin Panel, go to System > Cron Schedule > Configuration, select General

• Backend Notifications: Select Yes to display a notification when running cron jobs is fails.

• When admin click on Here will be directed to the Cron Jobs Log page.
• Email Notifications:
  • Select Yes to send a notification to admin when running cron jobs, report only Missed and Error Crons.
  • Install Mageplaza SMTP to avoid email sent to spam box.
• Sender: Select the representative to send the email to notify the customer:

• Send To:
  • Enter the admin email address.
  • You can enter multiple emails, each separated by commas (,).
• Email Template:
  • Select Email template sent automatically to admin.
  • You can access Marketing > Email Templates, select Add New Templates to create a notification email template
  • Instructions on how to create new email templates can be found here
• Schedule For Email: Choose the time to send an email error message after cron jobs finish:

• Auto Clear Log Every:
  • Set the time to auto clear log. Calculated by day.
  • If Empty or 0, the cron jobs log will not be clean.

2. Grid

There are three methods to run Cron manually:

• Method 1: Run the command: php bin/magento cron:run
• Method 2: Click Run All Cron Jobs at Manage Cron Jobs Page.
• Method 3: Tick to choose the Cron Jobs you want to check at Manage Cron Jobs table, then choose Action = Execute.

Note:

• First time running Cron, all the cron schedules are in Pending Status. You can view them at cron_schedule table or Cron Jobs Log Page.
• The second time running Cron, there are two cases:
  • The cron schedule will be Executed if its starting time is over current time but still smaller than 2 mins (The time set at field Missed If Not Run Within)
  • The cron schedule will be assigned as Missed status if its starting time is over 2 mins
• You can view or change the Missed Time by:

From the Admin Panel, go to Stores > Configuration > Advanced > System > Cron, change it in the field Missed If Not Run Within

2.1. Manage Cron Jobs

From the Admin Panel, go to System > Cron Schedule > Manage Cron Jobs

• This is where Cron Jobs information is displayed.
• From Manage Cron Jobs, admin can capture basic information such as Cron Job Code, Group Name, Status, Instance Classpath, Job Method, Time Schedule, Action.
• Action:
  • Delete: Delete information on Manage Cron Jobs page.
  • Change Status: Change the status of selected Cron Jobs.
  • Execute: Running Cron Jobs.
  • Edit: Navigate to the edit page for information Cron Jobs created earlier. Only show Edit button with the crons created by admin. Not editable with premade crons.
• Run All Cron Jobs: run all Cron Jobs in the table.
• In addition, admin can filter, change store view, hide/ display columns.

2.2. Create New Cron Jobs

From the Admin Panel, go to System > Cron Schedule > Manage Cron Jobs, select Add New

• Cron Job Code:
  • Enter the code of Cron Jobs.
  • This is a required field.
• Group Name:

• Choose the group suitable for cron job applying
• In which:
  • All groups are available on Magento EE 2.2.x
  • Magento CE 2.1.x only has two groups: Default and Index
  • Magento CE 2.2.x has three groups: Default, Index and Ddg_automation
  • Magento CE 2.3.x has four groups: Default, Index, Ddg_automation and Consumers
• Status: Select Enable for Cron Jobs to work.
• Instance Classpath:
  • Enter the path to the object, or called namespace
  • This is a required field.
  • Example: Mageplaza\CronSchedule\Model\Test
• Job Method:
  • Enter the Method name (Each object has several methods to fill in this field)
  • This is a required field.
  • Example: execute, recurring billing
• Time Schedule:
  • Enter the runtime of Cron Jobs.
  • Using Cron format here to set time for running cron job.
  • This is a required field.
  • Example: * * * * * means that cron will be run once every minute.

3. Cron Jobs Log

• From the Admin Panel, go to System > Cron Schedule > Cron Jobs Log

• This is where the Cron Jobs information is displayed running in 5 states: Error, Missed, Pending, Running, Success.
• From Cron Jobs Log, admin can capture basic information such as ID, Job Code, Status, Message, Total Executed Time, Created At, Scheduled At, Executed At, Finished At, Action.
• Action:
  • Delete: Delete the information on the Cron Jobs Log page.
  • View: View detailed information of running Job Code, only can see the cron jobs created by admin.
  • Clear All: Delete the entire history of running Cron Jobs before.
• In addition, admin can filter, change store view, hide/ display columns.

4. Cron Jobs Timetable

From the Admin Panel, go to System > Cron Schedule > Cron Jobs Timetable

• This is the Timetable display page of the Cron Jobs Log page. It plays the role of a chart report helping admin to know the results of the cron running process.
• Select Time: Select the time to display Cron Jobs.

Currency Formatter

Overview

Currently, Magento 2 does not support currency format as store owner wishes. With Mageplaza Currency Formatter Extension, admin can configure the currency format in various ways. This extension supports showing product price as well as order amount in the currency format configured by admin at both frontend and backend. Currency Formatter Extension is totally compatible with Mageplaza One Step Checkout.

Note: Mageplaza Currency Formatter Extension can be used with multiple stores.

• Stores are set the default as the Default Configuration.
• To change the configuration for each store, need to remove the tick at Use Website on the right of each option.
• Config of the extension in each store will be applied in the store itself.
• Config in this store doesn’t affect the config in the other store.

How to download and install

• Download Currency Formatter extension
• Installation guide

How to use

Admin can configure currency format at backend. At Magento Admin, Select Stores > Settings > Configuration > Mageplaza > Currency Formatter

Currency displayed on the frontend and backend such as product price, the total amount of the order will be displayed in the correct format:

How to configure

Login to Magento Admin, Select Stores > Settings > Configuration > Mageplaza > Currency Formatter

1. General

• Enable: Select Yes to enable the module.

1.1. Currency Configuration:

Configure the currency format for all currency enabled by the store

1.1.1 Currencies:

• Displays the name of the currency enabled by the store

• Use System (For Store View: Default Config):

  

  • Click to Use System checkbox, template is auto loaded using premade template of system.

• Use Default ( For Store View: Website):

  

  • Click to Use Default checkbox, template is auto loaded using default template at Configuration.

• Use Website (For Store View: store view):

  

  • Click to Use Website checkbox, template is auto loaded using website template

1.1.2 Template:

• Show symbol: Select the display position for the currency symbol. There are 5 options: Before value with space options, Before value, After value with space, After value and None:

  

  • Before value with space: The currency symbol displays before the numeric value. There is a space between symbol and the numerical value. For example: $ 100
  • Before value: Currency symbol displayed before numeric value, but between symbol and numeric value there is no space. For example: $100
  • After value with space: A currency symbol displayed behind a numeric value. There is a space between symbol and the numerical value. Example: 100 $
  • After value: The currency symbol displayed behind the numeric value, but between symbol and numeric value there is no space. Example: 100$
  • None: Do not display the currency symbol: Example: 100

• Symbol: Select the currency symbol. For example, if you enter Symbol = $, the currency symbol in currency format is $ which is displayed at the price of the product is $ 100.

• Thousands Separator: Choose a way to display the thousandth value separator.

  

  • Dot (.): The thousands value is separated by dots, for example: 1.000
  • Comma (,): The thousandth value is separated by commas, for example: 1,000
  • Space ( ): The thousandth value is separated by spaces, for example: 1 000
  • None: Do not separate thousands of values, for example: 1000

• Decimal Digit(s): Select the number of decimal value after the unit value. You can choose from 0 to 4 decimal numbers.

For example: Decimal Digit(s) = 2, there will be 2 decimal numbers. The product price as $ 100.00

• Decimal separator: Select a symbol to separate the integral and decimal value.

  

  • Dot (.): The integral and decimals are separated by dots, for example: 100.1
  • Comma (,): The integer and decimal are separated by commas, for example: 100,1

• Minus Sign: You can enter any character to represent discount value.

• Show minus sign: Select the display location of Minus Sign which include:

  

  • Before value: minus sign displays before the number. For example: -100
  • After value: minus sign displayed after the number. Example: $ 100-
  • Before symbol: minus sign displayed before the currency symbol. For example: -$ 100
  • After symbol: minus sign displayed after the currency symbol. Example: $ 100-

1.1.3. Preview:

Preview the format of the currency configured in the template section

When Template field changes, the currency format is shown in Preview also changes

Custom Order Number

Overview

With the ID of Order, Invoice, Shipment or Credit Memo, the default ID of Magento only includes the numbers and the ID of the first order is 000000001. Therefore, with newly established websites, the order quantity is low, which makes customers feel that this store has no the high reliability. This leads to the low number of purchasing quantity of customers at your store. Besides that, to manage the orders of customer that are created on whichever date, month, year of the store, store owners have to view the detail of the orders, this will cause the inconvenience for them.

To resolve this problem, Mageplaza has launched a handy extension, called Magento 2 Custom Order Number.

Note: Magento 2 Custom Order Number can be used with multiple stores. Multiple stores module:
- This extension is applied to multiple stores.
- Stores are set the default as the Default Configuration.
- To change the configuration for each store, need to remove tick at Use Website on the right of each option.
- Config of the extension in each store will be applied in the store itself.
- Config in this store doesn't affect the config in the other store.

Download & Install

• Mageplaza Custom Order Number
• How to install

How to configure

Login to the Magento Admin, choose Store > Settings > Configuration > Mageplaza Extensions > Customer Order Number

General Configuration

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Customer Order Number, choose General Configuration section

• Enable: Choose Yes to enable this module

Order Number

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Customer Order Number, choose Order Number section

• Enable: Choose Yes to use the feature that allows configuring the changing ID of the Order
• Pattern:
  • Enter the format for the Order ID. For instance, ORD-[store_id]-[yy]-[mm]-[dd]-[2N]-[2counter]
  • Only support some variables as: [store_id], [yy], [mm], [dd], [2N], [2counter], [4AN], [4A], [4N], [store_code], [y], [yyy], [M], [D], [m], [d], [country_id]
  • If the format of supported variables is entered wrong, the order ID will be displayed under the text
• Counter Start From:
  • Enter the counter when using the variable [counter]. When the number of digits in this field is less than the number of digits of the variable [counter], the ID is automatically added to the number 0 in front. Example: You enter as 15, counter variable that is used will be [4counter]. The ID displayed will have the format as 015
  • The ID of the next order will begin with the number entered and it will incrementally increase based on the Counter by Step field below.
  • For example, when you use the variable [2counter], if you enter 04, the order ID after configuring will start from 04
  • If you want to change the Counter Start From field, after entering a new value and saving, admins need to click on Reset Now button so that the Order ID can get a new Counter Start From value.
• Counter by Step:
  • Enter the distance number order ID of the next orders
  • For example, if you enter 2, the order ID of next orders will be separated by 2 units and gradually increased
  • If leaving this field blank, the default ID of orders will be separated by 1 unit.
• Counter by Store:
  • If you choose Yes, the order ID of the different stores will be increased separately based on the configuration of each store. For example, store A has an order ID as 50, store B has no order. Customers place the order at the store B, this order ID is 01.
  • If you choose No, the order ID of different stores will be merged and increased in succession based on the configuration of Main Website. For instance: Store A has 50 orders and the order ID is 50, store B don’t have any order. When customers purchase the products in the store B, the order ID of store B is 51.
• Reset Counter:

• Reset Counter = Daily: Counter will be reset to the Counter Start From value that is using at 00h daily
• Reset Counter = Weekly: Counter will be reset to the Counter Start From value that is using at 00h the first day of the week
• Reset Counter = Monthly: Counter will be reset to the Counter Start From value that is using at 00h the first day of the month
• Reset Counter = No: Counter will NOT be reset to the Counter Start From value that is using.
• Reset Now Button: Counter will be reset to the Counter Start From value that is using instantly. For example, Counter Start From field is 10000 now, Counter Step is 5. After a long time to order and click on Reset Now, the ID of the next order after resetting will start from Counter Start From + Counter Step values.

Invoice Number

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Customer Order Number, choose Invoice Number section

• Enable:
  • Choose Yes to use the feature that allows changing the ID of Invoice
  • Choose Same as Order Number to use the configuration the same as the configuration of Order Number

• Replace
  • Enter the characters you want to change if you choose the same configuration as the Order Number
  • If leaving this field blank, after you save, the Invoice ID will display the same as the configuration of Magento.
• To:
  • If leaving this field blank, the value in front of the Replace field will be used. This value is the same as the value entered in the Order Number
  • This value will replace the value of Replace field if you enter correct
• Pattern:
  • Enter the format for the Invoice ID. For instance, INV-[store_id]-[yy]-[mm]-[dd]-[2N]-[2counter]
  • Only support some variables as: [store_id], [yy], [mm], [dd], [2N], [2counter], [4AN], [4A], [4N], [store_code], [y], [yyy], [M], [D], [m], [d], [country_id]
  • If the format of supported variables is entered wrong, the Invoice ID will be displayed under the text
• Counter Start From:
  • Enter the counter when using the variable [counter]. When the number of digits in this field is less than the number of digits of the variable [counter], the ID is automatically added to the number 0 in front. For example: You enter as 15, counter variable that is used will be [4counter]. The ID displayed will have the format as 015
  • The ID of the next invoice will begin with the number entered and it will incrementally increase based on the Counter by Step field below.
  • For example, when you use the variable [2counter], if you enter 04, the invoice ID after configuring will start from 04
  • If you want to change the Counter Start From field, after entering a new value and saving, admins need to click on Reset Now button so that the Invoice ID can get a new Counter Start From value.
• Counter by Step:
  • Enter the distance number Invoice ID of the next invoices
  • For example, if you enter 2, the ID of next invoices will be separated by 2 units and gradually increased
  • If leaving this field blank, the default ID of invoices will be separated by 1 unit.
• Counter by Store:
  • If you choose Yes, the invoice ID of the different stores will be increased separately based on the configuration of each store. For example, store A has an invoice ID as 50, store B has no invoice. Customers purchase the product at the store B, this invoice ID is 01.
  • If you choose No, the invoice ID of different stores will be merged and increased in succession based on the configuration of Main Website. For instance: Store A has 50 invoices and the invoice ID is 50, store B don’t have any invoice. When customers purchase the products in the store B, the invoice ID of store B is 51.
• Reset Counter:

• Reset Counter = Daily: Counter will be reset to the Counter Start From value that is using at 00h daily
• Reset Counter = Weekly: Counter will be reset to the Counter Start From value that is using at 00h the first day of the week
• Reset Counter = Monthly: Counter will be reset to the Counter Start From value that is using at 00h the first day of the month
• Reset Counter = No: Counter will NOT be reset to the Counter Start From value that is using.
• Reset Now Button: Counter will be reset to the Counter Start From value that is using instantly. For example, Counter Start From field is 10000 now, Counter Step is 5. After a long time to order and click on Reset Now, the ID of the next invoice after resetting will start from Counter Start From + Counter Step values.

Shipment Number

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Customer Order Number, choose Shipment Number section

• Enable:
  • Choose Yes to use the function that allows configuring the change of the Shipment ID.
  • Choose Same as Order Number to use the configuration the same as the configuration of Order Number

• Replace
  • Enter the characters you want to change if you choose the same configuration as the Order Number
  • If leaving this field blank, after you save, the Shipment ID will display the same as the configuration of Magento.
• To:
  • If leaving this field blank, the value in front of the Replace field will be used. This value is the same as the value entered in the Order Number
  • This value will replace the value of Replace field if you enter correct
• Pattern:
  • Enter the format for the Shipment ID. For instance, SHI-[store_id]-[yy]-[mm]-[dd]-[2N]-[2counter]
  • Only support some variables as: [store_id], [yy], [mm], [dd], [2N], [2counter], [4AN], [4A], [4N], [store_code], [y], [yyy], [M], [D], [m], [d], [country_id]
  • If the format of supported variables is entered wrong, the Shipment ID will be displayed under the text.
• Counter Start From:
  • Enter the counter when using the variable [counter]. When the number of digits in this field is less than the number of digits of the variable [counter], the ID is automatically added one or multiple number 0 in front. For example: You enter as 15, counter variable that is used will be [4counter]. The ID displayed will have the format as 0015.
  • The ID of the next shipment will begin with the number entered and it will incrementally increase based on the Counter by Step field below.
  • For example, when you use the variable [2counter], if you enter 04, the shipment ID after configuring will start from 04
  • If you want to change the Counter Start From field, after entering a new value and saving, admins need to click on Reset Now button so that the Shipment ID can get a new Counter Start From value.
• Counter by Step:
  • Enter the distance number Shipment ID of the next shipments
  • For example, if you enter 2, the ID of next shipments will be separated by 2 units and gradually increased
  • If leaving this field blank, the default ID of shipments will be separated by 1 unit.
• Counter by Store:
  • If you choose Yes, the shipment ID of the different stores will be increased separately based on the configuration of each store. For example, store A has an shipment ID as 50, store B has no shipment. Customers purchase the product at the store B, this shipment ID is 01.
  • If you choose No, the shipment ID of different stores will be merged and increased in succession based on the configuration of Main Website. For instance: Store A has 50 shipments and the shipment ID is 50, store B don’t have any shipment. When customers purchase the products in the store B, the shipment ID of store B is 51.
• Reset Counter:

• Reset Counter = Daily: Counter will be reset to the Counter Start From value that is using at 00h daily
• Reset Counter = Weekly: Counter will be reset to the Counter Start From value that is using at 00h the first day of the week
• Reset Counter = Monthly: Counter will be reset to the Counter Start From value that is using at 00h the first day of the month
• Reset Counter = No: Counter will NOT be reset to the Counter Start From value that is using.
• Reset Now Button: Counter will be reset to the Counter Start From value that is using instantly. For example, Counter Start From field is 10000 now, Counter Step is 5. After a long time to order and click on Reset Now, the ID of the next shipment after resetting will start from Counter Start From + Counter Step values.

Credit Memo

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Customer Order Number, choose Creditmemos Number section

• Enable:
  • Choose Yes to use the function that allows configuring the change of the Credit Memo ID.
  • Choose Same as Order Number to use the configuration the same as the configuration of Order Number

• Replace
  • Enter the characters you want to change if you choose the same configuration as the Order Number
  • If leaving this field blank, after you save, the Shipment ID will display the same as the configuration of Magento.
• To:
  • If leaving this field blank, the value in front of the Replace field will be used. This value is the same as the value entered in the Order Number
  • This value will replace the value of Replace field if you enter correct
• Pattern:
  • Enter the format for the credit memo ID. For instance, CRE-[store_id]-[yy]-[mm]-[dd]-[2N]-[2counter]
  • Only support some variables as: [store_id], [yy], [mm], [dd], [2N], [2counter], [4AN], [4A], [4N], [store_code], [y], [yyy], [M], [D], [m], [d], [country_id]
  • If the format of supported variables is entered wrong, the credit memo ID will be displayed under the text
• Counter Start From:
  • Enter the counter when using the variable [counter]. When the number of digits in this field is less than the number of digits of the variable [counter], the ID is automatically added to the number 0 in front. For example: You enter as 15, counter variable that is used will be [4counter]. The ID displayed will have the format as 015
  • The ID of the next credit memo will begin with the number entered and it will incrementally increase based on the Counter by Step field below.
  • For example, when you use the variable [2counter], if you enter 04, the credit memo ID after configuring will start from 04
  • If you want to change the Counter Start From field, after entering a new value and saving, admins need to click on Reset Now button so that the credit memo ID can get a new Counter Start From value.
• Counter by Step:
  • Enter the distance number credit memo ID of the next shipments
  • For example, if you enter 2, the ID of next credit memo will be separated by 2 units and gradually increased
  • If leaving this field blank, the default ID of credit memos will be separated by 1 unit.
• Counter by Store:
  • If you choose Yes, the credit memo ID of the different stores will be increased separately based on the configuration of each store. For example, store A has an credit memo ID as 50, store B has no credit memo. Customers purchase the product at the store B, this credit memo ID is 01.
  • If you choose No, the credit memo ID of different stores will be merged and increased in succession based on the configuration of Main Website. For instance: Store A has 50 credit memos and the credit memo ID is 50, store B don’t have any credit memo. When customers purchase the products in the store B, after this order is refunded, the credit memo ID is 51.
• Reset Counter:

• Reset Counter = Daily: Counter will be reset to the Counter Start From value that is using at 00h daily
• Reset Counter = Weekly: Counter will be reset to the Counter Start From value that is using at 00h the first day of the week
• Reset Counter = Monthly: Counter will be reset to the Counter Start From value that is using at 00h the first day of the month
• Reset Counter = No: Counter will NOT be reset to the Counter Start From value that is using.
• Reset Now Button: Counter will be reset to the Counter Start From value that is using instantly. For example, Counter Start From field is 10000 now, Counter Step is 5. After a long time to order and click on Reset Now, the ID of the next credit memo after resetting will start from Counter Start From + Counter Step values.

Mail

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Customer Order Number, choose Email section

• Send Email To
  • Enter the email to send the notification
  • When the ID of the order, invoice, shipment or credit memos of the next time duplicates with the ID of the previous times, the ID will be automatically added to the variable [6AN] at the back and at that time, there’s an email to notify the store owner that the ID of the order, invoice, shipment or credit memos is existing and is replaced by the new ID.
• Send Email From: Choose the sender email notifications.

Note:

• Reset Now button is only displayed in the multiple stores
• If the ID of the order, invoice, shipment or credit memo deplicates with the existing IDs, the following IDs will be added a value [6AN] at the back of the pattern.

For the Pattern field of Order Number, Invoice Number, Shipment Number or Credit Memo Number, it only supports some variables as the following:

• [4AN]: The format for the ID will be displayed as 4 numbers and letters are randomly selected
• [4A]: The format for the ID will be displayed as 4 randomly selected number
• [4N]: The format for the ID will be displayed as 4 randomly selected number
• [6counter]: The format for the ID will be displayed with 6 counts depending on the configuration of the Counter fields.
• [store_code]: The format for the ID will be displayed as the code entered for the store view
• [store_id]: The format for the ID will be displayed as the symbolic number for the created order of the store views
• [yy]: The format for the ID will be displayed as the last two digits of the year. Example: 18
• [y]: The format for the ID will be displayed as the last digit of the year. Example: 8
• [yyy]: The format for the ID will be displayed as that year. Example: 2018
• [M]: The format for the ID will be displayed as the first 3 letters of the month. Example: AUG
• [mm] = [m]: The format for the ID will be displayed as the digit 08
• [dd]: The format for the ID will be displayed as date 01, 02, 03, etc
• [D]: The format for the ID will be displayed as the first 3 letters of the day. Example: MON
• [d]: The format for the ID will be displayed as 1. This only applies for the date less than 10. With the cases, you choose the format as [dd], the date is less than 10, you need to apply the format of ID as 01, 02, 03, etc.
• [country_id]: The format for the ID will be displayed as letters as the abbreviation of the country. For example, US.

The format of Email notification

Please click on here to know more information.

The ID’s format after configured

Display in the backend

Display on the frontend

Custom Form

Overview

Mageplaza Custom Form allows the admin to create multiple custom forms with different field types to collect customer information and feedbacks. Custom Form can be shown anywhere in the store. For each Custom Form submitted by customers, admin can manage and make statistics effectively. Thereby can capture customer trends and contribute to the increase in store revenue significantly.

How to download and install

• Download Mageplaza Custom Form
• How to Install

How to use

1. Customer

Customer can submit any form shown in Frontend.

2. Admin

• Admin can create multiple Custom Forms
• Admin can also set Custom Form displayed anywhere
• Report the customers’ responses via form results
• Turn on/ off the email notifications for admin or customer

How to Configure

1. Configuration

From the Admin panel, go to Stores > Configuration > Mageplaza > Custom Form

1.1. General Configuration

• Enable: Select “Yes” to enable the Module.

1.2. Customer Notification

• Enable Auto Response:

  • Select Yes to automatically send the email of a successful submission to Customer. Do not apply to Not Logged in Customer

• Email Sender: There are 5 default types of Magento Sender for Admin to choose: General Contact, Sales Representative, Customer Support, Custom Email 1, Custom Email 2

• Email Template:

  • This module has a default Email notification template for Customer

  

  • To change Email Template, Admin can create another Email Template in Marketing > Email Template.
  • Instructions for creating new Email Template here

1.3 Admin Notification

• Enable:

  • Select Yes to allow successful submission of email notification to Admin

• Send To:

  • All emails filled in this section will receive a notification every time the form is submitted
  • The email is separated by commas
  • If left blank, no email will be sent to admin

• Email Sender: There are 5 default types of Magento Sender for Admin to choose: General Contact, Sales Representative, Customer Support, Custom Email 1, Custom Email 2

• Email Template:

  • This module has a default Email notification template for Admin

  

  • To change Email Template, Admin can create another Email Template in Marketing > Email Template.
  • Instructions for creating new Email Template here
  • CC to Email: Enter one of multiple emails and separate them by commas. The list of recievers is visible to all of them.
  • BCC to Email: Enter one or multiple emails and separate them by commas. The list of recievers is invisible to all of them.
  • Attach Upload File to Email: Choose Yes to attach files in email that customers already upload files when sending feedback.

1.4. Google Map

• To have the Google Map feature run correctly on Custom Form, admin needs to enter the API key
• Instructions for creating API key here

2. Manage Form

Go to Content > Custom Form > Manage Forms

2.1. Grid

This grid stores all the submitted Forms.

• Admin can view basic information of submitted forms such as ID, Name, Status, Customer Group (s), Store View, Number of Responses, Created Date, Action and the report of the form on View, Number of Responses, CTR about customers’ actions shown in the feedback in each period of time.
• Report: Display statistic, report of each form with View, Number of Responses, and CTA about customers’ acions shown in their feedback in each period of time.
• Action: Admin can do the following action on grid:
  • Delete: Delete the form right in Grid.
  • Change Status: Change the status of the selected Forms.
  • Edit: Navigate to the edit page of the Form information previously created.
  • In addition, admin can filter, change store view, hide/display columns.

2.2. Add New Form

2.2.1. General

• Name: Enter the form name. This is a required field.
• Status: Select Enable to activate the form
• Store View(s):
  • Select storeview. The form is only displayed in the selected Store View
  • Many store views can be selected at the same time.
• Customer Group(s): Select one or more customer groups at the same time to use the form. Unselected customer groups will not see the form at Frontend.
• Valid from date: Click the calendar icon to select the date/month/year. The form will start showing up at Frontend from the date/ month/year you selected.
• Valid to date: Click the calendar icon to select the date/month/year to close the application form.

Note:

After saving the Form, the General Tab will display the Snippet section. Admin needs to copy this snippet to a certain position so that the Form is displayed in Frontend

2.2.2 Form Behavior

• Form Behavior: there are 2 Form Styles to choose from

  • Static: The form is displayed as soon as the page is loaded

  

  • Popup:
    • The form is displayed as a button. When Customer clicks on the button, the popup contains the Form will be shown.
    • Admin can choose either normal Popup or Slide Popup

  

• Actions: Set the action after submitting the form

  • Redirect to URL: After submitting the form successfully, Customer is linked to the predefined page by URL

  

  • Keep Current Page: After submitting the form successfully, the form is reset and remains on the original page containing the form

  

  • Redirect to CMS page: After successfully submitting the form, the page is linked to an existing Store CMS page

  

2.2.3 Email Notification

• Admin Notification:

  • Include email settings such as Admin Notification in Configuration. There is one additional “Send Time” to set the sending time for admin notification emails.
  • Send Time has 2 option: Daily and Immediately.
  • Daily: send daily emails
  • Immediaetly: send emails right after customers submit the form
  • Admin can use the default settings in Configuration or change depending on the form

  

• Auto-responder

  • Include email settings such as Auto-responder in Configuration
  • Admin can use the default settings in Configuration or change depending on the form
  • In addition, admin can select any field in the form to set that field as customer email. Auto-email will be sent to this address
  • Admin can plan to send email automatically
  • Note that Email Address Field can only be selected after the form has at least 1 field

2.2.4. Form Creator

• Here you can create form content.
• We provide 5 commonly-used forms including Feedback, Contact, Pre-Order, Survey, Customer Order request.
• Admin can Load Template and Preview immediately
• A form can have multiple pages, each page can have multiple groups, each group can contain multiple fields
• Admin can Add New or Duplicate any field/ group/ page
• We offer more than 12 types of fields: Text, Text Area, Dropdown, Checkbox, Radio, Date Time, Grid, Upload File, Policy Checkbox, Star Rating , Google Map, HTML

See the instruction video here:

• For each field, admin can edit Title information, Tooltip, Additional Class, Is Required, Validation Class, Width, Depend Field.

• In addition, there are some fields with other options such as:
  • Add Options with Field Type are Dropdown, Checkbox, Radio, Grid
  • Set number options of row with Checkbox, Radio field types
  • Field Type is Date Time. Admin can change Type to Date only, Time only or both Date Time
  • Grid includes 2 types: Grid Checkbox (Each row is selected in multiple column options) or Grid Radio (Each row is only selected in 1 column option)
  • Upload File: Set maximum capacity and upload file type
  • Policy Checkbox: Including 2 types: Redirect to url or Popup
  • Rating Star: Set the maximum number of stars and the default stars number
  • HTML: enter the HTML codes presenting the content should be shown in the form. With the field HTML, when submitting form, it will not be shown in the Response but the content in the form
    • For example: when creating the form, you enter the code Mageplaza, then in the form, the text “Mageplaza” will be shown
• After installing all the fields, admin can click Preview to see how the Form is displayed in Frontend

2.2.5. Responses Summary

• Only show response when at least one Customer successfully submitted this form
• Report on the number of times each field is filled in the Form
• For option fields, ít responses will be displayed as Chart

2.2.6. Responses Detail

Report the number of successful submitted responses.

3. Manage Responses

From the Admin panel, go to Contents > Custom Form > Manage Responses

3.1. Grid

This is where all the generated Response is kept.

• Here shows the basic information of the generated Responses including ID, Name, Customer Name, IP Address, Store View, Created Date, Action.
• Action:
  • View: Navigate to the previous Response details page.
  • Delete: Delete the response
• In addition, admin can filter, change store view, hide/ display columns.

3.2. View Details

Show details of responses:

4. How to display the form in Frontend

4.1. Use Snippet

After saving one form, the form’s Snippet will be created in the General tab

• Admin needs to copy the code to the location you want to show it on. The positions can be:
  • CMS Page
  • Phtml
  • Layout
• Example of inserting into CMS Page - About Us:

4.2. Use Widget

Step 1: Create Mageplaza Custom Form Widget

• Go to Contents > Elements > Widgets
• Select Add New
• Select Type = Mageplaza Custom Form
• Design Theme = Magento Luma
• Click Continue

Step 2: Set the display position of the Form in Frontend

• Set Widget Name
• Choose the Store View to display the form
• Set the Position of the current Form in Page

Step 3: Select the display form

• Select Widget Option Tab
• Enter Form ID and Name
• Save Widget

Step 4: Check Frontend

Customer Approval

Overview

Managing customers from the beginning will help you control your website well, gain profits and obtain certain customer trust. With Mageplaza’s Customer Approval extension, you can definitely do that. Admin will receive an email notification when a customer successfully registers for an account and he can choose auto-approve or manually approve. Accordingly, your customers will receive email notifications of successful signing up for an account, successfully approved or not approved. You should install Mageplaza_SMTP to avoid your email to be sent to the spam box and it is fully compatible with the Customer Approval extension.

Download & Install

• Mageplaza Customer Approval
• How to Install

How to use

Approval Account Notification: Show the notification when customers have registered accounts and are waiting for approval

[Customer] Successful Register: Send notification emails to customers when they have registered the accounts successfully

[Customer] Approve Notification: Send notification emails to customers when admins approve the customers’ accounts

[Customer] Not Approve Notification: Send notification emails to customers when admins do not approve the customers’ accounts

Admin Notification: Send notification emails to admins when customers registered accounts that need to be approved

How to configure

1. Configuration

Login to the Admin Magento, choose Stores> Configuration> Customer Approval.

1.1. General

• Enable: Select Yes to turn on the Module and use Approve Customer Account function

• Auto Approve: If selecting Yes, it will automatically Approve when the customer registers in Frontend.

• After-registration Notification:

  • Enter a notification when the account is successfully registered.
  • If left blank, the default is “Your account requires approval”.

• Not Approve Customer Login: Select the Not Approve Customer Login notification type and still login:

  • Show Error: Will display the Not Approve Customer Login error message. Displaying additional Error Message field.

    • Error Message: Enter the notification when the client account is not accepted or still has not been approved but try to log in. If left blank, the default is “Your account is not approved”.

    

  • Redirect CMS Page: Select to redirect to the Not Approve Customer Login page:

  

  • For Not Approve Customer Page

  

1.2. Admin Notification Email

• Enable:
  • Select “Yes” to turn on email notification for admin when a customer successfully registers an account.
  • Install Mageplaza_SMTP to avoid sending to spam box.
• Sender: Select the person to send email to notify admin:

• Email Template: Select an email template to notify admin when the customer successfully registered an account. You can go to Marketing> Email Templates, select Add New Template to choose to create a notification email template.
• Recipient(s):   - Enter the email who receives the notification when the customer registers the account.
  • You can enter multiple email recipients at the same time and they must be separated by commas.

1.3. Customer Notification Email

• Sender: Select the person who sent the email to notify the customer.

1.3.1. Successful Register

• Enable: Select “Yes” to enable email notification for customers when Successful Register.
• Email Template: Choose an email template to notify customers of successful account registration. You can go to Marketing> Email Templates, select Add New Template to choose to create a notification email template.

1.3.2. Approve Notification

• Enable: Select “Yes” to enable email notification to customers when approved with a registered account.
• Email Template: Choose an email template to notify customers when approved with a registered account. You can go to Marketing> Email Templates, select Add New Template to choose to create a notification email template.

1.3.3. Not Approve Notification

• Enable: Select “Yes” to turn on email notifications for customers when not approved with the registered account.
• Email Template: Select an email template to notify customers when not approved with a registered account. You can go to Marketing> Email Templates, select Add New Template to choose to create a notification email template.

2. Customers

2.1. Grid

• Login to the Magento Admin, choose Customers> All Customers.
• This section lists the information of the registered customer with fields such as Name, Email, Group, Approval Status, Date of Birth, etc. Here you can manually approve or not approve at Action and edit with any customer you want.

2.2. Edit Customer

• Click on Edit to edit or approve/not approve any client. With Approval Status shows the status of customer account registration.

Using API

• You can use the API integrated with Magento to view the Approved Customers, Waiting for Approval and Not Approval Customers when they sign up for an account.
• Here, we use Postman to support this. You can register Postman here. Also, you can use other apps to support approval and not approval.

1. Integration with Magento:

Step 1: Login to the Magento Admin, choose System> Extensions> Integrations> Add New Integrations to create new integration.

Note: For the API tab you should select Customers and Mageplaza Customer Approval.

Step 2: After creating the Integration, please select Activate

Step 3: Click Allow to get the information of the Access Token field.

2. Guide for using Postman to get customers list of waiting for approval, approved and not approved accounts.

2.1 To list the approved customers, you can use the GET method:

• For example:
  • Url: http://example.com//rest/V1/customer/id
  • For example: http://example.com/rest/V1/customers/1
  • With Key and Value: Get the information of the Access Token field that you have just integrated to fill it out below. For example: Authorization: bearer access_token và Content-Type: application/json
  • Click Send to get the list of approved customers.

2.2 Approve with customers who have registered an account are in the status of Pending or Not Approval, you can use POST method.

• Note: At the Body part, fill in the email you want to approve. As for the Header section, fill the same as above with the GET method.
• Example: Url: http://example.com/rest/V1/customer/approve/email

2.3 Not Approve with customers who have registered an account are in Pending or Approval status, you can use POST method.

• Example: Url: http://example.com/rest/V1/customer/not-approve/email

Instructions to run the command to Approve or Not Approve customer accounts

• Approve: You want approval when the registered account is in pending status or not approval, please run the following command:

php bin/magento customer:approve "email customer"

• Example: php bin/magento customer:approveemail"mageplaza@gmail.com"
• Not Approve:

php bin/magento customer:notapprove"emailcustomer"

• Example: php bin/magento customer:notapprove"mageplaza@gmail.com"

Note

When installing, you should run the following command to update customer grid:

  php bin/magento indexer:reindex customer_grid

When you want to remove the extension, you should go to the database to delete. Access to eav_attribute table, in the attribute_code column, you find and delete the is_approved attribute

Customer Attributes

Overview

Customer Attributes will help you run more focused marketing campaigns and increase sales significantly. Thanks to this module, it helps provide the neccessary information to support the order management process and customer management. Maybe you will need more fields than the fields provided by the system such as adding custom attributes to the Customer Account Create, Customer Account Edit, Customer Address Registration, Customer Address Edit and Checkout in the customer’s account, this will help you find out your client’s personal preferences and location, age, or any additional information. This is a great feature of Mageplaza Customer Attributes extension.

Download and Install

• Download the module
• How to Install

How to configure

From the Admin Panel, go to Customers > Attribute

1. Customer

How to create new Customer Attributes

• Step 1: Enter full informaiton about Customer Attributes into Properties
• Step 2: Fill titles in Manage Labels to replace Attributes name that you want to show on the store
• Step 3: Enter the information into Storefront Properities to display Attributes at the store position you want

Step 1: Enter full informaiton about Customer Attributes into Properties

From the Admin Panel, go to Customers > Attribute > Customer, select Add New Attribute`

1.1. Attribute Properties

• Default Label:

  • Enter the name for Attributes. The Attributes name will be displayed while you enter the data
  • Be a required field to enter a value that is not allowed to be empty. If you leave it blank, the notification will be shown: “This is a required field”.

• Input Type: Select the input type. For the Upload Image, it can be uploaded in .gif, .jpg, .png formats. Options include:

  • Dropdown:

  

  • Multiple-select: Customers can choose many options at the same time

  

  • Multiple-select with image: Show more Image columns in Manage Options. Customers can choose many images at the same time

  

  • Single Select With Image: Choose the Image. Display more Image columns in Manage Options

  

  • Media Image, Single File Attachment: Show Choose File button to upload the image or the file attachment from the laptop

  

  • Date: Display more Calendar box. Click on the Calendar box to choose the time

  

  • Yes/No: The Default Value field will be shown under Yes/No

  

  • Text Field: Display more Input Validation field to verify the input of Default Value

• Text Area: Display the Default Value field under the text

• Content:

• Value Required: Choose Yes so that this is a required field to enter the value, choose No so that it’s not a required field. If it’s a required field, an icon will display in the left of the attribute *

1.2. Manage Options

Manage Options only displays when you choose the Input Type as Dropdown, Multiple Select, Multiple Select With Image, Single Select With Image.

• Choose Add option to add options and it will show along with Attributes you create. Delete button is to remove the option.
• You can enter the title into the store field that you want to show to replace that option

1.3. Advance Attribute Properties

• Attribute Code:

  • Enter the Attribute code. This field is used internally. Make sure you do not use spaces or more than 30 symbols.
  • If you leave blank, the default value is based on Default Label field.

• Default Value:

  • Enter the value for the Default Value field. The value you enter will be displayed along with the Attributes you create in the - Customer Account Create section.
  • This field depends on the choice of the Input Type field

• Input Validation:

  • Select input validation type. This field will be displayed only when Input Type is set to be Text Field.
  • Validate the input of the Default Value according to the choice of the Input Validation field. Options include:

  

• Add to Customer Grid: Choose Yes to add the attribute into Customer Grid. The column will be added into Column options, Filter Option & Search Option of Customer Grid.

• Add to Sale Order Grid: Choose Yes to add the attribute into Sale Order Grid. The column will be adeed into Column options, filter option & search options of Sale Order Grid

1.4. Depend Fields

• Select Field Depend: Show the attributes when you select Input type as Dropdown and Single Select With Image. Thí field will display on the Frontend, admin customer form and admin checkout. Some attributes are available in the system as:

• Value Depend:

  • Choose the value for Value Depend field
  • This field depends on the option of created attributes and choose the attributes of Select Field Depend field. This section will help you expand the options.

  

Note: The display of attributes that you have created depends on the option selection.

Step 2: Fill titles in Manage Labels to replace Attributes name that you want to show on the store

Fill the titles in the Store fields that you want to show. The title will replace the Attributes name that you have created when entering the data. If you leave this field blank, the default attributes name is that you set in the Default Label field.

Step 3: Enter the information into Storefront Properities to display Attributes at the store position you want

• Show on Storefront: To display the attributes on Storefront, choose Yes. For the attributes are included in the system, you cannot edit the remaining fields in the Storefront Properties.

• Customer can edit: Choose Yes so that customers can edit the attributes

• Store View: Choose Store View that allows Attributes to diplay. For unselected store views, attributes will not appear

• Customer Group: Attributes only shows on the selected customer group.

• Show on forms: Show the forms on your store with some options:

  • Customer Account Create:

  

  • Customer Account Edit:

  

  • Admin checkout:

  

• Sort Order:

  • Enter the order number that you want to use to sort the attributes. If you leave this field blank, the default order number is 0.
  • The smaller the order number, the higher the priority.

2. Customer Address

How to create new customer address attributes

• Step 1: Enter full informaiton about Customer Address Attributes into Properties
• Step 2: Fill titles in Manage Labels to replace Attributes name that you want to show on the store
• Step 3: Enter the information into Storefront Properities to display Attributes at the store position you want

Step 1 and Step 2 are similar to the step 1 and 2 as above. You can refer it.

Step 3: Enter the information into Storefront Properities to display Attributes at the store position you want

The only difference of the Customer Address for the Customer function is that in this step 3, only the Show on Forms field has different display options. The remaining fields correspond to how to create a customer that we has guided you above.

• Show on forms: Show the forms on your store
  • If you have installed Mageplaza One Step Checkout extension, it will show the One Step Checkout page that helps you checkout quickly and conveniently with only one page.

From the Admin Panel, go to Store > One Step Checkout > Manage Fields, drag Attributes to the Sorted Fields column that you want to show on the One Step Checkout.

• Also, there’re 4 options for you to choose:

  • Customer Address Registration:

  

  • Customer Address Edit:

  

  • Frontend Checkout:

  

  • Admin Checkout:

  

3. REST API

Mageplaza’s Customer Attributes support the user to perform actions against attributes through the REST API: admin authority can obtain information about the customer attributes and customer address attributes, customer and guest permissions can upload file for Media Image attribute and Single File Attachment while checking out order.

• Find the details of the request that Customer Attributes of Mageplaza supports here
• See the Magento 2 REST API tutorial here. See the token generation instructions here

Custom Stock Status

Overview

Custom Stock Status will help admin install additional stock statuses for the products. Information about the product’s stock status is displayed at the frontend more accurately and clearly, giving customers better shopping experience and increasing the ability to buy from them. In particular, admins can custom stock status automatically or manually with image and text to quickly attract customers’ attention with appealing status. That’s the feature of Mageplaza Custom Stock Status extension.

How to download and install

• Download Mageplaza Custom Stock Status
• Install Custom Stock Status

How to use

Custom Stock Status apply for the followign product types:

• Simple Product

• Bundle Product: Can apply for child products of Bundle products

• Group Product: Can apply for child products of Bundle products

• Configurable Product: With this product type, you can configure the Custom Stock Status by size and color of products

How to configure

1. Configuration

Login to the Admin Magento, choose Stores> Custom Stock Status> Configuration.

1.1. General configuration

• Enable: Select Yes to turn on the module

• Apply for Products: Choose to apply Custom Stock Status to products:

  • Instock: only instock products will be applied Custom Stock Status.
  • Out of stock: only out of stock products are applied Custom Stock Status.
  • Both: apply custom stock status to all products.

• Status format: Choose to display the status of the product in Frontend with:

  • Image + Text: Show by the order of image then text

  

  • Image Only: Only show Custom Stock Status with image

  

  • Text only: Only show Custom Stock Status with text

  

  • Text + Image: Show by the order of text then image

  

• Display On: Choose to display the Custom Stock Status on the page below. You can choose to apply to multiple pages at the same time. Those not selected will not be applied:

  • Product Listing Page

  

  • Product View Page

  

  • Shopping Cart Page

  

  • Mageplaza One Step Checkout: This option only displays Custom Stock Status when you install the Mageplaza’s One Step Checkout extension. With this extension integration, you can summarize 6 payment steps in just one page to make it easier for customers to shorten the payment process.

  

• Apply with Child Configurable Product Options:

  • Selecting Yes to display the Custom Stock Status on options such as size, color, … with the Configurable Product and the sub-products of Group Product, Bundle Product.
  • Selecting No will not display the Custom Stock Status at any child product type.

• Enable Automatic Stock Status based on Dynamic Quantity Ranges:

  • Select Yes, it will enable Automatic Stock Status based on Dynamic Quantity Ranges. If the product satisfies Dynamic Group, it will apply Stock Status with Group Name group. Dynamic Group applies only to Simple Group.
  • If No is selected, it will not apply Dynamic Groups.
  • In case both the Custom Stock Status and Dynamic Groups are selected and enable, it will prioritize the information in the previous Dynamic Groups field. You can access Store> Attributes> Product to search with 2 attributes to create additional options for Custom Stock Status and Dynamic Groups.

2. Manage Custom Stock Status

Login to the Magento Admin, choose Stores > Custom Stock Status > Manage Custom Stock Status. Or you can access to Store > Attributes > Product, find mp_stock_status at Attributes Code.

In this section, you can create the option Custom Stock Status attribute when accessing Catalog> Product, edit a product.

2.1. Properties

2.1.1. Attribute Properties

• Default Label:

  • You can change the name for attributes, the names of these attributes will be displayed in the Catalog> Product section, edit a product.
  • This is a required field.

• Catalog Input Type for Store Owner:

  • Visual Swatch: Create an option of Custom Stock Status attributes in Manage Swatch (Values of Your Attribute) with label and image. You can upload image with .gif, .jpg, .png format. You can enter the replaced name of Custom Stock Status attributes for each store. Here, we support adding the variable in status to the Quantity label of the product. For example: Only {{qty}} in stock, Will be available tomorrow, {{attribute_code}}

  

• Note: If you select the Visual Swatch, you can display both the label and image outside the Frontend for Custom Stock Status, depending on the selection of the Status format field at Configuration.

With Admin is the value you must enter and for each store you can replace the option name of attributes. If the names of the stores are left blank, they will default using Admin values.

• Values Required: Select Yes means that this attributes will be required to select option.

2.1.2. Advanced Attribute Properties

This section you can configure the display position of attributes. The Attribute Code and the Validation Input for Store Owner field is the default value.

2.2. Manage Labels

Fill Titles to replace Custom Stock Status attributes of your storeviews. The title will replace the Attributes name. If left blank, it will default to the attributes name you set in the Default Label field. Example: Custom Stock Status

2.3. Storefront Properties

Select Storefront Properties information to display Attributes in the storeviews you want.

3. Manage Dynamic Groups

• Login to the Magento Admin, choose Stores> Custom Stock Status> Manage Dynamic Quantity Groups. Or you can visit Store> Attributes> Product, search in Attributes Code field with mp_dynamic_groups.
• For Dynamic Group, it only applies to Simple Product and if the product satisfies Dynamic Group, it will give priority to consider or apply Dynamic Group first.

3.1. Properties

3.1.1. Attribute Properties

• Default Label:
  • You can change the name for attributes, the names of these attributes will be displayed in the Catalog> Product section, edit a product. For example: Dynamic Group, …
  • This is a required field.
• Catalog Input Type for Store Owner: In this field, the default input type is Multiple Select.
• Multiple Select: create a name for Dynamic Group in Manage Options (Values of Your Attribute). If Simple Product satisfies each Dynamic group, then it will apply Stock Status with Dynamic group selected.

3.1.2. Advanced Attribute Properties

• This section is similar to the Custom Stock Status section, you can configure the display position of attributes. With the Attribute Code and the Validation Input type for Store Owner field are both the default value.
• With Manage Labels and Storefront Properties is exactly the same as the ones above we have guided.

3.2. Dynamic Quantity Groups Properties

• In this section, selecting the Dynamic Group based on qty will apply the selected Stock Status if the field Enable Automatic Stock Status based on Dynamic Quantity Ranges at Configuration is enabled and Dynamic Group applies only to Simple Product
• For example, with Group Name is Available, select Stock Status as Coming Soon2(get Stock Status from the Custom Stock Status option you created above) with Quantity From = 0, Quantity To = 3. If the Simple product has quantity within this range will be applied Dynamic Group.
• Note: When your product has a satisfactory quantity to apply Dynamic Group, you must also consider that product meets the condition that you have configured at Configuration and you will apply Dynamic Group. If the product selects all Dynamic Groups then the priority will be considered from top to bottom.

4. Edit Product

4.1. Edit Product

• Login to the Magento Admin, choose Catalog> Products.
• In the Edit product section, Custom Stock Status and Dynamic Groups are added when installing the Custom Stock Status extension of Mageplaza. With the option of these two fields, you have created options attributes in Manage Custom Stock Status and Manage Dynamic Groups

Note: In case if both Custom Stock Status and Dynamic Groups to be selected, then priority will be given to Dynamic Group first. If the product is not satisfied Dynamic group, it will continue to consider applying Custom Stock Status. And if it continue to unsatisfy Custom Custom Status, the default Stock Status will be applied by Magento.

4.2. Product Grid

You can edit products for multiple products at the same time to save time. Go to Catalog> Products, on the product page select the products you want to edit the Custom Stock Status and select Actions> Update Attributes.

5. Attention

• When you want to remove the extension, you should use composer to run the command: bin/magento module:uninstall Mageplaza_StockStatus
• If you delete the extension manually, you need to delete more the mp_dynamic_groups and mp_stock_status attributes in the database or in the backend.

5.1 Solution 1:

Go to the backend: From the Admin Panel, go to Stores> Attributes> Product. In the Attribute Code column, find the attribute mp_dynamic_groups and mp_stock_status, click and delete

5.2 Solution 2:

Go to the database to delete: Access to eav_attribute table. In the attribute_code column, you find and delete the attribute mp_dynamic_groups and mp_stock_status

6. Compatible with Mageplaza Extensions

You can install some Mageplaza extensions. They are fully compatible with Custom Stock Status and :

• Product Slider: allows you to easily create many sliders such as featured products, bestselling products, new products, etc. If you install Product Slider, products that apply Custom Stock Status on sliders with image or text or both.
• Automatic Related Products: with this extension you can design for related products displayed on slider and also show image and text of Custom Stock Status on that slider.
• Who Viewed This Also Viewed: Customers are more likely to make a purchase decision when they see a product that other customers have seen. By smart algorithms, the most viewed products will be automatically updated and proposed to customers.

7. API

Mageplaza Custom Stock Status uses Rest API to add product stock status data, display lable, and image. Besides, thanks to Rest API, store admins are able to view and manage product data easily.

View more details here

The instruction to generate Integration tokens can be viewed here

8. GrapQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-stock-status-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Custom Stock Status by Mageplaza supports admins to get the information of rules via GraphQL.

Follow steps below to start working with Custom Stock Status GraphQLl in Magento:

• Use Magento 2.3.x. Return your site to developer mode
• View the supported queries here

Daily Deal

Overview

Using discounts for items at certain times is a smart way to attract customers to purchase. Mageplaza Daily Deal extension will make it easy for shop owners to set a discount for each product. Each product will be set to display the discounted price, time left, item left, along with the status Upcoming/Running/Ended of the deal. In addition, Daily Deal has many outstanding features such as slider, flexible design, etc that support store owners to promote products, thereby stimulating the customer’s purchases and increase sales for stores significantly.

Download & Install

• Mageplaza Daily Deal
• How to Install

How to use

• Daily Deal only applies for Simple Product, Configurable Product, and Group Product
• Daily Deal is displayed on the Category Page and Product Detail Page, including the information as Countdown, Deal Price, Percent Discount, the number of sold deals, and the number of left deals

• Customers can access on the pages as All Deal, New Deal, Best-seller Deal, Feature Deal if admins allows them to be displayed on the frontend
• Also, Deal can be installed to display on the slidebar, or the screen corner of the Store

How to configure

Login to the Magento Admin, choose Marketing > Daily Deal

1. Manage Daily Deal

1.1. Managerial Grid

• This is a place to store all created deals
• From the grid, admins can understand all basic information of the Deal as ID, deal applied products, the products SKU, the deal’s status, Deal Price, Deal Quantity, Store View, Sale Quantity, Start On, End on, and Action
• Admins can perform some actions as the following:
  • Edit: Choose Edit in the Action column to edit the information on the Edit Deal page
  • Delete: Tick and choose 1 deal, choose Action > Delete (in the upper left of the grid) to delete the Deal
• Also, admins can filter, change store view, show/hide columns or export the grid

1.2. Add New/ Edit Form

• Product: The name of the product that is applied the deal. To select the product, click on Select Product. The name of the selected product will automatically appear in Product section
• Original Price:
  • The original price of the product will be automatically updated when the product is selected.
  • This price is displayed based on Catalog > Product.
• Product Qty:
  • The quantity of the product is automatically updated when the product is selected
  • This number is displayed based on Catalog > Product.
• Status: Select Active so that the deal can be active and displayed on the Frontend
• Is Feature: Select Yes so that the deal is displayed on Feature Deal and Floating slider deal pages
• Deal Price: Set the price you want to sell the product
• Discount:
  • This item will be automatically updated based on Original Price and Deal Price.
  • The discounted amount and the discounted percent will be displayed
  • Discount = Original Price - Deal Price
  • % = (Deal Price/Original Price)* 100%
• Deal Qty:
  • Set the quantity of the product you want to sell
  • The quantity of the deal can not exceed Product Qty
• Qauntity of sold items:
  • The quantity of sold items are automatically updated when the deal is purchased
  • The deal does not exceed Deal Qty
• Store View: A website can have multiple Store Views. The category is only visible with selected Store Views.
• From Date: Set the date to use the deal
• To Date: Set the end date using the deal

Note:

• With Configurable và Bundle product, Daily Deal only supports the simple children products.
• Virtual Product, Downloadable Product are supported (in case price and qty are available)

2. Configuration

2.1. General

From the Admin Panel, go to Mageplaza > Daily Deal

• Enable: Choose Yes to enable this module
• Show Qty of Remaining Items: Choose Yes to display the Deal Qty on the frontend
• Show Qty of Sold Items : Choose Yes to display Qty of sold items on the frontend

2.1.1. Countdown Timer

• Show countdown timer: Select Yes so that the countdown timer can be displayed on the Product Detail Page
• Clock Style: Select clock type shown at frontend. There are 5 types:

Imgur

• Outer background color: Change the background color of the Countdown timer
• Inner background color: Change the background color of the Countdown timer
• Number Clock: Change number color of the Countdown timer
• Text color: Change the texy color of the countdown timer

2.1.2. Discount Label

• Show Discount Label: Discount label can be displayed on the Category Page and the Product Detail Page. There are 3 options to choose:
  • No: Discount Label is not displayed on the Frontend
  • Under Price: Discount Label is displayed below the price of the product
  • Above Product Image: Discount Label is displayed in the image area
• Label: Display the discount label on the frontend
• Round percentage: Imgur
  • No: Do not make round the value on label
  • Round up: Round up the value on label
  • Round down: Round down the value on label
• Show On:
  • Only show this item when Show Discount label = Above Product Image
  • Select a location to display the Discount label on the product’s image
• Background Color: Change the background color of the discount label
• Border Color: Change the color of the label border
• Text Color: Change the text color of the Discount label

2.2. Deal Pages

2.2.1. All Deals Page

• Enable:
  • Select Yes to display the All Deals Page on the Frontend.
  • The page will display all the Deal RUNNING of the store
  • Products are sorted based on the ID in the backend. The deal created before will be displayed first
• Show Links:
  • Select the position to display the All Deals Page link on the Frontend
  • Multiple positions can be selected to display
  • Don’t show the link if you choose Please Select
• Route:
  • Setting the URL for the page.
  • Default = dailydeal
  • Page Title: Set the Title for All Deals Page

2.2.2. New Deals Page

Similar to the settings of All Deals Page, but New Deal Page displays all Product Deal based on Deal Start Date. Any deal RUNNING that is started lastest will be displayed first

2.2.3. Bestseller Deals Page

Similar to the settings of the All Deals Page, but the Bestseller Deals Page displays all Product Deals by old items. The deal RUNNING which is most bought by customers will be displayed first

2.2.4. Feature Deals Page

Similar to the settings of the All Deals Page, but the Deal Page Feature displays the Product Deal based on the Is Featured attribute in the backend. Only deals RUNNING that have Is Featured = Yes are displayed on this page

2.3. Sidebar Widget

• Enable: Select Yes to enable the Deal feature in the Sidebar widget
• Show Qty of Remaining Items: Select Yes to display the remaining Deal quantity of the Product
• Show Qty of Sold Items: Select Yes to display the number of sold deal

2.3.1. Random Deal

• Show: Choose Yes to display Block Random Deal on the sidebar. Product Deals are selected randomly
• Block Title:
  • Setup the title of Block Random Deal
  • If leaving this field blank, the block will not have the title
• Show On: Choose the position to show on the Top or Botton of the sidebar

• Limit:
  • Limit the maximum deals displaying in the block
  • If you leave this field blank or set this field as 0, the block will display one Product Deal randomly

2.3.2. Top Selling Deal

Similar to the setting of the Random Deal, but the Top Selling Deal Block displays Product Deal based on sold items. The deal RUNNING which is most bought by customers will be displayed first

2.3.3. Upcoming Deal

Similar to the setting of the Random Deal, but the Upcoming Deal Deal displays the Deal based on the Deal Start Date (Start On). The deal that has not arrived on sale is displayed in this block

2.3.4. Floating Slider Deal

• Show: Select Yes to display the Floating Slider Deal Block in the corner of the screen. Deal Features are displayed in this block
• Show on mobile: Choose NO to disable Floating Slider Deal when it’s on the mobile mode.
• Block Title:
  • Set the title of the Floating Slider Deal block
  • If leaving this field blank, the block has no the title
• Show On: Select the position displayed in the left corner or right corner of the screen
• Number of Deals:
  • Limit the maximum number of Deal that can be displayed in the Block
  • If leaving this field blank or set it as 0, the block displays one product deal randomly
• Show after:
  • When the floating bar is closed, it will automatically reappear after this time.
  • 0 means that it will not automatically reappear after being closed until the customers reload the page or move to a new page
  • Time is counted by seconds

2.4. Snippet

• With the command Snippet, admins can choose any position in the store to display the Daily Deal Block via pasting the command into the CMS Page, CMS Static Block of the store
• Daily Deal is displayed according to one or six types as the following: all, feature, new, upcoming, bestseller, random. If deleting typing in the command, it will be got the error.
• Change the number of deal displaying at a time on the slider in the block. If removing num in the command, the system will auto-get as 5 deals
• Change the total amount of Deal to be displayed on the Block. If you remove the limit in the statement, the system automatically gets the default as 5 deals
• Change the way to display the deal in the block. Admins can change to the grid or slider. If removing display in the command, the default will display according to the slider
• Change the title of the block. If removing title in the command, the default will display as DAILY DEAL PRODUCTS

2.5 Automatic Create Deal

• Schedule For: Set up the schedule in which deals are created automatically.
  • Disable: Disable auto-running deals by schedule
  • Daily: Auto-creating product deals daily
  • Weekly: Auto-creating product deals weekly
  • Monthly: Auto-creating product deals monthly
• Start Time: Date to start running deal
• Apply for Categories: Select category on which to create deals
• Special Price (Percent): Discount price (by percentage)
• Number Product Created: Number of products generated per cron run.
• Qty: Number of discount products
• Day(s): Number of days applied deals
• Run Manually: Click this button to create and run deals manually

3. Frontend

3.1. Category Page

3.2. Product Detail Page

3.3. Deal Pages

3.4. Sidebar Widget

3.5. Floating Deal Block

3.6. Snippet

For example: Displaying the Daily Deal on the About Us page by using the Snippet

• Step 1: In the backend, go to Content > Elements > Page, then edit the About us page

• Step 2: Insert the snippet code into the content of About us page

• Step 3: Save and check on the frontend

4. API

Mageplaza’s Daily Deal extension supports the use of the Rest API to add discount label and countdown timer data to individual products or all products, get deal by product SKU. Also, through the Rest API, you can retrieve, create and delete rule information.

• Details can be viewed here.
• Instructions for creating Integration tokens here.

5. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-daily-deal-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Mageplaza’s Daily Deal supports admins to get the information of rules via GrapQL

To start working with Daily Deal GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• View supported request GraphQl here

Delete Orders

Overview

Every day there are many orders placed and processed. The management at the Order Grid in the Magento database are very risky and time-consuming for admins’ work since they have to delete order one by one. The Mageplaza Delete Order extension makes it more convenient for the admin - either manually or automatically - to help them delete orders easily with a single or bulk delete command. Also, admin will receive an email notification when Order is Delete by schedule.

How to download and install

• Download Mageplaza Delete Orders
• How to Install

How to Configure

I.Configuration

From the Admin panel, go to Stores > Configuration > Mageplaza > Delete Orders.

1.General

Select Enable = Yes to enable the module.

2. Automatic Delete Configuration

An Order can only be deleted automatically by schedule when and only if it satisfies all the conditions of Purchase Date, Order Status, Customer Group, Store View, Shipping Country, and Order Total.

• Schedule For:
  • Set the schedule for delete order daily, weekly or monthly.
  • With Daily, the schedule runs automatically by date.
  • With Weekly, the schedule runs automatically on every Monday.
  • With Monthly, the schedule runs automatically on the 1st of the month.
• Start Time:
  • Set the starting time to delete order
  • By that time of day, the schedule will be run automatically.
• Excluded Period:
  • Enter the period to apply to delete order before it.
  • For example, Period = 10, today is December 31st, 2018, all orders created before December 21st, 2018 will be deleted (if they meet the conditions below).
• Order Status: Select order status to be applied Delete order.
• Customer Group(s): Choose the customer groups whose orders will be deleted auto by schedule
• Store View(s): Select Store view where Order is purchased to apply for Delete Orders
• Shipping Countries:
  • All Countries: Check all Orders.
  • Specific Country: Check for orders with Shipping Address at Country selected.
• Order Total less than: Limit the order’s Maximum Value to apply to delete order.
• Besides delete orders automatically, Admin can also click the “Run Manually” button to delete specific orders that meet all conditions
• Note: Admin can also delete orders by using the command line php bin/magento order:delete order_id. For example Admin wants to delete the order with ID = 15, admin on the command line running the command php bin/magento order:delete 15.

3. Email Notification

• Enable: Select yes to enable email sending to Admin every time an Order is deleted (including manual or auto-deletion).
• Sender: There are 5 default types of Magento Sender for Admin to choose: General Contact, Sales Representative, Customer Support, Custom Email 1, Custom Email 2.
• Email Template:
  • Choose the default email template to send email notification of delete order to admins
  • To change Email Template, Admin can create another Email Template in Marketing > Email Template.
  • Instructions for creating new Email Template here.
• Send To:
  • Insert the email who receive notification when Order is Delete.
  • Each email =must be separated by commas (,).

II. Grid

From Admin panel, go to Sales > Orders.

• Admin can delete orders created by clicking on the order ID
• In case Admin wants to delete all order, click Select All, the system will select all created orders.

• After Select order, admin click Action > Delete to delete order.

• Also, Admin can delete order by clicking to View of the order.

• Then click Delete.

• The system will show a popup, click OK to delete order

III. Email

Delivery Time

Overview

Delivery Time is an extension that supports for the checkout and delivery. With many outstanding features as setting the time, date for the delivery, and allowing leaving the comment when delivering, customers can easily setup the desired time which they want to receive the products. Also, thanks to these features, customers can know the day that the store doesn’t work and deliver the products. This extension will definitely bring many interesting benefits for store owners.

Moreover, Delivery Time extension is totally compatible with our One Step Checkout extension.

Download & Install

• Download Mageplaza Delivery Time
• How to Install

I. How to use

After adding the right products in the cart, the customers will be navigated to the checkout page. Delivery Time will be displayed here:

Display Delivery Time information in Order:

The customers can choose the day, time to receive the products and the related information to store owners as well as the shippers.

II. How to configure

Login to Magento Admin, go to Stores > Settings > Configuration > Mageplaza Extensions > Delivery Time > General Configuration

• Enable: Set “Yes” to allow customers to note the time when they can receive the shipping items
• Enable Delivery Time: Choose “Yes” so that customers can choose the time frame that they want to get the products. Admins need to set the time frame in the Delivery Time field.
• Enable House Security Code: Choose “Yes” if you want to display this field.
• Enable Delivery Comment: Choose Yes to display the comment field on the frontend. Also, customers can leave the note about their orders
• Date Format: Choose an appropriate format for the date and time. We offer 12 availble formats.
• In the Days Off field: Choose day(s) not in your official working time.
• Date Off: Choose any date that admins don’t want to deliver.
• Enable Cut-off Time: Set Yes to allow limiting the delivery time deadline, which will depend on the Cut-off Time field below.
• Cut-off Time: Set the daily delivery time deadline. After the time in this section, delivery actions can’t be implemented.

The instruction to attach Delivery Time information to Email Order

To add Delivery Time information to order confirmation email, please follow these steps:

1. Create Email template

• Access Marketing > Communications > Email Template. choose Add New Template (or edit template if you want)
• Load Template from New Order email

• Insert the codes to get Delivery Time to any position in the Template
  • Get deliverery date: {{var order.deliveryDate}}
  • Get delivery time: {{var order.deliveryTime}}
  • Get house security code: {{var order.houseSecurityCode}}
  • delivery comment: {{var order.deliveryComment}}

2. Apply email template

• Access Stores > Settings > Configuration, choose Sales > Sales Emails
• In New Order Confirmation Template, choose Email Template that has just been created

3. Check

• Plave an order in the frontend
• Check email sent to customers

III. GraphQL

3.1 How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-delivery-time-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

3.2 How to use

To start working with GraphQL in Magento, you need the following:

• Use Magento 2.3.x. Returns site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• View Mageplaza supported query here

Email Attachments

Overview

Email Attachments allows you to automatically attach the documents as PDF Invoices, Credit memos, Shipments and attach your Terms and Conditions to the sale emails. Mageplaza Email Attachments extension is released to solve the problem about sending the email with billing documents in PDF format in Magento. With the help of this module, it helps admins to reduce time in managing the store as well as help your customers understand better about the products on your store. Now let’s experience this module!!!

How to configure

1. Configuration

Login to the Magento Admin, choose Store > Configuration > Mageplaza > Email Attachments

1.1. General Configuration

• Enable: Select “Yes” to turn on this module or “No” to turn it off.
• CC to emails:
  • Enter the email address to send Attachments file copy to the customers you want to share.
  • Allows importing multiple emails at the same time and all the recipients of the mail will see the list of emails of those who have received Attachments file copy. These emails are separated by commas.
• BCC to emails:
  • Enter the email address to send Attachments file copy to the customers you want to share.
  • Allows importing multiple emails at the same time and all recipients of the message will not see the BCC recipient list. These emails are separated by commas.
• Enable Attach PDF: Select “Yes” to automatically attach billing documents in PDF format in the email and will display additional fields:
  • Attach PDF file for: Select the item you want to display Attach PDF file. PDF files for the above billing document(s) will be generated and attached to emails. Displayed in categories:
    • Invoice
    • Credit memo
    • Shipment

• Enable Attach Terms and Conditions: Select “Yes” to display the Attach Terms and Conditions in the email and it will display two more fields:
  • Attach Terms and Conditions: Select the item to display Attach Terms and Conditions in the email. Terms and Conditions will be attached to the above billing document(s) as a file. Displayed in categories:
    • Order
    • Invoice
    • Credit memo
    • Shipment
  • Terms and Conditions file:
    • Click Choose file button to upload PDF file for Terms and Conditions.
    • Allowed uploading the files: .pdf, .doc, .docx, .txt.

Edit Order

Overview

Currently, Magento 2 only allows editing Customer Information and Address Information at the view order page. If you want to edit other information, you must go to the separated Edit Order page, then the old order will automatically be canceled and the new order will be created. Also, admin can only edit other information (besides Customer and Address Information) when Order is Pending.

With Mageplaza Edit Order, the editing becomes easier than ever. This extension allows admin to edit information right at the order view page via slide popup without having to switch to another link. Quick Edit action is integrated to be able to edit all order information at the same time. In addition, this module automatically recalculates shipping fee if the order information changes and returns the item to stock if changing the item in the order.

Mageplaza Edit Order is fully compatible with Customer Order Number, Multiple Shipping Flat Rate, Shipping Restriction, Payment Restriction.

How to download and install

• Download Mageplaza Edit Order
• How to Install

How to Configuration

From the Admin Panel, go to Stores > Settings > Configuration > Mageplaza Extensions > Edit Order

1. Configuration

From the Admin Panel, go to Stores > Setting > Configuration > Mageplaza Extensions > Edit Order, select General

• Enable: Select Yes to turn on the Module.

• Only order in this status can be edited: Select order status that allows editing.

• Update Invoices/Shipments/Credit Memos After Editing:

  • No Change In Value: Created Invoices/ Shipments/ Credit Memos will not be changed when the order is updated.
  • Create new offline invoice and cancel Invoices/Shipments/Credit Memos: Created Invoices/ Shipments/ Credit Memos will be changed when the order is updated
    • Example: If the product quantity is updated to increase, the Ship/ Invoice button will be re-displayed for admins to create the new Ship/ Invoice for the updated quantity. If the product quantity is updated to decrease, the old Shipment/ Invoice/ Credit Memo will be canceled and the new Invoice will be created automatically; after that, the Ship/ Invoice button will be re-displayed for admins to create the new Shipment and Credit Memo.

• Enable Quick Edit:

  • Select Yes to display the Quick Edit button at the Edit Order page.
  • When clicked, the slide popup display can edit all information at the Edit Order page.

• Auto Recalculate Shipping Fee: Select Yes to auto apply the new shipping amount after updating ordered items or shipping addresses.

• Enable Return Item To Stock: Select Yes to return items to stock after items are removed or the item quantity decreased.

• Enable Track Order Shipping Status: Select Yes to display the Track Order Shipping Status button on the delivery created order and on the Shipment page.

  • On Manage Shipment Grid: Click Actions > Add Track Shipping for Order > Popup Add Track Shipping: Admin can add Tracking Number for one or multiple Shipment at the same time.

  

  

  • View Order:

  

2. Edit Order

2.1. Edit Order Information

From the Admin Panel, go to Sales> Orders > View Order > Edit Order, choose Edit Order Information

• Order Number:
  • Edit the order number, the same as the previous order.
  • Do not leave the field blank.
• Order Date:
  • Choose the date and time of order.
  • Do not leave the field blank.
• Status Order: You can only change the order status in the same state.

2.2. Edit Customer Information

From the Admin Panel, go to Sales > Orders > View Order > Edit Order, select Edit Customer

• Select: Choose to edit customer information

• Customer Email:

  • Edit Current Customer: show the customer email in text format, allowing you to edit customer emails.
  • Change Customer: show a input ext box with Select button. Click on Select to show a filterable grid to choose one existed account on your store.
  • Choose Save Information to save the information change in Customer account page.

• Note: In case you choose Select = Edit Current Customer then tick to Save Information to Customer and change that customer’ s email, the sytem will generate a new customer account.

  

Under the Edit Customer Information Grid shown the similar fields to Magento Edit/Add New Customer:

• Associate to Website: Choose the associate website with the edition of customer information. This is a required field.
• Name Prefix: Edit the Prefix of customer name
• First Name: Edit customer first name. This is a required field.
• Middle Name/ Initial: Edit customer middle/ initial name.
• Last Name: Edit customer last name. Do not leave the field blank.
• Name Suffix: Edit the Suffix of customer name
• Customer Group: Choose a group for customers.
• Date of Birth: Fill in customer date of birth
• Tax/VAT Number: Edit the tax information
• Gender: Choose the customer gender
• Send Welcome Email From: Choose the Magento storeview from which to send welcome email to customers when their email adress is changed.

• Vertex Customer Code: Enter the code to connect to Vertex Cloud which is used to calculate tax and sales.

2.3. Edit Billing Address/ Edit Shipping Address

From the Admin Panel, go to Sales> Orders > View Order > Edit Order, select Edit at Edit Billing Address/ Edit Shipping Address

Display information same as Magento but Edit Order extension will show Billing and Shipping Addresses via slide popup right at that view order page.

2.4. Edit Payment Method

From the Admin Panel, go to Sales > Orders > View Order > Edit Order, select Edit at Payment Information

Choose the available payment method at your store.

2.5. Edit Shipping Method

From the Admin Panel, go to Sales > Orders > View Order > Edit Order, select Edit in the Shipping & Handling Information section

Select the Shipping Method available at the store.

2.6. Edit Items Ordered

From the Admin Panel, go to Sales> Orders> View Order> Edit Order, select Edit in the Items Ordered section

• Choose Custom Price buttons if you want to update product prices.
• Custom:
  • Percent: Discount = percent of price.
  • Fixed Amount: Discount = value enter to the box below
• Action:
  • Remove: Remove the product from the shopping cart.
• To add products to cart, click Add Products > Select products > Add Selected Product(s) to Order:
• Note: When changing Qty, adding product, removing product, you always need to click the Update Items and Quantities > Update.

2.7. Quick Edit

From the Admin Panel, go to Sales> Orders > View Order > Edit Order, select Quick Edit

Edit order and customer information

Edit Billing Address

Edit Shipping Address

Edit Items Ordered

Quick edit allows editing all order information at the same time.

3. Grid

3.1. Manage Logs

From the Admin Panel, go to Sales > Edit Order > Manage Logs

• This is where the order information was edited.
• From Manage Logs, admin can capture basic information such as ID, Editor, Order Number, Edited Field, Created Date, Action.
• Action:
  • View: Redirect to Logs page to view edited orders before.
  • In addition, admin can filter, change store view, hide/ display columns.

3.2. View Logs

From the Admin Panel, go to Sales > Edit Order > Manage Logs, select View Logs

4. Compatible

4.1. Compatible with Customer Order Number

Order numbers will include both letters and numbers. It will be beneficial for the website, especially new websites, the number of orders is low which likely create higher reliability.

4.2. Compatible with Multiple Shipping Flat Rate

In addition to the Magento Shipping Method, when installing the module Multiple Shipping Flat Rate, you can create more Shipping Methods to help admin and customers have more options.

4.3. Compatible with Shipping Restriction

Creating the show/ hide the Shipping rule which is displayed in both the backend and frontend.

4.4. Compatible with Payment Restriction

Creating the show/ hide the Payment rule which is displayed in both the backend and frontend.

4.5. Compatible with One Step Checkout

Extra Fee

Overview

Magento currently only supports certain shipping methods: Free Shipping, Flat Rate, Table Rate, UPS, Magento Shipping, USPS, FedEx, DHL. If store owners want to add fees for any services in their store like gift wrap, fast shipment within 2 hours, etc, they can not be configured. Developed by Mageplaza, Extra Fee module allows shoppers to add whatever fees they want and display them on their Checkout and Shopping Cart pages.

Download and Install

• Download the module
• Install Mageplaza extension

How to configure

From the Admin Panel, go to Stores > Extra Fee > Configuration

1. Configuration

From the Admin Panel, go to Stores > Extra Fee > Configuration, choose General sections

• Enable: Select Yes to use the feature of the module

• Calculate Total includes: Choose how to calculate the service cost

  • Calculate Total includes = Discount: the service fee includes the discount
  • Calculate Total includes = Shipping Fee: The service fee is calculated after shipping surcharge
  • Calculate Total includes = Tax: The service fee includes the tax of the product
  • Many options can be selected
  • Only apply this calculation method with the fee type as a percentage

• Show Extra Fee on the Order Grid: If Yes, the extra fee information will be displayed in the order grid.

• Display Extra Fees on Product Page: Select Yes to display extra fee information of the product on the product page.

  • Title: Enter title of all extra fees on the product page.

  • Display Extra Fees on Product Page: Select the display position for all extra fees on the poroduct page. There are 2 positions:

    • Before Add to Cart button:

    

    • After Add to Cart button:

    

2. Manage Extra Fees

How to Add New Rule

• Step 1: Enter the full information in thr General section
• Step 2: Set the conditions to apply the rule in the Condition section
• Step 3: Set the form, service fee, display area … of the rule in Action section
• Step 4: Enter labels for service type for the store and in the backend

Step 1: Enter the full information in thr General section

• Name: Enter the name of the rule
• Status: Select “Enable” to apply the rule
• Description: Enter the information to desribe the extra fee

• Store Views
  • Only selected stores are applied the rule
  • Multiple stores can be selected at the same time
• Customer Groups
  • Only selected customer group can see the rule
  • Multiple groups can be selected at the same time
• Priority   - Enter the priority for applying the rule
  • The smaller the number, the higher the priority. For rules with equal priority, the priority will be based on ID.

Step 2: Set the conditions to apply the rule in the Condition section

• Select conditions to apply the rule
• You can set the conditions for the Cart or Product, Customer and Other…. section as Subtotal greater than 50, Total Items Quantity less than 5, Quantity In Stock, conditions based on customer information, etc.

Step 3: Set the form, service fee, display area … of the rule in Action section

• Apply Type:

• Apply Type = Manual: Customers can optionally choose the service type of the rule
  • Display Area: Choose the area to show the rule

• Display Area = Cart Summary: Display the rule in the Cart Summary section
• Display Area = Shipping Method: Display the rule in the Shipping Method section
• Display Area = Payment Method: Display the rule in the Payment Method section
• **Display Type`: Choose the display type of the rule for customers to choose

• Display Type = Radio: Allow choosing the display type as radio

• Display type= Select: Allow choosing the display type as select

• Display Type = Checkbox: Allow choosing the display type as checkbox

• Is Required: Choose Yes to force customers to choose at least one service type.

• Apply Type = Automatic: Service type of the rule will be applied automatically.

  • Fee Type: Choose the fee type

  

  • Fee  Type = Percentage of cart total: Service fee will be calculated as percentage of total cart
  • Fee Type = Fixed amount for the whole cart: Service fee will be charged as a certain amount when the customers purchase the products
  • Fee Type = Fixed amount for each item: The service fee will be calculated as a certain amount on each item in the cart

• Fee Amount

  • Enter the amount or percentage (depending on the payment type you choose) to apply for the service fee
  • This field is not allowed to be empty

• Fee Tax:

  • Choose Tax Rule to calculate the fee tax for service fee
  • Fee Tax = No: Not apply to calculate the fee tax for service fee

• Cart Sort Order:

  • Enther the priority for displaying the rule on the frontend and in the admin order
  • The smaller the input number, the higher the display priority. For the rule with equal priority, the priority will be based on the ID.

• Refundable:

  • Choose Yes to aplly the service fee for the refund order
  • The service fee will be applied at the first refund

• Stop further processing:

  • Choose Yes to limit the number of the rule that is applied for the service types (based on the priority and ID)

  • For example: There’re 4 rules as Rule 1, Rule 2, Rule 3 and Rule 4 and the respective priority is 0, 5, 3 and 3.

    • All rules are set as `Stop further processing = No: all rules are applied
    • Edit the Rule 3 and choose Stop further processing = Yes: After you Apply Ryle, the applied rules is Rule 1 (as the high priority) and Rule 3. Rule 2 (as the small priority) and Rule 4 (as creating later) are not applied.

    

Step 4: Enter labels for service types for the store and in the backend

• For Apply Type = Manual: Display the Manage Option

  • Type: Choose the service fee type
    • • Fee  Type = Percentage of cart total: Service fee will be calculated as percentage of total cart
    • Fee Type = Fixed amount for the whole cart: Service fee will be charged as a certain amount when the customers purchase the products
    • Fee Type = Fixed amount for each item: The service fee will be calculated as a certain amount on each item in the cart
  • Amount: Enter the amount or percentage (depending on the payment type you choose) to apply for the service fee
  • Admin:
    • Enter the display name in the admin order/invoice/shipment/credit memo for the selected service type
    • This field is not allowed to be empty
  • Stores: Enter the display name for added service type on the frontend of the stores
  • Is Default: Choose the default service type when customers choose a new service
  • New Option: Click on the New Option button to setup other services

• For Apply Type = Automatic: Display the Manage Labels

  • Admin:
    • Enter the display name in the admin order/invoice/shipment/credit memo for selected service type
    • This field is not allowed to be empty
  • Stores: Enter the display name for selected service type on the frontend of the stores

  

3. Frontend

3.1. Display on the Cart Summary

3.2. Display on the Payment Method

3.3. Display on the Shipping Methods

3.4. Display on the Order

3.5. Display on the Invoice

3.6. Display on the Shipment

3.7 Display on the Credit Memo

3.8 Display on the Checkout with Multiple Addresses

The extra fee is applied when checking out with multiple address in the following positions:

• Shipping Method:

• Payment Method:

• Cart Summary:

4. Backend

4.1. Order

4.2. Invoice

4.3. Shipment

4.4. Credit Memo

4.5. Order Grid

Show the extra fee information in the order grid. Go to Sales > Orders to learn more about this information.

5. Email

5.1. Order Email

5.2. Invoice Email

5.3. Shipment Email

5.4. Credit Memo Email

6. Compatible with Mageplaza One Step Checkout

7. Compatible with Mageplaza PDF Invoice

7.1. PDF Order

7.2. PDF Invoice

7.3. PDF Shipment

7.4. PDF Credit Memo

8. Compatible with PDF of Magento

8.1. PDF Invoice

8.2. PDF Shipment

8.3. PDF Credit Memo

9. How to custom using the layout handle

• To display Extra Fee in Magento’s default email, you need to visit Marketing > Communications > Email Templates. You can create a new template for order, invoice, shipment, credit memo, etc. Use different code for each template to display Extra Fee data (do the same for PDF Invoice templates). Note: If there is extra fee data, this data will be displayed and vice versa, if there is no data, this template will be the same as normal Magento template.
  • Order, Shipment
    • Get Extra Fee information at Payment Method.

{{if order.getHasBillingExtraFee()}}
{{layout handle="mp_billing_extra_fee" order_id=$order_id area="frontend"}}
{{/if}}

• Get Extra Fee information at Shipping Method.

{{if order.getHasBillingExtraFee()}}
{{layout handle="mp_billing_extra_fee" order_id=$order_id area="frontend"}}
{{/if}}

• Get Extra Fee information at Cart Summary. Note: The rules with Apply Type = Automatic will also appear in Cart Summary in the backend and display on the template.

{{if order.getHasExtraFee()}}
<h3>{{trans "Extra Fee"}}</h3>
{{layout handle="mp_extra_fee" order_id=$order_id area="frontend"}}
{{/if}}

• Invoice
  • Get Extra Fee information at Payment Method:

{{if invoice.getHasBillingExtraFee()}}
{{layout handle="mp_billing_extra_fee" order_id=$order_id area="frontend" invoice_id=$invoice_id}}
{{/if}}

• Get Extra Fee information at Shipping Method

{{if invoice.getHasShippingExtraFee()}}
{{layout handle="mp_shipping_extra_fee" order_id=$order_id area="frontend" invoice_id=$invoice_id}}
{{/if}}

• Get Extra Fee information at Cart Summary. Note: The rules with Apply Type = Automatic will also appear in Cart Summary in the backend and display on the template.

{{if invoice.getHasExtraFee()}}
<h3>{{trans "Extra Fee"}}</h3>
{{layout handle="mp_extra_fee" order_id=$order_id area="frontend" invoice_id=$invoice_id}}
{{/if}}

• Credit Memo:
  • Get Extra Fee information at Payment Method

{{if creditmemo.getHasBillingExtraFee()}}
{{layout handle="mp_billing_extra_fee" order_id=$order_id area="frontend" creditmemo_id=$creditmemo_id}}
{{/if}}

• Get Extra Fee informaiton at Shipping Method

{{if creditmemo.getHasShippingExtraFee()}}
{{layout handle="mp_shipping_extra_fee" order_id=$order_id area="frontend" creditmemo_id=$creditmemo_id}}
{{/if}}

• Get Extra Fee information at Cart Summary. Note: The rules with Apply Type = Automatic will also appear in Cart Summary in the backend and display on the template.

{{if creditmemo.getHasExtraFee()}}
<h3>{{trans "Extra Fee"}}</h3>
{{layout handle="mp_extra_fee" order_id=$order_id area="frontend" creditmemo_id=$creditmemo_id}}
{{/if}}

Note:

• You can view the template of PDF Order when it is compatible with Extra Fee extension here
• For Invoice and Credit Memo, all fees of Extra Fee will be added to Invoice or Credit Memo first.

10. API

Extra Fee extension by Mageplaza supports using Rest API to get extra fee data rules, collect total for customers or guest customers.

Please view details here.

Guide on how to create Integration tokens here.

11. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-extra-fee

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

Extra Fee extension by Mageplaza supports getting data of Extra Fee rule and extra information in order with positions such as: payment method, shipping address, cart summary.

To start working wwith Extra Fee GraphQL in Magento, you neeed to:

• Usse Magento 2.3.x orr 2.4.x. Take site to the developer mode.
• Learn morre about GraphQL requests wwe support here

Facebook Plugin

Overview

Nowadays, Facebook is one of the most popular social networks to be used. And almost store owners have the need to advertise their stores on Facebook. However, the cost of advertising on Facebook is quite large. Therefore, Mageplaza has built a new module as Facebook Plugin. It allows store owners to insert a Facebook Page widget easily. This makes it easier, less expensive, and more effective for online stores to reach consumers. Not only that, store owners can manage Facebook comments on the product details page with an ease.

Download and Install

• Download Facebook Plugin
• Install Mageplaza module

How to configure Facebook API

To create the Facebook app and the Facebook App API information, please follow these steps:

Step 1: Go to: https://developers.facebook.com/

Step 2: Log in to Facebook. Click Login to sign in with the existing Facebook account, or register a new account. After logging in, choose My App from the menu at the top.

Step 3: Select the app type that you are using. Fill out the Display name for your app.

Step 4: Go to Settings > Basic to get the App ID in Facebook to fill in the Facebook App ID field of Mageplaza Facebook Plugin extension to connect with your Facebook.

You can go to: https://developers.facebook.com/tools/comments to get the list of your Facebook apps, which lets you moderate all comments associated with each app.

Note: After setting up Facebook API information, you should go to Widget to select the display positions of the post or website,… of Facebook on your website.

How to configure

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Facebook Plugin > Configuration

1. Configuration

1.1. General Configuration

• Enable: Choose Yes to use the feature of this module
• Facebook App ID:
  • Enter App ID so that admins can manage the facebook comments on the product page
  • You are not allowed to leave this field blank

1.2. Facebook Plugin

• Enable: Select Yes to insert the Facebook page into the Widget
• Facebook URL:
  • Enter the URL of the Facebook page you want to advertise
  • Only show Facebook pages in the public mode
• Tabs:
  • Select the tabs displayed on the Facebook page
  • You can choose from three tabs: Timeline, Event, Messages
  • The default is the Timeline tab
• Width:
  • Enter the width of the Facebook page display frame
  • The default width for frames is 340px
  • Minimum width is 180px, maximum width is 500px
• Height:
  • Enter the length of the Facebook page display frame
  • The default is 500px
  • The minimum length is 70px
• Hide cover photo:
  • Select Yes to hide the cover of the Facebook page
  • The default is No
• Hide the custom Call To Action: Select Yes to hide the call-to-action button on the Facebook page (if this call-to-action button is available on the page). For example, on the Facebook page there is the buttons: Book Now, Call Now, Send Email, etc, then these buttons will be hidden if Hide the custom call to action = Yes
• Small header:
  • Select Yes to display the header with the small size
  • The call-to-action button will be hidden
• Adapt Width:
  • Select Yes to automatically adjust the width of the Facebook display frame accordingly
  • The default is Yes
• Snippet Code:
  • XML File: Copy and paste the code into a file that includes .xml where you want to display the Facebook page outside the frontend
• CMS Page, CMS Static Block: Copy and paste the code to the page or block the page you want to display the Facebook page outside the frontend
• Template .phtml file: Copy and paste the code into the .phtml file where you want to display the Facebook page outside the frontend.

1.3. Facebook Comment

• Enable Facebook Comment: Select Yes to enable the comment feature on the Product View page by Facebook
• Title:
  • Enter a title for the comment tab
  • The default title for the comment tab is Facebook Comment
• Width:
  • Enter the width for the comment section
  • The minimum width is 320px
• Number of Posts:
  • Enter the number of comments you want to display
  • The minimum number of comments for the display is 1

2. Product

From the Admin Panel, go to Catalog > Product

• Disabled Facebook Comments: Select Yes to allow the function Disabled Facebook Comments on the Product Detail Page

3. Widgets

How to add the widget

• Step 1: Select the type
• Step 2: Complete the Storefront Properties section
• Step 3: Configure Widget Options to display the Facebook page

Step 1: Select the type

• On the Panel Admin, Content > Elements > Widgets
• In the upper-right corner of Widgets workplace, click on Add Widget button.
• In the Settings section:
  • Choose CMS Static Block type in the Type box.
  • Choose the current theme you are applying in the Design Theme.
  • Click Continue button.

Step 2: Complete the Storefront Properties section

• In the Storefront Properties section,
  • Enter Widget Title for the internal reference.
  • Assign the block to all store views in the Assign to Store View field or to any store view you want to apply the block.
  • Set the Sort Order if many blocks are placed at the same container. The block is at the top if the inserted value is zero.

• In the Layout Updates section, click on Layout Update to set the layout.
  • Choose the category, product, or [page]https://www.mageplaza.com/kb/how-to-add-a-new-cms-page-magento-2.html) where shows the block in the Display on field.
  • If set to a specific page, you need to choose Page you want to the block to display and set Container that is the position of the page the block appears.

Step 3: Configure Widget Options to display the Facebook page

• Facebook Widget options:

• Facebook Widget options = Use Config: Use the configuration displaying for Facebook page in the Configuration section
• Facebook Widget options = Custom: Admins set the display for Facebook page

• Facebook URL:
  • Enter the URL of the Facebook page you want to advertise
  • Only show Facebook pages in the public mode
• Tabs:
  • Select the tabs displayed on the Facebook page
  • You can choose from three tabs: Timeline, Event, Messages
  • The default is the Timeline tab
• Width:
  • Enter the width of the Facebook page display frame
  • The default width for frames is 340px
  • Minimum width is 180px, maximum width is 500px
• Height:
  • Enter the length of the Facebook page display frame
  • The default is 500px
  • The minimum length is 70px
• Hide cover photo:
  • Select Yes to hide the cover of the Facebook page
  • The default is No
• Hide the custom Call To Action: Select Yes to hide the call-to-action button on the Facebook page (if this call-to-action button is available on the page). For example, on the Facebook page there is the buttons: Book Now, Call Now, Send Email, etc, then these buttons will be hidden if Hide the custom call to action = Yes
• Small header:
  • Select Yes to display the header with the small size
  • The call-to-action button will be hidden
• Adapt Width:
  • Select Yes to automatically adjust the width of the Facebook display frame accordingly
  • The default is Yes

4. Frontend

4.1. The display of the Facebook page

4.2. The display of facebook comment on the product page

4.3. Manage the comment on the App of Facebook

Note

• If you want to uninstall the extension, please use the composer to run the command: bin/magento module:uninstall Mageplaza_FacebookPlugin
• In case you have deleted the extension manually, you need to delete the mp_facebook_comments attribute as well in the data base or at backend
  • Method 1 Backend: From the Admin Panel, go to Stores > Attributes > Product. At column Attribute Code, look for attribute mp_facebook_comments, click to it and delete.

• Method 2 Data base: Navigate to eav_attribute table. At column Attribute_code, look for attribute mp_facebook_comments, click to it and delete.

FAQ extension

Overview

If you are looking for an extension that allows customers easily to find the inquiries, ask and answer the question about their confusing, it’s high time to choose FAQ extension.

Developed by Mageplaza for Magento 2 stores, FAQ extension offers an SEO-friendly FAQ page, which helps visitors look for the answer with ease instead of sending the email to the freshdesk page. Therefore, you can save much time for customers; this also makes them satisfied with your service, and of course, they will come back to your online store in the next purchase.

Download & Install

• Mageplaza FAQ
• How to install

How to use

FAQs Homepage

• Allow displaying all categories and dependent question
• Depending on the installation of admins, FAQ Homepage will display Search box or not. Customers can search any question on FAQ Homepage quickly when using Seach box.
• The answer of each question can be displayed when clicking on the question if Question type = Collapsible

FAQs Category Page

• Display all questions of the category
• The same as FAQ Homepage, Category page is also displayed on the Search box and performs the function as on FAQ Homepage. When you find by the search box, all satisfied questions (in all categories) will be displayed. To return the current category, you only need to delete the condition that you have just searched.
• The answer of each question can be displayed when clicking on the question if Question type = Collapsible

FAQs Detail Page

• Display all answer’s contents for each question, Pageview, first public dates, positive feedbacks.
• Question Detail Page can display the Voting for helpfulness field so that customers can respond if this answer is helpful to them or not.

• If getting the allowance of admins, customers can also submit the question at the bottom of each Question Detail page. The notification will be sent to the customer email box when their question is added the answer and public if they tick in the checkbox Receive email notification.
• For the countries don’t use the English alphabet (such as Russian, Japanese, Korean, Chinese, Arabic, etc.), questions will not be submitted.

FAQs Product Tab

• Display all questions regarding the product.
• Customers can submit a question here. The question submitted by creating the form in the Product Tab will be auto-displayed in the Product Detail when it’s public.
• Similar to the submit form in the Question detail page, we don’t support the countries that do not use the English alphabet (such as Russian, Japanese, Korean, Chinese, Arabic, etc.)

How to configure

Login to the Magento Admin, choose Content > FAQs

1. Manage Articles

1.1. Management Grid

• This is a place to save all required questions. It includes that admins have created and customers have created.
• From the Grid, admins can know all basic information of question as ID, the content and URL of the question, who created the question, the status of the question (answered or not), Visibility (public, hidden, need approved), displayed store view, Helpful rate, Create date, Update date, Position, and Action.
• Admins can perform some actions as the following:
  • Delete: Admins need to tick and choose the question that they want to delete, then select Delete in the Action box (in the upper left of the grid) to delete. A confirmation dialog will appear, then choose OK to continue deleting.
  • Change Visibility: Admins need to tick and choose the question that you want to change the Visibility, then choose Change Visibility > Public/Hidden/Need Approved in the Action box (in the upper left of the Grid) to change the Visibility. Instantly, selected questions will be changed about selected Visibility.
  • Edit: To edit a rule, admins need to choose Edit in the Action box (the last column on the right of the Grid)
  • Instant Edit: Admins can edit some fields of the Rule in the Grid by clicking the mouse to the field you want to edit. The Grid will change as the following:

• Also, admins can filter, change Store View, hide/represent the columns or export Grid.

1.2. Add New/Edit Form

1.2.1. General

Statistic

• This is a place to count the view (the detail page view), the total number of actions (counted by times), positive and negative (as a percentage).
• Details about those fields:
  • View is counted by numbers of detail question page.
  • Action = ratings of Positive + Negative.
  • Positive (%) = ratings of Positive/Action.
  • Negative (%) = ratings of Negative/Action.

General

• Question: The question will be filled in this section. It is displayed in the backend and on the frontend (if published)

• URL Key:

  • The content entered in this section is the URL of the detail question page.
  • To access the detail question page, customers need to click on the Read more link under each answer or click on the question when searching.
  • If you leave this field blank, the system will auto-create URL key for the detail question page.
  • Note: With the countries that don’t use the English alphabet, URL key won’t be created.

• Answer:

  • The content entered in this section is the answer to the question as we mentioned above.
  • If you leave this field blank, after Saving, the status will be displayed in the Grid, called PENDING.
  • In contrast, if the answer field contains the content, the status in the Grid, called ANSWERED.

• Categories:

  • A question will belong to a certain field and admins can classify it by adding Category to Question.

  

  • To display the Category, admins need to create it in the Manage Categories section.

• Store Views: A website can have many store views. Questions are only displayed with selected store views.

• Visibility: A question can have 3 visibilities. Real visibilities allow admins to distinguish what questions are public, which questions can be ignored and which questions need to be approved.

  • Public: Admins choose Public, this means that the questions will be displayed outside the frontend.
  • Hidden: When you choose this option, this means that the questions are removed by admins and will be hidden from the frontend.
  • Need Approved: When a question is submitted, or the question that admins don’t want to display, they will use this option.

• Position: This field stipulates the order to display the question on FAQs Homepage, FAQs Category, and FAQs Product Tab.

Customer Information

• Author Name:
  • When a question is submitted, the name of the submitter is also submitted to the backend.
  • In case, the name isn’t required, the information sent to the backend is Quest.
• Author Email:
  • When a question is submitted, the email of submitters is also submitted to the backend.
  • In case the email isn’t required, the information sent to the backend is quest@gmail.com
• Receive Email Notification:
  • When this section is selected, customers will get the email notification about the answer that they have submitted before.

SEO Config

• You can configure the meta that is useful for your better SEO
  • Set Meta title for question detail page
  • Set Meta description for question detail page
  • Set Meta keywords for question detail page
  • Set Meta Robots for question detail page

1.2.2. Product

• You can do Assign Products to the Question in the Products tab when you create a new post
• In the list of the available products, mark the checkbox that is next to the products you want to assign
• Tap Save and Continue Edit, then hit Save to finish

2. Manage Categories

2.1. Management Grid

• This is a place to save all categories that admins have created.
• From the Grid, admins can know all basic information of question as ID, the name and URL of the question, icon of the Category, the status of Category, Store View, the number of questions, Create Date, Update Date, Position, and Action.
• Admins can perform some actions as the following:
  • Delete: Admins need to tick and choose the question that they want to delete, then select Delete in the Action box (in the upper left of the grid) to delete. A confirmation dialog will appear, then choose OK to continue deleting.
  • Change Status: Admins need to choose the category that they want to change the status, then choose Change Status > Enable/Disable in the Action box (in the upper left of the Grid) to change the Status. Instantly, selected categories will be changed about the selected status.
  • Edit: To edit a rule, admins need to choose Edit in the Action box (the last column on the right of the Grid)
  • Instant Edit: Admins can edit some fields of the Rule in the Grid by clicking the mouse to the field you want to edit. The Grid will change as the following:

• Also, admins can also filter, change the store view, hide/represent the columns or export the grid.

2.2. Add New/Edit Form

2.2.1. General

General

• Name: The name of Category entered in this section will be displayed both in the backend and frontend (if enabled and it has the dependent questions)
• URL Key:
  • The content filled in this field will be URL of the category page
  • To access the category page, customers only click on the name of category on the frontend
  • If you leave this field blank, the system will auto-create the URL key for category page
• Status: You need to enable this field so that the category will be displayed on the frontend when it has the dependent questions.
• Store View: A website has many store views. The category will only be displayed with selected store views.
• Icon:
  • Go to the page: https://fontawesome.com/ to choose the icon of the category you want.
  • When you copy class of the icon into the field, immediately, an illustrated icon will be shown.
• Position: Stipulate the orders to display the category in FAQs Homepage

SEO Config

• You can configure the meta that is useful for your better SEO
  • Set Meta title for Category page
  • Set Meta description for Category page
  • Set Meta keywords for Category page
  • Set Meta Robots for Category page

2.2.2. Question

• You can do Assign Question to the Category in the Question tab when you create a new category
• In the list of the available question, mark the checkbox that is next to the question you want to assign
• Tap Save and Continue Edit, then hit Save to finish

3. Configuration

3.1. General

• Enable Module: Choose Yes to enable this module
• Choose FAQ’s color: The color that you choose in this section will stipulate the main color of FAQ Page on the frontend
• Allow Voting For Helpfulness: Choose Yes so that customers can rate Positive or Negative for each answer
• Restrict Rating For: Stipulating the customer group can rate the answer quality.

3.1.1. Add Question Config

• It is a part of General Config
• This field stipulates the configuration about adding questions
• The action about adding questions will be displayed in the Question detail page

• Allow Guests To Add Questions: There are 3 options to stipulate who can submit the question for admins

• Only Logged In Customer: Only customers who have the account can add the question
• Yes: All customers can add the question
• No: No customers can submit the question. The question is only added by admins in Manage Question
• Question maximum character:
  • Limit the maximum character for a question
  • If you leave this field blank, the maximum character is 255
• Need Admin’s Approved:
  • Any submitted question will not be displayed on the frontend, it will be changed to Manage Question
  • Choose Yes so that the question has the visibility is Need Approved when changing to the Manage Question
  • If you choose No, the visibility of the question is Hidden.
• The Name Field is:

• No: The name field won’t be displayed on the frontend
• Optional: The name field will be displayed on the frontend but customers don’t need to fill in
• Require: The name field will be displayed on the frontend and customers have to fill in this section so that the question is submitted
• In case you choose No and Optional, the default name will be sent to the backend is Quest.
• The Email Field is:

• No: The email field won’t be displayed on the frontend
• Optional: The email name will be displayed on the frontend but customers don’t need to fill in
• Require: The email field will be displayed on the frontend and customers must fill in this field so that the question is submitted
• In case you choose No and Optional, the default name will be sent to the backend is quest@gmail.com
• Show Email Notification checkbox:
  • Choose Yes so that the checkbox can receive the email when the answer is added and public
  • Customers need to tick on the new checkbox to allow receiving the email

3.1.2. Question Detail Page Config

• It’s a part of General Config
• This section stipulates the configuration about the Question Detail page

• Enable Question Details Page:
  • Choose Yes to view the question and answer detail when clicking on Read More
  • If choosing No, the answer will be displayed totally and it doesn’t include the Read More link. The original URL of the question is also changed to 404 page
• Short answer maximum character:
  • Limit the maximum character for each question
  • If leaving this field blank, the maximum character is 255
• Detail Page Layout:

• Select one of the following layouts to have your checkout page be shown in four different interfaces
  • 1 column
  • 2 columns with left bar
  • 3 columns with right bar
  • 3 columns

3.1.3. Search box Config

• Enable Search Box: Choose Yes so that Search Box will be displayed on the FAQ homepage, FAQ Category, and FAQ Question Detail.
• Search Box Title:
  • Enter the title of the Search Box
  • The content of this field will be displayed on the frontend
  • Default = Knowledge Base
• Search Box Description:
  • Enter the description of the Search Box
  • The content of this field will be displayed on the frontend
  • Default = Search our articles or browse by category below

3.2. FAQ Schema Markup

• Enable: Choose Yes to create FAQ Schema Markup for FAQs.
• Limit number of questions:
  • Limit the maximum number of questions displayed in the Schema Markup.
  • If left blank, the maximum number of questions is 5.

3.3. FAQ Home Page Configuration

• Enable: Choose Yes to enable the FAQ homepage
• Route: The route of FAQ Homepage is entered in this field. If leaving it blank, FAQ Homepage will be disabled
• Insert FAQ link on:
  • Choose the position for displaying the FAQ Homepage
  • There’re 3 positions to display: Toplink, Footerlink, and Category Menu
  • FAQ Homepage link will not be displayed if you choose Please Select
• Page Title:
  • Fill in the page title
  • If leaving it blank, the default = Frequently Answer and Question
• Page Layout:

• Select one of the following layouts to have your checkout page be shown in four different interfaces
  • 1 column
  • 2 columns with left bar
  • 3 columns with right bar
  • 3 columns
• FAQ Style: Now we offer one style only is Material
• Categories Columns: Categories are arranged into 1 or 2 or 3 columns depending on the option that admins choose in this section
• Question Style:

• Collapsible: On the FAQ Homepage, the answers will be collapsed with their questions. The answer only will be displayed if customers click on the question, and it will be hidden if the question is clicked again.
• Default: The answer will be displayed under the question and customers cannot collapse the question anymore.
• Limit Question per Category:
  • Limit the maximum questions displayed on each category
  • If leaving it blank, the maximum questions displayed is 5

3.3.1. SEO Config

• You can configure the meta that is useful for your better SEO
  • Set Meta title for FAQ Homepage
  • Set Meta description for FAQ Homepage
  • Set Meta keywords for FAQ Homepage
  • Set Meta Robots for FAQ Homepage

3.4. Product Tab Configuration

• Enable: Choose Yes so that FAQ Tab can display in the Product Info Detail Box
• Tab Title:
  • Fill in the Tab Title
  • If leaving it blank, the default = FAQs
• Limit question:
  • Limit the maximum questions that displayed on the Product Detail Page
  • If leaving it blank, the maximum questions displayed is 5
• FAQ Style: Now we only offer one style, Material.
• Question Style:

• Collapsible: On the homepage, the answers will be collapsed with their questions. The answer will only be displayed if customers click on the question, and it will be hidden if the question is clicked again.
• Default: The answer will be shown under each question and customers cannot collapse the question.
• Show Name: Choose Yes to allow displaying the name of the person who has submitted the question
• Show Date of Question/Answer:
  • Choose Yes to display the date that the answer is public
  • Note: The date will be displayed if the name is shown (Show Name = Yes)

3.5. Terms & Conditions

• Show Terms & Conditions when submitting questions:

• No: Terms & Conditions will not be displayed on the frontend, Submit Question Form
• Yes (checkbox): Terms & Conditions will be displayed in the Submit Question Form under checkbox form. Customers need to tick on the checkbox, after that the question can be submitted.
• Yes (hidden): Terms & Conditions will be shown in the Submit Question form under the text. At this time, customers default to accept the term & condition of the store owner
• Link popup label: The name of popup Terms & Conditions. When clicking on the popup label, the popup that contains the content of Terms $ Conditions will be displayed
• Title: Allow filling in the title of the popup
• Content: The content will be displayed on the popup. We recommend you should use the HTML language.

3.6. Email Configuration

• Enable: Choose Yes so that the actions regarding the email can be enabled

3.6.1. Email to Customer

• Send an email to a customer when an answer is added: Choose Yes to email the notification to customers when the answers are public and sent to the registered customers to receive the email
• Sender: Allow choosing one in five senders that Magento offers: General Contact, Sales Representative, Customer Support, Custom Email 1, and Custom Email 2
• Template: The extension is installed an available template to send to customers

3.6.2. Email to Admin

• Send an email to admins when a question is created: Choose Yes to email the notification for admin when a question is submitted by customers.
• Send To: Fill in the email that you want to get the notification when a question is submitted
• Template: The extension is installed an available template to send to customers

4. Widget

• With the widget, you can allow FAQ to display on any page you want.

• To create the widget, you can do the following steps:

  • Step 1: From the admin panel, choose Content > Elements > Widget > Add New Widget
  • Step 2: Choose Type = Mageplaza FAQs, Design Theme = Magento Luma. After that, select Continue

  

  • Step 3: Set the name for the widget (displayed in the backend) and choose Store View that you want to allow Widget to display

  

  • Step 4: Choose the page and the position that you want the FAQ Widget to display

  

  • Step 5: Switch to Widget Options tab, then set the widget name that you want to display on the frontend.

  

  • Step 6: Save Widget and check it on the frontend

  

5. API

Mageplaza’s FAQ extension supports users to use the API to make some requests, such as getting article/category information, creating new categories/article/questions or deleting categories/articles.

• You can view API requests we support here.
• See how to create token-based authentication here.

6. GraphQL

6.1 How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-faqs-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

6.2 How to use

Mageplaza’s FAQ extension supports getting categories, articles and creating questions through GraphQL. To start working with FAQs GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Refer the GraphQL requests we supports here.

Follow Up Email

Overview

With the Follow Up Email extension of Mageplaza, admin can create and customize unlimited email templates with campaigns in 5 main events: order, customer, abandoned cart, wishlist, date. Admin can also completely set up unlimited email series of events, statistic for each email, event, each campaign and collect all campaigns statistics.

In addition, the module supports A/B testing and their statistics. In particular, Mageplaza Follow Up Email extension allows to add coupon code and add product to email.

How to use

Email Abandoned Cart Events

Imgur

Email Customer Events

Imgur

Email Order Create Events

Imgur

Email Wishlist Events

Imgur

How to Configure

1.Configuration

From the Admin Panel, go to Marketing > Follow Up Email > Configuration

Imgur

Imgur

• Enable:
  • Select “Yes” to allow customers to send notification emails.
  • Install Mageplaza_SMTP to avoid email sent to spam box.
• Define Cart As Abandoned If After:
  • Set time to identify Abandoned Cart.
  • Time is in minutes. The default is 1d1h1m.
• Default Sender Name: Allows the admin to set the email sender’s name.
• Default Sender Email Address: Allows admin to enter the notification email adress.
• Sending Copy Email Method:
  • BCC: The list of recipients is included in only one email. However, no recipient can know that the other received the email.
  • Separate: Send separate emails to the recipients.
• Sends Copy Email To:
  • It is possible to fill multiple emails, separated by commas
  • When an email is sent to a customer, it is also sent to the email entered above.
• Clear Email Log: Select “Yes” to auto-delete the information in the Email Log table.
• Clear After:
  • Set the time after that email sent will be deleted
  • It must be in days, if left blank or = 0, the email log will not be automatically deleted
• Clear Email With Status: select email statuses which will be ato-deleted

2. Manage Campaigns

From the Admin Panel, go to Marketing > Follow Up Email > Manage Campaigns

The top of the page shows the statistics table of the total number of emails sent, opened, clicked and calculated as a percentage of opened, clicked compared to the total emails sent.

Imgur

2.1. Add New Campaign

Imgur

• Name: Enter the name of the Campaign
• Status: select “Enable” to run the campaign
• Description: Enter the Description of the Campaign, only displayed in the Backend.
• From Date: Campaign start date.
• To Date: Campaign end date.
• There are also actions such as Duplicate campaign, Edit campaign, Delete campaign, Reset campaign statistic displayed on the created Campaign as well as showing statistics of the total number of emails sent, opened, clicked and calculated the percentage of opened, clicked compared to with the total emails sent for that campaign.

2.2. Add New Event

From the Admin Panel, go to Marketing > Follow Up Email > Manage Campaigns > Add Event

At the beginning of each event shows actions such as Duplicate event, Edit event, Delete event, Reset event statistic displayed on the created event as well as showing statistics of the total number of emails sent, opened, clicked and calculated the percentage of opened, clicked compared to the total email sent for that event.

Imgur

• Name: Enter the name of the Event
• Status: Select “Enable” to activate the event
• Description: Enter the description of the event, the information is only displayed in the backend.
• Event Type: There are 5 main events: Abandoned Cart, Order, Customer, Wish-list, Date

Imgur

• Start Event Order Condition:
  • Abandoned Cart: no more conditions, when the cart is abandoned and the admin runs cron, it will automatically send an email to the customer. Imgur
  • Event Order: Choose additional conditions to apply this event: Imgur
  • Event Customer: Select additional conditions to apply this event: Imgur
    • Show more fields under some conditions in this event:
      • Event Type = Birthday: Show the Start Event Birthday Before field that allows you to enter information Imgur
      • Event Type = No Activity: display the Customer No Activity After field Imgur
  • Wishlist Event: Select additional conditions to apply this event: Imgur
  • Date: Display the Start Event From field, select more conditions to apply this event: Imgur
• Cancel Event: display and select the same information as the Start Event.
• Only Send to Newsletter Subscribers: Choose “Yes” if the admin only wants to send email to customers who subscribe to receive newsletter

Imgur

2.3. Add New Email

2.3.1. General

From the Admin Panel, go to Marketing > Follow Up Email > Manage Campaigns > Add Email, select General

Imgur

• Name: Enter the name of the email

• Status: Select “Enable” to send an email when the customer satisfies the corresponding event

• Send After: Fill in the field, email will be sent after the added time.

• Cart Price Rule:

  • Only show price rule cart whose code is auto generation
  • You can go to Marketing > Cart Price Rule, select Add New Rule to create a new rule.

• Coupon Pattern: A common pattern of generated codes. Admin can change this template according to their wishes. [4A] - 4 alpha, [4N] - 4 numeric, [4AN] - 4 alphanumeric.

• For example: GIFT- [4AN] - [3A] - [5N] => GIFT-J34T-OEC-54354

• Enable Add Product to Email: Select “Yes” to display more related products.

• Add Product Type:

  • Select the types of products you want to add to the email.
  • Admin can add more products by going to Catalog > Products > Edit Product > Related Products, Up-Sells, and Cross-Sells:

  Imgur

2.3.2. Email Details

From the Admin Panel, go to Marketing > Follow Up Email > Manage Campaigns > Add Email, select Email Details

Imgur

• Sender Name:

  • Allows admin to set the name of the sender of notification emails to Customer.
  • Use Config: Use the name entered in the Config section

• Sender Email Address:

  • Allow admin to set the name of the notification email to Customer.
  • Use Config: Use the name entered in the Config section

• Template:

  • Choose email template sent to customer when participating in the event.
  • You can go to Marketing > Email Templates, select Add New Templates to create notification email templates
  • Instructions on how to create a new email template can be found here
  • Select an email template > Click Load displays the fields of Subject, Content, and Customer CSS

• Subject: add simple text to use as the Subject of emails sent with the template you create. This field may contain system variables.

• Content: customize sample content.

  • Click Insert Variable to add a variable to the content. In addition to the basic variable, Follow Up Email has 7 more variables:

    • Customer Name: displays the customer name.
    • Customer Email: displays the email of customer.
    • Coupon Code: displays the coupon code.
    • Unsubscriber URL: Show a link on follow up email so customer can click on it to unsubscribe your email.
    • Restore Cart Url: for Abandoned Cart only, the link redirect to the cart that haven’t been checked out.
    • Quote All Items List: for Abandoned Cart only, list of products in cart haven’t been checked out.
    • Quote All Visible Items List: for Abandoned Cart only, showing a list of related products.

    

  • couponCode fill in the form below:

  Imgur

• Customer CSS: Add CSS to the template if you wish. These types are added inside an <style> tag in the email <head>.

• Email Preview: see email template at backend before using it

• Send Copy Emails To:

  • It is possible to fill multiple emails, separated by commas
  • When an email is sent to a customer, it is also sent to the email entered above.
  • Use Config: use the information entered in the Config section

• Send Test Email To: Test email can be sent to multi-email addresses. Separated by commas (,).

2.3.3. Statistics

Statistics of times, percentage sent, opened number, clicked number of each email.

Imgur

In addition, the email displayed on the Manage Campaigns page has the following actions:

• Edit: Edit the previously saved email.
• Delete: Delete the selected email.
• Duplicate: Add an identical email with the selected email.
• Reset Statistics: reset the count of the selected email.
• A/B Testing:
  • After creating the parent email (original email), child emails can be created by clicking Select> A/B Testing. Admin can edit this child email in the same way as the parent email.
  • When 2 emails are activated simultaneously, 2 emails will be applied alternately when sending to Customer (except for some events that can send both parent and child emails such as: Abandoned Cart, Birthday, No Activity, Date)
  • If one of the 2 email doesn’t work, the other email works normally; If the parent email is deleted, the child email will be automatically deleted.

Imgur

3. Email Logs

From the Admin Panel, go to Marketing > Follow Up Email > Email Logs

Imgur

This is the place to display the list of emails that the customer has been participating with 4 states: on queue, cancel, sent, error.

From Follow up Email Logs, admin can capture basic information of emails such as ID, Name, Status, Event, Campaign, Schedule Time, Send Time, Recipient Email, Error Message, Action.

• Action = Send: resend email
• Action = Back To Queue: send email to standby state
• Action = Cancel: Not send selected emails
• Action = Delete: delete emails
• Action = View: see email details

In addition, admin can filter, change store view, hide/show columns.

Freshsales

Overview

Freshsales is a famous product of Freshdesk, designed to meet all communication management needs of businesses. Free to use program of Freshsales is very useful for small and medium businesses, the useer-friendly design, eye-catching interface is the advantage of the software.

Mageplaza Freshsales extension will help you fully integrate with Freshsales CRM to connect and synchronize many or each data information from Magento (Customer data, Order data) to Freshsales CRM (Accounts, Contacts, Leads, Deals). That will help create a smooth flow to maintain customer relationships and well organize your business. In the process of sending data to the Freshsales, admin can choose to sync manually or automatically the data.

How to use

• To register for a Freshsales account, visit the this link

• After completing the information click Sign up for free. To get an account API, select Settings > API Settings

• Copy API Key to fill out the information in Magento (will be instructed below):

How to Configure

1. Configuration

Login to the Magento Admin, choose Stores > Settings > Configuration > Freshsales

1.1. General Configuration

• Enable: Select “Yes” to enable the module
• Freshsales Domain:

• Freshsales API Key:
  • With the value of this field, copy and paste it into the information of Freshsales.
  • Admin can get API Key to check the connection with Freshsales by saving the configuration once filled in, then click Test Connection button. After that, you will see the success message, you should close the tab to return to the configuration page to continue the configuration for the Freshsales extension.

1.2. Queue Schedule

• Delete Queue Log After:
  • Enter day(s) in the Delete Queue Log After field. The synchronized queue has the status of Success, then after the entered time period will automatically be deleted. For example: If you enter 6 days, the queues have the status of Success, then after 6 days will be automatically deleted.
  • If empty, queue log will no longer be deleted.
• Sync Schedule: Select the time to automatically synchronize data sent to the Freshsales object. The modified Magento object will be sent to the Freshsales object, whereas the unchanged data will not be sent to the Freshsales object anymore.
• Number Of Objects Send Per Time:
  • Enter the number of objects to limit the number of objects each time sending data to the Freshsales object into the Number Of Objects Send Per Time field. Queue which is added first will be given priority to send to the Freshsales object first. The value is allowed to range from 1 to 1000.
  • If empty or zero, schedule is not run.
• Developer Mode: Select the environment to synchronize data. With 2 options:
  • Sandbox: only allow admin to sync data manually.
  • Production: allows admin to synchronize data manually and synchronize automatically.

2. Manage Synchronization Rules

Login to the Magento Admin, choose Stores > Settings > Configuration > Synchronization Rules

2.1. Grid

• Here record Sync Rules information including Name, Magento Object, Freshsales Object, Website, Status, Total Object, Total Pending, Total Request, etc.
• Click Add new button to create new rules. After creating the rules, you can choose edit to edit the rules. Also admin can delete rules, change status (enable/disable), filter, so on.
• Select Add Data to Queue to add data to Queue. Or with the MassAction, the admin can sync one or multiple rules at the same time when clicking Add To Queue.
• Note: When installing Mageplaza Freshsales and creating Synchronization Rules, click Add Data to Queue to bring the previous data into the queue and synchronize the data on the Freshsales CRM.

2.2. Create Sync Rule

• Magento Object: Select the Magento Object to retrieve nd submit it to Freshsales CRM.
• Freshsales Object: Here will display Freshsales Object corresponding to the Magento Object selected. For example: Magento Object is Customer, so the data information submitted corresponding to Freshsales Object can be selected as Accounts, Leads, Contacts. With Magento Object as Order, the data information submitted corresponding to the Freshsales Object can be selected as Deals
• Website: Select Website to get Magento Object for submission to the Freshsales Module. Magento objects from non-selected websites will not be synchronized.
• After selecting the object, click Next to start the Form create/edit Sync Rule

2.2.1. General

• Name:
  • Enter the name that is applied to the Sync rules
  • This is a Required field.
• Status: Select Active to make the rules active and synchronize the data on the Freshsales Object.
• Magento Object, Freshsales Object, Website data are retrieved according to the above object information before creating sync rules and the information is only changed when the admin changes the object information before creating.
• Priority: If several rules meet the condition, the one with the highest priority will be applied. Smaller number means higher priority

2.2.2. Conditions

• Select the condition to filter the data that the admin wants to sync to Freshsales CRM. Those data that meet the conditions will be put into Manage Queue to synchronize data and vice versa.
• Note: Each rule will have different options and conditions.

2.2.3. Mapping Fields

• Here, select the information of the corresponding Magento fields to submit data to the Freshsales CRM.

• Freshsales Fields: Displays fields managed by Freshsales for this object according to the selected Magento Object. Fields of Freshsales Field vary depending on the selected Magento Object such as Customer, Order.
• Magento Fields
  • Enter the fields of the corresponding magento object to push the data corresponding to the fields of the Freshsales object.
  • Leaving this column blank will take the Default Value field value to be applied to the Freshsales object.
• Internal Note: Enter a description in the Internal Note field. This section is only for admin note information with this rule.
• Insert Variables: Select the fields of the Magento object that correspond to the fields of the Freshsales object.

2.2.4. Queue Report

• Here record the Queue information with each rule including the following information: Object, Status, Events, Created On, Updated On. Statistical information with Pending Request, Total Object, Total Request (total number of Queue created).
• Note: With Created On is the time data is entered into the Queue. Updated On is the time when the queue is synchronized to Freshsales CRM.

3. Manage Queue

Login to the Magento Admin, choose Stores > Settings > Configuration > Queue

• This section records information of Queue including Object information, Sync Rule, Magento Object, Freshsales Object, etc.
• Here admin can synchronize all data or select each data included in queue to sync to CRM Freshsales. All data changes such as create, update, delete are included in Queue.
• When clicking on View, will display Popup View Queue to view the full information of each Queue. Select Delete to delete Queue and Resend to Re-synchronize Queue.

4. Customer, Order

4.1. Grid

• Here admin can synchronize data or each data information by event: customer, order such as Account, Lead, Contact, these data will be put into Manage Queue to synchronize data. This feature will help admin perform synchronized data selection according to each customer data, each product, etc. more quickly and conveniently.

4.2. Edit

• With the data available before, admin can Add To Freshsales Queue with As Account, As Lead, As Contact, Order to put data into Manage Queue and synchronize data.
• Will display more Freshsales CRM tab when editing into customer account data, order. This grid shows statistics and displays a list of queues with each data information, including information: Status, Freshsales Object , Event, Created On, Updated On, etc. Also, the admin can filter, search at those columns.

Free Gifts

Overview

Mageplaza Free Gifts Extension helps store owners set up special promotions by offering free gifts when customers purchase the products on their stores. Admins not only can easily set up conditions for free gifts, they also could customize these rules with discount products, customer groups, quantity restrictions, etc. Therefore, customers are interested in shopping in your Magento store.

Download and Install

• Download Free Gifts extension
• Installation guide

How to Use

Free Gift is auto-added if the product customer adds to the cart is qualified for conditions.

Customer can change the desired gift in the Gift list that the admin offer

Customer can add gift to cart right at Product Detail Page

Customers can view the gift information of each product and add gift to their carts right at Category page

When a product with free gift promotion is removed from the cart, their free gifts are removed as well

How to Configure

From the Admin panel, go to Marketing > Free Gifts

1. Configuration

From the Admin panel, go to Marketing > Free Gifts > Configuration

1.1 General Configuration

• Enable: Select Yes to make the extension active
• Prefix Free Gift Item Name: Fill out the prefix for the gift name to let customers easily recognize the free gifts in the list

• Gift List Layout: Set how to show gift list in Frontend. There are 3 ways:
  • List
  • Grid
  • Slider
• Choose Multiple Free Gifts in the Cart: Select Yes to allow customers to add multiple free gifts to their carts.

• No Free Gifts applied to Products with Special Prices: Select Yes to disallow free gifts for special-priced products or on-sale products. This can stop customers from having double discounts. Extra fields can be shown:
  • No Free Gifts applied to the Configurable Products with special-priced Child Products: Select Yes to disallow free gifts for child products of Configurable products that have special prices or discounts.
• Show Notice For Gift:
  • Select Yes so that notice is displayed with the gift. Thereby, customers can easily distinguish gift from other products
  • Notice is displayed in minicart and View Cart Page
• Notice Content: Enter the notice content
• Allow Customers to hide gift notification: On the View Cart Page, there is a general notice for all gifts. Select Yes to allow customer to turn off this notice
• Gift Icon:
  • Uploaded image will be used as Gift Icon and displayed in Frontend
  • Accept image files in jpg, png, gif, svg, etc.
  • If the admin does not upload the icon, there will be no Gift Icon displayed
  • We recommend using a 20x20 px icon
• Reminder about the free gift:
  • Choose Yes to show the notification of free gift selectoni right on category page if the product meets the item rule/cart rule. When clicking on check your available gift, customers will be redirected to cart page
  • If Yes is chosen, show the Notification Message field
• Notification Message:
  • You can change the notification message to select free gifts in this part
  • Replace the {url checkout/cart} with the actual cart to redirect to the cart page

1.2 Button Display

• Show At Cart Page: applies to auto cart rules
  • Click Yes to display the add gift button on the View Cart Page
  • If No is selected, the gift is automatically added following the rule, and the customer cannot change to another Gift
• Show At Cart Item: applies to manual item rules
  • Select Yes to display the add gift button on the View Cart Page, Customer needs to click the button to select the desired Gift
  • If No, the add gift button is not displayed in View Cart Page. Customers can only add gifts from the product detail page
  • In case the gift is not displayed in the Product Detail Page nor in the View Cart Page, which means that the rule not being applied.
• Show Free Gift Information on Category Page: Select Yes to show information of the Free Gift, including the name and short description of the Free Gift of each product on the Category page.
• Show Gifts At Product Page: select Yes so that the gift list shown on the Product Detail pages meets the condition of the rules. Show Gift List As Popup and Open Popup Automatically depends on this field.
• Show Gift List As Popup:
  • Select Yes to have the gift list displayed on the Product Detail page as a popup
  • If you select No, the gift list is displayed as a block
• Open Popup Automatically: Choose Yes to auto display the free gifts popup when item/cart meet the conditions (without clicking on add free gift button). This field depends on the Show Gift List As Popup field.

1.3 Button Design

• Button label:
  • The button label will be displayed in Frontend with the Add Manual mode
  • The content needs to show Customer that the Product they are buying is given additional gifts
• Button Color: Set the background color of the add gift button
• Text Color: Set the font color of the text entered by the admin in the Button label field

2. Manage Rule

2.1 Grid

• All the created rules are shown on this grid
• From the grid, admin can capture the basic information of the rule such as ID, Name, Status, Apply For, State, Website, Customer Group, Priority and Action can be performed with the Rule.
• In the Actions tab, the admin can perform the following actions:
  • Delete: Admin needs to tick the Rule you want to delete, then select Delete in the Actions box (upper left of the Grid) to delete. A confirmation box will appear, click OK to continue
  • Change Status: Admin needs to tick the Rule you want to change the status, then select Change Status > Active/ Inactive in the Actions tab (upper left side of the Grid) to change. A confirmation box will appear, select OK to confirm the change
• In the Action column, admin click on Edit to Rule to edit the information
• In addition, the admin can Filter, Change Store View, Hide/Show the Columns, Export Grid or Edit inline

2.2 Add New/ Edit Form

• There are two main types of rules: Rules that apply to Whole Cart and rules that apply Per Item. Both rules have the same form, except for the Condition tab. The rule that applies to the whole cart will use the condition of the cart, the rule applied to each item will use the condition of the product

2.2.1 General tab

• Name: Enter the name of the rule. This name is only displayed in the backend to distinguish it from other rules
• Status: Select Enable to active the rule
• Description: Enter a simple description of the rule
• Website: Rule is applied only to the selected website
• Customer Group: Choose customer group to apply the rule
• Active From: Choose the date to start applying the rule
• Active To: Select the date to finish the rule
• Priority:
  • For different rules applying to one product, the rule that has the highest priority is applied first
  • 0 is the highest priority

2.2.2 Condition

• Condition for Cart

• Condition for Item (Product)

• Here you select the conditions for the rule. Only apply rules for products that satisfy the selected condition
• You can add or remove conditions by clicking on the + or x sign
• You can change the true/ false of condition by clicking on the bold text

2.2.3 Action

• Action:
  • Type: Choose how to add a Gift to Cart:
    • Automatic: Gift is automatically added from Gift List in order from top to bottom
    • Manually: Customer can add the Free Gifts that they want. The Gift List will be displayed as a popup in the frontend
  • Number of gifts allowed: Limit the number of free gifts that a Customer receives when applying this rule
  • Show notice for Gift: Select Yes to notify customer when they add gift to the cart
  • Notice: The message notice that Customer has successfully added free gift
  • Discard Subsequent Rules:
    • Select Yes to limit the number of gift rules applied to the product or cart.
    • Rules with lower priority than this rule or rules with Priority but created later will not be applied
    • Discard Subsequent Rules are divided into 2 cases applicable to Cart or Item
• For example: There are 6 rules in which: rule 4 has a priority of 10; rule 1.5 is 1; rule 2 is 10; rule 3 is 15; rule 6 is 10. If you choose stop at 4 then:
  • Rule 1.5 with a higher priority should be applied
  • Rule 3 is not applied because the priority is lower
  • Rule 2 is applied because of the same priority but created earlier
  • 6 is not applied because it has the same priority but creates it later
• Gift List:
  • Contains basic information of Gift including: Product ID, Name, SKU, Qty, Original Price, Discount Type, Gift Price, Free shipping and Action
  • Admin click Add Gift to add Free Gift or use Mass Action Delete to delete Free Gift
  • To edit gift price, admin need to click Action Edit. There are 3 types of Discount that admin can choose for Free Gift:
    • Free: Gift is completely free
    • Percent: Gift is sold at X % of the original price (0 <= X <= 100)
    • Fixed: Gift sold for $ X (0 <= X <= Original Price)
• For each Discount type, admin can set the amount of Discount Amount they want
• For each Free Gift, the Admin can allow the Free Ship or not

Popup to add gifts to the gift list

2.2.4 Free Gift Banner

Only apply Free Gift Banner for item rules and display at the Product page.

Upload Banner Image

• Admins can upload one or multiple banners to attract customers
• Position: show banners on different positions on the Product page: Above Content, Below Content, Before Add To Cart Button, After Add To Cart Button

Design Banner

• Banner Image Width (px): Enter the (px) width for banners. Notice that you should choose the suitable px so that the banner quality will not be changed.
• Banner Image Height (px): Enter the (px) height for banners. Notice that you should choose the suitable px so that the banner quality will not be changed
• Show Next/Prev Buttons: Select Yes to show Next/Prev buttons together with the banner to navigate and view the next banners of the slider.

• Show Dots Navigation: Select Yes to show Dots Navigation.

• Auto Play: If select Yes, next banners will automatically displayed.
  • Auto Time-Out: Enter the time to automatically display the next banners (in seconds).

3. API

• Free Gifts extension from Mageplaza support using Rest API to view and check all carts and items in carts of customers and even guest. Also, admin and customers can view Free Gift Items list, add/delete Free Gift Item to/from Cart.
• For more details, please see here

4. Frontend

4.1 View Cart Page

4.2 Product Detail Page

Popup

Block

4.3 Gift Layout

Gift List = List

Gift List = Grid

Gift List = Slider

5. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-free-gifts-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

• Use Magento 2.3.x. Return your site to developer mode
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• Perform a query in the left cell then click the Run button or Ctrl + Enter to see the result in the right cell
• Currently, Mageplaza Free Gifts extension support the following queries and mutations: Gift By Product SKU, get Gifts By Quote Item, Add Gift By ID, Delete Gift By Quote Item ID,etc. View more details here

6. Compatibility with Special Promotions module of Mageplaza

Free Gift extension is well compatible with Special Promotions by Mageplaza. You can configure items in cart that can be discounted, and customers can receive free gifts or not when purchasing those items.

Free Shipping Bar

Overview

Free Shipping Bar is an important and simple strategy for store owners to stimulate customers to purchase more products so that they can get the free ship. With the release of Mageplaza Free Shipping Bar extension, store owners can totally notify the lacking cash amount of customers for getting the free ship or notify them that they have accumulated enough money to get the free ship when purchasing.

Besides that, Mageplaza Free Shipping Bar is highly customizable about the design and position. Store owners can design and put the Free Shipping bar on any position they want. This is an ideal extension for every store to boost sales effectively.

Download & Install

• Mageplaza Free Shipping Bar
• How to install

How to use

• Free Shipping bar will be displayed on the frontend under 3 statuses:
  • When the Cart is empty: Notice the minimum subtotal number so that customers can be delivered free of charge
  • When the Cart has products, but the Subtotal amount has not reached the level that can be free ship: Notice the lacking money amount for customers
  • When the subtotal amount has reached the minimum quantity to ship fee = 0: Congratulations! Customers have got the free shipping
• Free Shipping bar can be shown on some positions as the following:
  • Top of the page
  • Fixed bar on the top page
  • Top of the content
  • Fixed bar bellow bottom page
  • Some other optional positions

How to configure

Login to the Magento Admin, choose Marketing > Free Shipping bar

1. Free Shipping Bar Manage

1.1. Managerial Grid

• This is a place to store all Free Shipping bar created.
• From the Grid, admins can understand all basic information of Free Shipping bar as ID, Name, From Date, To Date, Update Date, Status, and Action.
• In the Action box, admins can perform Action Delete: Admins need to choose the question that they want to delete, then choose Delete in the Action box (the upper left of the Grid) to delete. A confirmation dialog will appear, then choose OK to continue removing.
• In the Action column, admins can perform some actions:
  • Select > Edit: Go to the Edit Free Shipping Bar page to edit the information
  • Select > Delete: Delete Free Shipping Bar
  • Select > Pause: Disable Free Shipping Bar quickly
  • Select > Duplicate: Duplicate Free Shipping Bar
• Also, admins can filter, change Store View, hide/represent the columns or export grid.

1.2. Add New/Edit Form

1.2.1. General

• Name: The name of Free Shipping bar. This name is only displayed in the backend.
• Status: Choose Enable to display the Free Shipping Bar on the backend.
• Priority: At the same position, Free Shipping bar has the higher priority, it will be displayed on the frontend.
• Store View: One website can have many store views. The category will only display selected store views.
• Customer Groups: Select customer groups to apply Free Shipping Bar. Admin can choose multiple customer groups once.
• From Date: Set the start date to use Free Shipping bar
• To Date: Set the finish date to use Free Shipping bar

1.2.2. What to Display

What to Display

• Goal:

  • Enter the minimum subtotal value for free shipping
  • This number should be exactly the number that is installed in the Config
  • To set the minimum value for free shipping, admins can refer to here

• The first message:

  • Enter the first message of Free Shipping bar
  • The content to inform customers is the minimum value of their order required to get the free shipping
  • To enter a round number (example: $100 instead of $100.00), admins can remove the variable {{goal}} and fill in the message directly.

  

• Below-goal message:

  • When customers add at least 1 product to Cart, this message will be displayed
  • This message informs the customer of the amount of money that is lacking to achieve the free shipping

• Achieve-goal message:

  • When the subtotal amount of customers reaches or exceed the goal value, this message will be displayed
  • This message informs customers that their order has been got the free ship.

• Clickable:

  • Select Yes to assign another link to the Free Shipping bar.
  • When the customers click on the Free Shipping bar, the page will be redirected to the page containing the filled link in this item

• Link Url:

  • Fill in the link for the free shipping bar
  • This link is used simultaneously for all 3 messages

• Open a new page: Choose Yes to open a new tab when clicking on the Free Shipping bar

Design Template

• We offer 6 available templates, admins can rely on it to change as they like. All changes (except that the image must be saved) are displayed immediately in the Preview Template
• Bar Background Opacity: Adjust the opacity for Free Shipping bar
• Bar Background Color:
  • Change the color of the Free Shipping bar
  • The color will not be displayed on the frontend if the admins add photos in the Image section
• Bar Text Color:
  • Set the text color of the messages filled in the What to Display section
  • The text color setting here is displayed if clicking Able = No
• Bar Link Color:
  • Set the text color of the messages filled in the What to Display section
  • The font color setting here is displayed if clicking Able = Yes
• Goal text color: Set the text color of the goal that is filled in the What to Display section
• Image: Select a background image for the bar. We suggest using the image size 150x50 px
• Font: Select the font for the messages of the bar
• Font Size: Adjust the font size of messages displayed on the bar

Preview Template

• All changes above (except that the image must be saved) are displayed immediately in the Preview Template section
• Goal and Below Goal sections are updated on the frontend

1.2.3. Where to Display

Where to display

• Position: There are 5 positions that admins can choose:

  • The top of the page: Free Shipping bar is put fixed at the top of the page, it will not slip when customers scroll down the page.
  • Fixed bar at the top of the page: Free Shipping bar is always displayed at the top of the page, it will slip when the customers scroll down the page.
  • The top of the content: Free Shipping bar is fixed at the top of the content on a page
  • Fixed bar at the bottom of the page: Free Shipping bar is fixed at the bottom of the page, it will slip when customers scroll down the page
  • Insert snippet: Free shipping bar is located at the insert snippet

• Allow Show = All Pages:

  • Display Free Shipping bar on all pages To exclude some pages you do not want, admins can set the handle name or its Url in the Exclude page and the Exclude page with the contains URL section.

• Allow Show = Specific Pages:

  • Displayed on pages with handle name and url included in Include option
  • Pages included the Exclude category will not be displayed on Free Shipping bar
  • The priority of Exclude is greater than the Include

• The handle name and the urls that are filled in the Exclude/Include section are distinguished by down the line

• For instance:

  • Handle name:

  

  • URL:

  

Snippet Code

• CMS Page/Static Block: Copy the code and insert it into the pages in the Content > Page section
• Template .phtml file: Copy the code and insert it into the .phtml file of Magento or other extensions that you want to show Free Shipping bar
• Layout file: Copy the code and insert it into .xml file of Magento or other extensions that you want to display Free Shipping bar

2. Configuration

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Free Shipping bar

• Enable: Choose Yes to allow this module to work well.

3. API

Free Shipping Bar extension supports using Rest API to modify the free shipping bar information. Admins can create, adjust, view, delete and manage extension’ information.

View details here

Creating Integration tokens guidlines

4. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-free-shipping-bar-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

To start work with Free Shipping Bar GraphQL in Magento, you need to follow this guide:

• Use Magento 2.3.x. Set the site in developer mode
• Set GraphQL endpoint is http://<magento2-3-server>/graphql in the URL field, click on Set endpoint (E.g. http://develop.mageplaza.com/graphql)
• View details about queris supported here

Frequently Bought Together

Mageplaza Frequently Bought Together extention will display native related products in the product page, and has the Add all items to cart feature that makes it easy for customers to add a list of items to their shopping cart. This extension suggests the right products which might attract buyers in further purchasing, or makes it easy for shoppers to find other products. It also dramatically increases the value of orders, sales, profits for your business.

Download & Install

You can download from the following resouces:

• Mageplaza
• Magento Marketplace
• How to Install

Overview

Here how Frequently Bought Together block appears in your shopping site

How to configure

After logging to Magento Admin, navigate to Stores > Settings > Configuration > Mageplaza Extension > Frequently Bought Together

General configuration

From the Admin Panel, go to Stores > Settings > Configuration > Mageplaza Extension > Frequently Bought Together, choose General Configuration sections

• In the Enable Frequently Bought Together field: choose “Yes” to enable extension. Here some rough sketch how this module works.

  • The Frequently Bought Together list is under the Product image and on the Product Description tab.
  • There will be a horizontal line separating the list from the Product image.
  • Products included in the Frequently purchased together list are from the Related Products in the Backend.

• Method of Choosing Product: Select the products to be displayed in the Frequently Bought Together block. The extension now supports displaying two types of products: Related Product and Frequently Bought Together Product. The configuration of these two types of products is guided below.

• In the Block name field

  • Name the Frequently Bought Together block displaying in Product page.
  • The block’s name will be displayed in default as “Frequently Bought Together”.
  • If you don’t need a name for block, leave it blank.

• In the Number of Products field

  • The number of the product is displayed by the default in the list as Number +1, including the selected products.
  • If leaving this field blank or = 0, it will display all Related Products in the list

• In the Enable Add to Wishlist button field

  • Choose Yes to display Add all items to Wishlist button on the frontend
  • Add to Wishlist button only works when you have logged in an account. If not, it will redirect to the login page

• In the Remove Native Related Products Block field

  • Choose Yes to not display Block Related Products that is the default of Magento
  • When you choose No, Block Related Products of Magento will show under the Product Description Detail field.

• In the Separator Image is the minor plus button among products

  • Valid file should be *jpg, *png and *gif
  • If you like our plus image as default, it’s ok to leave it blank.

• Use Popup to Select Product Options: Select Yes to display popup selecting the option for the product when clicking Add To Cart.

• Display Style: Select the display style of the Frequently Bought Together product block on the product page.

  • Default:

  

  • Slider:

  

• Number of Frequently Bought Together products on the Slider: This field is shown when Display Style = Slider. The default & limit number is 3. If you fill in 0 or leave it empty, 3 products will be automatically displayed on the slider.

How to add Related Products

Related Products refers those products which have a certain link to each other evaluated by buyer’s frequently shopping habit. So we will take The Related Products advantage apply it in the Frequently Bought Together extension. Based on the Related Products, the extension will filter out the products that can be purchased with the product that the customer is selecting, thereby helping customers shop more, increase store revenue.

Follow this instruction to know how to add your custom combination related product, offer visitors better choice.

• Back to the Magento’s Admin page again, choose Products > Inventory > Catalog, choose the product you want add Related Product to it.

• Scroll down until the Related Product, Up-sells, and Cross-sells reaches your eyesight, choose black Add Related Product button.

• In the Add Related Products, tick preferred items you wish to add. When you’ve done, choose red Add Selected Product near the header of the page.

• You will be redirected back to Product page, don’t forget clicking the Save button.

• Finally, check on the frontend. Go the the product detail page on the frontend to check again.

And now you can back to the live site to check the completed result.

How to Add Frequently Bought Together Product

Step 1: Open the Product details page in Admin

• Select Products > Inventory > Catalog > Edit 1 Product

Step 2: Add Related Product

• Under Related Products, Up-Sells, Cross-Sells and Frequently Bought Together on Edit Product page, select Add Frequently Bought Together Products. Note: You must Enable the extension to see the Frequently Bought Together Product section.

• On the Add Frequently Bought Together Products page, tick the Products you want to add

• Select Add Selected Products

• Save the Product changes: Click Save Config

REST API Document

This extension supports retrieving and uploading data to the website using the REST API. Please check this link for more details.

The instruction for creating Integration tokens can be seen from here

GraphQL Document

This extension aslo supports getting and uploading data to the website using GraphQL.

To use GraphQL, first run the following commands in the root Magento 2 directory:

composer require mageplaza/module-frequently-bought-together-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

To start working with Frequently Bought Together GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)

The module currently supports queries to retrieve a list of Frequently Bought Together products under certain conditional fields related to the product.

The details can be seen from here

GDPR

Overview

GDPR principle was created to protect customer data. In a nutshell, GDPR establishes a clear set of rules about which regulations businesses can operate in relation to the process of executing customer data. With these new rules, boundaries are easier to understand for both businesses and consumers, which will facilitate earning money and retain customer loyalty.

In order to capture the EU data protection standards, Mageplaza has released a new extension for this standard. That’s the GDPR module. Magento 2 GDPR module will assist you deleting customer data permanently, to ensure your GDPR regulation compliance.

Note: Update GDPR to the higher version here

How to Configure

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > GDPR

Check in General to learn the basic configuration of the module

• In the Enable field: Choose “Yes” to turn the module on.
• In the Allow Delete Customer Account: Choose “Yes” to allow customers can delete their account by themselves.
• In the Delete message field
  • Enter the message displayed when customers are going to delete their account.
  • Custom message is supported by HTML code.

• In the Allow Delete Default Address field: Choose “Yes” to allow customers can delete their default address.

Must-have extensions for your Magento stores

• Increase website traffic: SEO
• Build leads
• Increase conversion rates: One Step Checkout, Layered Navigation
• We believe that you can sell more: Gift Cards, Auto Related Products, Frequently Bought Together, Free shipping bar, Daily Deal , Product Feed
• Keep customers return: Reward Points
• Let your customer become raving fans
• Optimize your stores: PDF Invoice, Custom Order Number, Stop return items issue

API

Mageplaza’s GDPR extension allows using Rest API to view configuration.

Details can be viewed here.

Instructions for creating Integration tokens here

GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza / module-gdpr-graphql

php bin / magento setup: upgrade

php bin / magento setup: static-content: deploy

To start working with GDPR GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install the Chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• The mutation Mageplaza supports is creating customer requests,etc. Details can be viewed here.

GDPR Professional

Overview

GDPR principle was created to protect customer data. In a nutshell, GDPR establishes a clear set of rules about which regulations businesses can operate in relation to the process of executing customer data. With these new rules, boundaries are easier to understand for both businesses and consumers, which will facilitate earning money and retain customer loyalty.

In order to capture the EU data protection standards, Mageplaza has released a new extension for this standard. That’s the GDPR module. Magento 2 GDPR module will assist you to delete customer data permanently, to ensure your GDPR regulation compliance.

In addition, GDPR pro now supports customers to download their account information which also can be auto deleted after a long time unlogged in. This removal will be notified for customers before the deleting date.

How to Configure

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > GDPR

I. General

Check in General to learn the basic configuration of the module

• In the Enable field: Choose “Yes” to turn the module on.
• Allow Download Customer Information: Choose Yes to allow customers to download their personal data related their account. The supported file is in CSV and Excel XML. There are one extra field shown:
  • Download message:
  • Enter the message shown when customer want to downloaf their personal data. This message will be displayed in Download section. HTML code is allowed.
  • Default message is: “Here you can download a copy of your personal data in CSV or Excel XML file”.

• In the Allow Delete Customer Account: Choose “Yes” to allow customers can delete their account by themselves.
• In the Delete message field
  • Enter the message displayed when customers are going to delete their account.
  • Custom message is supported by HTML code.

• In the Allow Delete Default Address field: Choose “Yes” to allow customers to delete their default address.

• In the Allow password verification field:
  • Choose Yes to use this feature
  • When customers want to remove their account, they need to enter the password correctly to delete the account successfully.

• In the Show Customer Register Term and Condition: Select Yes to show the Term and Condition when customers create a new account.

• In the GDPR Checkbox Title field: Enter the title that is displayed in the checkbox in the Term and Condition section.
• In the Term and Condition field:
  • Allow editing the display content of the GDPR policy or use the default content of Mageplaza
  • Support HTML code
• Auto Delete Customer Account: If you select yes, it will automatically delete the account of the customer when the customer after a long time does not log in. Show more fields:
  • Delete After Last Login For:
    • Enter the time period in the field Delete After Last Login For. After the selected time will automatically delete the customer’s account. Time is calculated from the last time customers log into their account.
    • If you leave it blank or enter 0, it will not automatically delete the customer’s account.

Note: It is recommended to enter a time period in the Delete After Last Login For field greater than or equal to the period in the Notification Email Before Delete Account section. Because sending an email to notify customers that their account is about to be deleted is essential for customers to continue using that account with your site.

II. Anonymise Account Configuration

• In the Allow Delete Abandoned Cart field: Choose “Yes” to delete abandoned cart when customers delete their accounts.

• In the Allow anonymizing account in billing document field:
  • Choose “Yes” to anonymize Billing Address, Shipping Address of the customer after he deletes his account.
  • Anonymized information will be encrypted and displayed as a random character string.
• In the Anonymise Account Firstname Value field:
  • Enter Firstname value that you want to replace it with the customer’s Firstname value.
  • If you leave the field blank, Firstname will be encrypted and displayed as a string of 10 random characters.
  • Firstname value will be displayed in orders, invoices, shipments and credit memos.
• In the Anonymise Account Lastname Value field:
  • Enter Lastname value that you want to replace it with the customer’s Lastname value.
  • If you leave the field blank, Lastname will be encrypted and displayed as a string of 10 random characters.
  • Lastname value will be displayed in orders, invoices, shipments and credit memos.
• In the Anonymise Account Email Value field:
  • Enter Email value that you want to replace it with the customer’s Email value.
  • If you leave the field blank, Email will be encrypted and displayed as a string of 10 random characters.
  • Email value will be displayed in orders, invoices, shipments and credit memos.
• In the Allow Anonymise Address Option In Order Processing field:
  • Choose “Yes” to anonymize information in billing, shipping address.
  • You can choose to hide one or more information from the address optionally.
  • Anonymized information will be encrypted as a random character string.
• In the Allow Anonymise Address Option field:
  • Allow hiding one or more information in the address field.
  • The selected information will be hidden when the customers delete the account.

The information will be hidden in the order when customers remove their account.

III. Cookie Restriction

• In the Enable Cookie Restriction Mode field: Choose “Yes” to restrict the cookie using of Magento 2.
• In the Visitors must accept cookie policy field: Choose “Yes” so that:
  • Customers need to confirm their consent in cookie using policies to be able to sign in, or add the product to their Wishlist.
  • A warning popup box will be displayed if customers don’t accept the policy

• In the Cookie Text Message field:
  • Enter the content of the suggest message to let them consider whether or not to allow cookies using.
  • HTML code is supported.

• In the CMS Cookie Policy Page field: Choose from the list the page you want to put the internal link in Learn more of Cookie Text Message.
• In the Button Label field: Enter the name of the button in Cookie Text Message (default is “Allow Cookies”)
• In the Location To Show Cookie Law field: Choose the pages you want to show Cookie Policy
• In the Apply For field: Choose the country you want to apply Cookie Policy.
• In the Custom CSS field: You can freely customize the cookie displaying.

IV. Email Configuration

• In the Enable Email Confirmation field:
  • Choose Yes to send the email confirmation when customers remove the account.
  • Customers only need to click to the link in their email and login to verify that deleting the account is completed.
• Select an email template used to confirm before deleting the account:
  • Allow choosing the confirmation email template to send to the customers.
  • Ability to design or add a new template by going to Marketing > Email Templates.
• In the Sender Email field: Allow choosing the email sender.

Below is the content of the email:

• Notification Email Before Delete Account
  • Enable: Select yes to send email to customers before thier accounts are auto deleted
  • Send Email Before Delete Account:
    • Enter the number of days before deletting account that notification email will be sent out. Hence, value in this field must be less than or equal to the number of days in Delete After Last Login For.
    • If left blank or 0, notification email will not be sent.
  • Notification Email Template: Choose the email template. You can design new email template by going to Marketing > Email Templates.

V. API

Mageplaza’s GDPR Pro extension allows using Rest API to view configuration, view downloaded account data, check passwords, delete addresses or accounts as requested by customers.

Details can be viewed here.

Instructions for creating Integration tokens here

VI. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza / module-gdpr-pro-graphql

php bin / magento setup: upgrade

php bin / magento setup: static-content: deploy

To start working with GDPR Professional GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install the Chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• The mutation Mageplaza supports is creating customer requests,etc. Details can be viewed here.

GeoIP

Overview

In the market, you want to expand your business in different countries to meet your customer’s shopping demand. With Mageplaza’s new Geo IP extension, you can automatically identify customers’ locations based on their IP addresses, contributing to improving the shopping experience of customers from many different countries.

How to configure

Configuration

From the Admin Panel, go to Stores > Store Switcher > Configuration > Mageplaza Extension > Geo IP Configuration, choose Geo IP Configuration section.

• Enable Geo IP: Choose “Yes” to enable the feature of Geo IP that helps you verify the customers countries.
• Token Please create account and get license key here. Click button Generate new license key
• Fill license key description> Select Yes> Select information below> Click Confirm
• Copy the License key and fill in the Token field of the extension
• Download Library: Click on Download Library button to download the library of Geo IP. Please download library before enabling it.

Gift Wrap

Overview

In order to improve consumption of products, especially during important holidays and customers’ special days, Mageplaza developed Gift Wrap extension. Gift Wrap allows to create/ delete/ edit/ classify attractive gift packages to serve customers. Admins can view and manage order information with gift packages. And of course, customers can freely choose suitable gift packages. In addition, customers can add cards with messages to the recipient. The Gift Wrap plugin is fully compatible with Mageplaza’s One Step Checkout.

How to download and install

• Download Mageplaza Gift Wrap
• How to Install

How to use

• Customers can choose the Gift Wrap and Postcard

• Change Gift Wrap

• Send messages to recipients.

How to Configuration

From the Admin Panel, go to Marketing > Gift Wrap > Configuration

1. Configuration

From the Admin Panel, go to Marketing > Gift Wrap > Configuration, select General

• Enable: Select Yes to turn on the Module.
• Add Gift Wrap Button Label: Choose the label for Gift Wrap button, default label is Add Gift Wrap.
• Change Gift Wrap Button Label: Choose the label for selected gift wrap, the default label is Change Your Gift Wrap.
• Tax Class: Select Tax Class that customers need to pay.

• Gift Wrap Icon:
  • Click Choose file to select the icon displayed infront of Add Gift Wrap label in Frontend.
  • Delete image: Delete the icon chosen.
  • Only accept jpg, png and gif files
  • Provie suggested icon for admin

• Gift Wrap Type:

  • Per Item: applicable to each type of product, displaying an extra field Gift Wrap on Product View Page

    • Gift Wrap on Product View Page: Choose “Yes” to wrap the gift on the Product Detail Page
    • For example: Cart has 3 products, customers can choose each type of Gift Wrap and postcard for each product

    

  • Per Cart: Applies one Gift Wrap type to all products in the shopping cart, displaying the extra field Notice for Customer

    • Notice for Customer: Displays a notification to the customer, default message is All items will be wrapped in one gift box by default
    • For example: Cart has 3 products, customers can only choose one type of Gift Wrap and postcard to apply to all Product in Cart

    

• Both:

  • Apply for each certain Product and for the shopping cart as well .
  • For example: A Cart has 3 products, customer can choose a Gift Wrap/Postcard type, apply for all Product in Cart, or choose separately Gift Wrap/Postcard for each Product
  • Show both fields above (Notice to Customers and Gift Wrap on Product View Page)

• Enable Gift Note: Select Yes to display the message box, display 2 more fields: Max Characters, Gift Message Fee.
• Max Characters: limit the maximum number of characters of the message, the default is 120. (This limitation applies to both Gift Note and Gift Message on the frontend)
• Gift Note Fee: set the message fee, default fee is 0.
• Description: add a description for the Gift Note field, displayed under the Gift Note in the frontend
• Show Gift Note Under Product On: Choose to show gift message under porduct on the following pages:
  • Shopping Cart Page

• Checkout Page

• Mageplaza One Step Checkout

• Show the Mageplaza One Step Checkout option when installing Mageplaza’s One Step Checkout extension. With this module, customers can go through 6 steps of payment in one page, making it convenient for them to process with checkout.
• Show Report Gift Wrappers: Select Yes to allow the report to be displayed in Manage Gift Wrappers
• Button Synchronize Wrap Histories: in case the orders containing Gift wrap were created before the Show Report Gift Wrappers feature was updated, you need to click the Synchronize Wrap Histories button to synchronize the data for the report.

2. Manage Wrap Categories

From the Admin Panel, go to Marketing > Gift Wrap > Manage Category

2.1. Manage Category Grid

• This is where the gift package catalog is displayed.
• From Manage Category, admin can capture basic information of Gift Wrap such as ID, Name, Status, Price Type, Amount, Image, Category, Sort Order, Action.
• Action:
  • Delete: Delete information on Manage Category Page
  • Change Status: Change the status of the selected Categories.
  • Edit: Redirect to the Edit Category page created before.
• In addition, admin can Filter, Change Store View, Hide/Display Columns.

2.2. Create/Edit Category

From the Admin Panel, go to Marketing> Gift Wrap > Manage Category > Create New Category/Edit

• Name: Enter a name for the Category. This is a required field.
• Status: Select Enable to display the Category in Frontend.
• Description: Enter the description of the Category.
• Store View(s): Select a storeview for category shown at frontend. You can select multiple storeviews.
• Customer Group(s): Select the customer group for which the Category will display. You can select multiple customer groups.
• Sort Order: default is 0, the Category with smaller Sort Order will be displayed first at Frontend.

3. Manage Gift Wrappers

From the Admin Panel, go to Marketing > Gift Wrap > Manage Gift Wrappers

3.1. Manage Gift Wrappers Grid

• This is where the gift wrap catalog is displayed
• Report: show Top Gift Wrap with the highest Total Revenue (display up to 30 gift wrap) and Top Postcard with the highest Total Revenue (display up to 30 postcards)
• From Manage Gift Wrappers, admin can capture basic information of Gift Wrap such as ID, Name, Status, Price Type, Amount, Image, Category, Sort Order, Action.
• Action:
  • Delete: Delete information on Manage Gift Wrappers page
  • Change Status: Change the status of the selected Gift Wrap/Postcard.
  • Edit: Redirect to the Edit Gift Wrap/Postcard page created before.
• In addition, admin can Filter, Change Store View, Hide/Display Columns.

3.2. Create/Edit Gift Wrap

From the Admin Panel, go to Marketing> Gift Wrap > Manage Gift Wrap > Create New Gift Wrap

• Name: Enter a name for Gift Wrap. This is a required field.
• Status: Select Enable to display Gift Wrap in Frontend.
• Price: Choose the type of gift price calculation:
  • Fixed: Calculate the price basing on cart total.
  • By Qty: Calculate price by product quantity. For example, the number of products is 2, get the price $ multiplied by 2
• Amount: Enter the gift package price.
• Description: Enter the description shown under Gift Wrap.

• Image: Select the image displayed in Frontend.
• Quantity Limit: limit the number of products that can be wrapped with one type of gift wrap per order.
• Category: Select the gift package category.
• Sort Order: default to 0, Gift Wrap with smaller Sort Order will be displayed first at Frontend.

3.3 Create/Edit Postcard

From the Admin Panel, go to Marketing > Gift Wrap > Manage Gift Wrap > Create New Postcard

• Name: Enter a name for the Postcard, a required field
• Status: Select “Enable” to display Postcard in Frontend.
• Price: Select the type of gift wrapping price:
  • Fixed: Calculate the price according to the whole cart.
  • By Qty: Calculated according to the number of products. For example, the number of products is 2, multiply the price of $ by 2.
• Amount: Enter the package price.
• Description: Enter the description of the Postcard, the description will be displayed below the Postcard

• Image: Select the image to display in the Frontend.
• Category: Select a gift wrapping category.
• Sort Order: default is 0, Postcards with smaller Sort Order numbers will be displayed first at Frontend.

4. Manage Wrapping Orders

From Admin panel, go to Marketing > Gift Wrap > Manage History

• Here is the storage of the Gift Wrap products and messages that customers has ordered.
• Admin can Filter, Change Store View, Hide/Show Columns or download information table in csv and xml file.

5. API

Mageplaza’s Gift Wrap extension supports the use of the Rest API to add Gift Wrap data then allow the creation, classification of gift packages. Also, through the Rest API, Magento stores can view, delete and manage gift wrap order information.

• Details can be viewed here.
• Instructions for creating Integration tokens here.

6. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-gift-wrap-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

With Gift Wrap extension developed by Mageplaza, admins can get Gift Wrap information via GraphQL.

To start working with Gift Wrap GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• View supported request GraphQL here

Google Tag Manager

Overview

How to know the increase in traffic of a website every week? What is the conversion rate of turning visitors to customers this month? Mageplaza Google Tag Manager extension will help online store track and report these data. The module is integrated with Google Analytics, Google Tag Manager, Facebook and Google Adwords to provide statistics about Shopping Behavior, Checkout Behavior, Product Performance that allow you to track website traffic and conversion rates with a few clicks.

How to download and install

• Download Mageplaza Google Tag Manager
• How to Install

Note:

• After installing the extension, you need to download Liquid by running the command composer require liquid/liquid or need to install the library.

How to use

Google Tag Manager:

• To register a Google Tag Manager account, please access the following link here

• Then, fill in the required information to register your account:

• Copy the code below and paste it into each page of your site.

• Get Container ID to install in your Magento store.

Google Analytics:

Visit the following link to register a Google Analytics account

First, click on Sign up to register using the Google Analytics tool

• Select the object you want to track, either Website or Mobile Apps. Then complete your account information in the New Account registration form.
• After completing the information, click on the “Get Tracking ID” button.
• Another dialog will appear:

• Select to agree to the terms of service. And click on the I accept button.
• If the registration is successful, we will see the following interface, and get GA Tracking ID to install in Magento.

Facebook Pixel

• Visit here to get Facebook Pixel ID.
• First, click on the Catalog section in the top left corner of the screen. In the Measure & Report column go to the Events Manager> select Pixels.

• This time, at Datasources, go to Facebook Pixel > Track Website Activities. Click to Get Started to create Facebook Pixel

• You can skip the Website URL field. It is not a required field. Click Create

• Then, you can see a Pixel ID under your Pixel Name. That is the Facebook Pixel ID you need to get.

Google Adwords

• Access to the link ads.google.com to log in with your Gmail account and enter the website to start using Google Adwords.
• First, click on the Start now button in the top right corner of the screen.

• Then select a suitable campain type then click on Continue. Or you can create an account without choosing any campain.

• Confirm your business information and click Submit.

• Next, click on Explore your account to explore your account and get your Google Adwords ID.

• The serial number above your gmail is Google Adwords ID.

How to configure

1. Configuration

Login to the Magento Admin, choose Stores > Configuration > Mageplaza Extensions > Google Tag Manager.

1.1. General

• Enable: Select Yes to enable the module’s feature.
• Deduct Tax From Transaction: Select Yes to deduct tax from Gran Total
• Enable Brand: Selct Yes to turn on the configuration, take the value according to the brand
• Brand Attribute: There are four attributes - Manufacturer, Color, Size, Format. Brand will be set accoding to the selected Attribute

• Enable Variant: Select Yes to show the Variant field

• Deduct Shipping From Transaction: Select Yes to deduct Shipping from transaction
• Ignore Orders with value 0: Select Yes to exclude orders with the value of 0

1.2. Google Tag Manager

• Enable: Selecting Yes to enable the use of the Google Tag Manager feature is to update and control all tags for the site.
• ID Variable Base On: Select the variable of the product ID to be replaced displayed:
  • ID: Display the ID value of the product according to the product ID.
  • SKU: Display the ID value of the product according to the product SKU.
• Google Tag ID:
  • Enter Google Tag Manager’s ID into the Google Tag ID field to update some information of event such as in category page, product page, when adding to cart, remove fromcart, order success, search, checkout default or checkout page of One Step Checkout) extensions which help shorten checkout process to only 6 steps within a page.

• If left blank or incorrectly entered the Container ID will not display tag information.

Note: To turn on Google Tag Manager, you need to create Trigger then Tag and click Preview or Submit in case GTM is disable.

• Google Analytics 4
  • Select Yes to add items of Google Analytics 4 to Google Tag Manager

1.3. Google Analytics eCommerce

• Enable: Select Yes to enable the use of the Google Analytics function for the website to analyze the report.

• ID Variable Base On: Select the variable of the product ID to be replaced displayed:

  • ID: Display the ID value of the product according to the product ID.
  • SKU: Display the ID value of the product according to the product SKU.

• GA Tracking ID:

  • Enter Tracking ID of Google Analytics into GA Tracking ID field.
  • If you leave it blank or enter a wrong tracking ID, it will not be able to track the information.

• Second Tracking ID:

  • Enter another Tracking ID of Google Analytics in the Second Tracking ID field so you can add the ability to track website information such as product, category page, checkout page, page cart, one step checkout page (compatible with One step checkout), remove from cart, …

  

• Enable Enhanced Link Attribution: Selecting Yes to enable allows customers to track each link, know the accuracy of the analytics report in the page by automatically distinguishing between multiple links to the same URL on one The page from which the number of customers clicked on the page or product was calculated. For example, your link to the same page is the same but the path is completely different in the same page. When you go to Gear> Bags folder, but you still click on the view of products like Grid or List, then click on each part in the Bags folder and when you click on the Grid or list are different You should install and turn on Google Analytics Debugger and Page Analytics add to the browser you are using to support the reporting feature to see the number of clicks.

• Enable Linker:

  • If you select Yes, Google Analytics allows you to view sessions from two related websites (such as separate e-commerce and shopping cart websites) as a session. Show more Linker Domain(s) fields.
    • Linker Domain(s): Enter an additional domain link to count customer tracking from two related websites. You can import multiple domain links at the same time and be separated by a “,”. You can configure additional domain links for your site when you go to Store > Configuration > Web. For example, the current link domain of your site is http://example.com. You configure another domain link when changing store view with the same content as http://mageplaza.com. So the tracking number of customers will be counted as 1 session. You can access to Audience > Overview of Google Analytics to view the exact number of sessions by day.

  

• Enable Display Ads (Remarketing): Select Yes to enable Google Analytics advertising features (including Remarketing Lists for Search Ads) that can be enabled in Google Analytics from Property Settings > Data Collection.

• Enable IP Anonymization: Select Yes to allow anonymous IP addresses of visits (http requests) sent to Google Analytics. And will be sent to the region. You can view it at Google Analytics, go to Real-Time > Overview or Locations.

Note: To see the amount of Link Attribution, Linker or some features of Google Analytics, you need to wait some time for Google Analytics to update data. You should install and enable Google Analytics Debugger and Page Analytics add to the browser you are using to support adding reporting features to see the number of clicks.

• Enable Google Analytics Opt Out: Select Yes so that when customers enter your website, if they do not follow and accept cookies, the data will not be synced to Google Analytics, and if they do, the data will be synced to Google Analytics. This can help customers protect their information and reduce some unecessary data. This feature is compatible with Mageplaza GDPR Professional.

• Custom Dimensions:

  • First, you should go to Admin > Custom Dimensions > Add New Customer Dimensions or Dimensions available in Google Analytics.

  

  • Then go to Custom Dimensions field, click Add button and select values of Name, Track Custom Attribute, Index so that when you create New Customer Report in Google Analytics, you can collect and analyze selected store attributes that are not automatically tracked by Google Analytics.

  

• Custom Metrics:

  • Enter Admin > Custom Dimensions > Add New Customer Metrics or Metrics available in Google Analytics.

  

  • Then go to Custom Metrics field, click Add button and select values of Name, Track Custom Attribute, Index so that when you create New Customer Report in Google Analytics, you can collect and analyze selected store attributes that are not automatically tracked by Google Analytics.

  

  Note: To create New Custom Report in Google Analytics, Dimensions and metrics are 2 custom attributes that always go along with each other and needs creating and customizing.

1.4. Facebook Pixel

• Enable: Select Yes to enable the use of Facebook Pixel features.

• ID Variable Base On: Select the variable of the product ID to be replaced displayed:

  • ID: Display the ID value of the product according to the product ID.
  • SKU: Display the ID value of the product according to the product SKU.

• Facebook Pixel ID:

  • Enter Facebook Pixel ID in the Facebook Pixel ID field to report and update website information such as in product page, category, checkout page, cart page, one step checkout page (compatible with Mageplaza One Step Checkout), remove from cart,…You should installl Facebook pixel helper into your browse to view information.

  

  • If left blank or incorrectly filled in, the Pixel ID will not report and update the website’s information to Facebook.

• Enable Advanced Matching: Select Yes to add Tracking Add to Wishlist and Advanced Matching Parameters for Facebook Pixel.

1.5. Google Adwords Conversion Tracking

• Guide: Click to the link to configure the conversion tracking function in Google Adwords in Magento 2.

1.6. Create Tags, Triggers, Variables

• Enter essential information to Export JSON File for Tags, Triggers, Variables such as: Measurement ID of Google Analytics 4, Conversion ID and Conversion Label of Google Ads Conversion Tracking and Google Ads Conversion Remarketing.
• Click Export JSON File for Tags, Triggers, Variables button to Export JSON File. After that, you can upload that file to Google Tag Manager to create and import Tags, Triggers, Variables.

You can upload file here:

2. API

Google Tag Manager extension by Mageplaza supports using the REST API to get data with events such as product, category, homepage, catalog search, checkout index, checkout cart, checkout success, one step checkout, multi shipping checkout success, thank you page, add to cart, remove cart, and get head of Google Tag Manager, Google Analytics, Facebook Pixel.

Please see details here.

Guide on how to create Integration tokens can be viewed here.

3. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-google-tag-manager

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

Google Tag Manager extension by Mageplaza supports getting data with events such as product, category, homepage, catalog search, checkout index, checkout cart, checkout success, one step checkout, multi shipping checkout success, thank you page, add to cart, remove cart, and get head of Google Tag Manager, Google Analytics, Facebook Pixel via GraphQL.

To start working with Google Tag Manager GraphQL in Magento, you need to:

• Use Magento 2.3.x or 2.4.x. Return your site to the developer mode
• See GraphQL requests we support here.

Google Recaptcha

Overview

According to the search from Economictimes, today’s Artificial Intelligence (AI) technology can solve almost variant of distorted text at 99.8% accuracy. Distorted text, therefore, is no longer a dependable tool to test. To prevent human effort from accessing your online store, Magento 2 Google Recaptcha extension has been released by Mageplaza experts.

Google Recaptcha extension is the best solution to protect your e-commerce store from spams and frauds. Also, it is also a useful tool that helps online stores avoid the requirements of the bots. Thanks to this module, interestingly, valid users can be accepted easily.

Besides, Mageplaza Google Recaptcha extension is fully compatible with Mageplaza Age Verification, Better Product Reviews, One Step Checkout.

Installation

• Download the Google reCaptcha extension
• How to install

How to Configure

Configuration

General Configuration

• Enable: Choose Yes to enable this module
• Language Code: Choose the language displaying the reCAPTCHA on the frontend and in the backend
• Invisible

Note: Apply for the frontend

• Google API Key: Enter the Key Invisible reCAPTCHA
• Google API Secret Key: Enter the Secret Key
• How to create reCAPTCHA: Can be found here
• Visible

Note: Apply for the backend and frontend

• Google API Key: Enter the Key Visible reCAPTCHA
• Google API Secret Key: Enter the Secret Key
• How to create reCAPTCHA: Can be found here

Backend Configuration

• Enable: Choose Yes to enable reCAPTCHA when accessing the admin panel
• Forms: Choose a place displaying the reCAPTCHA. Store owners can allow reCAPTCHA to display in 2 forms:
  • Forms = Admin Login: reCAPTCHA will display in the Admin Login Form when store owners log into the admin page
  • Forms = Admin Forgot Password: reCAPTCHA will display in the Admin Forgot Password Form when store owners access on the Admin Forgot Password page
• Size: Choose the size to show the reCAPTCHA

• Size = Compact: reCAPTCHA will display as the following image:

• Size = Normal: reCAPTCHA will display as the following:

• Theme

• Theme = Light: reCAPTCHA will display the light color
• Theme = Dark: reCAPTCHA will display the dark color

Frontend Configuration

• Enable: Select Yes to display reCAPTCHA on the frontend
• Recaptcha Type: Show Recaptcha at Frontend with 2 types:
  • Visible: Show Visible Recaptcha at Frontend
  • Invisible: Show Invisible raCapcha at Frontend
• Forms: Choose a place displaying reCAPTCHA on the frontend. Store owners can allow reCAPTCHA to display in all forms.
  • Forms = Login: reCAPTCHA will show in the Login Form when visitors login to the website
  • Forms = Create User: reCAPTCHA will show in the Create User Forms when visitors create an account
  • Forms = Forgot Password: reCAPTCHA will show in the Forgot Password Form when customers access the website to get their password
  • Forms = Contact Us: reCAPTCHA will display in the Contact Us Form
  • Forms = Change Password: reCAPTCHA will show in the Change Password Form
  • Forms = Product ReView: reCAPTCHA will display when visitors access the product page to review
• Google Recaptcha is totally compatible with Better Product Reviews extension which supports customers to leave reviews to your product pages easily and accurately. Recaptcha will be shown when you click to Write a review button.

• Age Verification: Only show this feature configuration when installing Mageplaza Age Verification extension which supports your store to show reCaptcha at age verification popup.
• Badge Position: Show this field when choosing Invisible reCaptcha

• Badge Position = Inline: Recaptcha will display in the selected form on the frontend
• Badge Position = Bottom Right: Recaptcha will display at the bottom right of the page
• Badge Position = Bottom Left: Recaptcha will display at the bottom left of the page
• Size: Show this field when choosing Visible reCaptcha
  • Normal: Show reCaptcha at Frontend as in the following image:
  • Compact: Recaptcha is shown at Frontend like this:
• Theme

• Theme = Light: reCAPTCHA will display the light color
• Theme = Dark: reCAPTCHA will display the dark color
• Custom Form Position: Use this feature to add reCAPTCHA into any form on your store

• Form Post Paths

  • Enter the path (url) where will process your form information

  For example: newsletter/subscriber/new/, display reCAPTCHA in the email address field on the website.

Below are some detailed steps:

• Step 1: Login to your website
• Step 2: Choose Form that you want to display reCAPTCHA and open the Test window
• Step 3: After that, choose Element tab, then choose the form that contains the field you want to add reCAPTCHA

• Step 4: In the Subscriber Form in the Action field, copy the URL path. (In this example, the URL is “newsletter/subscriber/new/”)

• Step 5: Paste the URL into the Form Post Paths field

  • The paths are separated by down stream.
  • If you this field is empty and you fill in the information in the CSS Selectors field, reCAPTCHA still displays on the form that you fill in the information CSS Selectors, but it doesn’t still work on that form.

  

• CSS Selectors

  • You need to take CSS Selector of the form. At our example, we will take ID of the form.

  For example: #newsletter-validate-detail, display reCAPTCHA in the Subscriber

  

  • The IDs are separated by down stream.
  • If you leave this field blank while filling in the information in Form Post Paths field, reCAPTCHA won’t display on the form you want.

Note:

• In the Custom Form Position field, if you want to show reCAPTCHA on the form you want, you have to fill in all information of 2 fields: Form Post Paths and CSS Selectors.
• Using the invisible CAPTCHA system outside the frontend, most users won’t see CAPTCHAs at all, not even the “I’m not a robot” checkbox. If you are flagged as “suspicious” by the system, then it will display the usual challenges. Hence, If you want to check it you can try to click the Create an Account button many times.
• Need to download the library of Google Recaptcha so that when you run this extension, there's no error occur
• When you cannot access to the admin panel while reCAPTCHA enables, you can use the following command to disable the module via composer as well as can access the admin page as usual.

php bin/magento module:disable Mageplaza_Recaptcha

Or you also disable the configuration by the command below:

php bin/magento mageplaza:core:disable Mageplaza_Recaptcha

Refer the guide to download the library

• Create the folder: lib/internal/Mageplaza
• Go to the path to download the library of Google Recaptcha here
• Extract magento-2-google-recaptcha-library.zip into lib/internal/Mageplaza, then change the name of the file that you have just extracted, Recaptcha

• Run the following command to install: php bin/magento setup:upgrade

The display of reCAPTCHA on the frontend

The display of reCAPTCHA in the backend

Command line

Run the following command to enable or disable google recaptcha display in the backend:

php bin/magento mpgooglerecaptcha:backend:enable

php bin/magento mpgooglerecaptcha:backend:disable

Google Analytics

User Guide Magento 2

How to know the increasing of traffic to a website in this week? How much is the conversion rate of visitors into customers in this month? Google Analytics is the great support tool to answer those question clearly with logical information and since then, you can evaluate the development potential of your business effectively.

Before using Google Analytics in Magento, it is necessary to get tracking ID by creating a new account from Google Analytics Homepage.

Set up in Google

• Access to http://www.google.com/analytics/

• Fill out required account information

Click on Get Tracking ID button below to complete your registration.

• Get Tracking ID and write it down into Magento Configuration

Set up in Magento

After installing Google Analytics, login to Admin Panel > Google Analytics > Sales > Google API

• Choose Yes in Enable field to use Google Analytics functionality for your store.
• Insert the tracking ID number you get from the above into Main Tracking ID field.

Especially, the second tracking ID is available for more convenience. If you do not need it, let leave empty.

Configure Google Analytics’ functionalities

Go to Admin Panel > Google Analytics > Settings

Select Yes for each functionality if you want to apply them for your analytics.

User Guide Magento 2

How to know the increasing of traffic to a website in this week? How much is the conversion rate of visitors into customers in this month? Google Analytics is the great support tool to answer those question clearly with logical information and since then, you can evaluate the development potential of your business effectively.

Before using Google Analytics in Magento, it is necessary to get tracking ID by creating a new account from Google Analytics Homepage.

Set up in Google

• Access to http://www.google.com/analytics/

• Fill out required account information

Click on Get Tracking ID button below to complete your registration.

• Get Tracking ID and write it down into Magento Configuration

Set up in Magento

After installing Google Analytics, login to Admin Panel > Google Analytics > Sales > Google API

• Choose Yes in Enable field to use Google Analytics functionality for your store.
• Insert the tracking ID number you get from the above into Main Tracking ID field.

Especially, the second tracking ID is available for more convenience. If you do not need it, let leave empty.

Configure Google Analytics’ functionalities

Go to Admin Panel > Google Analytics > Settings

Select Yes for each functionality if you want to apply them for your analytics.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Google Maps

Overview

Magento’s Contact Us page is too simple, it displays the text only. With the release of Mageplaza Google Maps, it allows adding Google Maps with an ease that is displayed on the contact us page. This also helps your online stores improve the trust of customers, especial when they know your location exactly.

How to configure

I. Configuration

Login to the Magento Admin, choose Store > Settings > Configuration > Mageplaza Extensions > Google Maps

1. General

• Enable: Choose Yes to enable this feature
• Insert on Contact Pgae: Choose yes to insert Google Maps on Contact Page and show the Position field
• Position: There’re 2 positions to display Google Maps on Contact Page, including Top and Bottom

2. Map Settings

It supports 2 modes to set the maps as the following:

Protocol = API

• Google API Key: Enter Google API Key. You can get the Google API Key here
• Map Type: There’re 4 types to display maps on the frontend: Roadmap, Terrain, Satellite, and Hybrid.
• Map Style: This is a map style to display on the frontend. There’re 10 popular map styles as below:

• Allow Map Dragging: Choose Yes to allow dragging and dropping on the maps
• Zoom Default: The default zoom of the map when loading maps
• Marker Icon: Marker icon on the maps. You should the icon that has the size as 20x20 px.
• Location Settings: Map Setting > Location Settings

• Address: Enter the address shown on the map.
  • Click Get GPS coordinates button to load Latitude and Longitude.
• Latitude: Enter the latitude of the address
• Longitude: Enter the longitude of the address

Protocol = Embed Code:

This way, just embed the google iframe code to insert the map on the frontend without the map setting below

• Code: Embed google iframe code.

II. Widget

By adding a widget, you can insert the map anywhere on your store.

How to create a widget

• Step 1: Login to Magento Admin, select Content> Elements> Widgets
• Step 2: Click the Add Widget button to start the widget installation

• Choose Type = Mageplaza Google Maps, Design Theme = Magento Luma, then click on Continue
• Step 3: Fill in the information in the Storefrontend Properties section

• Step 4: Choose the position to show the widget

From Layout Updates > Click on Add Layout Updates:

• Step 5: Save > System > Cache Management > Flush Magento Cache

Frontend

Use API

Use Embed Code

Image Optimizer

Overview

Do you want your website’ s images to have the best quality with optimal size and still ensure the high loading speed? With Image Optimizer extension of Mageplaza, it is definitely possible. The module supports online stores to manually or auto optimize images after a certain time. Also, it can backup the original image, optimize the size and image quality by folder. And in particular, you can optimize images through the server and use commands to optimize each image or all photos quickly and conveniently.

Mageplaza Image Optimizer extension is fully compatible with Mageplaza Cron Schedule to support automatic scan, backup original photos and optimize images in the most convenient and fast way.

How to download and install

• Download Mageplaza Image Optimizer
• How to Install

How to Configure

1. Configuration

Login to the Admin Magento, choose Stores > Image Optimizer > Configuration

1.1. General

• Enable: Select Yes to use the module features. Support image types: JPG, PNG, GIF, TIF, BMP.
• Backup Image: If Yes is selected, the original image will be backed up at var/ backup_image directory before being optimized.

1.2. Optimize Options

• Image Quality: select the image optimization level, including 2 types:
  • Custom: a filter which help to remove some data. Noted that this will reduce the image quality so you should be careful with the level of image quality reduction as the image can be blurry and unclear. Choosing Custom will show more fields:
    • Quality Percent: Enter the percent in the Quality percent field which will be limited between 1 and 100. For good image quality, please maintain quality above 90. If left blank, default value is 92.
• Lossless: is a data compression filter. This does not reduce image quality but it will require uncompressed images before they can be rendered.
• Create Webp Image File When Optimizing: if you select Yes, when being optimized, image files will be transfered to Webp format. It helps reduce the image size for your server without decreasing the image quality. Field shown:
  • Replace With Webp Image Format: if you select Yes, the system will automatically replace olf file format with new ones (Webp file) on the frontned

• Skip Transparent Images: If yes is selected, the white image or transparent image will be skipped during the optimization process. If you want to optimzie these transparent photos, you must Restore and Requeue them. The second way is just choosing “No” in this field, all the transparent images will be optimized too.
• Force File Permission:
  • If No is selected, there is no change on the image permission.
  • Select Yes to provide permission for optimized images. Choose Yes will show more fields:
    • Select Permission:
      • Enter the number presenting the permission in the Select Permission field to choose the permission types for optimized images. You can refer more information here. Example: 0755, …
  • This is a required field.

1.3. Scan Directory

• Included Directories:
  • Click Add button to enter the path into the path field. The entered paths will be scanned with images in that path. For example: pub/media/catalog/product, pub/media/customer.
  • If left blank, the system will scan the default directory of pub/media/. Click Remove to delete the entered path.
• Excluded Directories:
  • Select Add button to enter the path where you don’t want to scan the image in that folder. For example: pub/media/mageplaza, pub/ media/logo.
  • If left blank, there is no limit to scan images with paths. Click Remove to delete the path if you still want to optimize the path.
• Note: If the path is in both Excluded Directories and Included Directories, then the scan with that path will not apply.

1.4. Cron job

• Enable Image Scan: Select yes to automatically scan images after a certain period of time and display additional fields:
  • Scan Schedule: Enter the time in the Scan Schedule field, after the selected time will automatically scan the image. You can refer to this link. For example:
    • Enter ***** is every 1 minute automatically scan the image.
    • 20 * / 3 * * * is running every 3 hours on 20 minutes will scan the image.
    • Run Daily: is 00 ***. It will be run at 00:00 daily
    • Run Weekly: 00 ** 7 will be run at 00:00 Sunday, 00 ** 1 will be run at 00:00 Monday
    • Run Month: 001 ** will be run at 00:00 on 01/01/2019. Note: When entering values, between two values linked by spaces, start running scans. For example: * * * * *
• Enable Optimization: Select yes to automatically optimize with scanned images after a certain time and display additional fields:
  • Optimization Schedule: Enter the time in Optimization Schedule field, after the selected time will automatically optimize the scanned images. Unscanned images will not be optimized. The time period entered in Optimization Schedule field is the same as the Scan Schedule field, you can refer to above.
  • Limit Number of Images: Enter the number of photos that each time you want to automatically optimize after the selected time period.

2. Manage Images

• Login to the Admin Magento, choose Stores > Image Optimizer > Manage Images
• Here recorded and statistics scanned image information and Optimize or not include information of the fields: Path, Status, Original Size, Optimized Size, Compression Level (%), Error Message , ….

• Click Scan Images button to start scaning all images. Only optimize the scanned images.
• Choose Optimize Images button to optimize with the scanned images.
• With Optimize Action, you can choose optimize with each image or all scanned images without optimizing, the optimized images will not be optimized anymore.
• If Restore, the image returns to skipped status and will ignore the optimize image. - Re-Queue: the image returns to the pending state.
• Delete: Delete images that you don’t want to optimize.
• Progress: recounting the status of the photo with Pending, Error, Skipped, Success.
• Display popup when clicking Mass Action Optimized or button Optimize Image. When Optimize is clicked, the Progress bar displays 0%, and displays the first image. Click Stop if you want to stop the pptimize process.

• Display the popup when clicking Stop with message Are you sure you want to stop optimizing images?

3. Command line

It is possible to run the following command to optimize images quickly, conveniently and the number of images after each optimize will be based on the value of the Limit Number of Images field in the Configuration section:

php bin/magento mpimageoptimizer:optimize

Also, please run the following command to scan images following the confiruration at the field Scan Directory:

php bin/magento mpimageoptimizer:scan

Magento 2 Import Export Categories

Overview Import/Export Categories

Currently, stores use e-commerce sites more and more, thus shop owners must cooperate with suppliers to add categories pages to their stores. With Mageplaza Import Export Categories extension, customers can perform import and export of their categories. By this, admins can easily manage products by categories, update new categories quickly hence help them lessen time and increase the efficiency of product data management.

How to download and install Magento 2 Import Export Categories

• Download Magento 2 Import Export Categories
• How to Install

How to Configure Magento 2 Import Export Categories

1. Import Categories

Step 1: Prepare data

Login to the Magento Admin, choose System> Import

Magento 2 Import Categories

• In the Import Settings section, select Entity Type = Mageplaza Categories Import and click Download Sample File to download the file. We support the imported file type as CSV.
• Make sure that the input file size isn’t more than 5M.

Magento 2 Import Categories

• Edit the information you want to import in the template file

Magento 2 Import Categories

Step 2: Configure Import Behavior

Configure Import Behavior

• In the Import Behavior section,
  • Select the action you want when importing data:
    • Add/Update
    • Replace
    • Delete
  • The data stream is compared and executed based on the identify action of each categories imported
  • With the option Stop on Error means to stop importing when you get an error or Skip Error Entries is to ignore the error and continue importing.
• Next, in the Allowed Errors Count field, enter the error number to pause the import process. The default value is 10.
• Field separator:
  • Field separator: Enter a marker to separate the fields in the column. Default value is a comma (,)
  • Multiple value separator: Enter the mark to separate multiple values in the cell of 1 column. Default value is a comma (,)
    • Note: In a CSV file, a comma is the default delimiter. To use a different character, make sure that the data in the CSV file matches the character you choose.
  • Fields enclosure: Click the checkbox to enclose the value in the column. The default value is apostrophe (”)
• Note: If you want Replace or Delete, please enter the correct category_id of the category to be able to perform your action.

Step 3: Select File to Import

Select File to Import

• In the Select File to Import section, click Choose File to select the imported categories file.
• Note: If Entity File = Mageplaza Categories Import then your entity file must be matched with the fields in that file. The file format is CSV.
• If the imported files contains a path to the product image, in case the Images File Directory is empty, include your image in the directory with the path: pub/media/import/wysiwyg (if not available, you need to create this folder)

Select File to Import

Step 4: Check data and finish data entry

• After entering the above information, click Check Data at the top right to check if the data you entered is correct.
  • If the file is valid, click Import in the Validation Results section.

Check data and finish data entry

• Otherwise, if the upload file is invalid or your process is wrong, correct the error reported in the message and try again.
• Examples of displaying error messages when entering data incorrectly:

Check data and finish data entry

When the import process is complete, the system displays your successful message.

Check data and finish data entry

2. Export Categories

Login to the Magento Admin, choose System > Export

Magento 2 Export Categories

Step 1: Prepare to export product data

• In the Export Settings section, select Entity Type = Mageplaza Categories Export to start exporting your categories.
• Set the file format when exporting at Export File Format, select CSV.
• Fields enclosure: Click the checkbox to enclose the value in the column. The default value is apostrophe (”)

Prepare to export product data

Step 2: Configure export data

• After completing step 1, the Entity Attributes section will appear, listing all the properties available in alphabetical order.

• To search for categories categories by category or category codes, enter the label/code in the Attribute Label/Attribute Code then click the Search button.

  • To export only records with specific attribute values, enter the value in the Filter column.
  • To not export properties, click the checkbox in the Exclude column.

  Configure export data

Step 3: Export your data and open the CSV file to view

• After completing Entity Attributes, please scroll down and click Continue on the lower left corner of the page to perform the file export action.
• When prompted, click Save to save the exported file.
• Open the CSV file to view or edit the imported data.

Export your data and open the CSV file

Note: In case you want to get the Export file to import, pay attention to the following cases:

• Incase you need to change some of the export fields before you want to perform Import such as store_id, parent, is_active, include_in_menu
  • Store_id: In the Export file, the value of the fields is admin when you import it to “0”.
  • Parent: Notice that the value parent cannot be the same as the value of category_id.
  • Is_active: In the Export file, the value of the fields is Yes/No when you import it to change to 1/0.
  • Include_in_menu: In the Export file, the value of the fields is Yes/No when you import it into 1/0.
• If you have done Import and still have the following error, follow these steps.

Magento 2 Import Export Categories

In the Export file, drag to the right to find and delete the column “attribute_set_id”, “parent_id”, “path”, “product_count”

• Notice of successful import:

Magento 2 Import/Export Categories

Import Export CMS

Overview

Currently, business doers use e-commerce sites more and more. Therefore, shop owners must cooperate with suppliers to add products to their stores. With Mageplaza Import Export CMS extension, customers can transfer CMS data from this Magento 2 site to another Magento 2 site using the Import/Export function.

How to download and install

• Download Mageplaza Import Export CMS
• How to Install

How to Configure

I. Configuration

Login to the Magento Admin, choose Store> Configuration> Mageplaza> Import Export CMS

1. General

• Enable: Select “Yes” to turn on the Module
• Export cms page Fields: Admin selects the required field when exporting CMS pages. Fields that are not selected when exporting the file will not display the field and its data in the CMS page.

• Export cms block Fields: Admin selects the required fields when exporting CMS blocks. Fields that are not selected when exporting the file will not display the field and that field data in the CMS block.

II. Pages

1. Export

Login to the Magento Admin, choose Content> Pages> Export. This section records the information of the created pages.

• Select the page you want to export the file
• Select the file format you want to export (CSV or Excel XML)
• Click Export to make the output file you want. If left blank, no page selection will execute the entire page and the exported information will be completely based on the fields you have chosen to export the file to the page in the Export cms page Fields field at Configuration above.
• The contents of the exported file are based on the selected fields in the Configuration section.
• Click Cancel to cancel the file export

2. Import

Step 1: Prepare data

Login to the Magento Admin, choose Content> Pages> Import.

• In the Import CMS Page section, select File Type and click Download Sample File that you want to download.
  • Select file type:
    • We support 2 file types that admin can use to import which are CSV and XML
    • For each file type, the admin needs to download and edit the sample file so that it can be imported correctly.
• Check that the input file size does not exceed the limit shown in the message which is 5M.

• Edit the information you want to import in the template file

If the input data includes the path to the product image, the image files must be uploaded to the appropriate location. Read more at Step 3

Step 2: Configure Import Behavior

• In the Import Behavior section,
  • Select the action you want when importing data in the Import Behavior field:
    • Add/ Update
    • Replace
    • Delete
  • The data stream is compared and executed based on the identity of each page imported
  • With the option Stop on Error or Skip Error to stop importing when you get an error or ignore the error to continue importing
• Next, in the Allowed Errors Count field, enter the error number to pause the import process. The default value is 10.
• In the field separator field:
  • Field separator: Enter a marker to separate the field in the column. Default value is a comma (,)
  • Multiple value separator: Enter the mark to separate multiple values in the cell of 1 column. Default value is a comma (,)
    • Note: In a CSV file, a comma is the default delimiter. To use a different character, make sure that the data in the CSV file matches the character you specify.
  • Fields enclosure: Enter a mark to enclose the value in the column. The default value is apostrophe (”)
• If you select “File Type = XML” then the “Field separator”, “Multiple value separator” fields, “Fields enclosure” will be hidden.

Step 3: Select File to Import

• In the Select File to Import section, click “Choose File” to select your page input file.
  • Note: If you select File Type = CSV (or XML), your input file must be a CSV (or XML) file correctly.
• If the input contains a path to the product image, in the Images File Directory field, please enter the path to the image uploaded to the server. For example: var/ export, var/ import, …
  • Note: Create an image folder in the pub/media directory to save all images in the import file, and then copy the path to Images File Directory.

Step 4: Check data and finish data entry

• After entering the above information, click “Check Data” at the top right of the popup to check if the data you entered is correct.
  • If the file is valid, click “Import” is displayed in the Validation Results section.

• Otherwise, if the upload file is invalid, please correct the error reported in the message and try again.
• Example of error message:

• When the import process is complete, the system turn off the popup and displays your action message in addition to the grid.
• Example of displaying message success on grid.

III. Blocks

1. Export

Login to the Magento Admin, choose Content> Blocks> Export. This section records the information of the created blocks.

• Select the block you want to export the file
• Select the file format you want to export (CSV or Excel XML)
• Click Export to make the output file you want. If left blank, no block selection will execute the entire block and the exported information will be completely based on the fields you have chosen to export the file to the block in the Export cms block Fields field at Configuration above.
• The contents of the exported file are based on the selected fields in the Configuration section.
• Click Cancel to cancel the file export

2. Import

Step 1: Prepare data

Login to the Magento Admin, choose Content> Blocks> Import.

• In the Import CMS Block section, select File Type and click Download Sample File that you want to download.
  • Select file type:
    • We support 2 file types that admin can use to import which are CSV and XML
    • For each file type, the admin needs to download and edit the sample file so that it can be imported correctly.
• Check that the input file size does not exceed the limit shown in the message which is 5M.

• Edit the information you want to import in the template file

If the input data includes the path to the product image, the image files must be uploaded to the appropriate location. Read more at Step 3

Step 2: Configure Import Behavior

• In the Import Behavior section,
  • Select the action you want when importing data in the Import Behavior field:
    • Add/ Update
    • Replace
    • Delete
  • The data stream is compared and executed based on the identity of each block imported
  • With the option Stop on Error or Skip Error to stop importing when you get an error or ignore the error to continue importing
• Next, in the Allowed Errors Count field, enter the error number to pause the import process. The default value is 10.
• In the field separator field:
  • Field separator: Enter a marker to separate the field in the column. Default value is a comma (,)
  • Multiple value separator: Enter the mark to separate multiple values in the cell of 1 column. Default value is a comma (,)
    • Note: In a CSV file, a comma is the default delimiter. To use a different character, make sure that the data in the CSV file matches the character you specify.
  • Fields enclosure: Enter a mark to enclose the value in the column. The default value is apostrophe (”)
• If you select “File Type = XML” then the “Field separator”, “Multiple value separator” fields, “Fields enclosure” will be hidden.

Step 3: Select File to Import

• In the Select File to Import section, click “Choose File” to select your block input file.
  • Note: If you select File Type = CSV (or XML), your input file must be a CSV (or XML) file correctly.
• If the input contains a path to the product image, in the Images File Directory field, please enter the path to the image uploaded to the server. For example: var/ export, var/ import, …
  • Note: Create an image folder in the pub/media directory to save all images in the import file, and then copy the path to Images File Directory.

Step 4: Check data and finish data entry

• After entering the above information, click “Check Data” at the top right of the popup to check if the data you entered is correct.
  • If the file is valid, click “Import” is displayed in the Validation Results section.

• Otherwise, if the upload file is invalid, please correct the error reported in the message and try again.
• Example of error message:

• When the import process is complete, the system turn off the popup and displays your action message in addition to the grid.
• Example of displaying message success on grid.

• NOTE:
• If you want to delete the page (or block) format, you should switch to a file to notepad to delete the page, to avoid any information or comma that will not delete the page.

Instagram Feed

Overview

Instagram is becoming popular when people desire more and more to share, comment and post their images every day. Now you definitely can utilize this on Magento 2 for your eCommerce website with the support of Mageplaza Instagram Feed module.

The Instagram Feed supports displaying your Instagram photos on the homepage, product page or on any CMS page within your sites. You can also configure the number of images per row and the maximum number of images displayed. Images can be sorted and arranged according to the most recent, most liked, most comments and randomly.

Installation guide

• Download the Mageplaza Instagram Feed extension
• How to Install

How to configure Instagram API

To create the Facebook app and the Facebook App API information, please follow these steps:

Step 1: Go to: https://developers.facebook.com/

Step 2: Log in to Facebook. Click Login to sign in with the existing Facebook account, or register a new account. After logging in, choose My App from the menu at the top.

Step 3: Select the app type that you are using. Fill out the Display name for your app.

Step 4: Go to Settings > Basic, click Add platform and choose Website. After that, click Next button to add your website’s URL. You can add other platforms based on your needs.

Step 5: Go to Products, click Ađ Product and select Setup in Instagram Basic Display to add products to your app.

Step 6: After clicking Setup, you are redirected to Instagram Basic Display > Basic Display, click Create New App to start creating new app.

Here you need to complete fields such as Valid OAuth Redirect URIs, Deauthorize callback URL, Data Deletion Request URL (can enter your website URL), and with the User Token Generator, you click Add or Remove Instagram Testers button.

Step 7: Redirect to Roles > Roles, select Add Instagram Tester button connected to the Instagram account. Enter the username of the Instagram account that you want to send invitation and click Submit button.Note: The posts of the Instagram account that you sent invitation and get its token, will be displayed on your website.

Step 8: Log in the Instagram account that got invitation, select your profile icon and click Profile.

Then click the settings icon, select Apps and Websites and go to Tester Invites section to Accept the sent invitation.

Step 9: Go to Instagram Basic Play > Basic Display >  User Token Generator, choose Generate Token button in the account you just sent the invitation to get Token.

Copy that token and go to User Token field in the Mageplaza Instagram Feed extension.

Note: After setting up Instagram API information, you should go to Widget to select the display positions of the post or website,… of Instagram on your website.

How to Use

1. Slider

2. Gird

3. Show Popup when licking to the images

How to configure

From the Admin Panel, go to Store > Settings > Configuration > MAGEPLAZA EXTENSIONS > Instagram Feed

1. Configuration

1.1. General

• Enable: Select Yes to enable the module
• User Token: Enter Instagram Access Token
• You can see the instruction for creating Instagram Access Token here

1.2. Display

• Total number of items

  • Select the number of images to be shown on your site
  • The maximum image number is 25

• Layout

  • Layout = Slider: Show photos from Instagram feed as slider. Display another field as below:
    • Number of items shown: Insert the number of items to show in the slider. Highly recommend from 1 to 25 (valid numbers) for a clearer visuality on your website.

  

  • Layout = Grid: Show photos from Instagram feed as gird. Display another field as below:

    • Number of rows: Insert the number of rows to determine the number of items displayed on each row. Highly recommend from 1-25 (valid numbers) for a clearer visuality on your website.

    The number of items shown on each row = (total number of items)/(numbers of rows)

  

• Show Video: Select Yes to show Instagram video in the slider or grid form.

• Show Caption: Select Yes to show caption when hovering image.

• Show pop-up: Select Yes to allow displaying popup as clicking to images.

2. Widget

2.1 Add Widget

• Step 1: Select the Type
• Step 2: Complete the Storefront Properties section
• Step 3: Configure Widget Options to display Instagram images

Step 1: Select the Type

On the Panel Admin, go to Content > Elements > Widgets

• In the upper-right corner of Widgets workplace, click on Add Widget button.
• In the Settings section:
  • Choose Widget type in the Type box.
  • Choose the current theme you are applying in the Design Theme.
  • Click Continue button.

Step 2: Complete the Storefront Properties section

• In the Storefront Properties section,
  • Enter Widget Title for the internal reference.
  • Assign the block to all store views in the Assign to Store View field or to any store view you want to apply the block.
  • Set the Sort Order if many blocks are placed at the same container. The block is at the top if the inserted value is zero.

• In the Layout Updates section, click on Layout Update to set the layout.
  • In the Display on field, choose the category, product, or page in which the block can be shown
  • If you want to display the block on specific page, you can choose the Page and the Container is the position the block will appear on that page.

Step 3: Configure Widget Options to display Instagram images

• Title: Insert the title for Instagram images displayed on Frontend
• Description: Insert the description for Instagram images displayed on Frontend
• Design

• Design = Use Config: Display the product images by using the Instagram images configuration

• Design = Custom: Admin can custom the displaying of Instagram images on frontend

• Total number of items

  • Select the image or video number displayed on frontend
  • The maximum number is 25

• Layout

  • Layout = Slider: Show photos from Instagram feed as slider. Display another field as below:
    • Number of items shown: Insert the number of items to show in the slider. Highly recommend from 1 to 25 (valid numbers) for a clearer visuality on your website.

  

  • Layout = Grid: Show photos from Instagram feed as gird. Display another field as below:

    • Number of rows: Insert the number of rows to determine the number of items displayed on each row. Highly recommend from 1-25 (valid numbers) for a clearer visuality on your website.

    The number of items shown on each row = (total number of items)/(numbers of rows)

  

• Show Video: Select Yes to show Instagram video in the slider or grid form.

• Show Caption: Select Yes to show caption when hovering image.

• Show pop-up: Select Yes to allow displaying popup as clicking to images.

Lazy Loading

Overview

Normally, all images of a web page are loaded at the same time, which likely slow down the page speed and customers will leave because it takes too much time to wait. Therefore, Mageplaza has released Lazy Loading extension which helps reduce bandwidth, page loading time and enhance the website performance by loading images only when necessary. Lazy Loading can be applied to: Category Page, Product Detail Page, CMS Page, Search Result Page, Related, Up-sell, Cross-sell products and exclude any page or image you want.

In addition, the extension also supports lazy loading by icons or placeholders and setting Loading Threshold for images. And especially, Lazy Loading extension is fully compatible with SEO extension to automatically insert alt attributes if the image does not already have this attribute. This is an extremely useful feature that Mageplaza has created.

How to use

Process Lazy Load with the icon

Process Lazy Loading with placeholder

How to configure

Login to the Magento Admin, go to Stores > Settings > Configuration > Mageplaza Extensions > Lazy Loading.

General configuration

• Enable = Yes/No: To enable/disable the extension feature.
• Apply For: Select pages to apply lazy loading. You can select one or multiple pages at the same time.

• Exclude Pages With URL Including: Click Add button to enter the path of the page that you do not want to apply lazy loading. Pages with URLs entered in this field will not apply lazy loading. Click Delete icon to delete the path you have just entered.
• Example:

• Exclude Css Class: Click Add button to enter the class name containing the image that you do not want to apply Lazy Loading. Click Delete icon to delete the class name just entered.
• Example:

<img class = "downloadable-product" src = "lifelong.jpg">. Images of the “downloadable-product” class will not apply lazy loading.

• Exclude Text: Click the Add button to enter the title or alt of the Image tag. Images with the tags that contain the text entered do not apply lazy loading.
• Example:

<img title = "lifelong" src = "download.jpg"> or <img name = "lifelong" src = "product.jpg">. When filling in “lifelong”, this image will not apply lazy loading.

• Loading Threshold: Set the distance from the screen to the product image to process lazy loading. Products in the threshold range will still load without scrolling.
• Loading Type: Select the lazy loading processing effect.
  • Icon: Process lazy loading with Icon. Show more fields:
    • Upload Icon: Click the Choose File button to select the image you want to display during lazy loading processing. If left blank, the default icon will be displayed. Click Delete Image button to delete the selected image.
    • NOTE: Only support files in the format: gif, png, jpg, svg.
    • Resize Icon Width: Enter the width of the image displayed when processing lazy loading. The default value is 64px.
    • Resize Icon Height: Enter the height of the displayed image when processing lazy loading. The default value is 64px.
  • Placeholder: Processing the lazy loading with the placeholder. Show additional Placeholder Type field with the following options:
    • Blurred: Product image is blurred during processing of lazy loading.
    • Low Resolution: Product image quality is reduced during lazy loading processing.
    • Transparent: Display transparent images during lazy loading processing.

Lookbook

Introduce

Lookbooks are an effective tool in assisting online stores to attract and engage with customers as well as boost sales revenue. For Magento stores, the Lookbook extension will enable you to create multiple gallery collections that educate and recommend customers about the ways to mix and match products together. You can attach the product links to their positions on the images and the links will lead customers to the individual product pages. Also, you are able to place the lookbooks anywhere on the website as your wish.

How to configure

Log into your backend, go to Content > Lookbook Sliders

1. Configuration

Log in your backend, choose Content > Lookbook Sliders > Configuration or Stores > Settings > Configuration > Mageplaza Extensions > Lookbook

1.1 General Configuration

• Enable: Select Yes to enable the module
• Marker Icon: Select icon for the marker. Allow file types: jpg, gif, png. If left blank, the icon will be displayed according to the default setting
• Marker Width: Set the width for the icon
• Marker Height: Set the height for the icon

1.2 Slider Design Configuration

• Infinity Loop: Select Yes to display the first lookbook after the last lookbook is displayed

• Show Next/Prev Buttons: Select Yes to display Next / Prev in the slider. Click Next / Prev to move to the next lookbook or return to the previous lookbook.

• Show Dots Navigation: Select Yes to display dots representing the number of sliders.

• Lazy Loading Images:
  • No: The images are loaded simultaneously when the page is loaded
  • On demand: The first image is displayed as soon as the page loads, the other images will be loaded at the transition event
  • Progressive: The first image is displayed as soon as the page loads, other images will be loaded in the background one after another
• Autoplay: Select Yes to automatically move the lookbooks to the left with the time set at Autoplay Speed. When Yes selected, the Autoplay Speed and Pause On Mouse Hover fields are displayed.
• Autoplay Speed: Set the playing speed of the slider
• Pause On Mouse Hover: Select Yes so that when you hover on the displayed lookbook, the slider will not move automatically

2. Manage Lookbooks

Log in to your Magento backend, go to Content > Lookbook Sliders > Manage Lookbooks

2.1 Grid

• You can find all created lookbooks here.
• At the grid, admins can view all general information of lookbooks such as ID, Image, Name, Status, Store View, Created, Modified.
• Admins can perform these actions:
  • Edit: Select Edit at the Action column to display the lookbook page and edit the lookbook information
  • Delete: Select one or multiple lookbooks needed to delete. Select Action > Delete > OK
  • Change Status: Change the status of the lookbook. Select one or multiple lookbooks needed to change the status. Select Action > Change Status > Enable/Disable
  • Add New: Create a new lookbook

2.2 Add New

2.2.1 Lookbook Information

• Name: Enter a name for the lookbook. This field is required.
• Status: Select Enable to display lookbook on the frontend
• Store Views: Select the storeviews to display
• Marker Type: Select the format to display products with markers on the frontend
  • Popup: click on the marker to show the product

• Tooltip: Hover on the marker to show the product

• Image Width: Enter the width of the image
• Image Height: Enter the height of the image
• Note: If Image Width and Image Height left blank, the images are shown with the default size
• Image: Select images with file type: jpg, png, gif. This a required field so you need to select images to save the lookbook

2.2.2. Add Marker

After creating lookbooks successfully, go to the Edit Lookbook page to add markers.

Click to choose the positions to add markers. Click on the pencil icon to edit marker, click on the delete icon to remove the marker

• What to show = Product
  • Select product: Select the products that are shown on the lookbook. Click Save pin to save the information

• What to show = Custom
  • Template: Enter the information that you want to show with the marker. Click Save pin to save the setting.

3.Manage Sliders

Log in your Magento backend, go to Content > Lookbook Sliders > Manage Sliders

3.1 Grid

• You can find all created sliders here.
• At the grid, admins can view all general information such as ID, Name, Status, Created, Modified.
• Admins can perform these actions:
  • Edit: Select Edit at the Action column to display the slider page and edit the slider information
  • Delete: Select one or multiple sliders to delete. Select Action > Delete > OK.
  • Change Status: Change the status of the slider. Select one or multiple sliders to change the status. Select Action > Change - Status > Enable/Disable.
  • Add New: Create a new slider

3.2 Add new

3.2.1 General Information

• Name: Enter the name of the slider. This is a required field
• Status: Select Enable to enable the slider
• Design = No: The slider will be shown with the settings in the configuration part
• Design = Yes: Configure the slider with more fields: Infinity Loop, Show Next/Prev Buttons, Show Dots Button, Lazy Loading - Images, Autoplay, Pause On Mouse Hover, Autoplay Speed. Custom Css: Custom the slider with Css (for example: .slick-dots li.slick-active button:before {color: red;})

3.2.2 Manage Lookbook

• Add Lookbooks: Show a popup with a list of products
• Click on the lookbook and click on Add Selected Lookbooks to add lookbooks to the slider

• Select Remove to delete lookbooks from the slider
• You can change the order of lookbooks displayed on the slider

4.1. Widget

You can add lookbooks or sliders anywhere by adding widgets on Blocks, Pages or creating new widgets.

• Add Widget

• Insert Widget

5. Rest API

Mageplaza’s Lookbook extension supports using Rest API to list information and list of Lookbook.

Please view details here.

View guide to create Integration tokens here.

Mass Order Actions

Overview

Currently, when having to process orders at the management page, the shop owner must go to each order to be able to create invoices, shipping methods, email notifications to customers in each order. From now on, with Mageplaza Mass Order Actions extension, admins can create more features at the order grid page to manage and handle multiple orders at the same time. In addition, we support Mass Order Actions compatible with some extensions such as Delete Orders, PDF Invoice, SMTP, Order Archive to reduce workload for your sites. This extension helps you quickly process orders and dramatically improve your order management.

How to download and install

• Download Mageplaza Mass Order Actions
• How to Install

How to Configure

I. Configuration

Login to the Magento Admin, choose Store > Configuration > Mageplaza > Mass Order Actions.

1. General

• Select Enable = Yes to enable the module. Mass Order Actions extension is compatible with Delete Orders and Order Archive.
• Select Actions:
  • Click the checkbox to allow the corresponding Action to work. Admin is allowed to select multiple actions.
  • Position: Create priority for Action to display Grid creation.
    • Note:
      • The smaller the Position value, the higher the priority.
      • If Position is equal, the grid will display the order of actions that are the same as the order at Select Actions.
• Only change status with same state orders:
  • Select Yes, the admin is allowed to change the status of the orders in the same state.
  • Select No, the admin is allowed to change the status of orders in the same state and not in the same order.
• Default Tracking Carrier: choose the default value for Carrier of Tracking Information in the Order grid or Create Shipment pop-up

2. Create Invoice

• Auto Select Order Status After Invoice: Select the status, the selected status will automatically be assigned to the Create Invoice popup at the grid.
• Auto Check Email Copy of Invoice: Select Yes to automatically send mail to customers.

3. Create Shipment

• Auto Select Order Status After Shipment: Select the status, the selected status will automatically be assigned to popup Create Shipment at the grid.
• Auto Check Email Copy of Shipment: Select Yes to automatically send mail to customers.

II. Grid

Login to the Magento Admin, choose Sales > Orders

Click Actions, where the actions will display in the Select Actions configuration created at the Configuration section.

2.1. Create Invoice

• Change order status to: Select to change the status display for the invoice.
• Note: If at the Configuration, in the Create Invoice section you have selected the default display status for Invoice, then at Change order status to will display that status.
• Email Copy of Invoice: Select to send a copy of the invoice to the customer via email.
• Invoice Comments: Add a comment for the invoice.
• Append comment: Tick it to display comments on email.
  • Note: If you do not select Email Copy of Invoice, the Append Comments checkbox will not allow you to select.
• Select Process to create an invoice
  • Select Process & Print to create and print invoices.
  • Select Process & Print PDF Invoices to create and print invoices in PDF format.
    • Note: PDF Invoice only appears when Admin install extension PDF Invoice.
• Show message to notify of creating Invoice successfully:

• Note: You can create an Invoice for Order by: Move the mouse to the Order you want to create an invoice and click Invoice. The next configurations you do as the same as we guided above.

2.2. Create Shipment

• Change order status to: Select to change the status display for the shipment.
• Note: If at the Configuration, in the Create shipment section you have selected the default display status for shipment, then at Change order status to will display that status.
• Email Copy of Shipment: Select to send a copy of the shipment to the customer via email.
• Shipment Comments: Add a comment for the shipment.
• Append comment: Tick it to display comments on email.
  • Note: If you do not select Email Copy of Shipment, the Append Comments checkbox will not allow you to select.
• Add Tracking Number:

Admin chooses the delivery method for order.

• Select Process to create an shipment method
• Select Process & Print to create and print shipment.
  • Select Process & Print Shipping Labels to print shipment labels.
    • Note: To create Shipping labels, please see the guide here
  • Select Process & Print PDF Shipment to create and print shipmets in PDF format.
    • Note: PDF Shipment only appears when Admin install extension PDF Invoice.
• Show message to notify of creating Shipment successfully:

• Note: You can create an Shipment for Order by: Move the mouse to the Order you want to create an invoice and click Ship. The next configurations you do as the same as we guided above.

2.3. Create Invoice and Shipment

• Change order status to: Select to change the order status
• Invoice
  • Email Copy of Invoice: Select to send a copy of the invoice to the customer via email.
  • Invoice Comments: Add a comment for the invoice.
  • Append comment: Tick it to display comments on email.
    • Note: If you do not select Email Copy of Invoice, the Append Comments checkbox will not allow you to select.
• Shipment
  • Email Copy of Shipment: Select to send a copy of the shipment to the customer via email.
  • Shipment Comments: Add a comment for the shipment.
  • Append comment: Tick it to display comments on email.
    • Note: If you do not select Email Copy of Shipment, the Append Comments checkbox will not allow you to select.
  • Add Tracking Number:

Admin selects the shipment method for order

• Select Process to create invoices and shipping
• Select Process & Print Invoices + Shipment: create, print invoices and print shipping methods.
• Select Process & Print Invoices + Shipping Labels: create, print invoices and print shipping labels.
  • To create Shipping Labels, you can refer here.
• The message displays successful generating of Invoice and Shipment

2.4. Add Order Comments

• Change order status to: Select to change the invoice status display.
• Comment: Add a comment for the invoice.
• Send Email to Customer: Select to send email to customers.
• Visible on Store Front: Select to allow displaying comments on the store.
• Select Submit Comment to create a comment.
• Display message Add comment successfully:

2.5. Change Orders Status

• Admin select to change the status of Orders.
• Admin can select multiple orders to change to the same status and not allowed to select multiple statuses for one order.
• Notice of changign status successfully:

2.6. Send Tracking Information

• Admins can send Tracking Information right from the Order grid by ticking on the checkbox of the desired order. Go to mass actions, select Send Tracking Information
• Admins can send tracking information of multiple orders at once
• Here is the success notification of Send Tracking Information

Order grid > Tracking Information

• Carrier: select a value from the droplist
• Type in the value for Title and Number
• Action: click on Add button to add tracking information

2.7. Add Tracking Number In Order Grid

III. Frontend

3.1. Display Comments

3.2. Display Invoice

3.3. Display Shipment

IV. Backend

4.1. Display Comments

4.2. Display Tracking Information in Order grid

V. Email

5.1. Display Comments

5.2. Display Invoice

5.3. Display Shipment

Mass Product Actions

Overview

Sometimes, stores’ admins want to change or edit products data in their store, they need to go to the edit link, then edit the product one by one manually. But what if you have to do it in large quantities? With Mageplaza Mass Product Actions extension, we created more advanced features to help you handle bulk actions. To save your time and effort, the module creates additional mass action at product grid pages so that you can update many products at the same time. This extension makes it easy to handle products quickly and dramatically improve product management at your store.

How to download and install

• Download Mageplaza Mass Product Actions
• How to Install

How to Configure

I.Configuration

Login to the Magento Admin, go to Stores > Configuration > Mageplaza > Mass Product Actions.

1. General

• Select Enable = Yes to enable the module.
• Select Actions:
  • Click checkbox to activate Action. Admin csn choose mulitple actions
  • Position: Set the priority of Action shown on Grid
  • Note:
    • The smaller the position is, the higher the priority of it
    • If two actions have same position, Grid will show Actions in order at Select Actions field

II. Grid

Login to the Magento Admin, choose Catalog > Products.

Click Actions, there, actions will be displayed according to Enable Mass Action configuration created at the Configuration section.

2.1. Change Attribute Set

• Admin can Change Attribute Set for one or multiple products by clicking on ticket box of each product ID
• In case Admin wants to do mass action for all product, click Select All, the system will auto-select all created products.
  • Click Select All on This Page, the system will select all products displayed on the grid.

After selecting the product, Admin click Action and select Change Attribute Set. The system will display a popup for admin to change product attributes.

2.2 Quick Attributes Update

• Admin can perform Quick Attributes Update for one or multiple products by clicking on the ticket box of each product ID
• In case Admin wants to do mass action for all product, click Select All, the system will auto-select all created products.
  • Click Select All on This Page, the system will select all products displayed on the grid.

Admins change Update the Product Attributes by clicking to the checkbox. After finish action, click to Submit.

2.3. Update Category

• Admin can perform Update Category for one or multiple product by clicking on product ID
• In case Admin wants to do mass action for all product, click Select All, the system will auto-select all created products.
  • Click Select All on This Page, the system will select all products displayed on the grid.
• After selecting the product, Admin click Action and select Update Category. The system will display a popup for admin to perform the action

• Admin changes the display of the product on the page by clicking Remove Categories/Add Categories.
  • Select Remove Categories if Admin wants to delete the current display position of the product.
  • Select Add Categories if Admin wants to display products at different pages.
• In addition, Admin can create a new display position for the product by clicking New Category.
  • Category Name: Enter a name for the Category. The system will report an error if this field is left blank.
  • Parent Category: Set the location for Category. The system will report an error if this field is left blank.
  • Click Create Category to complete creating the category.

2.4. Update Cross-sell Products

• Admin can perform Update Cross-sell Products for one or multiple product by clicking on the ticket box of each product ID

• In case Admin wants to do mass action for all product, click Select All, the system will auto select all created products.

  • Click Select All on This Page, the system will select all products displayed on the grid.

  

• After selecting the product, Admin click Action and select Update Cross-sell Products. The system will display a popup for admin to perform the action

Configuration to display or delete Cross-sell products.

• Direction:

  

  • Select One-way relation: The action product will display or delete the selected product at Remove/Add Related Products.
  • Select Mutual-way relations: Products that perform actions and selected products at Remove/Add Related Products are related.

• Remove Cross-sell Product(s): Admin selects the product to remove Cross-sell Products.

  • All Product: Delete all Cross-Sell Products.
  • Remove Specidic Products: Admin selects the product to remove it from Cross-sell Products.

• Add Cross-sell Product(s): Admin selects the product to display the product at Cross-sell Products.

• Copy from Product(s): Admin selects the product to copy its Cross-sell products.

Admin selects the product by clicking Select. The system will display product grid for selecting

Admin can choose one or more products by clicking on the desired product and click Submit to finish action.

2.5. Copy Custom Options

• Admin can perform Copy Custom Options for one or multiple product by clicking on the ticket box off each product ID

• In case Admin wants to do mass action for all product, click Select All, the system will auto-select all created products.

  • Click Select All on This Page, the system will select all products displayed on the grid.

  

After selecting the product, Admin click Action and select Copy Custom Options. The system will display popup for admin to perform the action

Admin can choose one or more products by clicking on the desired product and click Submit to finish action.

2.6. Add Custom Options

• Admin can Add Custom Options for 1 or multiple products by click on the tickbox of each product ID.
• In case Admin wants to do mass action for all product, click Select All, the system will auto select all created products.
  • Click Select All on This Page, the system will select all products displayed on the grid.

After selecting products, admins can click Action and select Add Custom options. The system will display popup for admin to take actions.

2.7. Remove Custom Options

• Admin can Remove Custom Options for 1 or multiple products by click on the tickbox of each product ID.
• In case Admin wants to do mass action for all product, click Select All, the system will auto select all created products.
  • Click Select All on This Page, the system will select all products displayed on the grid.

After selecting products, admins can click Action and select Remove Custom options. The system will display popup for admin to take actions.

2.8. Update Images

• Admin can perform Update Images for one or multiple product by clicking on the tickbox of each product ID
• In case Admin wants to do mass action for all product, click Select All, the system will auto select all created products.
  • Click Select All on This Page, the system will select all products displayed on the grid.

After selecting the product, Admin click Action and select Update Images. The system will display popup for admin to perform the action. Admin changes the product image by clicking **Remove all images of selected products/Copy image(s) from other product(s).

• Remove all images of selected products: Admin deletes the product image. The image of the product will be deleted in the backend and frontend.
• Copy image(s) from other product(s): Admin copies images og other product’s image. The image of the product will be displayed in the backend and frontend.

Admin can choose one or more products by clicking on the desired product and click Submit to finish action.

2.7. Update Inventory

• Admin can perform Update Inventory for one or multiple product by clicking on product ID

• In case Admin wants to do mass action for all order, click Select All, the system will auto select all created products.

  • Click Select All on This Page, the system will select all products displayed on the grid.

  

After selecting the product, Admin click Action and select Update Inventory. The system will display popup for admin to perform the action

• Admin can Update Inventory by clicking to checbox Change

  • Note: With the products having Use Config Settings checkbox, Admin can click to that checkbox to update the inventory of products.

• Choose Manage Stock = Yes to be enabled to manage the inventory

• Qty: Add the products number in the inventory

• Out-of-Stock Threshold: Insert the number of out-of-stock products

• Minimum Qty Allowed in Shopping Cart/Maximum Qty Allowed in Shopping Cart: Insert the maximum and minimum quantity allowed in Shopping Cart

• Qty Uses Decimals: Choose Yes if the product quantity can be in decimal number

• Set Backorders from CMS block:

  

  • No Backorder: Do not allow customers to backorder the out-of-stock product
  • Allow Qty Below 0: Allow backorder when the product quantity is below 0 - cho phép đặt hàng backorder với số lượng ít hơn 0.
  • Allow Qty Below 0 and Notify Customer: Allow backorder when the product quantity is below 0 and notify customers that they can backorder

• Notify for Quantity Below: if product quantity is smaller than the number inserted here, the module will send notification to customers

• Enable Qty Increments: Select Yes and insert the incremental number. For example: You insert number 4, means that shopping cart of customers must be added up 4, 8, 12 products each time updated.

• Stock Availability: Choose In Stock if the product is in stock and choose Out of Stock if it is running out in the inventory.

• Note: With some fields having the following options:

  • Fixed value: Only get the new value
  • Plus: Add the new value to the previous one
  • Minus: Minus the previous value by the new one. If the new value is greater than the old one, the value resulted is 0

  

2.8. Update Price

• Admin can perform Update Price for one or multiple product by clicking on product ID

• In case Admin wants to do mass action for all order, click Select All, the system will auto select all created productss.

  • Click Select All on This Page, the system will select all products displayed on the grid.

  

After selecting the product, Admin click Action and select Update Price. The system will display popup for admin to perform the action

2.8.1 Change Price: Select one of the following actions

• Plus: Plus the price value
• Plus by Percentage: Plus the price by percentage
• Fixed value: Use as a fixed value
• Minus: Minus the value
• Minus by Percentage: Minus value by percentage
• After you select one of the above options, two more fields will be shown

• Update using Cost = Yes: The Price value will be updated based on Cost value
• Value: Insert the value. The system will notify an error if you leave this field blank or insert the wrong value.

2.8.2 Change Cost: Select one of the following options to change product cost

• Plus: Plus the cost value
• Plus by Percentage: Plus the cost by percentage
• Fixed value: Use as fixed value
• Minus: Minus the value
• Minus by Percentage: Minus value by percentage
• After you select one of the above options, one more field will be shown:

• Value: Insert the value. The system will notify an error if you leave this field blank or insert the wrong value.

2.8.3. Special Price: Select option to change the special price of products

• Plus: Plus the cost value
• Plus by Percentage: Plus the cost by percentage
• Fixed value: Use as fixed value
• Minus: Minus the value
• Minus by Percentage: Minus value by percentage
• After you select one of the above options, some more fields will be shown:

• Update using Price = Yes: The Special Price value will be updated based on Price value
• Value: Insert the value. The system will notify an error if you leave this field blank or insert the wrong value.
• Special Price From Date: Choose the day to begin applying special price
• Special Price To Date: Choose the day to finish applying special price

2.8.4 Change Tier Price: Select options to change the tier price of products

• Website: If you have more than one website. choose the one you to add tier price
• Customer Group: choose customer group to apply tier price
• Quantity: Insert the quantity to apply the tier price
• Price: Insert the price to apply to the rule
• Click icon “Garbage bin” to delete rule

2.9. Update Related Products

• Admin can perform Update Related Products for one or multiple product by clicking on product ID
• In case Admin wants to do mass action for all product, click Select All, the system will auto select all created products.
  • Click Select All on This Page, the system will select all products displayed on the grid.

After selecting the product, Admin click Action and select Update Category. The system will display popup for admin to perform the action

Admin choose settings to display or delete related products.

• Direction:

• Select One-way relation: The action product will display or delete the selected product at Remove/Add Related Products.
• Select Mutual-way relations: Products that perform actions and selected products at Remove/Add Related Products are related.
• Remove Related Product(s): Admin selects the product to delete Related Products.
  • All Product: Delete all Related Products.
  • Remove Specific Products: Admin selects the product to remove it from Related Products.
• Add Related Product(s): Admin selects the product to display the product at Related Products.
• Copy from Product(s): Admin selects the product to copy its related products.

Admin selects the product by clicking Select. The system will display product grid for selecting

Admin can choose one or more products by clicking on the desired product and click Submit to finish selecting products.

2.10. Update Up-sell Products

• Admin can perform Update Up-sell Products for one or multiple product by clicking on product ID
• In case Admin wants to do mass action for all product, click Select All, the system will auto select all created products.
  • Click Select All on This Page, the system will select all products displayed on the grid.

After selecting the product, Admin click Action and select Update Up-sell Products. The system will display popup for admin to perform the action

Configuration to display or delete Up-sell products.

• Direction:

• Select One-way relation: The action product will display or delete the selected product at Remove/Add Related Products.
• Select Mutual-way relations: Products that perform actions and selected products at Remove/Add Related Products are related.
• Remove Up-sell Product(s): Admin selects the product to remove Up-sell Products.
  • All Product: Delete all Up-sell Products
  • Remove Specific Products: Admin selects the product to remove it from the Up-sell Products.
• Add Up-sell Product(s): Admin selects the product to display the product at Up-sell Products.
• Copy from Product(s): Admin selects the product to copy its Up-sell products.

Admin selects the product by clicking Select. The system will display product grid for selecting

Admin can choose one or more products by clicking on the desired product and click Submit to finish select products.

2.11. Update Website

• Admin can perform Update Website for one or multiple websites by clicking on product ID
• In case Admin wants to do mass action for all product, click Select All, the system will auto select all created products.
  • Click Select All on This Page, the system will select all products displayed on the grid.

After selecting the product, Admin click Action and select Update Websites. The system will display popup for admin to choose actions to update websites

Admin changes the display position of the product on the website by clicking Remove Product From Websites/Add Product To Websites.

• Remove Product From Websites: Admin select the website on which products are not displayed
• Add Product To Websites: Admin select the website on which allowing the product to display

Note: In the case admin select both Remove and Add Product From Websites, the system will perform Remove first and then perform Add Product From Websites

III. Backend

3.1. Change Attribute Set

3.2. Update Category

3.3. Update Website

3.4. Update Related Products

3.5. Update Up-sell Products

3.6. Update Cross-sell Products

3.7. Copy Custom Options

• Custom options are displayed in the Admin order page.

• Custom options are displayed in the Admin order page.

• The Custom options results are displayed in the order information.

3.8. Add Custom Options

3.9. Update Images

3.10. Update Price

Tier Price is shown on admin order page

IV. Frontend

4.1. Update Category

4.2. Update Related Products

4.3. Update Up-sell Products

4.4. Update Cross-sell Products

4.5. Copy Custom Options

• Custom options displayed at Product Page

• Custom options are displayed in the Shopping Cart Page after performing Add products to the cart.

• The Custom options results are displayed in the order information.

4.6. Add Custom Options

4.7. Update Images

4.8. Update Price

• Special Price is shown on Category Product Page.

• Special Price is shown on Detail Product Page.

• Tier price is shown on Category product page

• Tier price is shown on Detail product page

Membership

Overview

Mageplaza Membership extension will create a customer group management system based on customer group. Customers can purchase the right to join the customer group by acquiring membership products. This encourages customers to buy more with their appealing offers corresponding with their membership levels. As a member of your store, customers will be able to enjoy other benefits that the outsiders do not have. In particular, there will be an expiration for each membership. When it expires, it automatically switches to the default customer group or the admin can configure the transfer of the customer group.

How to download and install

• Download Mageplaza Membership
• How to Install

How to use

• Product View & Item: Display information of Membership product on the Product View Page

• Membership Dashboard: This section will display the information and payment history of the membership purchased by the customer. You can use the link Membership Dashboard at toplink. After memebership is expired, the Membership Dashboard will display the expire status of the membership with the Re New button. And the Upgrade button is displayed when the membership has not expired. You can click the Upgrade button to upgrade the membership package at a better price and offer, and the site only has membership levels higher than the current membership.

• Membership Page: Display memberships at the Membership page if they had ordered the default products

How to configure

1. Configuration

Login to the Magento Admin, choose Marketing> Membership> Configuration.

1.1. General

• Enable: Select Yes to enable the module’s features.

• Default Group: Select default customer group so that when the Membership expires, the customer will be transferred back to this default customer group. With the following customer group options:

  • General
  • Wholesale
  • Retail

• Override Membership:

  • If you choose Yes so that when customers had bought and used membership, they can buy another membership product
  • Selecting No, customers in certain membership cannot buy products from other membership types. They only can buy other memebership products if their current memberships are exprired.

  

• Upgrade Membership:

  • If Yes is selected, the current membership will be allowed to upgrade even when it is not expired. Showing a upgrade button on My Membership at frontend. You can click the Upgrade button to upgrade the membership package at a better price and offer, and the site only has membership levels higher than the current membership. Show extra fields as following:
    • Upgrading Price: Choose the type of cost when customer can upgrade your current membership:
      • Full Price: When upgrading membership, the price will be calculated according to new membership price and not be discounted even if the old membership has not expired.
      • Deducted by Remaining Time: When upgrading membership, the price will be deducted by the old membership if membership has not expired. Example: The old Membership you bought has a duration of 2 months, the price is $60. After 1 month of membership use, you want to use another membership which cost $100 but the old membership hasn’t expired. When buying this new membership, your membership price is deducted by the amount of the remaining time of the old membership (which means that you only have to pay $70)
  • If you select No, you will not be allowed to upgrade membership if the membership is not expired.

Note: The deduction time will be converted to seconds and rounded up to the hour unit. Example: Your membership is 2 hours long and has been used for several minutes. Time will be rounded up, you will only be deducted 1 hour.

• Show Membership Dashboard Link at Toplink: If you select Yes, the link membership dashboard will be displayed on toplink.

• Activate Membership When: After buying membership product, the customer can apply that membership when:
  • Invoice created: customer applies that membership when Invoice created (order is created with invoice). If not Invoice is not created completely, membership will not be applied. For example: when customers buy one membership product and 1 non-vertual product ( ex: Joust Duffle Bag). Membership only be applied when customers place the order and invoice is created.
  • Order complete: customer applies that membership when Order complete (invoice and shipment are created). If not, you won’t be able to apply that membership. For example, when customers buy one membership product and 1 non-vertual product ( ex: Joust Duffle Bag). Membership only be applied when customers place the order and invoice as well as shipment is generated.

1.2. Membership Page

• Enable: Select yes to display the Membership page at the frontend and display 2 more Display on and Membership route.

• Display on: Select the place to display Membership Page link on:

  • Menu: display membership page link on the menu bar.

  

  • Footer Links: displays membership page link on Footer Links.

  

• Membership route:

  • Enter a route for the membership page.
  • If left blank, the default is “Membership”.

• Snippet Code: Can add the following code to insert membership page anywhere you want:

  

2. Manage Membership

Login to the Magento Admin, choose Marketing> Membership> Manage Membership.

2.1. Membership Grid

• This section records the membership creation information including Membership Name, Level, Status, No. Member, Customer Groups, Is Feature,…You can add membership when creating customer groups. To set customer group, please go to Customers > Customer Group, click Add new customer group
• You can choose to edit membership and delete information to delete membership.
• Choose Change Status to change Active/Inactive status of membership.
• Filter the fields of information you want to search.

2.2. Edit Membership

2.2.1. General

• Customer Group: Select customer group for membership:
  • General
  • Wholesale
  • Retail
• Status: Select the status of membership with:
  • Inactive: membership will not work and does not appear in Frontend.
  • Active: Membership works and does membership on the frontend.
• Level:
  • Enter the level of membership. Only higher levers can be displayed on Upgrade Page
  • If left blank, the default level is 0.
• Default Duration: Select the duration for membership by:
  • Day
  • Month
  • Year
• Duration No.:
  • Enter the number in the Duration No. field to determine the duration of that membership. Only apply this configuration if you choose Duration at Membership product is in Default value.
  • If left blank or insert “0”, membership will be applied unlimited time.

2.2.2. Display

• Membership Name:
  • Enter a name for membership. With each store view, you can name a membership replacement in the frontend.
  • If left blank, it will default to the value of the Admin field.
• Image: Click Choose file to upload image file for membership. If you cannot find the suitable image for specific memembership, it will left empty.
• Background Color: Choose color for background membership.

• Default Product: Choose products to apply to membership, this product will be used to add to cart on page membership. If you do not choose default product, membership will not be shown on Membership Page
• Benefit:
  • Click Add Option to enter promotion programs, benefit from buying membership and thế benefits will be displayed in membership at frontend. You can enter specific benefits for each store view.
  • With the benefits you want to remove, click Delete.
• Is Feature: Choose yes to use Featured for membership.

• Featured Label: Add the label for Featured Label. If left blank, the default label is Featured. Please make sure that your label is nottoo long so that it can be shown on forntend.
• Sort Order:
  • Enter the number for the Sort Order field. If left blank, the default is 0.
  • The one with the smallest order will display first.

2.2.3. Members

This section records the information, status and duration of membership packages that customers use including Customer, Status, Activation Date, Expiration Date fields.

2.2.4. History

Here save the information and payment history of customers when buying each membership, which including Customer, Action, Pay Amount, Duration, Purchased Date, Activation Date

3. Transactions

The information in this Transaction section is similar to History in Manage Membership but here are all membership histories. It stores customer information and payment history when purchasing membership.

4. Membership Product

Login to the Magento Admin, choose Catalog> Products. At Add Product button, choose Membership Product:

• Enable Product: Select Yes to display membership product at frontend.
• Product Name: Enter a name for the membership product. This is a required field.
• SKU: Enter SKU for membership product. This is a required field.
• Membership: Choosing membership to apply for membership products, if membership products are set up by Membership as a default product, it will not be possible to change membership.
• Duration: Choose the duration and price corresponding to membership products:
  • Default: Apply the membership product price following Default Duration selected at membership. Choose default will show another field Price:
    • Price: Enter the price into the Price field. This price will be applied according to the duration of membership products.
  • Permanent: Apply membership price permanently with selected price. When the time is up, it will still display that price. Show more fields Price:
    • Price: Enter the price into the Price field. This price will be applied permanently to membership products.
  • Custom: Show more Duration, No., Price schools to enter each time and price separately when customers buy membership products.

Note:

• To update the newest products, please run the following commands: php bin/magento indexer:reindex
• Each membership will only be able to choose one membership product to make the default product and be displayed at the Membership page. For other membership products, it’s not the default choice of the membership. You should create a separate category page to organize membership products there. That, membership products will not show up scattered, miscellaneous and in particular can create many choices for customers when buying membership products. Visit the Catalog> Categories to create a category page.

5. Customer edit

• Login to the Magento Admin, choose Customers> All Customers> Add New Customer/Edit Customer.
• Here, Admin can change customer group manually and the customers in group will be assigned to the default duration of that membership. Upon expiration (in hours) will expire membership and move the customer back to the default group you configured at Configuration.

• With Membership Expiration Date field, you can set your own membership duration for each customer and will prioritize membership configuration here.

6. Manage Members

In this part, Members’ information of Membership will be recorded here including Customers’ email, Membership type, Status, Activation Date, Expiration Date.

Notation

• To uninstall the module, please use composer to run the command bin/magento module:uninstall Mageplaza_Membership

• Delete the module by going to data base, please

  • Access eav_attribute table, at attribute_code, please find and delete attribute mpmembership, mpmembership_duration, mpmembership_price_fixed, mpmembership_duration_options

  

  • Then delete mp_mageplaza_membership_customer, mp_mageplaza_membership_history, mp_mageplaza_membership_list

  

  • Access table mp_ui_bookmark. At column namespace, delete mpmembership_membership_grid, mpmembership_membership_grid, mpmembership_history_grid, mpmembership_history_grid

5. API

Mageplaza’s Membership extension supports the use of the Rest API to add size charts’ data to get information of Membership, Member, Transaction, Membership products, Membership Page, Upgrade Page and add membership products to cart, get cart information, etc.

• Details can be viewed here.
• Instructions for creating Integration tokens here.

6. GraphQL

How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-membership-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

How to use

Mageplaza’s Membership GraphQL supports getting Membership Page information, Upgrade Page, Membership products, membership and transaction information of customers, adding membership products to cart, getting cart information

To start working with Membership GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• Refer to the GraphQL requests we support here

Milestone

Overview

To manage customers more efficiently, Mageplaza developed the Milestone extension. This module can be configured to change the Customer Group based on rules automatically. Also, it supports sending email notification to customer when changing Group and email notification includes changes log sent to admin. You should install Mageplaza_SMTP to avoid your email being sent to the spam box and it is fully compatible with the Milestone extension.

How to download and install

• Download Mageplaza Milestone
• How to Install

How to use

Email notification to Customer

Email notification to Admin

Display the Customer Group at Frontend

Show more Disable Auto Assign Rule at Customer Backend (Go to Customer > All Customer > Edit > Account Information):

How to Configure

1. Configuration

From the Admin Panel, go to Customers > Milestone > Configuration

1.1. General

From the Admin Panel, go to Customers > Milestone > Configuration, select General

• Enable: Select Yes to enable the module.
• Show Group: Select Yes to display the Group name at the Customer Dashboard in Frontend.
• Schedule For Cron: Applied for Processing Type as Cron. Set schedule to automatically switch customer groups on a frequent basis as daily, weekly or monthly:
  • Daily: Email automatically every day.
  • Weekly: Automatically send email every week.
  • Monthly: Automatically send email every month.
  • Disable: Turn off the schedule to send email.
• Start Time: Set the start time email will be sent.

For example: Schedule For Cron = Daily, Start Time = 12:30:00, the email will be sent daily at 12:30

1.2. Customer Notification

From the Admin Panel, go to Customers > Milestone > Configuration, select Customer Notification

• Enable:
  • Select “Yes” to allow email notifications to customers.
  • Install Mageplaza_SMTP to avoid sending email to spam box.
• Sender: Select the representative to send notification email to customer:

• Email Template:
  • Email notifications are sent automatically when a customer reaches a certain Customer Group condition.
  • You can access Marketing > Email Templates, select Add New Templates to create a notification email template
  • Instructions on how to create new email templates can be found here

1.3. Admin Notification

From the Admin Panel, go to Customers > Milestone > Configuration, select Admin Notification

• Enable: Select “Yes” to allow email notifications to admin about changing on Customer Group.
• Sender: Select the representative to send notification email to admin:

• Email Template:
  • Email notifications are sent automatically to admin.
  • You can access Marketing > Email Templates, select Add New Templates to create a notification email template
  • Instructions on how to create new email templates can be found here
• Send To:
  • Enter the admin email address.
  • You can enter multiple emails, each separated by commas (,).
• Schedule For: Set a schedule for email to be sent automatically. Options included:
  • Daily: Email automatically every day.
  • Weekly: Automatically send email every week.
  • Monthly: Automatically send email every month.
  • Disable: Turn off the schedule to send email.
• Start Time: Set the start time email will be sent.

2. Grid

2.1. Manage Rules

From the Admin Panel, go to Customers > Milestone > Manage Rules

• Rules of changing customer group are displayed here.
• From Manage Rules, admin can view basic information such as ID, Name, Status, Website, Original Group, Destined Group, Priority, From Date, To Date, Action.
• Apply Rule: Apply all the rules to customer to change their Group when meeting the conditions.
• Action:
  • Delete: Delete the information in the Manage Rule page.
  • Change Status: Change the status of the selected rules.
  • Edit: Navigate to the edit page of the previously created rule.
• In addition, admin can filter,change store view, hide/show columns.

2.2. Create/ Edit Rule

From the Admin Panel, go to Customers > Milestone > Manage Rules, select Add new/ edit

2.2.1. General

• Name: Enter the rule name, which is a required field.
• Description: Enter the rule description, only displayed in Backend.
• Status: Select Enable for the rule to work.
• Website: Select the Website for the operation rule.
• From: Select the date/month/year for the rule to start.
• To: Select the date/month/year for the rule to finish.
• Priority:
  • Set the priority to apply to conditions of assigning customers to certain groups.
  • 0 is the highest priority. The smaller the number, the higher the priority.

2.2.2. Conditions

Select the condition to apply customers to each rule:

2.2.3. Actions

• Original Group:
  • Select the original group to apply the group switching.
  • You can select multiple customer groups.
  • This is a required field.
• Destined Group:
  • Select the group you want to convert to.
  • This is a required field.
• Processing Type: Customer’s Customer Group will change if it meets the above Conditions and 1 of 2 types below:
  • Event: Displays 2 events:
    • Customer Creating & Saving Actions: Customer account will convert Customer Group when customer create account and save.
    • Order Creating & Saving Actions: Customer account will convert Customer when order is created and saved
  • Cron: Customer Group changed when running cron command: php bin/magento cron:run
• Coupon Rule:
  • Set the rule in which customers can earn coupon when they are assigned to new groups.
  • Go to Marketing > Cart Price Rule to generate a rule
  • The rule should be set as a Specific Coupon and Auto-generated.
• Email Template:
  • Email sent automatically when customer reach any customer group will be attached with a coupon
  • You can access Marketing > Email Templates, select Add New Templates to create a notification email template
  • Instructions on how to create new email templates can be found here

3.Manage Log

From the Admin Panel, go to Customers > Milestone > Manage Logs

• This shown info of customers’ accounts which are transferred from this Customer Group to another Customer Group.
• From Manage Logs, admin can view basic information such as ID, Customers Name, Customer Email, Original Group, Destined Group, Rule Name, Update Date.
• Also, admin can filter, change store view, hide/ display columns.

4. Rest API

Mageplaza Milestone Extension supports usigng REST API to perform some requests related to extension: get rule information, create/update/delete rule, customers can view their customer groups.

View details of requests suppoerted by Mageplaza Milestone Extension here

View Magento 2 REST API Guidelines here.

View REST API Guidelines to create tokens here.

5. GraphQL

5.1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-milestone-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Note: Magento 2 Milestone GraphQL requires installing Mageplaza Milestone in your Magento installation.

2. How to use

To perform GraphQL queries in Magento, please do the following requirements:

• Use Magento 2.3.x or higher. Set your site to developer mode.
• Set GraphQL endpoint as http://<magento2-server>/graphql in url box, click Set endpoint. (e.g. http://dev.site.com/graphql)
• To view the queries that the Mageplaza Milestone GraphQL extension supports, click here.

Moneris

Moneris provides online payment services with different card types (debit, credit card, Visa), especially for customers in the USA and Canada. Mageplaza Moneris extension will help you integrate this payment gateway with your store. Customers can save and edit credit card information at the first payment to save time at the next purchase. In particular, admin can configure the module to redirect to Moneris payment gateway. Also, Moneris support authorizes, capture and 3D secure, AVS Verification.

Mageplaza Moneris extension is fully compatible with Mageplaza One Step Checkout

How to download and install

• Download Mageplaza Moneris
• How to Install

How to get the Moneris credentials

1. Register Moneris account

• To register the Moneris account, please access to this link

• After logging in the Moneris account, request to sign in information in USA or Canada by clicking to Full Profile

• At Full Profile, look at My Testing Credentials, click to Request Testing Credentials then a popup shown requires you to fill in your Password and Country to verify your test account.

• At homepage, Test Credentials is on the right bar menu. Store ID is at the first line (represented by store icon). The second line is API Token (represented by a key icon). Admin needs this two information to configure the module Moneris.

• After logging in to your account, you need to fill in some account information and questions.

2. Configure Redirect Moneris Checkout

For USA:

• At Moneris Page, please go to Admin > Hosted Config. You need to configure Magento 2 using hpp_id, hpp_key. If you do not have these keys, please click to Generate a New Configuration to create new keys.

• At Response Method, insert your Store Response URL then Save Changes. URLs must start with http or https and must be a registered domain. IP addresses are not supported here.

For Canada:

• Log in to your Moneris account and go to Admin > Hosted Paypage Config. You need to configure Magento 2 using ps_store_id and hpp_key. If you do not have those keys, please click to Generate a New Configuration to create new keys.

• At Paypage Appearance choose Configure Appearance to add the Cancel button Url.

• At Response/Receipt Field Configuration, choose Return the txn_number. This is a required selection.

• Checkout page: Choose the Moneris Payment method. Fill in the credit card information: Credit Card Number, Expiration Date, Card Verification Number. Here, customers can save the credit card information for the next payments.

• Stored Payment Methods: Here saves the credit card info. Customers can delete the outdated/ no-longer-used credit card.

• Redirect Moneris Checkout: This feature will be configured by admin at backend, which allows customers to be redirected to Moneris Payment Gateway to process their payment.

• Here is the USA Moneris Checkout Page after being redirected:

• Here is the Canada Moneris Checkout Page after being redirected:

• Test card numbers

Use any of the following test card numbers, a valid expiration date in the future, and any random CVC number, to create a successful payment. Each test card’s billing country is set to U.S, Canada.

 

BRAND	NUMBER
MasterCard	5454545454545454
MasterCard (Bin2 CAN)	2222400041240011
MasterCard (Bin2 US)	2223000048400011
Visa	4242424242424242
Amex	373599005095005
JCB	3566007770015365
Diners	36462462742008
Discover	6011000992927602
Track 2	5258968987035454=06061015454001060101?
UnionPay	6250944000000771   Expiry date: 12/49 (MM/YY), CVN2 value '371'

• 3D Secure (MPI) test card numbers

When testing your implementation of the Moneris MPI, you can use the VISA/MasterCard/Amex PIT (production integration testing) environment.

May only be tested in the following test stores

 

	CANADA	US
Store ID	store5	monusqa002
API Token	yesguy	qatoken

• Test Card numbers (Visa and MasterCard Only)

 

CARD NUMBER	VERES	PARES	ACTION
4012001038443335	N	NA	Send transaction to Moneris Payment Gateway using either the basic Purchase or the basic Pre-Authorization transaction. Set crypt_type = 6.
4012001038488884	U	NA	Send transaction to Moneris Payment Gateway using either the basic Purchase or the basic Pre-Authorization transaction. Set crypt_type = 7.
4012001037141112	Y	True	TXN – Call function to create inLine window. ACS – Send CAVV to Moneris Payment Gateway using either the Cavv Purchase or the Cavv Pre-Authorization transaction
4005559876540	Y	True	TXN – Call function to create inLine window. ACS – Send CAVV to Moneris Payment Gateway using either the Cavv Purchase or the Cavv Pre-Authorization transaction
4012001037167778	Y	True	TXN – Call function to create inLine window. ACS – Send CAVV to Moneris Payment Gateway using either the Cavv Purchase or the Cavv Pre-Authorization transaction
4012001037461114	Y	False	Card failed to authenticate. Merchant may choose to send transaction or decline transaction. If transaction is sent, use crypt type = 7.

• Test Card numbers (AmEx Only)

 

CARD NUMBER AMEX ONLY	VERES	PARES	ACTION
375987000000062			Set crypt_type = 7
375987000000013			Set crypt_type = 6

• You can refer 3D secure testing here
  • CVD & AVS test card numbers
• Things to consider:
  • CVD is only supported by Visa, MasterCard, Discover, JCB and American Express.
  • AVS is only supported by Visa, MasterCard, Discover and American Express.
  • Card verification transaction is only supported by Visa, MasterCard, Discover and American Express.
• VISA Pre-Authorization/Purchase with AVS & CVD ( Applicable for card: 4242424242424242)

 

REQUEST		RESPONSE
AMOUNT	RESPONSE	AVS	CVD
AVS
$10.10	Approved	A	M
$10.13	Approved	D	M
$10.24	Declined	Y	M
$10.26	Declined	S	M
CVD
$10.30	Approved	Y	P
$10.36	Declined	Y	M
$10.37	Declined	Z	M
COMBO (AVS AND CVD)
$10.40	Approved	Z	S
$10.41	Approved	X	M

• For other card types such as MasterCard, Discover, Visa, AMEX, please refer the testing here
• CVD result definitions

 

VALUE	DEFINITION
M	Match
N	No Match
P	Not Processed
S	CVD should be on the card, but Merchant has indicated that CVD is not present.
U	Issuer is not a CVD participant
Y	Match for AmEx/JCB only
D	Invalid security code for AmEx/JCB
Other	Invalid response code

Table of CAVV Result Codes

 

RESULT CODE	MESSAGE	WHAT THIS MEANS TO YOU AS A MERCHANT…
0	CAVV could not be verified or CAVV data was not provided when expected	For this transaction you may not receive protection from chargebacks as a result of using VBV as the CAVV was considered invalid at the time the financial transaction was processed. Please check that you are following the VBV process correctly and passing the correct data in our transactions.
1	CAVV failed validation; authentication	Provided that you have implemented the VBV process correctly the liability for this transaction should remain with the Issuer for chargeback reason codes covered by Verified by Visa.
2	CAVV passed verification—authentication	The CAVV was confirmed as part of the financial transaction. This transaction is a fully authenticated VBV transaction (ECI 5)
3	CAVV passed verification—attempted authentication	The CAVV was confirmed as part of the financial transaction. This transaction is an attempted VBV transaction (ECI 6)
4	CAVV failed verification—attempted authentication	Provided that you have implemented the VBV process correctly the liability for this transaction should remain with the Issuer for chargeback reason codes covered by Verified by Visa.
6	CAVV not verified, issuer not participating in CAVV verification	CAVV value was not verified, because the issueing bank does not participate in VBV
7	CAVV failed verification—attempted authentication	Please check that you are following the VBV process correctly and passing the correct data in our transactions. Provided that you have implemented the VBV process correctly the liability for this transaction should be the same as an attempted transaction (ECI 6)
8	CAVV passed verification—attempted authentication	The CAVV was confirmed as part of the financial transaction. This transaction is an attempted VBV transaction (ECI 6)
9	CAVV failed verification—attempted authentication	Please check that you are following the VBV process correctly and passing the correct data in our transactions. Provided that you have implemented the VBV process correctly the liability for this transaction should be the same as an attempted transaction (ECI 6)
A	CAVV passed verification—attempted authentication	The CAVV was confirmed as part of the financial transaction. This transaction is an attempted VBV transaction (ECI 6)
B	CAVV passed verification—attempted authentication, no liability shift	The CAVV was confirmed as part of the financial transaction. However, this transaction does qualify for the liability shift. Treat this transaction the same as an ECI 7.
C	CAVV was not verified—attempted authentication	If 3-D Secure Authentication Results Code value is 07 in the CAVV and the issuer did not return a CAVV results code in the authorization response,
D	CAVV was not verified—cardholder authentication	If 3-D Secure Authentication Results Code value is 00 in the CAVV and the issuer did not return a CAVV results code in the authorization response

How to Configure

1. Configuration

Login to the Magento Admin, choose Stores > Configuration > Sales > Payment Method > Moneris.

• Enable: Select Yes to activate the module.

1.1. Credentials

• Environment:
  • Admin can choose Sandbox environment to test the payment by Moneris
  • For real payment on your live site, change the environment to Production
• Merchant Server: Choose the Moneris Payment in:
  • Canada:
  • USA:
• Store ID:
  • Insert the Store ID got after sign up the Moneris account above.
  • If left blank or insert the wrong ID, you can not connect to Moneris.
• API Token:
  • Insert the API Token got after sign up the Moneris account above.
  • If left blank or insert the wrong ID, you can not connect to Moneris.
• Enable Hosted Payment Gateway:
  • Select Yes, customers are redirected to Moneris Paypage. And show more fields following:
    • For Canada users:
      • PS Store ID: Insert the PS Store ID at configuration of Moneris hosted paypage to allow redirecting to Moneris Paypage.
      • Accept URL: Use Accept URL to configure the Moneris Hosted Paypage
      • Cancel URL: Use Accept URL to configure the Moneris Hosted Paypage
      • HPP Key: Insert the HPP key from Moneris Hosted Paypage to HPP Key Field.
    • For USA users:
      • HPP ID: Insert the HPP ID at configuration of Moneris hosted paypage to HPP ID Field.
      • Response URL: Use Response URL to configure the Moneris Hosted Paypage
      • HPP Key: Insert the HPP key from Moneris Hosted Paypage to HPP Key Field.
• Test Credential button: Admin can check your app by clicking to Test Credential.

1.2. Card

• Title: Add the Title of Payment Method, which will be shown at checkout page.
• Payment Action:
  • Authorize and Capture: Payment is captured right after customers place order successfully. At that time, customers’ credit card is used to pay before invoice is created then.
  • Authorize: Payments captured only when Invoice is created.
• Card Types:
  • You can choose one or several card types to use in payment.
  • Cards will be authorized after customers fill in Card ID at checkout. For the unselected cards, there is an invalid message shown here.
• Allow Customer Credit Vault:
  • Select Yes, Credit Card Information will be saved in Customer account and can use it for payment right after.
  • You can tick on the tick box to save the credit card ino. Do not apppy for Not Logged In customers.
• Vault Title:
  • Enter an alternate name in the Vault Title field. This name will be displayed when customer order is completed and using the previously saved credit card.   - If left blank, use the default name
• Payment from Applicable Countries:
  • Select All Countries to allow Card payment method available in all countries
  • Select Specific Countries to restrict certain countries to use this payment method
    • Payment from Specific Countries: Choose the countries that allow this Card payment method
• Debug Mode: If Yes, diagnostic information is stored in log file on Magento web server.
• Sort Order:
  • Specify the display position of this payment method compared to other payment methods
  • 0 is the largest number. The smaller the number, the more priority the country is displayed first.

1.3. Verification and Security

• Enable AVS Verification: Select yes to turn on AVS verification for Billing Address of customers. AVS is only supported by Visa, MasterCard, Discover and American Express.
• AVS verification failed: AVS verification for Billing Address failed when Customer Name, Street Address and Zip/ Postal Code do not match. In case AVS verification fails, you can:
  • Reject Payment: deny payment and customers cannot continue making payments.
  • Accept Payment: still accept payment for customers who want to keep making payments.
• Enable CVD verification: Select Yes to enable CVD verification for payment address (CVD is 3 digits on the back of the card). CVD is only supported by Visa, MasterCard, Discover, JCB and American Express.
• CVD verification failed: Verify CVD for Billing Address failed when CVD is wrong or unable to verify. In case CVD verification fails, you can:
  • Reject Payment: deny payment and customers cannot continue making payments.
  • Accept Payment: still accept payment for customers who want to keep making payments.
• Enable 3D secure: Select Yes to use 3D Secure to verify Customer’s card, thereby preventing payment fraud. Display add Force To Use field.
• Force To Use: Select Yes to force user to verify their card. Only successful 3D Secure verified cards can process orders.
• Response Setting:
  • Fill in the Code, Message fields to list the error cases that customer often encountered. Please refer here.
  • Click the Add button to add the case, click the Delete icon to delete the error cases you want.

2. Admin order

This section records the Credit Card (Moneris) information that the customer has ordered and paid.

3. Order Frontend

4. Compatible with Instant Purchase

• Customers can use Instant Purchase to place orders quickly.
• Note: Instant Purchase only shown when you have saved your payment cards. Also, you should disable 3D Secure because the card verification was done when customers fill in the payment card information.

• Compatible with One Step Checkout

• Compatible with Mageplaza Payment Restriction: Payment Restriction extension supports hiding/showing Moneris at Frontend following admin configurations.

5. Refund Order

Here admin can Refund Online/ Offline individual or all orders.

6. Instructions for installing the library

• Create directory: lib/internal/Mageplaza
• Visit the link to download the Moneris library here
• Extract the module-moneris-library into lib/internal/Mageplaza and rename the file name you just extracted as: Moneris

Multiple Shipping Flat Rates

Overview

Multiple Shipping Flat Rates extension gives your store more choices about the shipping method. Thanks to this module, you can apply different delivery rates to different countries. It not only helps increase the conversion rate but also boost your sale significantly.

Note: Magento 2 Multiple Shipping Flat Rates can be used with multiple stores. Multiple stores module:

• This extension is applied to multiple stores.
• Stores are set the default as the Default Configuration.
• To change the configuration for each store, need to remove tick at Use Website on the right of each option.
• Config of the extension in each store will be applied in the store itself.
• Config in this store doesn’t affect the config in the other store.

Download & Install

• How to Install

How to configure

Login to Magento Admin, Stores > Settings > Configuration > Sales > Shipping methods > Flat Rate #1-5

1. Flat rate #1

• Enable: Choose Yes so that this module can work well
• Method Name:
  • This is a place to set the name for flat rate, displaying on the View cart page and checkout page at frontend and Create order at backend.
  • If you leave this field blank, it doesn’t display on the View cart page or checkout page at frontend and Create order at backend.
• Price:
  • Set the price for the Shipping method. The price will display on the frontend
  • If leaving this field blank, the default price is $0.00
• Sort Order: Set the order to appear of flat rate on the flat rate list when displaying on the frontend

For example: flat rate #1: Sort Order = 1, flate rate #2: Sort Order = 2, when it displays on the frontend, flate rate #1 will be ordered first.

• Title:
  • Set the title for flat rate 31-5, the title will display on the cart page and checkout page
  • If leaving this field blank, it will not display the title
• Ship to Appicable Countries”
  • All Allowed Countries: Flat rate is applied in all countries
  • Specific Countries: The Flat rate will only be applied in the selected countries in the Ship to Specific Countries field

• Ship to Specific Countries: Choose the countries that you want to apply the flat rate

• Ship to Specific Zipcodes: Fill in this field the zipcode which allows applying flat rate. Apllicable for multiple zipcodes. Zipcodes are separated by a dot comma “ ; ”

• Displayed Error Message:

  • Enter the content of the message when the shipping method isn’t available
  • If leaving this field blank, the default message is Sorry, but we can't deliver to the destination country with this shipping module.
  • The error message will display on the frontend if the Show Method if Not Applicable = Yes

  

• Show Method if Not Applicable: Choose Yes to display the shipping methods when it doesn’t include in the Applicable Countries

The same as Flate rate #1, admins can add at most 5 shipping methods to their store.

Frontend

1. On View Cart page

2. On Checkout page

Backend:

Login vào Magento Admin > Sales > Orders > Create New Order > Choose Customer > Select Store > select products > Add Selected Product(s) to Order > Shipping Method > Click Get shipping methods and rates

Multiple Coupons

Overview

Magento basically does not support applying multiple coupons to a Cart. Mageplaza Multiple Coupons extension will help you solve that problem. This module supports applying multiple coupons in 3 commonly used pages including Shopping Cart Page, Checkout Page, Admin Order Page. Customers can use all the coupons they have to receive the maximum discount. With this wonderful experience, store will retain loyal Customers and entice more new customers. Bu that increase store revenue significantly.

This extension is fully compatible with Mageplaza One Step Checkout

Download and Install

• Mageplaza Multiple Coupons
• How to Install

How to use

1. Shopping Cart page

2. Magento Default Checkout page

3. One Step Checkout page

4. Admin Order page

How to Configure

1. Configuration

From the Admin panel, go to Stores > Configuration > Mageplaza > Multiple Coupons

• Select Enable = Yes to enable the module
• Apply for: Select Page to apply Multiple Coupon
• Coupon Limit Qty:
  • The coupon limit can be used for 1 Cart
  • Please note that with different coupon types, when used at the same time, the coupon is applied in order from the beginning to the end or until the subtotal reaches 0
  • If left this field blank or equal to 0, the coupon number can be used unrestricted

Unique Coupon Code:

• It is helpful to avoid multiple discount coupons used in the same cart as the owner may suffer loss
• When the specific coupon in this field is applied, all other coupons will be canceled (including before or after the unique coupon)
• For multiple coupons, the customer needs to remove unique coupon

2. How to create a coupon

To create a coupon, admin needs to go to Marketing> Promotions> Cart Prices Rule

Please see details guide here

API

Multiple Coupon extension supports API integration with Rest API commands of Magento. By using the available command structures to check the order information, invoice, credit memo, admins can quickly capture the details of an order. See the details about Rest API Magento here

View the supported API from here

The instruction for creating Integration tokens can be seen from here

Multichannel Selling

Overview

Mageplaza Multichannel Selling is a must-have solution for every store that wants to expand the brand exposure, boost sales from all selling channels and become the market leader:

• Speedily upload product feeds to multiple platform with pre-made and auto-generated product feeds
• Send folow-up emails based on various important triggered events and customer-based events
• Flexibly tailor your own email marketing campaigns
• Integrate Instagram to your store with Instagram widgets that show likes and comments
• Keep customers coming back to store
• Build loyaty
• Drive sales ultimately

Download & Install

• Download Mageplaza Multichannel Selling
• How to Install

How to use

This solution contains 3 extensions. Please click on each link to see the User Guide of each extension:

• Mageplaza Product Feed - User Guide
• Mageplaza Follow up Email - User Guide
• Mageplaza Instagram Feed - User Guide

Name Your Price

Overview

When shopping, customers would love to bargain for their favored products. Mageplaza Name Your Price extension can help them gain this little joy. Customers can request a price that he wants to buy for the owner. All requests are sent to the server, and the admin may approve or reject this request according to the suitability of the price offered by the customer. Of course, approve or reject will be notified to Customer by email. When the price is released, Customer will buy the Product at that price for a certain period of time. If you do not like the price that Admin has approved, Customer can completely cancel it and request a new price. However, only the Product installed by the admin can be sent.

• Name Your Price supports these product types: Simple, Configurable, Downloadable, Bundle
• Name Your Price is compatible with Mageplaza One Step Checkout and Mageplaza SMTP.

How to download and install

• Download Mageplaza Name Your Price
• How to Install

How to Use

With this extension, customers can conduct the following actions:

• Send a request quantity and price of products to admin

• Buy with request price for a certain period of time
• Cancel the previously paid price of a product

• Review details of all products that have been successfully bargained

How to Configure

From the Admin panel, go to Marketing > Name Your Price

1. Configuration

1.1. General Tab

• Enable: Select Yes to enable the extension
• Customer Group: Only selected customer groups can send requests to the store admins
• Apply for: Products that meet the conditions here will display the Price Bargain button for the Customers to send the request to the store owner.
• Bargain Price Type: set the lowest price calculation type that Customer can give to admin, includes:
  • Fixed Price: The lowest price is a fixed price admin set. All bargain products chosen will be applied to this fixed lowest price.
  • Percentage of Original Price: The lowest price is taken as the percentage of the original price of each Product. All products that are applied may have different lowest prices.
• Min Bargain Value: Set the value of the lowest bargain price
  • Fixed Price: The value filled in this field will be the lowest bargain price for all products. The price unit bases on the Default Display Currency of your site
  • Percentage of Original Price: Fill in the % value. The lowest price is equal to the original price multiply with the % value entered in this section then divided by 100.
• Apply for Tax: If Yes, the approved bargain products can be applied with current discounts(from cart price rules, coupon codes, affiliate policies)
• Allow Using Discounts: Select Yes to allow discounts to be available for the order containing admin approved bargain products
• Bargain Usage Time:
  • Calculated in days
  • During this time, customers will be able to purchase products at the price they requested (as long as the admin has approved request).
  • If empty or 0, there is no time limitation.
• Commit Minimum Quantity:
  • Select Yes to display the Qty Step field when customers request the bargain price
  • Customer is required to buy x items in one cart

1.2 Bargain Form

• Use Popup: Select Yes to use a popup to display the form request
• Additional Fields: The selected fields will be displayed on the front-end, not required to fill in these fields.
• Button Label: Set the label to open bargain price form. Default = Price Bargain.

1.3 Notification Email

• Enable: Select Yes to allow Notification Email
• Sender:
  • Select Email Representative sent to customers.
  • 1 of 5 default Magento representative emails are: Sales Representative, Customer Support , General Contact, Custom Email 1, Custom Email 2
  • To edit Nickname and Email, admin can refer here
• Admin Email:
  • When customers bargain on the product and Submit the request, the notification email will be sent to the admin via this email.
  • You can enter multiple emails here, they must be separated by commas
• Email Confirm:
  • Select the Confirmation email template sent to the customer
  • Confirm email will be sent to customers after they send a bargain request
  • To change Email Confirm Template, Admin can create another Email Template in Marketing> Email Template
  • Instructions for creating new Email Template here.
• Email Approve:
  • Select the Approve email template sent to the customer
  • Approve email will be sent to customers after their bargain request is accepted
  • To change Email Approval Template, Admin can create another Email Template in Marketing> Email Template
  • Instructions for creating new Email Template here.
• Email Reject:
  • Select the Reject email template sent to the customer
  • Rejection email will be sent to customers after their bargain request is rejected
  • To change Email Rejection Template, Admin can create another Email Template in Marketing> Email Template
  • Instructions for creating new Email Template here.

2. Bargain Requests

• Go to Marketing > Name Your Price > Bargain Requests

2.1. Grid

• Grid includes information: Id, Product Name, SKU, Original Price, Bargain Price, Quantity, Status, Customer Name, Customer Email, View Store, Submitted Date, Order’s Id, Action
• Admin can conduct some actions such as Delete, Approve, Reject
• Also, admin can Sort, Filter, Search the Bargain Request.

2.2. Edit Request

• Admin can quickly Approve or Reject a request when editing the request

2.2.1. General tab

• Customer Name: Display customer name submitted. Admin cannot edit this field
• Customer Email: Display customer email. Admin cannot edit this field
• Product Name: Show the Bargained Product name. Admin cannot edit this field
• SKU: SKU of the product. Admin cannot edit this field
• Original Price: Original price of the product. Admin cannot edit this field
• Qty: Quantity of products that customers want to buy with bargain price
• Bargain Price:
  • The price that customers want to pay for the product.
  • Admin has the right to edit the price if it is not appropriate.
• Store view: Display store view - where the customer submits the request. Admin cannot edit this field
• Submitted Date:
  • The date when the customer sends information to bargain for his product.
  • This field is not allowed to edit.
• Status:
  • Show the status of Bargain Price.
  • Pending: Admins are review and not yet accept the bargain price.
  • Approved: Admin approved the bargain price from customers. They can buy the products with bargain price in the specific time allowed
  • Rejected: Admin does not agree with bargain price. Customers cannot buy products at that price
  • Reject by customer: When customer cancel Request
  • Closed: when Request has expired
• Order’s Id:
  • Display the order ID of purchased products with bargain price
  • Not displayed if the customer has never had an order with the product above.

2.2.2 Message

• Customer’s Message:
  • Display the message of the customer along with bargain products
  • Admin cannot edit the message
  • These Messages are displayed in Frontend
• Admin’s Response:
  • Display Admin Reply to customers’ messages
  • The admin’s response will be included in the email to notify the customer when the admin clicks on Save & Approve or Save & Reject
  • These responses are displayed in Frontend

Order Archive

Overview

Every day in online stores, there are many orders placed and processed, Magento’s default Order Management Grid quickly becomes cluttered and difficult to control. Therefore, Admin must spend a long time to manage orders in his store. Mageplaza Order Archive extension makes it possible for the admin to- manually or automatically- transfer orders in different states to the order storage (Order Archive), making order management easy and convenient. Admin will receive an email notification whenever the order is archived according to schedule. The order has been stored or not displayed in the Customer’s Account, depending on the settings by admin. Furthermore, admins can also use the API to manage archived orders.

In addition, this extension is fully compatible with the Mageplaza Delete Order extension, admins can delete the order even after it has been archived.

How to download and install

• How to Install

How to use

• Admin can transfer orders from the Grid order by default to the Grid Order Archive, perform mass actions like the default Grid Order
• Set the time to store orders automatically
• Edit, turn off the feature Send email notification when the order is archived according to schedule
• Check API
• Use the Command line

How to Configure

1. Configuration

From the Admin panel, go to Stores> Configuration> Mageplaza> Order Archive

1.1. General Configuration

• Enable: Select Enable = Yes to enable the module
• Show Archive Order for Customer(s): Select No to have the orders transferred to the Archive be hidden from My Orders in Customer’s Dashboard

1.2. Schedule Configuration

• Includes settings related to automatic order storage. An order is only stored in schedule when and only if it satisfies all the conditions on Purchase Date, Order Status, Customer Group, Store View, Shipping Country and Order Total
• Schedule For:
  • Set the cycle automatically according to daily, weekly or monthly
  • With Weekly, schedule will run automatically on every Monday
  • With Monthly, schedule will run automatically on the 1st of every month
• Start Time:
  • Set the automatic storage time of each cycle
  • By that time of day, the schedule will be run automatically
• Excluded Period:
  • Set the time interval for automatic schedule application
  • The orders calculated from the moment the current number of days back and forth will be converted to Archive
  • For example, Period = 10, today is December 31st, 2018, all orders created from December 21st, 2018 and earlier will be transferred to Archive (if they meet the conditions below)
• Order Status:
  • Satisfactory orders can be archived automatically according to schedule
  • When selecting Please Select, no order can automatically be archived
• Customer Group(s): Automatic Schedule applies only to orders purchased by customers of the selected Customer group
• Store View(s): Select Store view where the order is placed
• Shipping Countries:
  • All Countries: Check all Orders
  • Specific Country: Check for orders with Shipping Address at Country selected
• Order Total less than: Order’s Maximum Total Paid
• In addition to the way the schedule is run automatically, Admin can also click the Run Manually button to store orders that meet conditions whenever they want.

1.3. Email Notification

• Enable: Select Yes to enable email sending feature to admin every time an order is stored (including manual or automatic storage)
• Sender: There are 5 default types of Magento Sender for Admin to choose: General Contact, Sales Representative, Customer Support, Custom Email 1, Custom Email 2
• Email Template:
  • This extension supports email to informs admin when the order is archived
  • To change Email Template, admin can create another Email Template in Marketing> Email Template.
  • Instructions for creating new Email Template here
• Send To:
  • The chosen emails will receive a notification when the Archive is ordered
  • Each email is separated by commas (,)

2. Order Archives Grid

• Similar to the default Magento Grid Order, the Order Archives Grid also has basic features such as Filter, Add Columns or Export and View Order
• In Grid, Admin can perform 3 main actions
  • UnArchive: The selected orders will be transferred to the default Grid Order
  • Delete: The selected Orders will be deleted from the database. This feature only works when the store owner installs the Mageplaza Delete Order module
  • View: The Detail Order page will be displayed

3. Command line

Admins can use the following command to archive or unarchive any order that they want:

php bin/magento order:archive order_id
php bin/magento order:unarchive order_id

4. API

Order Archive features API integration with the Rest API commands of Magento. By using the available order structures to check the order information, invoice, credit memo of the order, the admin can quickly capture the details of an order. Details about Rest API Magento here

Instructions for using Postman to check order information with API

Step 1: Get Access Token

• Log in to Postman, in the Headers section select Key = Content-Type, Value = application/json
• At Body tab, insert {"username": "demo", "password": "demo123"} with demo/demo123are username/password to login to your backend
• Use the Post and Send method with the following command: http://example.com/rest/default/V1/integration/admin/token

• Access Key will be displayed in the Body section

Step 2: Use the REST API commands of Magento

• Open a new tab, at the Headers enter 2 Key:
  • Authorization: bearer access_token
  • Content-Type: application/json

• Send REST API command

• Result:

5. Notification Email

Order Attributes

Overview

When shop owners understand more about customers, it’s easy to increase sales and handle fast for their stores. Mageplaza Order Attributes extension allows admins to add custom fields to the checkout page. It helps the store owner to easily collect more information and increase customer satisfaction. This module provides a variety of custom fields such as Text Field, Text Area, Date, Yes/No, Dropdown, Single-select With Image, Multiple Select with Image, Single File Attachment, Content. Order Attributes will be managed easily on the grid order. Admins can also restrict them to customers group or store views.

Order Attributes is also displayed when admins creates the order in the backend.

Download and Install

• Download Mageplaza Order Attributes
• Installation Mageplaza extension

How to configure

From the Admin Panel, go to Sales > Order Attributes

1. Configuration

From the Admin Panel, go to Sales > Order Attributes > Configuration

General Configuration

• Enable: Choose Yes to use this module

Checkout Configuration

• Date Format: Select the date format for attributes with Date or Date & Time type to show attributes on frontend.
• Time Format: Select the time format for attributes with Time or Date & Time type to show attributes on frontend.

PDF documents

• Display Order Attributes on Shipment: Select Yes to show Order Attributes info in PDF Shipment file when choosing to Print Shipment.

• Display Order Attributes on Invoice: Select Yes to show Order Attributes info in PDF Invoice file when choosing to Print Invoice.

2. Manage Attributes

2.1. Grid

• This is a place to store all created Order Attributes
• From the Grid, admins can capture the basic information of Attribute such as: Default Label, Attribute Code, Type, Required, Position, Store View, Customer Group, Sort Order, Create At, Updated At and Action.
• To delete the Attribute, admins need to edit the attribute and click Delete
• In addition, admins can Filter, Change Store View, hide/show the Columns

2.2. Add New Attribute

2.2.1. Properties

• Default Label: The default display name for Attributes in the Grid and Frontend
• Attribute Code:
  • Enter the Attribute code. Admins can use Attribute code to add some templates such as Order, Email, …
  • Make sure you do not use spaces or more than 30 symbols.
  • If leaving this field, it is based on the Default Label field.
• Input Type: Select input/select data type. There are 11 input types that admins can choose

• Text: The input type is a text line (not downstream).

• Text Area: The input type is a text. Customers can enter multiple lines of text in this field

• Date: This field has the format as Date. When accessing the checkout page, the field is assumed to be the current date.

• Date & Time: This field has the format as Date and Time

• Time: This field has the format as Time

• Yes/No: The field only includes 2 options as Yes or No.

• Dropdown: The field has the format as Dropdown. Customers are only selected one of the options that admin has set in the backend

• Checkbox/Multi-Select: The field has the format as Multiple-Select. Customers can choose one or more options that admins have set in the backend

• Radio/Single-select with image: Customers only choose one of the Images/Colors that admins have set

• Multiple-select with image: Customers can choose one of the Images/Colors that admins have set

• Media Image: Customers can upload the image file (only include the image file, not docs file or PDF files, etc) that they want. Besides, it is possible to limit file upload size in Maximum File Size and file upload format in Allow File Formats
• Single File Attachment: Customers can upload the attachment that they want. Besides, they can limit file upload size as well as file upload format by respectively filling in it in Maximum File Size field and Allow File Formats field.
• Content: Customers can insert the image and enter the text as well as edit them with ease.

• Static Block: Show attributes having block format. Show extra field:

  • Select CMS Block: Select blocks to display in orders.

  

• Default Value:

  • Only display with the Input Type as Text Field, Text Area, Date, Yes/No, Content, Time, Date, Date & Time
  • This value will be displayed as the value of the field if the attribute is displayed in the Frontend

• Minimum Text Length:

  • The minimum length for the text
  • Shows when the Input Type is Text Field and Text Area

• Maximum Text Length:

  • The maximum length for the text
  • Shows when the Input Type is Text Field and Text Area

• Minimum Value:

  • The minimum value
  • Shows when the Input Type is Date, Date & Time, Time

• Maximum Value:

  • The maximum value
  • Shows when the Input Type is Date, Date & Time, Time

• Values Required:

  • Select Yes to force the users to enter a value for the field
  • Not displayed with Input Type = Media Image and Single File Attachment

• Input Validation:

  • Only show when Input Type = Text Field
  • Stipulate the values that are accepted in this field, which is one of the following values:

• Input/Output Filter:
  • Show when Input Type = text field, text area
  • It has the benefit as aiming to the HTML values that customers can enter the field
  • There’re 3 options:
    • None: Ignore the check HTML, allow HTML tag that can work

For example: test

HTML

is transformed into:

• Strip HTML Tags: Remove the HTML tags that include in the field

For example: test

HTML

is transformed into:

• Escape HTML Entities: Encode the HTML tags that include in the field

For example: test

HTML

is transformed into:

• Add to Sales Order Grid: Choose Yes so that the attribute is displayed in the grid at Sale > Orders
• Add to PDF Files:
  • Show the compatiblity with Mageplaza PDF Invoice extensions (only apply for PDF Order)
  • You can refer the guide here
• Add to Confirmation Emails:
  • Show to insert Order Attribute to the email confirm order
  • You can refer the guide here

2.2.2. Frontend Properties

• Position: We support 7 positions that can display Order Attribute:
  • None: Order Attribute doesn’t show on the Frontend and in the Backend
  • Shipping Address
  • Shipping Method Top
  • Shipping Method Bottom
  • Payment Method Top
  • Payment Method Bottom
  • Order Summary
• Use Tooltip:
  • Select Yes to display the Tooltip instructing the customers enter a value in the Field
  • Admins need to enter the Tooltip in the Manage Labels/Options so that the tooltip is displayed on the Frontend
• Store View: The attribute is only displayed in the selected Store View
• Customer Group: The attribute is only displayed to the Customer in the selected group
• Add to Sales Order View: Select Yes to display the Attribute at the Order of the Customer. Customers can check the content of the attribute that was filled after placing order.
• Sort Order:
  • Set the display order of the Attribute
  • 0 is the highest position
  • Admins need to pay attention when placing this dependency on another Attribute. It is possible that the attribute child will be displayed on the Attribute parent

2.2.3. Manage Labels/Options

• Manage Labels:
  • Set the display name outside the frontend for the Attribute in each store view
  • If leaving this field blank, the Default Label is populated in the Properties tab
• Manage Tooltips:
  • Set up short instructional content of Attribute for Customer in each store
  • mIf left blank, the tooltip is not displayed on the Frontend
• Manage Options:
  • Only display with Input Type = Dropdown, Multiple Select, Single-select with Image, Multiple-select with Image
  • Admin can add options for Attribute in each store view for Customer to choose
  • Image is only displayed with Input Type = Single-select with Image, Multiple-select with Image. Admin can choose color or upload image for option

2.2.4. Depend Attributes

• Select an attribute with drop type, Single-select with Image to parent field. Parent Field options are automatically loaded into Depend on options
• Attribute editing is only displayed when Customer selects the option selected in Depend on options. Admin can install depend on many options
• In addition, Attribute can also depend on one or more shipping methods
• When the Attribute has been added to another Attribute, just depend on the Shipping method, make sure the 2 dependents are selected so that the attribute is displayed.
• Depend on countries: Select one or multiple countriles to display attributes when customers make orders. Attributes will depend on each selected country. This extra field will be shown:
  • Countries: Select countries to apply attributes display. If left empty, will show attributes for all countries.

3. API

Mageplaza Order Attribute supports the use of API to get order attribute information, order information, fullfil attributes in order, upload file for order attributes which allows file to be uploaded.

View supported request here

See how can you create token-based authentication here

4. GraphQL

4.1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-order-attributes-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

4.2. How to use

Order Attribute GraphQL by Mageplaza allows you to get order attribute information, save ordr attribute when customers order via GrapQL

Note: To start using GraphQL, you need to return your site to developer mode and uee Magento 2.3.x

Check supported GraphQL request here

5. Manage Checkout Step

5.1. Grid

• This is where created steps are stored.
• In the Grid, admin can have basic information of some steps such as: Name, Code, Position, Store View, Customer Group, etc.
• Besides that, admin can delete, edit, filter, change store view, hide/show the columns for those steps. Click Create New Form button to create a new step.

5.2. Add New Order Form

5.2.1. General

General Information

• Name: Enter the name of the Step to show in the Position field when creating attributes and on the frontend when ordering. This is a compulsory field.
• Code: Enter the code for the Step. This is for internal use, must be unique with no spaces, and the maximum length of attribute code must be fewer than 60 symbols. This is a compulsory field.
• Status: Select Enable to display step in the Position field when creating attributes and on the frontend when ordering. This is a compulsory field.
• Icon Type: Select the icon type to show next to the step during checkout or on the One Step Checkout page by Mageplaza. There are 2 types:
  • Font Awesom: Show the extra Icon field yo enter the Class name of the icon. Please refer to these icons here
  • Custom: Show the extra Icon field to upload any image file you want. Click Choose File button to upload file and Delete to delete the image.

5.2.2. Condition

Select the condition to display steps when ordering. In the steps there can be different attributes, and if the conditions to display steps are not satisfied, the step will not be shown, and the attributes of that step will not be shown as well.

5.2.3. Frontend Properties

• Store View: Select the store view to show the step.
• Customer Group: Select the customer group to show the step to specific customers of the group chosen when ordering.
• Position: Select the position to show the step, including:
  • None: Not display the step on the frontend when ordering, even when all step conditions are satisfied.
  • Before Shipping Step: Display the step before the Shipping step. The extra depend field Sort Order will be shown to enter the show the step before the Shipping step. Because the Shipping step has the 9th order, please enter any value within [0,9]. The smaller the Sort Order value is, the higher the step is displayed.
  • After Shipping Step: Display the step after the Shipping step. The extra depend field Sort Order will be shown to enter the show the step before the Shipping step. Because the Shipping step has the 9th order, please enter any value within [11,19]. The smaller the Sort Order value is, the closer to the shipping step it is.

Frontend

1. Checkout page Magento

2. Mageplaza One Step Checkout

3. Display attributes in Step

• Checkout Page:

• One Step Checkout Page:

Order Export

Overview

Mageplaza Order Export extension can make the export process automatically with the information as orders invoices, credit memos, shipments based on Cron scheduler. It allows you to export profiles to file formats such as CSV, XML, Excel XML, TXT, TSV, and Json. Available additional Magento 2 objects for export include: Order, Invoice, Credit Memo, and Shipment. Profile after you generate will be sent to the server by FPT/sFPT or sent to any email that admins want. Besides that, this helps you to save more time and money to quickly export the profiles. This extension promises to be the best exporting solution for Magento shop owners. Mageplaza Order Export is definitely a must-have tool of your Magento store.

How to configure

From the Admin Panel, go to Sales > Order Export

Admins can export the profile by 4 ways:

1. Manual: Go to Manage Profiles > Edit Profile, Click Generate. After the file is generated, go to Donwload link to download file
2. Cron: Profile is generated based on Cron: After a long time, profile will auto-generate the file content. After refresh, go to Download link to download file
3. Quick Export: Easy to export quickly order/invoice/memo/shipment in Sales > Order/Invoice/Memo/Shipment
4. Command: Use the command: php bin/magento orderexport:generate. After the profile is generated the content, go to Download link to download file

1. Configuration

Go to Sales > Order Export > Configuration

• General:
  • Enable: Choose Yes to enable this module and display in the Sales section
  • Log Cleaning Automatically after(Day): Enter the number of days after which the old logs will be cleaned. If left empty, the email log will not be cleaned.
  • Export Limit: Limit the number of orders that can be exported in a single iteration. If left empty or zero, each export will be 1000 orders in maximum.
• Email Alert:
  • Enable: Choose Yes to enable email notification for store owners
  • Send to:
    • Enter the email to send the notification
    • Allow entering many emails. These emails are separated by commas
  • When:
    • Choose the events that when it occurs, the email notification will be sent
    • Allow choosing many events simultaneously

2. Manage Profiles

2.1. Grid

• This is a place where all the profiles are stored
• From the Grid, admins can capture the basic information of the Profile such as ID, Name, Object, Status, File Type, Run Mode, Created Date, Generated On and Action can be done with Profile.
• In the Actions dialog, admins can perform the following actions:
  • Delete: Admins needs to tick the profile that they want to delete, then select Delete in the Actions (upper left of the Grid) to delete. A confirmation dialog will appear, select OK to continue deleting.
  • Generate: Admins need tick tick the Profile that they want to generate data, then select Generate in the Actions dialog (top left of Grid) to Generate. A confirmation dialog will appear, select OK to confirm the data re-creation. Note that Profiles can be created or overridden on previous generated profiles that depend on the admin’s choice in the profile.
  • Change Status: Admins need to tick the profile they want to change the status, then select Change Status > Enable/Disable1 in the Actions dialog (top left of the Grid) to change. A confirmation dialog will appear, select OK to confirm the change.
• In the Action column, Admins can perform the following actions:
  • Select > Edit: Go to the Edit Profile page to edit the information
  • Select > Download: Download the profile
• In addition, Admins can Filter, Change Store View, hide/show Columns, Export Grid or edit inline.

2.2. Add New/Edit Profile Order form

To create a profile, admins need to do some following steps:

• Step 1: Enter the full information in the General section
• Step 2: Choose the template type
• Step 3: Add the condition for export profile
• Step 4: Set the mothod to send the exported file
• Step 5: Check the update history of the exported file

2.2.1. General

• From the Admin Panel, go to Sales > Order Export > Manage Profiles
• Choose Add New Order
• General Tab

• Fill in the name displaying in the Grid Profile for the export type
• Status: Choose Enable so that Profile can auto-export based on Cron or Command
• File name: Set the file nam when it is exported. File name will be shown as soon as it is downloaded
• Add timestamp to file name: Choose Yes so that when you you download, the file name will auto-add the file downloading time into the file name.

For example: File Name is OrderExport. If Add timestamp to file name = yes, when you download the file, the file name is OrderExport_20181020_132054.xml

• Export Limit: Limit the number of orders that can be exported in a single iteration. If left empty or zero, each export will be 1000 orders in maximum.
• Private Download URL: the system will auto-create Download URL after Save. Download URL will have Secret key if possible. Anyone who has a Private Download Url can download the export file.
• Secret Key: Created a 32 character string when admins click on Reset Key. Secret Key will be automatically added to Private Download Url after Save.
• Number of order exports: After Generate, the system automatically updates the exported order number. These orders must satisfy the condition of the profile.
• Schedule:
  • Auto run profile:
    • Select No to Generate manually (Manual): Admins need to click Generate to export file
    • Select Yes to make the file automatically generate according to the cron schedule set below
  • Cron schedule: Set the interval between each Generate automatically

2.2.2. Template

• Choose the file format. There’re 5 formats: TXT, CSV, XML, Excel XML, TSV (table-delimited)

• Click on the Load Default button to display the template content that we have installed in the Template field. Admins can configure the Template as they want with ease.

• For the file format is XML, Excel XML, JSON:

  

  • Template Content: The template content is shown in this field. Admins can edit the template here
  • Add values to the template by clicking on the Insert Variable button
  • After adding the template content, admins can click Download first 5 items to download the example about the file content

• For file format is CSV, TXT, TSV, ODS, XLSX:

  

  • Export Type:

    • Loop order: If you choose this format, when the file is exported, it will repeat the order with each item as a line

    export type

    • Not loop order: If you choose this format, when the file is exported, it will not repeat the order. Each order is a line, items will be listed on that line

  • To add attributes, admins can click on the Add button and choose Value to add into the template

  • Select the character separating the fields when exporting the file in the Field Separate field

  • Select the character that surrounds the fields when exporting the file in the Field Around By field

  • To get the header field when exporting the file, select Yes in the Include Field Header field

  • Click Preview to see an example of file content

2.2.3. Conditions

• Choose the condition to export the file. Any order that meets the conditions will be exported. If all fields (except Store Views field) are empty, all orders will be exported

• Order Status: The orders with the selected status will be exported

• Customer Groups: Orders placed by selected customers will be exported

• Store Views: The orders placed on the selected Store view will be exported

• Change order Status: After generating profile, the exported orders will change status to the selected item. Admins can go to Sales > Operations > Order to check

• Create From - To: The orders placed during this time will be exported

• Order ID From - To: Orders with IDs in the selected range will be exported

• Export Duplicate: Select No so that the export file overwrites into the old file. However, if the file name has a timestamp add, the file is always created newly.

• Apply the rule only if the following conditions are met (leave blank for all products)

  • Set the conditions to apply the rule

  

2.2.4. Delivery

• Upload to a remote server:
  • To export the exported file to the server, select Yes in the Delivery field
  • Select the file sending the file in the Protocol field: FTP or SFTP
    • For FTP protocol, there is an option to use Passive Mode. We recommend that you choose this mode to avoid being blocked by firewalls/NATs/proxies from sending files to the server.
  • Enter the host name in the Host Name field
  • Enter the host name in the User Name field
  • Enter the password to access the host in the Password field
  • If you want to save the file where to enter the path in the Directory Path field.
  • To check whether it is connected to the host, press Test Connection

• Email:

• Select Enable so that Admins can receive email with attached export file when the profile is delivered
• Admins can select one of 5 available Magento Senders to be the sender, including: General Contact, Sales Representative, Customer Support, Custom Email 1, Custom Email 2
• Email Subject: Fill the subject for email
• Send Email To: Enter the email that admins want to receive notification when uploading file to the error remote server. You can enter multiple emails separated by commas ,
• Email Template:
  • Extension is pre-installed Email notification
  • To change Email Template, Admins can create another Email Template under Marketing > Email Template.
  • How to create a new Email Template here
• HTTP Request

• Choose Enable = Yes to send the file by HTTP Request via URL that is filled below
• Admins can add Headers to clarify about HTTP Request

2.2.5. History

• Check the update history of exported files. Admins can check the update history of the file in Logs.

NOTE: Creating Profile of Invoice, Credit Memo, Shipment is similar to create profile of Order. However, they don’t have change Order Status section.

3. Manage Export Logs

This section will record all changes of profiles as status, type, notification, etc. When licking on any file, it will auto-download the file.

4. Quick Export

• To export quickly, admins need to create a profile for the object they want to export (Order, Invoice, Memo, Shipment)
• Admins can export any order they want without caring to the condition of the Profile
• The exported file will retrieve the type and template from the selected profile.

5. Email Notification

5.1. Email notification about Generate/Delivery successfully or fail

5.2. Email notification when sending the exported file uploaded successfully

Order History

Overview

Normally, it is very time consuming and complicated for admin to be able to monitor and manage each customer’s order. But with the Mageplaza Order History extension, it is completely easy and convenient. The module allows to add statistics of ordered products by customers, hide/ show order statistics by product on Product Edit page. In addition, the module can export data in CSV and Excel XML format. The Mageplaza Order History extension is fully compatible with Mageplaza Delete Orders, enabling the admin to manage and delete orders quickly.

How to download and install

• Download Mageplaza Order History
• How to Install

How to Configuration

From Admin Panel, go to Stores > Settings > Configuration> Mageplaza Extensions > Order History

1. Configuration

From the Admin Panel, go to Stores > Setting > Configuration > Mageplaza Extensions > Order History, select General

• Enable: Select Yes to turn on the Module.
• Show Item Details at the Order tab: Select Yes to display the product details purchased by the customer on the Orders tab in Customer Detail Backend.
• Show Ordered Products History on Customer Details Page:
  • Select Yes to display the Order Product History tab which shows a list of products that this customer has purchased, each product is on one row.
  • If the order has many product types, when displayed in the table, it will divide the cart into multiple rows, one for each type of product, and they have the same Order ID number.
• Show Related Orders History on Product Edit Page: Select Yes to display the Order History tab which shows order data by product on Product Details Page.

2. Orders tab on Customer Details Page

From the Admin Panel, go to Customers > All Customers > Edit Customers> Order

• Here shown successfully ordered products.
• From the table, admin can capture the following information: ID, Purchase Point, Purchase Date, Bill-to Name, Ship-to Name, Grand Total (Purchased), Status, Action, Item Detail (Name, SKU, Qty, Item Status).
• In addition, admin can also filter, export order data in two forms, CSV and Excel XML.
• Below is the information exported from the grid:

3. Ordered Produce History tab on Customer Details Page

From the Admin Panel, go to Customers > All Customers > Edit Customers > Ordered Products History

• Here shown the purchased products information. Admin can save and export this data.
• From the grid, admin can capture the following information: Order ID, Order Status, Product Name, Product SKU, Qty, Discount, Item Status, Order Total.
• When you click on any product, you will be redirected to the product details page.
• In addition, admin can Sort, Filter, Search, Export order data in two forms, CSV and Excel XML.
• The exported data is shown below:

4. Related Orders History tab on Product Edit Page

From the Admin Panel, go to Catalog > Products > Product Edit > Related Orders History

• Here saved the orders by products
• From the table, the admin can capture the following information: ID, Status, Purchase Point, Purchase Date, Customer Name, Customer Email, Original Price, Order Price, Qty, Grand Total (Purchased), Action.
• Action:
  • View: Displays the detailed order information of the customer.
  • In addition, admin can Sort, Filter, Search, Export order data in two forms, CSV and Excel XML
• The exported data is shown below:

Order Labels

Overview

Mageplaza Order Labels extension allows admin to create and customize the labels of order columns, sort orders in Order Grid explicitly, thereby easier to manage orders. With this module, admin can not only use an image or text to display the label but can also use a combination of both. In addition, this module also supports manual assignment or automatic labeling of orders. Moreover, this module also displays and allows for Label editing in both Order Grid and Order Form. In particular, it improves the Order Status display section and allows it to be displayed at Frontend so that customers can quickly know how their order is in status.

How to download and install

• Download Mageplaza Order Labels
• How to Install

How to Configure

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Order Labels

1. Configuration

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Order Labels > General Configuration

• Enable: Select Yes to enable the Order Labels module.
• Label’s Columns: These are columns containing Label. There must be at least one column for a label.
  • Name: The name of the column containing Label. This is a required field.
  • Is Multiple: If you choose Yes, you can display many types of labels on a column for an order.
  • Show on Grid: Select Yes to display Column to Order Grid
  • Show on Form: Select the option to display Column to Order Form
    • Show on Form = Alway: Always display Column to Order Form
    • Show on Form = Only has label: Only when Label is available for Column, will it display Column to Order Form
    • Show on Form = No: Do not display Column to Order Form
• Skip Manually-added Order Labels:
  • If Yes is selected, the label has been manually added will not be affected by Auto-set labels.
  • If No is selected, manually added labels can still be deleted if the order status is unsatisfied the conditions of Auto-set labels.
• Auto-set Order Labels: Click Run to allow auto-set labels for columns at order grid.

2. Management Grid Labels

From the Admin Panel, go to Sales > Order Labels > Order Label

• This is where the Order Labels are displayed
• From Management Grid Labels, admin can view basic information of Order Labels such as ID, Name, Column, Enable / Disable, Sort Order, Action
• Action:
  • Delete: Delete Order Labels
  • Edit: Choose Edit will redirect to the previously created Order Label page.
  • Create New Label: Create a new Order Label
• Also, Admin can Filter, Sort, Search Order Labels

3. Create / Edit Label

From the Admin Panel, go to Sales > Order Labels > Order Label > Add New Label

3.1. General

From the Admin Panel, go to Sales > Order Labels > Order Label > Add New Label, select General

3.1.1. General Tab

• Name: Enter a name for Label, this is a required field
• Code: This is the code/symbol for Label.
• Enable: Select Yes to enable Label display on the column.
• Select Column: Select the column to display Label. The column list is taken from the Configuration section
• Sort Order: Shows the display priority of this Label compared to other Labels in a column if Is Multiple in the Configuration section is enabled.

3.1.2. Display Tab

• Display on: Choose a position to display Label. There are two options that are on Admin Grid and Admin Form
• Display Type: Select Label display type, there are 4 choices.
  • Image Only: Only displayed in image format
  • Text Only: Only displayed in text
  • Image + Text: Displayed in images and followed by text
  • Text + Image: Display in text and followed by images
• Select Image: Select the image to represent Label. It is recommended that you use a picture of 150x50 px size. Or you can use the icon suggested here.
• Background Color: Select the background color for Label.
• Text Color: Choose colors for text.

3.2. Auto Assign Condition Tab

From the Admin Panel, go to Sales > Order Labels > Order Label > Add New Label, select Auto Assign Condition

• Auto Assign Label: Select Yes to enable the auto-tagging function for the Order that meets the selected condition.
• We will choose the condition to automatically assign this Label to the order that meets the selected conditions. These conditions are taken from Mageplaza Order Attributes module. You can see how to install and use the Order Attributes module here.

4. Order Status

4.1. Order Status Grid

From Admin Panel, go to Stores > Setting > Order Status

• This is where the list of order status is displayed.
• From Order Status, admin can easily grasp basic Order Status information such as Status, Status Code, Default Status, Visible on Storefront, Display, Action
• Action:
  • Unassign: Unassign Status.
• Also, Admin can Filter, Search Order Status.

4.2. Create New/Edit Order Status

• From Admin Panel, go to Stores> Settings> Order Status> Create New Order Status
• If you want to Edit an order status, you just need to click on that Order Status and start editing the information.

4.2.1. Order Status Information

• Status Code: Enter the Status Code. This is a required field.
• Status Labels: Enter the Status Labels. This is a required field.

4.2.2. Store View Specific Labels

Select Store View to apply Label

4.2.3. Display

• Use Custom: Select Yes to allow Customization. Otherwise, if No is selected, the following fields will not be shown.
• Apply on: There are three options to display Order Status: Admin Grid, Admin Form and Frontend Order View. This field depends on Use Custom = Yes
• Display Type: Select Label display type, there are 4 choices. This field depends on Use Custom = Yes.
  • Image Only: Only displayed in image format
  • Text Only: Only displayed in text
  • Image + Text: Displayed in images and followed by text
  • Text + Image: Display in text and followed by images
• Select Image: Select an image to represent Status. This field depends on *Use Custom = Yes.
• Background Color: Select the background color for the Status name. This field depends on Use Custom = Yes.
• Text Color: Choose colors for text. This field depends on Use Custom = Yes.

5. Order

From Admin Panel, go to Sales > Operations > Orders

5.1. Order Grid

From Admin Panel, go to Sales > Operations > Orders

• Label’s status will be displayed in the column in the Order Grid.
• When we click on Label or Add Label a popup will appear and we can edit Label right here.

5.2. Order View

• From a record of an Order, in the Action column, click on View to see Order information. Select Information.

• On the Information tab, you can see Label information there. If you want to update the status of the Label, click “Update Labels” and edit.

Frontend

• Order Label is in the Order list

• Order Labels are in the order detail form

Pay360

Overview

Pay360 by Capita has been providing secure payment services for over 20 years. Mageplaza Pay360 extension helps stores in integrating Pay360 to support online payment using cards in multiple countries. Trussted by large and small brands, this extension allows customers to experience a smooth payment process on all payment channels.

Mageplaza Worldpay (Pay360) extension is fully compatible with Mageplaza One Step Checkout.

Download and Install

• How to download Pay360 extension
• How to install Mageplaza extension

How to use

1. Pay360

Go to Sign up to register an account for Pay360.

After creating an account successfully, an email with the sign-in information to log in Pay360 Explorer will be sent to the email you used to register the account.

• Copy API User Name, API Password, Hosted Cashier to fill in the Configuration section (will be guided in the How to Configure section).

2. Display Checkout

• Click on Redirect to Pay360 Hosted button to be redirected to the payment card details page.

• Fill in information and click Pay Now to be redirected to the payment confirmation page.

• Click Authenticated to take the final step to authenticate your payment. After the payment is completed successfully, you will be taken to the Order Success page.
• You can check the payment by some sample cards as following:

Test card numbers

Only the following credit/debit card numbers may be used for test payments in the test environment. When using test cards, you can specify an expiry date up to seven years in the future. The test cards do not have a card verification code or an issue number. Find more details here

CARD TYPE	NUMBER
MC_DEBIT	9900000000005159
MC_CREDIT	9901000000005133
VISA_DEBIT	9902000000005132
VISA_CREDIT	9903000000005131
AMEX	9905000000005139

How to Configure

Log in to the Magento Admin, choose Stores > Configuration > Sale > Payment Methods

• At Pay360 Payment Method, click Configure:

1. Credentials

Login to the Magento Admin, choose Stores > Configuration > Sale > Payment Methods. At the Pay360 Payment Method, click Configure > Credentials:

• Environment:
  • Admin can choose Sandbox environment to check payment features of methods.
  • When you want to apply for online payment, admin needs to change the environment to Production.
• API Username:
  • Copy API Username above and paste it here.
  • If left blank or incorrectly entered, the payment method will not be connected.
• API Password:
  • Copy API Password above and paste it here.
  • If left blank or incorrectly entered, the payment method will not be connected.
• Hosted Installation ID:
  • Copy Hosted Cashier above and paste it here.
  • If left blank or incorrectly entered, the payment method will not be connected.

2. General Settings

Login to the Magento Admin, choose Stores > Configuration > Sale > Payment Methods. At the Pay360 Payment Method, click Configure > General Setting:

• Show Pay360 Logo: Select Yes to show the Pay360 logo on the payment page.

3. Pay360 Cards

Login to the Magento Admin, choose Stores > Configuration > Sale > Payment Methods. At the Pay360 Payment Method, click Configure > Pay360 Cards:

• Enable: Select Yes to enable using the Worldpay Cards payment feature.
• Title: Enter the title of the method. The name of the payment method will be replaced displayed on the checkout page.
• New Order Status: Select status when customer order succeeds:
  • Processing: Display status with Processing when order is successful. You can change the status in the backend with each order.
  • Suspected Fraud: Displays status with Suspected Fraud when order is successful. You can change the status in the backend with each order. With this status admin can accept payment or reject payment and then transfer status to Processing.
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the order is placed successfully. At that moment, the customer’s card will be applied for the order and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates an Invoice for customer’ s order. When the Invoice is successfully created, admin can receive money from customer’ s card.
• Payment from Applicable Countries:
  • Select the All Allowed Countries to apply Card payment methods in all countries
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries will be allowed to apply the Card payment method.
• Minimum Order Total:
  • Enter the minimum amount of order which allow applying specific payment by Worldpay Cards.
  • If the order amount is smaller than the value in this field, the payment method will not be displayed.
• Maximum Order Total:
  • Enter the maximum amount of order which allow applying specific payment by Worldpay Cards.
  • If the order amount is greater than the value in this field, the payment method will not be displayed.
• Debug Mode:
  • If select Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Choose the display position of this payment method compared to other payment methods
  • 0 is the largest number. The smaller the number, the more priority will be displayed in the first position.

4. Order Frontend

5. Compatible One Step Checkout

Payment Restriction

Overview

In practice, shop owners often want to limit the display of Payment Method based on multiple criteria such as Customer group, Cart condition, product attribute, time limit, or the compatibility with sales rule. Thanks to Mageplaza Payment Restriction extension, you will be able to achieve this and fully control the use of in-store payment methods and improve efficiency.

This extension is totally compatible with Mageplaza One Step Checkout.

Download and Install

• Download Payment Restrictions
• Install Mageplaza extension

How to configure

1. Configuration

From the Admin Panel, go to Sales > Payment Restriction > Configuration, choose General Configuration section.

• Enable: Choose “Yes” to enable the features of this module

2. Manage Rule

2.1. Grid

From the Admin Panel, go to Sales > Payment Restriction > Manage Rules.

• This section will record all created rules with the basic information as Name, Status, Method, Store view, Customer Groups, etc
• Admins can perform some actions:
  • Delete: Choose the rule you want to delete
  • Change status: Tick to choose the rule that you want to change the status, choose “Running” to use the rules
  • Edit: Click on “edit” button onn any rule you want to edit the content
  • Also, admins can filter, change the store view, hide/show the grid and they can click on Add New button to create a new rule

2.2. Create New Rul

How to Create New Rule

From the Admin Panel, go to Sales > Payment Restriction > Configuration, choose Add New button in the right corner

2.2.1. General

• Name: Set the name of the name
• Description: Enter the description for the rule
• Status: Choose “Enable” to apply the rule
• Store View(s):
  • Choose Store view, rules will be redirected to display on the selected store. Only apply the rule for the products on the selected stores.
  • Multiple store views can be selected at the same time to display the rule
• Customer Group(s): Choose one or many customer groups at the same time to use the rule. The unselected customer groups won’t be applied the rule
• From: Click on Calendar box to choose date/month/year. The rule will start from date/month/year you have chosen.
• To: Click on Calendar box to choose date/month/year to finish applying the rule
• Select Day(s): Choose the days in week. The rule will be applied for the days in week with date/month/year you have chosen. The remaining days won’t be applied the rule
• Time from:
  • Select the hours of the day to start applying the rule.
  • For countries located in different time zones, they will be applied according to the hours configured for those countries. For example, Viet Nam is in GMT +7, America is in GMT -5. Time from is 8.00 AM, then 8.00 AM in Viet Nam and 8.00 AM in America will start applying the rule when customers purchase.
• Time to:
  • Choose the hours of the day. The rule will finish diplaying at the time you have chosen.
  • For countries located in different time zones, they will be applied according to the hours configured for those countries. For example, Viet Nam is in GMT +7, America is in GMT -5. Time To is 6.00 PM, then 6.00 PM in Viet Nam and 6.00 PM in America will not apply the rule when customers purchase.
• Priority:
  • Enter the priority for the rule
  • The smaller the number of the rule priority, the higher priority. O is the highest priority.

2.2.2. Conditions

Apply the rule only if the following conditions are met (leave blank for all products)

• Set the conditions to apply the rule. All products that meet the conditions will be applied the rule

Apply the rule depending on Cart Price Rules (This will override the conditions above)

• Active if these Cart Price Rules are applied:
  • Select created the rule in the Cart Price Rules to activate the rule for Payment.
  • Multiple rules can be selected at the same time.
  • If customers use a coupon or purchase and satisfy the condition of the selected rule in the Cart Price Rules, this rule will be applied to the Payment without checking the applicable conditions of the selection above.
• Inactive if these Cart Price Rules are applied:
  • Choose the created rule in the Cart Price Rules to activate the rule for Payment.
  • Multiple rules can be selected at the same time.
  • If customers use a coupon or purchase and satisfy the condition of the selected rule in the Cart Price Rules, this rule will not be applied to the Payment Restriction without checking the applicable conditions of the selection above.
  • If one or more rules is selected at the same time in the both Active if Cart Price Rules applied and Inactive if Cart Price Rules applied fields, then in the Inactive if Cart Price Rules field, the rule that is applied for Payment will be checked based on the feature of Inactive if Cart Price Rules applied field.

2.2.3. Actions

• Select Payment Methods: Choose the payment method to apply the rule. You can choose more or all payment methods to show all Enabled Payment Methods
• Action: Choose “Show” to display the selected payment methods
• Apply for: You can choose the position to apply the rule on:
  • Backend Order
  • Frontend Order

Payment Suite

Overview

Mageplaza Payment Suite is a solution that help you to fully controll the payment process on your store:

• Add extra fees/payment surcharges (e.g.insurance service, gift wrapping,etc,) to the checkout page.
• When customer checkout, they can choose these services. Doing this way, you can both please your customers and earn more money by add-on ones.
• Restrict payment methods with specific conditions of cart, customer groups, shipping methods, product attributes combination.

Download & Install

• Download Mageplaza Payment Suite
• How to Install

How to use

This solution contains 2 extensions. Please click on each link to see the User Guide of each extension:

• Mageplaza Payment Restriction - User Guide
• Mageplaza Extra Fee - User Guide

Product Attachments

Overview

With attachments that admins have installed on the product, Mageplaza Product Attachments Extension allows users to get the full information about the product they are interested in with ease. Depending on admins that customers can view online or download files, and also log the view/download actions that customers have done. Product Attachments module supports admins to upload many types of files and the unlimited number of attachments for each product. This is a great tool helping your store better than ever.

Download and Install

• Download the extension
• Installation guide

How to use

• Product Attachments can display on some following positions:

  • Product Tab

  

  • Under “Add to Cart” button

  

  • Sidebar

  

  • Some different positions according to Widget or Snippet

• Customers can perform two actions:
  • View Online
  • Download File

How to configure

Login to the Magento Admin, choose Catalog > Product Attachments

Admins can add an attached file for the Product in 2 ways:

• Create a file at the Manage General File. It’s so quick and convenient if you want to apply an attached file for many products.
• Create a file at Catalog > Product (Grid or Edit Product): This way will help admins add various files for various products.

1. Configuration

From the Admin Panel, go to Catalog > Product Attachments > Configuration

1.1. General

• Enable: Choose Yes so that this module can work well
• Block Title:
  • The content displayed on this field is the title of Attachment block
  • The title is displayed on the Frontend
• Show On: Admins can choose many positions to display Product Attachments. There’re 3 positions as the following:
  • Product Tab
  • Under Add to Cart button
  • Sidebar
• Display Attachments File Size: If Yes, display the file size next to the attachment in the frontend.
• File Size Limit Allowed(MB): Note that the limit for sending attachments in gmail cannot exceed 25 MB. Please select below 25 MB to fully view the best quality attached file. If empty or 0, the limit will be 25 MB by default.
• Add Attachments in Order Emails: If Yes, add the attachment to the order email.
• Groups: Add group to sort attachment files. Groups will be displayed with the attachment file on the product page.

• Manage Icons:

  • Admins can add or remove icones in this field
  • The icons added in this field will display in the Edit/Add New File under Dropdown
  • We recommend you should use SVG file, or the icons have the size format not as 45x25

  

1.2. Default Value

• All values selected in this section are taken as the default value of the product attachment when they are uploaded
• These values will be selected by default when adding new files, but admins can change these values while editing/adding new files.
• Store View: Stipulate the Store Views that Product Attachment is displayed on the Frontend
• Customer Group: Stipulate group customers that can perform Customer Action
• Customer must login to download file: Select “Yes” means that customers must login to view/download product attachment
• Only available for verified buyers: Select “Yes” means that Customers must have at least 1 order of this product so that Product Attachments display to view/download.
• Order Status: When the customer orders, if the order status is satisfied, the attached file will be viewed / downloaded.
• Customer Action:
  • View Online
  • Download

1.3. Snippet

• CMS Page/Static Block: Copy code and insert into the pages in the Content > Page section.
• Template .phtml file: Copy code and insert into the .phtml files of Magento or other extensions that you want to display Product Attachments
• Layout file: Copy code and insert into .xml files of Magento or other extensions that you want to display Product Attachments

2. Manage General Files

From the Admin Panel, go to Catalog > Product Attachments > Manage Files

2.1. Managerial Grid

• This is a place to save all attached files into the product.
• From the Grid, admins can understand the basic information of the file as ID, Label, Name, Status, Store View, Customer Group, Group, Priority, Create Date, and Action.
• In the Action Dialog, admins can perform Action Delete: Admins need to tick and choose the question that they want to delete, then choose Delete in the Action box (upper left of Grid) to delete. A confirmation dialog will appear, select OK to continue deleting.
• In the Action column, admins click on Edit to edit the information of the attached files.
• Also, admins can filter, change store view, hide/show columns or export grid

2.2. Add New/Edit Form

2.2.1. General

• File Label:

  • Set the file label to display on the Frontend
  • The label needs to set close to the content of attached files so that customers can understand before viewing/downloading.

• File Name:

  • Set the name for the file. This name will replace for uploaded the file name.
  • This name will display on the Frontend when customers click on the attached files to view/download.
  • Not support hieroglyphs such as Chinese, Japanese, Korean, Russian, etc
  • If leaving this field blank, take the name of the uploaded file.

• File Type:

  • Link other: show File Link field with the links
  • File in Store: show File field with uploaded files

• File link: The links are attached with the protocols httl://, https:// or ftp://

• File:

  • Upload the file from your PC
  • We support you some following file formats:
  • The file name will display on the Frontend if admins don’t enter the file name.

• Icon:

  • The icon will auto-update when admins upload the file according to the file format.
  • Admins can change into the icon that they want.
  • To upload a new icon, admins need to install in the Configuration

• Status: Choose “Enable” so that the attached file can display on the Frontend.

• Store Views: One website can have many store views. Product Attachment only displays in the selected store views.

• Show files to Customer Group(s): Stipulate which customer group can see the attached file.

• Logged-in Customer: Select “Yes” to allow only customers who are logged into the store to view/download the file

• Verified buyers:

  • Select “Yes” to indicate for customers who have purchased the product to view/download the attached file.
  • In case, Logged in Customer = No: Customers don’t need to purchase the products, they can also view/download the file

• Order Status: Select the Order Status whose customers can view/download attached files

• Customer Action:

  • View Online: Customers who meet the conditions of the Store, Group, Login and Verify will be able to view the contents of the attached file.
  • Download: Customers who meet the conditions of Store, Group, Login and Verify will be able to download attachments

• Select Group: Choose the groups under which attachments are displayed

• Priority:

  • At the same location, Product Attachment that has a higher priority will be sorted first.
  • 0 is the highest priority.
  • Attachments that is added directly in the Edit Product will be displayed first. After displaying all attachments in Edit Product, attachments in the Manage Files will be arranged again based on Priority

  

2.2.2. Assign To

• This is a place for you to select the conditions for the rule. Only available on selected products, the new rule can be applied.
• You can add/remove the condition by clicking on + or x
• You can change the true/false of the condition by clicking bold text
• Admins can review the products satisfied the condition when clicking on Preview Products

3. Add the attached file in the Catalog > Products

• Admins can add directly in the Grid or go to Edit Product Page to add the file.
  • Grid
  • Edit Product Page

• By one of two ways, admins can set the display location of the attached files and upload files easily.
• All product attachments are displayed here, including the files created in the Manage Product (if that file is assigned to this product).
• When you click on an attached file, a popup is displayed and admins can quickly edit the file information.

• The information is similar to the information when adding new files in Manage File
• Note that File Name does not support hieroglyphs such as Chinese, Japanese, Korean, Russian
• The files added here will be sorted before the attachments in Manage Files even with lower priority. After all the attachments in the Edit Product are listed, Attachments in Manage Files are sorted again based on priority.

4. Report

From the Admin Panel, go to Catalog > Product Attachments > Logs

• Record the information about actions performed by the customer on the Product Attachments such as: File Label, File Name, Customer Implementation, Product, Action, Store View, Customer Group and Action Date.
• Admins can clear logs if they want.

5. Import File

• The import function is built based on the import function of Magento.
• Note that admins must select Entity Type = Mageplaza Product Attachments

• Before Check Data, admins need to upload attachments into the var/import/images

• After importing, Product Attachment files are stored in Manage General File
• To know more Magento’s import, please visit here

6. REST API

Mageplaza Product Attachments supports using REST API to perform some requests: get information of product’s attachment, allow customers or guests to download product’s attachment.

View requests supported by Mageplaza here.

View REST API guidelines of Magento 2 here. View create token guidelines here.

Product Labels

Overview

Product Labels extension offers the feature that helps store owners display images, labels, characters, symbols on the products. This feature brings the customers the intuitive interface that allows them to know that Which products are being got the sale off and what percentage of sales is, etc. Also, when you integrate this module, store owners can easily attract customers to the best-selling products or products that they are planning for marketing to increase sales and revenues for their online stores.

Documentation

• Download Mageplaza Product Labels extension
• How to install

I. How to install

Install via composer (Recommend)

Run the following command in Magento 2 root folder

composer require mageplaza/module-product-labels
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

II. How to configure

From the Admin Panel, go to Content > Product Labels > Configuration

Configuration

From the Admin Panel, go to Content > Product Labels > Configuration

General

• Enable: Choose Yes to use this module
• Limit The Number Of Labels Per Product: Enter the number of labels that can be displayed on each product. The default value of the field is 2. If left blank, the number of labels displayed per product is not limited.
• Show Labels On Pages: Select one or more pages to show labels on the frontend. Pages that are not chosen will not display any labels.
• Show Labels with Related Products: Select Yes to display labels of Related Products on the Product Details page
• Show Labels with Upsell Products: Select Yes to display labels of Upsell Products on the Product Details page
• Show Labels with Cross-sell Products: Select Yes to display labels of Cross-sell Products on the Product Details page
• Hide Label when Variable equal to zero: Select Yes to hide labels when the value of the variable is 0 or the variable name is incorrect

On Sale Product Setting

• Min Value of Discount Amount Variable: The minimum value of the {{discount}} variable shown in the label.
• Min Value of Discount Percentage Variable: The minimum value of the {{discount_percent}} variable shown in the label.
• Rounding Method of Discount Percentage: The value of Rounding Method applied to the {{discount_percent}} variable can be changed with all label display rules.
  • Normal: The number of points converted from the currency (USD, EUR, …) will be rounded according to the normal rule. E.x: 10.2 rounded to 10; 10.8 rounded to 11.
  • Rounding Up: The number of points converted from the currency (USD, EUR, …) will be rounded up. E.x: 10.2 or 10.8 is rounded to 11.
  • Rounding Down: The number of points converted from the currency (USD, EUR, …) will be rounded down. Ex: 10.2 or 10.8 is rounded to 10.

New Product Setting

• How to set the New Products: There are 2 ways to set products as new products:
  • New from Date and New to Date
  • Create date product:
    • Number of Days: The maximum number of days from the Create day of product until today, which depends when How to set the New Products = Create Date

Stock Status Label Setting

• Displays Label When The Product Is Out Of Stock: If Yes, the out of stock products are only sticked with the ‘Out of Stock’ Label.
• ‘Out of Stock’ Label: Select a label to display with out of stock products

Manage Rules

From the Admin Panel, go to Content > Product Label > Manage Rules

Create New Feed

• Step 1: Fill in the full information in the General section
• Step 2: Set the condition to apply the label display for the products in the Where to Show section
• Step 3: Design labels and images on the product in the label design section

Step 1: Fill in the full information in the General section

• Name: Enter the name of the item
• Status: Choose Enable tô display the label on the product
• State:
  • State includes 4 statuses: NONE, QUEUE, RUNNING, DONE. When a new rule is created, the status is NONE
  • The change of the state depends on the date that you apply the rule
• Store View:
  • Only the selected products in the store display the label
  • Allow choosing many stores simultaneously
• Customer Group(s):
  • Only the selected customer groups can see the label displayed on the product
  • Allow choosing many groups simultaneously
• From Date: Choose the start day displaying the label on the product
• To Date: Choose the finish displaying the label on the product
• Stop further processing: Choose Yes to limit the number of the rule that applied for a product (based in the priority and ID)
  • For example: Whether there are 4 rules created as Rule 1, Rule 2, Rule 3, and Rule 4 and the priority respectively is 0, 5, 3, 3.
    • All rules are set as Stop further processing = No. This means that all rules are applied.
    • Edit the Rule 3, and choose Stop futher processing = Yes. After you Apply Rule, the rules are applied as Rule 1 (has the higher priority) and Rule 3. Rule 2 (the priority is lower) and Rule 4 (created later) are not applied.
• Priority:
  • Enter priority for synchronizing objects
  • The smaller the input number, the higher the priority. Items have the equal priority, the priority will be based on ID.

Step 2: Set the condition to apply the label display for the products in the Where to Show section

• Best seller: Choose Yes to auto-assign the label for the bestselling products
• New Products: If Yes, display label on all products that are new products and meet the conditions
• On Sale Product: If Yes, display label on all products are on a discount or Special Price and meet the conditions
• Limit: Enter the maximum number of best-selling products automatically labeled
• You can customize the product displayed the label by selecting the products shown below after clicking the Preview Product button or selecting the products of the category that will be displayed the label. You will see all products meet the conditions in the PREVIEW PRODUCTS field

Step 3: Design labels and images on the product in the label design section

Design the labels and images for the product on the Product Page

• Template: Choose the template displaying on the product
• Image: Choose the images displaying on the product
• Image Size:
  • Enter the length and width of the image
  • If you use the available template, the length and width of the image will be automatically loaded when you load the template
• Show Label if Stock is lower than: The label will be shown at the products having fewer stocks than the entered number. If left empty, the label will be shown at all products that follow the rule.
• Label:
  • Fill in the label displaying on the product
  • Only support some following variables:
    • {{discount}}: Discount amount
    • {{discount_percent}}: Discount percentage
    • {{current_price}}: Original Price
    • {{attribute_code}}: Any product attribute code
• Font family: Choose the text font for labels
• Font size: Enter the size of labels
• Label color:
  • Choose the color for labels
  • The default color will be changed according to the template
• Custom CSS: You can edit the labels as your want
• Select position: You can edit the display position of labels here by moving the mouse or edit the display position of labels by choosing the positions respectively with the squares on the side.
• Tooltip: Enter text for tooltip shown when hovering on the label.

Design the labels and images for the product on the Product Listing (the label will display on the product in the Category, Search Page or Layered Navigation if your website installs Layered Navigation extension of Mageplaza.

• Same design with product page
  • Same design with product page = Yes: Auto-get the design the same as with Product Page above
  • Same design with product page = No: Display the design the same as Product Page above and admins can edit arbitrarily

III. Frontend

Display on the Product Listing

Display on the Product Page

Display on the Mini Cart

Display on the Shopping Cart Page

Display on the Checkout Page

Display on the One Step Checkout Page

IV. API

Product Labels extension of Mageplaza supports the use of the Rest API to view a detailed list of all labels that the admin has created.

• Details can be viewed here.
• Instructions for creating Integration tokens are here.

V. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-product-labels-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

To start working with Product Labels GraphQL in Magento, you need the following:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)

View Mageplaza-supported queries here

VI. Widget

Step 1: Select the Type

• On the Panel Admin, go to Content > Elements > Widgets
• In the upper-right corner of Widgets workplace, click on the Add Widget button.

• In the Settings section:
  • Choose Mageplaza Product Labels type in the Type box.
  • Choose the current theme you are applying in the Design Theme.
  • Click the Continue button.

Step 2: Complete the Storefront Properties section

• In the Storefront Properties section:
  • Enter Widget Title for the internal reference.
  • Assign the block to all store views in the Assign to Store View field or to any store view you want to apply the block.
  • Set the Sort Order if many blocks are placed at the same container. The block is at the top if the inserted value is zero.
• In the Layout Updates section, click on Add Layout Update to set the layout.
  • Choose the category, product, or page to show the block in the Display on field.
  • If set to a specific page, you need to choose the Page you want the block to display and set Container that is the position of the page the block appears.

Step 3: Widget Options

• Click the button Select Label… to select label

You can also add widget on Pages or Blocks via Insert Widget

Product Slider

I. Overview

In the default Magento, the products on your store are listed in bulk without any purpose. This will cause the difficulty in searching the desired products of customers. That’s great that Mageplaza has developed Magento 2 Product Slider extension that can improve the order of products on your online store.

Product Slider for Magento 2 enables store owners to create many slider titles like featured products, bestsellers, most reviewed products, or new products, etc. This will be easy to attract visitors when they visit your website. Moreover, it also helps boost sales dramatically.

II. How to configure

1. Configuration

Login to the Magento Admin, choose Stores > Settings > Configuration > Mageplaza Extensions > Product Slider

1.1. General Configuration

• In the Enable field: Choose Yes to enable Product Slider extension
• In the Default Display Additional Information field:
  • Select the options that can display with products on the slider
  • Allow choosing many options to display
  • Only apply for Widget or when admins add Product Slider by the code

1.2. Slider Design Configuration

• In the Is Responsive field:

  • Choose No so that the number of products display on the browser is the default (3 products)

  

  • Choose Yes so that the number of products display on the slider can be changed when changing the size of the browser window. You can set this in the Max item slider field.
  • Only apply for Widget or when admins add Product Slider by the code or can choose this in the rule Reponsive = Use Config

• In the Max item slider field: This section only displays when the Is Responsive = Yes. Set the number of products display on the slide when the browser window changes the size.

  • Example: Screen size max = 1000, Number of item is 5. The frontend will be displayed as the following:

  

• In the Loop Slider field: Choose “Yes” to allow the first products repeated when the slider runs to the end

• In the Margin Between Items field:

  • This is a place that allows you to set the distance between products in the slider
  • We recommend you should set the distance to be 10

  

• In the Next/Prev buttons field:

  • Choose “Yes” so that the Prev/Next button is displayed on the frontend
  • When you click on Prev/Next button, Sliders will move the product to the left or the right

  

• In the Show Dots Navigation field:

  • You can choose “Yes” in this section to display dots representing the number of slider pages

  

  • When clicking on Dots, products on the side slider will be displayed (in this case, it includes 5 products)

• In the Lazy Load Images field: Choose “Yes” to represent Lazy Load displayed when loading the image

• In the Autoplay field: Select “Yes” so that products on the slider will auto-move to the left after a certain period of time installed at the Autoplay Timeout section

• In the Autoplay Timeout field: Set the amount of time so that the slider moves a product to the left. For example, set “Autoplay Timeout” = 5000 (ms), after 5 seconds, the slider will auto-run instead of clicking on the next button to move.
• In the Autoplay HoverPause field: Choose “Yes” so that the slider stops running automatically when the cursor is placed on the slider

2. Manage Rules

2.1. Grid

• This section saves all Product Sliders created
• From the Grid, admins can understand all basic information of the rule as ID, Name, Slider Type, Slider Location, Start Date, End Date, and Action.
• Admins can perform some actions:
  • Delete: Admins need to tick and choose “Size Chart Rule” that they want to delete, after that, choose Delete in the Action box (in the upper left of the Grid) to remove. The confirmation dialog will be appeared, then choose “OK” to continue removing.
  • Change Status: Admins need to tick and choose “Size Chart Rule” that they want to change the status, after that, choose “Change Status > Enable/Disable in the Action box” (in the upper left of the Grid) to change the status. Immediataly, selected Size Chart Rules will be changed to the selected status.
• Also, admins can filter, change store view, hide/present columns or export grid.

2.2. Add New/Edit Form

2.2.1. General Information

• Name: The name of the slider is filled in this section only show in the backend. It helps distinguish with other products.
• Status: Choose “Enable” so that the sliders work well.
• Position: Choose the position to appear of sliders on the frontend. We offer the available positions as the following:

• Type: Choose Product Type that you want to showw on the slider

• Select By Category: When choosing Type = Select By Category, Option Categories will be displayed for you to choose. Products of selected categories will be shown on the slider outside the frontend.

• Custom Specific Products: When choosing Type = Select By Category, Tab Select Product will be displayed for you to choose. The selected products will be shown on the slider outside the frontend.

• Store View: Choose Store View that sliders are displayed. With unselected store views, sliders never appear.
• Customer: The slider only displays for selected customer group.
• Cache Lifetime: To refresh instantly, clear the Blocks HTML Output cache. If you leave this field blank, the default is 86400 seconds.
• From Date: Allow installing the date you start using the slider. Sliders will not appear on the frontend if the displayed date hasn’t come yet.
• To Date: Allow installing the end date that the slider is used. After this date, the slider will be hided from the frontend.

2.2.2. Design

• Title: The content filled in this field will be the name of the slider displaying on the frontend.
• Description: Describe about the slider. The description is also displayed on the frontend.
• Limit number of products: Fill the maximum number of products on the slider.
• Display additional information:
  • Choose the options that can display with products on the slider
  • Allow choosing many options to show
• Is Responsive:
  • Choose No so that the number of products display on the browser window to be the default (3 products)
  • Choose Yes to allow changing the number of products displaying on the screen. When you choosing Yes, the slider will ignore install the Responsive in the configuration.
  • Choose Use Config to use Responsive in the Configuration.
• Max Items Slider: This field only displays when you choose Responsive = Yes. Installing the number of products show on the slider when the browser window changes the size.

3. Widget

When creating the widget, you can allow Product Slider to appear anywhere you want. To create the Widget, you need to do the following steps:

• Step 1: From the Admin panel, go to Content > Elements > Widgets, choose Add Widget
• Step 2: Choose Type = Mageplaza Product Slider, Design Theme = Magento Luma. Afterward, click on Continue.

• Step 3: Enter the required information in the Storefront Properties

• Step 4: Choose the position to display the widget

• Step 5: Fill in the information about the slider into Type Product displayed on the slider in the Widget Options Tab

• Step 6: Save the widget and check on the frontend.

III. How to Use (Apply for Developers)

List of Available Blocks

• Mageplaza\Productslider\Block\OnSaleProduct : On Sale Products
• Mageplaza\Productslider\Block\CategoryId : CategoryId , get products from specific category id
• Mageplaza\Productslider\Block\FeaturedProducts : Featured Products
• Mageplaza\Productslider\Block\NewProducts : New Products
• More (coming soon). Request more at support@mageplaza.com

How to use

We will show you how to use insert Product Slider in CMS page, Static Block, XML File, XML Data, .phtml file.

1. CMS Page, CMS Static Block

{{block class="Mageplaza\Productslider\Block\NewProducts" template="Mageplaza_Productslider::productslider.phtml" products_count="8" heading="New Products" description="Here is your new products description"}}

You can paste the above block of snippet into CMS page such as Home page or specific CMS page or any CMS static block in Magento 2.

2. XML File , XML Data

::

<block class="Mageplaza\Productslider\Block\NewProducts" name="product.slider.  newproduct" template="productslider.phtml">
  <arguments>
    <argument name="products_count" xsi:type="number">8</argument>
    <argument name="margin" xsi:type="string">5</argument>
    <argument name="heading" xsi:type="string">New Products</argument>
    <argument name="description" xsi:type="string">Here is your new products   description </argument>
  </arguments>
</block>

Open layout file such as category_catalog_view.xml or XML Data and insert the above block of code, then all categories page will be added the product slider with 8 new products.

3. .phtml file

::

<?php echo $block->getLayout()->createBlock('Mageplaza\Productslider\Block\NewProducts')->setTemplate('productslider.phtml')->toHtml();?>

Open a .phtml file and insert where you want to display the product slider.

4. Custom Style

You can custom template file at app/code/Mageplaza/Productslider/view/frontend/templates/productslider.phtml

.. important:: In your theme, custom design, you should copy this file into your package and edit them instead of directly edit it.

IV. How to set a product is a new/onsale/… product

1. On Sale Product

1.1. From the Admin Panel, go to Catalog > Products 1.2. Edit the product that you want to sale 1.3. Choose Advanced Pricing in the Option Price 1.4. In the field Special Price, enter the sale price of the product 1.5. Click Done > Save & Close 1.6. From the Admin Panel, go to System > Cache Management > Flush Magento Cache 1.7. Check on the Frontend

2. New Product

2.1. From the Admin Panel, go to Catalog > Products 2.2. Edit Product that you want to set to be New Product 2.3. Change the date/time in the Set Product field as New From 2.4. Click Save & Close 2.5. From the Admin Panel, go to System > Cache Management > Flush Magento Cache 2.6. Check on the Frontend (You will see that it appears in the Product Slider if you have set)

3. Feature Product

3.1. From the Admin Panel, go to Catalog > Products 3.2. Edit Product that you want to set to be Feature Product 3.3. Chọn Yes in the Feature Product field 3.4. Click Save & Close 3.5. From the Admin Panel, go to System > Cache Management > Flush Magento Cache 3.6. Check in the Frontend (You will see that it appears in the Product Slider if you have set)

4. Best Seller Product

4.1. From the Admin Panel, go to Report > Products > Bestsellers 4.2. Click here to update the Best Seller Products

4.3. Check this on the Frontend (You will see that it appears in the Product Slider if you have set). You can also check it in the Dashboard/Bestsellers field.

5. Recent Product

• This is a block that only display when customers login to the store
• You need to add the code so that the slider can be shown on the frontend
• Recent products of customers will be displayed in the slider
• The slider won’t appear if the customers haven’t seen any product

6. Wishlist Product

• This is a block that only display when customers login to the store
• You need to add the code so that the slider can be shown on the frontend
• Wishlist products of customers will be shown on the slider
• The slider won’t appear if the customers haven’t seen any product

7. Category ID

The code to display the Products in the selected Category ID is different than the other blocks. More details:

• CMS Page

{{block class="Mageplaza\Productslider\Block\CategoryId" template="Mageplaza_Productslider::productslider.phtml" products_count="8" heading="CategoryId" category_id="2" description="Here is your products of Category Id description"}}

• XML File

<block class="Mageplaza\Productslider\Block\CategoryId" name="product.slider.category" template="productslider.phtml">   <arguments> <argument name="loop" xsi:type="string">1</argument> <argument name="category_id" xsi:type="string">2</argument> <argument name="products_count" xsi:type="string">8</argument> <argument name="heading" xsi:type="string">Category Id</argument> <argument name="description" xsi:type="string">Here is your category description</argument> </arguments> </block>

You can change the ID of the Category based on the ID of the Category in the Catalog/Categories field.

Product Alerts

Overview

These days, your customers may too busy to drop in your stores but they still want to update their interested products. Thanks to Mageplaza Product Alerts extension, your customers can subscribe to get notification for out-of-stock products or price change. The notification emails of restock items or better prices will be sent to related customers. By this extension, online stores save a lot of time and effort for advertising since they can keep in touch with their potential customers, hence helps boost sales and profit significantly.

Download & Install

• Mageplaza Product Alerts
• How to Install

How to configure

I. Configuration

Login to the Magento Admin, choose Store > Configuration > Mageplaza > Product Alerts

1. General

• Enable: Choose Yes to activate the module
• Custom CSS: Allow changing CSS. This field is applied to Product List and Product View page. For example: .action.primary { background: #f311cd; }, .product.alert { background: pink,…
• Cron Schedule: Insert the value to run cron which decides email sending frequency. With default cron will run every 1 hour. You can refer this link for detailed instruction.

For example:

• Insert ***** means that sending email of price change or restock notifications each minute
• 20 */3 * * * means that sending email at minute 20th after every 3 hours
• Run Daily is 00*** means that cron will run at 00:00 every day
• Run Weekly is 00**7 means that email sent at 00:00 every Sunday. If insert 00**1, emails are sent at 00:00 every Monday
• Run Monthly is 001** means that emails sent at 00:00 on 1st January 2019

Note: When entering values, between two values must be a space so that cron can be run. For example: * * * * *

2. Alert for Price Changed Product

• Enable:
  • Choose Yes to allow notification email of price change of subscribed products. Install SMTP to avoid email to spam box.
  • When admins enable Price change alert, the link Notify me when the price drops appears in each product page
  • When customers click to that link, a popup displayed allows customers subscribe for notification of price change. All subscribers will get notification emails whenever their favored items are offered at a better price.

• Apply for Customer Groups: You can choose one or more customer groups to send emails.
• Email Sender: Select the store representative that you want to show in the notification emails. Here are the options:

• Email Template: Access to Marketing > Email Templates > Add New Template to create Email Templates. Please choose the email template that you want to send for price change of products.
• Text for subscribed customers: This message will be displayed when customers have subscribed successfully. You can insert the text here, otherwise, the default message is: Congratulations! You will receive a notification email when this product has just changed the price

2.1 Popup configuration

• Popup Heading: Add the Title for Popup. Allow showing popup when customers click to Notify me when the price drops and only show popup with not-log-in customers. The default heading is: Stay tuned for any updates on this product's price!
• Popup Description: Insert the description for your Popup. The default description is: Subscribe Price-Change Alerts now! Register your email address to be the first to know when our product has any changes in price. You are always updated to get product pricing goodness!
• Email Placeholder: Insert the Placeholder message for notifying customers that this is the field to add email addresses receiving notification. For example: Your email address
• Button text: Add the button name for popup. When customers insert the email correctly, click to this button to subscribe notification of price change. If you leave it blank, the default button is: Notify me!
• Footer Content: Insert the note or warning to your customers, which is displayed at the footer of Popup. If it is left blank, the default content is: Kindly notice that the price notification email will be delivered only one time, and your email address will not be shared or published with anyone else.

3. Alert of Out Of Stock Product

• Enable:
  • Choose Yes to allow notification emails of restock of subscribed products. Install SMTP to avoid email to spam box.
  • When admin enable Out of stock alert, the link Notify me when this product is in stock appears in each product page
  • When customers click to that link, a popup displayed allows customers subscribe for notification of back-in-stock products. All subscribers will get notification emails whenever their favored items are restocked.

• Apply for Customer Groups: You can choose one or more customer groups to send emails.
• Email Sender: Select the store representative that you want to show in the notification emails. Here are the options:

• Email Template: Go to Marketing > Email Templates > Add New Template to create Email template. Please choose the email template that you want to send to your customers when their favorite items are restocked.

• Show on Product Listing Page: Select Yes to show the Button text field

  • Button text: Name the Button to be shown at Product Listing Page. When customers click on this button, they can register to get notification emails of restock items. If you leave it empty, it will be Notify me as default.

  

• Text for subscribed customers: Insert the message you want to send to customers. This text is displayed after subscribing successfully, so customers can subscribe only once. For example: Congratulations! You will receive a notification email when this product has just come back to stock.

3.1. Popup Configuration

• Popup Heading:
  • Add the Title for Popup. Allow showing Popup when customers click to Notify me! and only show Popup with not-log-in customers (Notify me! button is the name set for Button text).
  • If you leave it blank, the default message is: Grab your chance when this product back in stock!
• Popup Description: Insert the description for your Popup. If you leave it empty, the default description is: Subscribe Back-In-Stock Alerts now! Register your email address to be the first to know when our product comes back. Do not miss your chance!
• Email Placeholder: Insert the Placeholder message for notifying customers that this is the field to add email addresses receiving notification. The default text if you leave this field blank is: Your email address
• Button text: Add the button name for popup. When customers insert the email correctly, click to this button to subscribe notification of restock products. If you leave it blank, the default button is: Notify me!
• Footer Content: Insert the note or warning to your customers, which is displayed at the footer of Popup. If it is left blank, the default content is: Kindly notice that the back-in-stock email will be delivered only one time, and your email address will not be shared or published with anyone else.

II. Out of Stock Notification

Login to the Magento Admin, choose Catalog > Product Alerts > Out of Stock Notification

1. Subscribers

• New subscription

• Edit subscription

• Product SKU: Insert the SKUs for products that customers want to be notified when they are out of stock and restocked as well. This is a required field.
• Product Name: This field allows showing the product name after customers subscribe the email notifications
• Customer Email: Insert the customer emails to get notification when products are in stock. This is a required field.
• Customer Name: This field allows showing the customers’ name after they subscribe the email notifications, which are based on their email addresses. For customers who have not subscribed accounts on your site, they will be named as Guest
• Store View: Select the store views whose products can be subscribed for out of stock notification.
• Status: Show the product status after subscription. Status will be change along with the change of product SKU, Product name and Customer email.
• Created At: Show the time of subscription only after subscribing.
• Last Send Date: Show the last date of subscription

Note: When you click to Save or Save and continue edit, the system will send email to the customers who have subscribed notification. If you click Sent or Resent, the system will send emails to customers notifying of back in stock products.

2. Most Requested Products

2.1. Most Requested Products

This part reports the most wanted products based on the data of customers subscription of restock items, which includes: Product name, Product SKU, Number of Requests, etc. The subscribed products which are canceled will not be reported here.

2.2. Report

Basing on the above data, this module enables generating the chart of most requested products. The horizontal axis is Product SKU whereas the vertical axis is Number of Requests.

III. Product Price Alerts

Login to the Magento Admin, choose Catalog > Product Alerts > Product Price Alerts.

1. Subscribers

• New subcription

• Edit subcription

• Product SKU: Insert the SKUs for products that customers want to be notified when they have better prices. This is a required field.
• Product Name: This field allows showing the product name after customers subscribe the email notifications
• Customer Email: Insert the customer emails to get notification when product prices are better. This is a required field.
• Customer Name: This field allows showing the customers’ name after they subscribe the email notifications, which are based on their email addresses. For customers who have not subscribed accounts on your site, they will be named as Guest
• Store View: Select the store views whose products can be subscribed of price change notification.
• Status: Show the product status after subscription. Status will be change along with the change of product SKU, Product name and Customer email.
• Created At: Show the time of subscription only after subscribing.
• Last Send Date: Show the last date of subscription

Note: When you click to save or Save and continue edit, the system will send email to the customers who have subscribed notification. If you click Sent or Resent, the system wil send emails to customers notifying of back in stock products.

2. Most Requested Products

2.1. Most Requested Products

This part reports the most wanted products based on the data of customers subscription of better price items, which includes: Product name, Product SKU, Number of Requests, etc. The subscribed products which are canceled will not be reported here.

2.2. Report

Using the above data, this module enables generating the chart of most requested products for better prices. The horizontal axis is Product SKU whereas the vertical axis is Number of Requests.

IV. Edit product

Login to the Magento Admin, choose Catalog > Products.

This part records the subscribers’ information ( both for out-of-stock products and better price products notifications, which includes: Customer name, Customer Email, Subscribe Date, Last Sent, Send Count.

• Stock Status (Magento default): Select the stock status including In Stock and Out of Stock.
• Back in Stock Notification: Turn on this field to activate Stock Notification function.
  • Choose Enable, then the link Notify me when this product is in stock will be displayed on product page. This configuration applies for each product.
  • Customers can click to this link to subscribe for notification of back-in-stock products
• Price Alert: Turn on this field to activate Price Alert function.
  • Choose Enable, then the link Notify me when the price drops will be displayed on product page. This configuration applies for each product.
  • Customers can click to this link to subscribe for notification of price change products

V. Email Notifications

1. Price Change

Notification of Successful subscription for price change

Price change notification

2. Out of Stock

Notification of Successful subscription for out of stock

Back in Stock Notification

Note: Click View Your List button, visitors will be redirected to My product alerts where all the subscribed products of them are listed.

VI. Compatible with Reports extension

Products Alert extension is fully compatible with Mageplaza Reports extension. This allows admin to generate Reports of Recent request stock available, Recent request price change, Most request price change and Most request stock available. Click to View Details will redirect to Grid or Most Requested Product

Frontend

At My product alert, customers can view their subscribed products of out-of-stock and price change notifications.

Note

• If you want to uninstall the extension, please use the composer to run the command: bin/magento module:uninstall Mageplaza_ProductAlerts
• In case you have deleted the extension manually, you need to delete the mp_productalerts_price_alert attribute and mp_productalerts_stock_notify as well in the data base or at backend
  • Method 1 Backend: From the Admin Panel, go to Stores > Attributes > Product. At column Attribute Code, look for attribute mp_productalerts_price_alert and mp_productalerts_stock_notify, click to them and delete

• Method 2 Data base: Navigate to eav_attribute table. At column Attribute_code, look for attribute mp_productalerts_price_alert and mp_productalerts_stock_notify, click to them and delete

API

Mageplaza’s Product Alerts extension allows using the Rest API to view information about subcribers and requested products. In addition, the extension also supports direct subscriptions through API requests.

Details can be viewed here.

Instructions for creating Integration tokens here.

GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza / module-product-alerts-graphql
php bin / magento setup: upgrade
php bin / magento setup: static-content: deploy

To start working with Product Alerts GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• The queries Mageplaza supports can be viewed here.

Product Finder

Overview

Mageplaza Product Finder extension is an essential tool for Magento 2 stores. It allows customers to search their favored items using product attributes via filter options. All products meeting the filter options will be displayed quickly and clearly. With this extension, admins can add Product Finder to any category page you want. The admin can also customize the design and filter results according to your preferences. As a result, your customers can find what they want and enjoy their shopping experience.

How to use

1. Category Page

Customers can use the Product Finder to search for products according to the options they want

2.Finder Result Page

3.Product Detail Page

Customer can see all product attribute options of the same finder found in the Comparision Tab in Product Detail Page

How to configure

I.Configuration

Login to the Magento Admin, choose Catalog > Product Finder > Configuration

1. General

• Enable: Select Yes to enable the module.
• Enable Find Button When: Choose when the “Find” button is clickable in the finder
  • Always enable: The “Find” button is always clickable
  • All filter is selected: The “Find” button is clickable only when all filters are selected
  • At least one filter is selected: The “Find” button is clickable when one of the Filters is selected
• Enable “Reset” Button When: Choose when the “Reset” button is displayed in the finder
  • Always Enable: The “Reset” button is always displayed in the frontend
  • No: The “Reset” button is not displayed in the frontend
  • At least a filter is selected: The “Reset” button is displayed in the frontend when one of the filters is selected
• Reset Finder Page To: Select the page to redirect whenever the “Reset” button is clicked
  • Home Page: Clicking on “Reset” will load the Home Page.
  • Current Page: When clicking on “Reset” the system will reload the page.
• Auto-redirect To Result Page: If Yes, you will be automatically redirected to the result page when all the filters are selected.
• Reset Unselected Finder(s): If Yes, when one Finder is selected, the other finder on the same page will automatically reset.
• Redirect To Product Page:
  • Select Yes to enable this feature
  • When the Result Page only displays 1 satisfied Product, the page immediately redirect to the Product Detail Page of that product
• Enable “Chosen” Plugin: If Yes, Chosen Plugin will be used in the frontend, which makes filters more beautiful and user-friendly.
• Show Promoted Product:
  • If Yes, Promoted Products will always be displayed at the bottom of the corresponding finder results page
  • Promoted Products are set for each finder
• Show Comparision Tab:
  • If Yes, the Comparision tab will be displayed on the Product Detail page.
  • The Comparision tab only shows products with the same finder.

II. Manage Product Finder

1. Grid

From the Admin Panel, go to Catalog > Product Finder > Manage Product Finder

• This is where the Product Finder information is displayed
• From Manage Product Finder, admin can capture basic information of Product Finder such as ID, Name, Status, Created At, Updated At, Action.
• Action:
  • Delete: Delete the Product Finder.
  • Change Status: Change the status of the selected Product Finder.
  • Edit: Navigate to the page to edit Product Finder information you created earlier.
• In addition, admin can filter, change store view, hide/ show columns.

2. Form Add New Product Finder

From the Admin Panel, go to Catalog > Product Finder > Manage Product Finder, select Add new/ edit

2.1. General

• Name: Enter the name of the Product Finder displayed at frontend.
• Status: Select “Enable” to enable the finder to work
• Finder Layout:
• Vertical: The Finder displays vertically
• Horizontal: The Finder displays horizontally
• Position: choose the position to put the Product Finder
  • Main Sidebar: Only appears when Finder Layout = Vertical, finder will be displayed in the sidebar.
  • Top Content: Finder displays above Content.
  • Bottom Content: Finder displays under Content.
• Page Finder Route: Admin enter the URL for the Result Page.
• Full URL: Only appears when the admin has saved the finder. Admin can use this URL directly without having to go to the Category page.
• Page Title: Enter a display name for the result page.
• Category: Select the Category Page in which the finder is displayed.
• Sort Order: In the same position, finder with a smaller sort order number will be displayed first.
• Another way to add finder to your page: This field will be displayed when editing finder.
  • Allow finders to be shown by assigning snippet code on CMS Page/ Static Block, .phtml file, or on layout file.
  • The finder assigned with a snippet code only is displayed when the admin has not set the category.

2.2. Filters & Options

Display the list of Attributes and Options that this finder will implement filter

• Name: Admin enters attribute name shown at frontend
• Sort By: The option sort order can be increasing or decreasing
• Display: Admin chooses the display type for the attribute.
  • With Auto, the default display is dropdown.
• Icon delete: Click the icon when you want to delete the attribute.
• To create a new attribute, click the Add New button.
• To edit attributes, admin needs to click on Setting button
• With Mode = Automatic: When you click on Settings, the popup Filter Options will display and the Attributes will be automatically listed. Admin needs to select the filter attribute to add to finder.

• With Mode = Manual: Admin need to create a name for the Attribute then Save. Now at the saved Attributes will display Settings, admin click on it to create an option for the Attribute.

2.3. Filtered Products

• This field is only displayed after the finder has been saved.
• With Mode = Auto:
  • Index Products: Products are automatically added based on the Filter Options added above.
  • Admin can delete 1 or delete all automatically added products.
  • Click the Export button when the admin wants to export the added products.

• With Mode = Manual
  • Admin needs to add each product manually or import the product from a CSV file
  • Admin can delete 1 or delete all added products.
  • Click the Export button when the admin wants the productivity of the added products.

2.4. Promoted Products

• This function allows admin to add the products they want to advertise on this Finder’s Result page
• Any product can be added here, and they will not comply with the above-added filter
• Admin can add manually or import Product from CSV file
• Admin can delete the added products as well

Product Grid

Overview

To save time and effort for the admin to change the information on the product page, Mageplaza has created the Product Grid extension. The Product Grid module allows editing information right on the Manage Product page, displaying detailed information about the product info, synchronizing data, changing column headers of columns. Also, admin can set any field to be edited or filtered.

Mageplaza Product Grid is fully compatible with Mageplaza Product Attachment extension.

How to Configure

I. Configuration

1. General

From the Admin Panel, go to Stores > Settings > Configuration > Mageplaza Extensions > Product Grid, select General

• Enable: Select Yes to enable the module.

• Edit In Line Mode:

  • Multiple Cells: Edit various cells of different products at the same time, click Save Edits after finishing.

  

  • Single Cells: Edit one cell each time. Edited cell will be saved when you click outside that cell.
  • Multiple Rows: Show all editable cells of a/ multiple products. Click Apply when you have edited All in Column, click Save Edits when you have changed the information of columns. Click Cancel to remove the changes.

  

• Change Columns Header: Select Yes to allow editing column header at column tab.

• Default Qty: Enter the maximum qty of Related/ Cross-sell/ Up-sell products and Recent Order to show on grid, default qty = 3, qty limit from 0 to 10 records.

2. Qty Sold

From the Admin Panel, go to Stores > Settings > Configuration > Mageplaza Extensions > Product Grid, select Qty Sold:

• ‘Qty Sold’ Date From: Select the start date to calculate the quantity of products sold.
• ‘Qty Sold’ Date To: Select the end date to calculate the number of products sold.
• ‘Qty Sold’ Order Statuses:
  • Select order status of orders to calculate the number of products sold in the “Qty Sold” column.
  • Admin can select multiple statuses.

II.Gird

From the Admin Panel, go to Catalog > Products:

1. Columns

Admin can select specfic columns from the Product menu to hide/ show columns on the product grid.

In the Columns menu, there are 4 order attributes tabs:

1.1 Default Group

• Admin can choose certain columns to be shown/hide at Product Grid
• Admin can also choose which columns can be edited and filtered by clicking to corresponding column titles.
• At Column Header, admin can changes column names and clicks Save.
• Reset: The system will display the default columns again.
• Cancel: Cancel the action.
• Change Thumbnail:

• Change Qty: Admin can fill in fixed numbers or using +/- signs

1.2 Attribute Group

• Admin can choose certain columns to be shown/hide at Product Grid
• Admin can also choose which columns can be edited and filtered by clicking to corresponding column titles.
• At Column Header, admin can changes column names and clicks Save.
• To add more columns, you needs to add a new attribute as instructed here.
• Reset: The system will display the default columns again.
• Cancel: Cancel the action.

1.3 Extra Group

• Admin can choose certain columns to be shown/hide at Product Grid
• Admin can also choose which columns can be edited and filtered by clicking to corresponding column titles.
• At Column Header, admin can changes column names and clicks Save.
• Reset: The system will display the default columns again.
• Cancel: Cancel the action.

1.4 Product Info Group

• Admin ticks to the checkboxes to allow showing corresponding columns at the grid. Display columns information in Related Products, Up-sell Products, Cross-sell Products.

• At Column Header, admin changes column names and clicks Save.
• Cancel: Cancel the action.

2. Default View

With this extension, admin can create multiple order forms and switch between them to quickly access information related to different orders.

To create a new view, admin enters the Order menu area, click Default View, and click Save View As. Then, enter a name for the template and click the arrow icon. To delete a template, admin selects the form and clicks the trash can icon.

3. Filters

The selected order attributes are shown in Filter as well. Admin can sort the specific order by those attributes.

Admin insert the data to sort the specific order information and click Apply Filters.

4. Export

From the Admin Panel, go to System > Data Transfer > Export

Check if the downloaded files has any product changes.

Magento 2 Promo Bar

Promo Bar Overview

Suppose that you have special promotions or big events coming up, how can you notify your customers about those programs or events? With Magento 2 Promo Bar extension, you can do it with ease. Promo Bar allows you to display one or more advertising bars at different locations and on multiple pages. By that, you can also set the display time for the promo bar. In addition, we also support Promo Bar compatible with our Mageplaza One Step Checkout, Mageplaza Free Shipping Bar.

How to download and install Promo Bar

• Download Mageplaza Promo Bar
• How to Install

How to Configuration Promo Bar

I. Configuration

Login to the Magento Admin, go to Marketing > Promo Bars > Configuration.

Admin can also go to Stores > Configuration > Mageplaza > Promo Bars to set module configuration.

1.1. General

• Select Enable = Yes to enable the module.
• Promotion Category:
  • Category Name: Admin enters a name for the promotion. The system will display an error message if left blank.
  • Action: Click on the trash icon if you want to delete promotion category.
  • Add: Click Add button if you want to create a promotion category.
• Allow Customer to Close Promo Bar: Select No not to allow customers to close the promo bar.
• Auto Close Promo Bar After: Admin set the time period for automatically closing the promo bar
• Auto-reopen schedule: admin select the schedule to re-open the promo bar after being closed.
  • Note: Auto-reopen is activated when customers click close button.

1.2. Display Setting

• Select Enable Multiple Promo Bars = Yes to allow multiple promo bars to be displayed.
• If you choose No, it will hide Number of Promo Bar field.
• Number of Promo Bar: Select the display type for promo bar
  • Separate: The promo bars are shown separately.
  • Slider: The promo bars are shown in the slider.

• Change Bar Time: Enter the display time for each promo bar and it is displayed only when Number of Promo Bar = Slider is selected above.

II. Manage Promo Bars

• Here saved all the created Promo Bars.
• At the grid, Admin can view all the basic information of Promo Bar such as ID, Content, Name, Status, Promotion Category, Position, Start Time, End Time, Priority, Action.
• Admin can do some of the following actions:
  • Edit: Select Edit in the Action column to edit the information on the edit Promo Bar page.
  • Delete: Select promo bar to delete, Action > Delete.
  • Change Status: Change the promo bar status.
• Add New Promo Bar: Create new Promo Bar.

2.1. Create New/ Edit Promo Bar

2.1.1 General

• Name: Set the title for promo bar.
• Select Status = Enable to allow promo bar to be applied.
• Store Views: Admin selects a store to display promo bar .
• Customer Groups: Select groups of customers who can view promo bar.
• Promotion Category: Select the promo category to be applied on promo bar.
• Start Date: Select the start date of promo bar display.
• End Date: Select the end date of the promo bar display.
• Priority: Enter the priority for the promo bar. The lower the value is, the higher the priority.

2.1.2. Conditions

Admin chooses the conditions to show promo bar at Checkout Page.

2.1.3. Design

• Load Template: Choose Promo Bar template. The system will show the Preview Promo Bar when admin choose a specific template.
• Text Content: Admin enters content for promo bar.
• URL Text: Enter the content displayed for the value {{url_text}}.
• URL: Assign the link to the URL Text. When customer clicks on the text url will automatically open a new tab with the assigned link.
• Load Template: Admin selects the template for the promo bar.
• Text Content Color: Select the font color for the content section.
• Background Color: Select the background color for the promo bar.
• URL Text Color: Select the font color for url text.
• URL Text Background Color: Select the background color for the text url.
• Preview Template: Click here admin can preview the promo bar template.

2.1.4. Display

• Display Position: Select the display position of the promo bar.

  

  • Top of the page: promo bar displayed at the top of the page.
  • Top of the content: promo bar displayed on the content section.
  • Fixed bar at the top of the page: promo bar displayed fixed at the top of the page.
  • Fixed bar at the bottom of the page: promo bar displayed fixed at the bottom of the page

• Custom: Admin can choose any location in the store to display the Promo Bar by copying and pasting commands into the CMS page/ Static Block, template.phtml file and store Layout file.

• Select Page: Select the location for displaying the promo bar at the pages.
  • All Pages: Promo Bar displayed on all pages.
  • Specific Page:
    • Display On Page(s): Select the page that allows you to display promo bar on. The One Step Checkout Page will be displayed here when the admin configure the One Step Checkout extension
    • Display On Category Page: Select the category page to display the promo bar on.
    • Display On Product Page: Select Yes to allow promo bar to display in the product page.

2.1.5. Trigger Setting

• Auto-close after: Admin selects the time to automatically turn off Promo Bar. If you select Use Config, the promo bar will apply the time set in the Configuration section.

Imgur

• Auto-reopen schedule: Admin choose the time to re-display Promo Bar. If you select Use Config, the promo bar will apply the time set in the Configuration section.

III. Frontend

1. Home page

2. Category Product

3. Product Detail Page

4. Check Out Page

5. One Step Checkout Page

Promo Bar is fully compatible with One Step Checkout

6. Shopping Cart Page

7. Compatible with Free Shipping Bar

8. Custom

8.1. CMS Page/ Static Block

For example: Admin wants to display Promo Bar on the About us page, follow these steps:

• Step 1: Go to the backend, click Content > Pages and select Edit at About us.

• Step 2: Insert the code into the page content About us.

• Step 3: Save and check on the frontend

8.2. Template .phtml file

If admin wants to insert a promo bar into a certain location in the .phtml Template file, follow these steps:

• Step 1: Go to the server and find the directory with the path vendor/magento/module-catalog/view/frontend/templates

Below are the folders in the templates file.

• Step 2: Select the folder then select the file with the format of .phtml

For example: I select the product folder, continue to select listing.phtml file to conduct the action

• Step 3: Open the selected .phtml file and insert the code

Save and check at the frontend

8.3. Layout file

If admin wants to insert a promo bar into a certain location at the Layout file, follow these steps:

• Step 1: Go to the server and find the directory with the path vendor/magento/module-catalog/view/frontend/layout

• Step 2: Select any file and insert the code into the file

For example: I selected the file catalog_category_view.xml

Save and check at the frontend.

IV. REST API

Mageplaza Promo Bar supports users in using REST API to add data to Free Shipping Bar. You can add/edit/view/delete the information of the extension.

View more details here.

View guidelines to create Integration Tokens here

V. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-promo-bar-graphql

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

To start working with Promo Bar GraphQL in Magento, you need to:

• Use Magento 2.3.x or higher. Set your site to developer mode.
• Set GraphQL endpoint as http:///graphql in url box, click Set endpoint. (e.g. http://dev.site.com/graphql)
• The queries and mutations that Mageplaza support can be used to view the details here.

Promo Banner

Similar to Promo Bar, the next extension of Mageplaza - Promo Banner helps admin advertise store promotions or major upcoming events. Moreover, it allows customers to catch news and events of the store more quickly and conveniently. The extension let the admin display one or more banner at different locations and multiple pages, they can also set the display time for each banner. More specifically, Promo Banner also displays in various forms such as image, slider, floating, popup, text.

In addition, Promo Banner is fully compatible with One Step Checkout, Free Shipping Bar, Banner Slider, Promo Bar.

How to download and install

• Download Mageplaza Promo Banner
• How to Install

How to Configure

I. Configuration

Login to the Magento Admin, go to Marketing > Promo Banners > Configuration.

Admin can also access Stores > Configuration > Mageplaza > Promo Banner to configure module.

1.General

• Select Enable = Yes to enable the module
• Promotion Category:
  • Category Name: Admin enters a name for the promotion category. This is a required field.
• Action:
  • Delete: Click on the trash icon when you want to delete promotion category.
  • Add: Click Add button when you want to create a promotion category.
  • Allow Customer to Close Promo Banner: Select Yes to allow customers to turn off promo banner.
  • Auto Close Promo Banner After: Admin sets the auto-closing time for promo banner.
  • Auto-reopen schedule: Admin set time to reopen the promo banner after being closed.
    • Note: Auto-reopen will be run again if customers click Close button.

2. Slider Banner Settings

• Show Next/ Prev Buttons: select Yes to display the Next/ Prev button. You can click these two buttons to see more banner or return to the previous banner.
• Switching Time: Enter the displaying time for each slider.

3. Popup Banner Settings

• Popup Responsive: admins choose showing style of promo banner in popup.
  • Full Screen Popup: Popup show in full screen
  • Center Popup: Popup show at the screen center
• Rejection Checkbox: Select Yes to display the checkbox asking customers if they do not want to see the popup Promo Banner for the next visit. If the customer tick to this checkbox, on the next visit, promo banner will not be displayed.
• Checkbox Label: Enter a name for the checkbox.

4. Floating Banner Settings

• Floating Block Width: Enter the width for floating block.
• Floating Block Height: Enter the length for floating block.

II. Manage Promo Banner

• Here saved all the Promo Banner created.
• At form grid, admin can view all basic information of Promo Banner such as ID, Content, Name, Status, Promotion Category, Position, Start Time, End Time, Priority, Action.
• Admin can perform some of the following actions:
  • Edit: Select Edit in the Action column to edit the information on the Edit Promo Banner page.
  • Delete: Select promo banner to delete Action > Delete.
  • Change Status: Change the status of promo banner.
  • Add New Promo Banner: Create new Promo Banner.

1. General

• Name: Admin names the promo banner
• Select Status = Enable to allow promo banner to be applied
• Store Views: Admin choose a store to display promo banner
• Customer Groups: Select groups of customers who can view banner.
• Promotion Category: Select the applicable promotional category.
• Start Date: Select the start date for the promo banner being shown.
• End Date: Select the end date for the promo banner being closed.
• Priority: Enter the priority for promo banner. The lower the input value, the higher the priority.

2. Conditions

Admin chooses the conditions for promo banner displayed in the checkout page.

3. Design

3.1. Single-Image Banner

• Choose Promo Banner Type = Single-Image Banner: The display promo banner in images form.
• Select Image: Click Choose File to download images for promo banner.
• Direct URL: Insert a link to redirect customers to when they click on promo banner image at frontend.

3.2. Slider Banner

• Select Promo Banner Type = Slider Banner: The display promo banner in slider type ( multiple images).
• Select Image(s):
  • Add New Image: Click this button, the system will automatically display the new image creation section for slider.
  • Image: Click Choose File to upload the image for the slider.
  • Direct URL: Insert a link for visitors to be redirected to when clicking on the promo banner image at frontend.
  • Sort Order: Enter the priority for the image of the slider. The smaller the input value, the higher the priority.
  • Action: Click on the trash can icon to delete the image of the slider.

3.3. Popup Banner

• Choose Promo Banner Type = Popup Banner: The display promo banner in popup.
• Select Popup Banner: Click Choose File to upload a popup image
• Responsive Popup: Select the position to display for the popup.
  • Use Config: Popup Banner is displayed according to settings at Configuration.
  • Center Popup: Promo Banner is displayed in the middle of the popup.
  • Full Screen Popup: Promo Banner is displayed full screen.
• Direct URL: Insert a link for visitors to be redirected to when clicking on the promo banner image at frontend.

3.4. Floating Banner

• Select Promo Banner Type = Floating Banner: The display type of promo banner is floating.
• Select Floating Banner: Click Choose File to upload image for Floating banner.
• Direct URL: Insert a link for visitors to be redirected to when clicking on the promo banner image at frontend.

3.5. HTML Text

• Choose Promo Banner Type = HTML Text: The display style of promo banner is HTML Text.
• Text Content:
• Show/ Hide Editor: Enter the content displayed for promo banner.
• Insert Image: Download photos for promo banner.

3.6. CMS Block

• Select Promo Banner Type = CMS Block: Promo banner is shown in CMS block
• Select CMS Block: Select CMS to make promo banner.

4. Display

4.1. Apply to Design is Single-Image Banner, Slider Banner, CMS Block, HTML Text

• Display Position: Select the place to show promo banner

• Top of the content: Promo banner is displayed above the content
• Top of the page: Promo banner is displayed at the top of the page
• Main Sidebar: Promo banner is shown in the main sidebar
• Additional Sidebar: Promo banner display in the additional sidebar
• Under Add To Cart button (Product Details Page): Display promo banner under the Add to Cart button on the Product Details Page when choose Select page (s) = Specific Pages
• Under Total Order (Cart View Page): Display promo banner under the total order in the view cart page.
• Customize position using Widget: The promo banner displayed at the position is customized in the widget.
• Customize position using Snippet Code: Promo banner can be displayed at any store position by insert commands into CMS page/ Static Block, template.phtml file and Layout file.

• Select Page(s):
  • All Pages: Promo Banner displayed on all pages.
  • Specific Pages
    • Display on Page(s): Select the page that you want to display promo banner.
    • Display on Category Page: Select the position at category page to display promo banner.
    • Display on Product Page: Select Yes to allow promo banner to be shown on the product page.

4.2. Apply to Design as Floating Banner

• Display Position: Select the display position for floating promo banner. There are 2 options: Left Floating and Right Floating.
• Select Page(s): Select the page to display promo banner. (Same as Point 4.2)

4.3. Apply with Design as Popup Banner

• Display Position: Promo Banner displays in popup.
• Select Page (s): Select the page to display promo banner. (Same as Point 4.2)

5. Trigger

• Auto-close after: Admin selects the time to automatically close the Promo Banner. If you select Use Config, promo banner will be shown following the time in the Configuration section.

• Auto-reopen schedule: Admin choose the time to display the Promo Banner again. If you select Use Config, promo banner will be re-shown following the time in the Configuration section.

)

III. Frontend

1. Design

1.1. Single-Image Banner

1.2. Slider Banner

1.3. Popup Banner

1.4. Floating Banner

1.5. HTML Text

1.6. CMS Block

2. Display

2.1. Top of the content

2.2. Top of the page

2.3. Main Sidebar

2.4. Additional Sidebar

2.5. Under Add To Cart Button (Product Details Page)

2.6. Under Total Order (Cart View Page)

2.7. Checkout Page

2.8. Mageplaza One Step Checkout Page

3. Snippet Code

3.1. CMS Page / Static Block

For example: Admin wants to display Promo Banner on the About us page, follow these steps:

• Step 1: Go to the backend, click Content > Pages and select Edit at About us.

• Step 2: Insert the code into the page content About us.

• Step 3: Save and check on the frontend

3.2. Template .phtml file

If admin wants to insert a Promo Banner into a certain location in the .phtml Template file, follow these steps:

• Step 1: Admin go to the server and find the directory with the path of vendor/magento/module-catalog/view/frontend/templates

Below are the folders in the templates file.

• Step 2: Select the folder then choose the file with the format of .phtml

For example: I select the product folder, continue to select listing.phtml file to perform the action

• Step 3: Open the selected .phtml file and insert the code

Save and check at the frontend

3.3. Layout file

If admin wants to insert a Promo Banner into a certain location at the Layout file, please follow these steps:

• Step 1: Admin go to the server and find the directory with the path as vendor vendor/magento/module-catalog/view/frontend/layout

• Step 2: Select any file and insert the code into the file

For example: I selected the file catalog_category_view.xml

Save and check at the frontend.

4. Widget

Admin can set Promo Banner to display at any location with Widget. To create a widget, you need to do the following:

• Step 1: Go to Admin page, select Content > Elements > Widgets, continue to select Add Widget
• Step 2: Select Type = Mageplaza Promo Banner, Design Theme = Magento Luma. Then choose Continue.

• Step 3: Enter the required information.

• Step 4: Click Add Layout Update to set the location for the widget.

• Step 5: Select which Promo Banner to display the widget.

• Step 6: Save and check at the frontend.

Quickbooks Online

Overview

Quickbooks Online is a software that helps small and medium businesses perform accounting tasks most effectively. Mageplaza Quickbooks Online extension will help you fully integrate with Quickbooks Online to connect and synchronize mass or each data information from Magento such as Customer, Product, Order, Invoice, Credit Memo, Payment Method, Tax to Quickbooks Online(corresponding with Customer, Sales Receipt, Invoice, Products and Services, Credit Memo, Tax Service, Payment Method).

That will help create a smooth flow for your business, better manage your accounting data and better organize your financial work. Also, in the process of sending data to the Quickbooks Online, admin can be sent manually or automatically synchronize whenever there is any update. These settings are configured by admin in the backend.

How to download and install

• Download Mageplaza Quickbooks Online
• How to Install

How to use

Quickbooks Online:

• To register a Quickbooks Online account, visit the this link.

• After registering an account, visit this link to get your API login information. The select My Apps and click to Create an app. There provided with Client Id and Client Secret you need save it to be able to connect with Quickbooks Online later.

• Select QuickBooks Online and Payment. Then enter the required information and click Create app to start creating the app.

Imgur

• Accessing the Key & OAuth tab, you can get Client ID and Client Secret information. Click the Add URI button and copy the Redirect URIs value available in Mageplaza’s Quickbooks Online to fill out.

How to Configure

1. Configuration

Login to the Magento Admin, choose Stores > Settings > Configuration > Quickbooks Online.

1.1. General Configuration

• Enable: Select Yes to activate the module and use the function data synchronization from the Magento Objects to Quickbooks Online.

• Environment:

  • Admin can select Sandbox environment to test module function
  • When you want to apply data synchronization inlive site, choose Production.

• Client ID:

  • Enter the obtained ID in Quickbooks Online into the Client Id field to connect to Magento.
  • If left blank or incorrectly entered ID, it will not synchronize data with Quickbooks Online.

• Client Secret:

  • Enter the Client Secret obtained in Quickbooks Online.
  • If left blank or filled incorrectly in the Client Secret, it will not synchronize data with Quickbooks Online.

• Redirect URIs:

  • Copy value in this field and paste to the similar field in Quickbooks Online

  

  • Admin can get Company Name and Company ID to check the connection with Quickbooks Online by clicking Connect button and choose the Company Name you want to sync. After that, you will see a successful notification. You should close the current tab then return to Quickbooks Online to configure the module

1.2. Queue Log/Sync Schedule

• Delete Queue Log After:
  • Enter the number of days into Delete Queue Log After. In which, for the queues synchronized having success will be auto-deleted after the time configured here. For example: You enter 6 days in this field, meaning that those queues with success status will be deleted after 6 days.
  • If empty, Log will no longer be deleted.
• Sync schedule: Select the time to send data to Quickbooks Online automatically. Any Magento objects changes will be sent to Quickbooks Online; otherwise, the unchanged data will not be sent to Quickbooks Online anymore.
• Number Of Objects Send Per Time:
  • Enter the number of objects limit each time sending data to Quickbooks Online. Any pre-added queues will be prioritized to be sent to the Quickbooks Online first. The value is allowed to range from 1 to 1000.
  • If you leave it blank or zero, the schedule is not run.

2. Manage Sync Rules

Login to the Magento Admin, choose Stores > Quickbooks Online > Synchronization Rules.

2.1. Grid

Here, the Sync Rules information includes the Name, Magento Object, Quickbooks Module, Website, Total Objects, Total Request (include error and success statuses), Total Pending, etc.

• Click Add new button to create a new rule. After creating rules, you can choose Edit to edit rules. Also admin can delete rules, change status (Enable/Disable), filter, and so on.
• Select Add Data to Queue if you want to add more data to Queue. Or with Mass Actions, admin can synchronize one or more rules at the same time when clicking Add To Queue.

Note: When installing Mageplaza Quickbooks Online and creating the Synchronization Rules, you should click Add Data to Queue to put the previous data into Queue and synchronize data to Quickbooks Online.

Mageplaza’s Quickbooks Online extension is fully compatible with the Report extension, which provide reports on queue synchronized quickly and conveniently at three columns: Total Object, Total Pending, Total Request.

2.2. Create Sync Rule

• Magento Object: Select Magento Object to allow sending that Magento object data to Quickbooks Online.
• Quickbooks Module: Here will display the Quickbooks Module corresponding to the selected Magento Object. For example: Magento Object is Customer, so the information corresponds from Zoho Module selectable are Customer.
• Website: Select Website from which to get Magento Object data sending to Quickbooks Online.

After selecting the object, click Next to start filling at Form create/ edit Sync Rule

2.2.1. General

• Name:
  • Enter the name of Sync rules
  • This is a required field
• Status: Select Active to anable the rules work and synchronize data to Quickbooks Online.
• Data of Magento Object, Quickbooks Module, Website are taken according to the object data above before creating sync rules and can only be changed when admin changes object information before creating.

2.2.2. Conditions

• Select the conditions to filter the data that the admin wants to sync to Quickbooks Online. Those data that meet the conditions of each rule will be put into Manage Queue to synchronize data and vice versa.
• Note: Each rule will have different options and conditions. There is no Conditions tab when creating rules with Payment Method.

2.2.3. Mapping Fields

Here select the corresponding Magento Fields to send data to Quickbooks Online. There is no Mappign fields tab when creating rules with Payment Method.

• Quickbooks Fields: Displays the fields managed by Quickbooks corresponding to the selected Magento Objects. Quickbooks Fields change depending on the change on selected Magento Object such as Customer, Product, etc.
• Magento Fields:
  • Enter the fields of the corresponding Magento object to upload data with the fields of Quickbooks Module.
  • Leaving this column blank will get the Default Value column to apply to Quickbooks Module.
• Internal Note: Enter an internal note for any note of this rule. This is for admin use only, not for data synchronization.
• Insert Variables: Select the fields of the Magento object corresponding to the fields of Quickbooks Online.

2.2.4. Queue Report

Here records Queue data by rules which include information of Object, Created On, Status, Updated On. etc. Also, there are reports of Pending Request, Total Object, Total Request (Queue number created).

Note: With Created On is the time that data are imported to Queue. Updated On is the time when the queue is synchronized to Quickbooks Online.

2.2.5 Payment Method List

The Payment Method List tab only appears when creating rules with the Payment Method and shows the tab after clicking Save/Save and Continue Edit.

• Reindex Payment button: Click Reindex Payment button to update payment method when there is a change in title or when that payment method is not used on your website.
• Here record the Payment Method information including the fields: Code, Title, Quickbooks Entity,… It is possible to synchronize each or multiple payment methods when you select the payment and click Add to queue in the Action section.

3. Manage Queue

• This section records the information of Queue including Object, Sync Rule, Magento Object, Quickbooks Module, and so on.
• Here admin can synchronize all data or select specific data to add to queue and synchronize to Quickbooks Online. All data changes such as create, update, delete are included in Queue.
• When you click on View, it will display Popup View Queue to see all information of each Queue. Select Delete to delete Queue and Resend to resend Queue.

4. Customer, Product, Order, Invoice, Catalog Rules

4.1. Grid

Here admin can synchronize multiple data or individual data by event: product, order, invoice, credit memo, customer (not include Tax and Payment method). These data will be sent to Manage Queue to be synchronized. This feature will help admin synchronize selected data by each product, customer, etc., more quickly and conveniently.

4.2. Edit

With the available data before, admin can Add To Quickbooks Queue with Customer, Product, Order, Invoice, Credit Memo to send data into Manage Queue and synchronize them.

• System will show a Quickbooks Online tab when editing into customer account data, product, order, so on; which helps report and display a list of queues with each of that data information, including Status, Quickbooks Module, Event, Created On, Updated On, etc.
• Admin can filter, search those data from the available columns.

Quick Cart

Overview

Usually, if you want to check the cart details right into view cart or check out, it will be inconvenient and quite time-consuming. But with Mageplaza, it is solved easily and quickly thanks to Quick Cart extension. The module has a modern minicart design, combined with a shopping cart detailing feature that helps customers save shopping time, without having to access the view cart page directly. The module also allows to customize the number of products, options to configure the background color, title, customize CSS in minicart. In addition, you can set effects for minicart.

Mageplaza Quick Cart is fully compatible with Mageplaza Reward Points and Mageplaza Gift Card helping customers have a better overview and save more time to purchase items quickly.

How to download and install

• Download Mageplaza Quick Cart
• How to Install

How to use

Minicart with new interface:

Automatically display minicart popup when hovering to cart:

Always display the minicart when the page is scrolled down:

Compatible with Reward Points and Gift Card:

How to Configure

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Quick Cart

1.Configuration

1.1. General

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Quick Cart, select General

• Enable: Select Yes to turn on the Module.

• Popup Effect:

  • Slide-in (right side): Display new popup minicart when clicking on cart:
  • Hover-over: Automatically display the minicart popup when hovering to the shopping cart

• Auto Open Minicart:

  • Only displayed when at Popup Effect field, you select Slide popup (right).
  • Minicart is auto displayed when customer adds product to cart.
  • Note: this feature will work provided that AJAX is supported. If the page reloads after customers clicking on Add to Cart, it will not work (e.g. My Wishlist page, Recently Ordered, Catalog Products List widget, ..).

  

• Show Coupon Box:

  • Display the coupon filling box applied
  • You can access Marketing > Cart Price Rules, select Add New Rule to create new coupon rules
  • Instructions on how to create new rules can be found here.

• Show Information:

  • Full Total Information: Displays all information in minicart including: Subtotal, Discount, Shipping & Handling, Tax, Grand Total.
  • Only Subtotal: Only displays Subtotal information in minicart.

• Fixed Minicart On Scroll: Select Yes to always display the minicart icon when the page is scrolled.

1.2. Design

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Quick Cart, select Design

• Header Background color:
  • Select the background color for the minicart header.
  • If empty, the default color #1979c3 will be used.
• Header Text Color:
  • Select the text color of the minicart header.
  • If empty, the default color #ffffff will be used.
• Subtotal Background color:
  • Select Subtotal background color.
  • If empty, the default color #ffffff will be used.
• Subtotal Text Color:
  • Select the font color in Subtotal.
  • If empty, the default color #333333 will be used.

• Custom CSS: you can write CSS code here, it not only can change colors but also many other things
• Example: At the Custom CSS field, you fill in .mpquickcart .block-title {font-size: 28px;}, then at Frontend, it will display the bigger size of text indicating the item number in the cart ( see picture below)

2. Compatible with Reward Points

With Reward Points integration, it allows displaying the total number of points of the shopping cart that customer can get after payment in minicart. Also, it enables displaying the number of reward points that customer uses to deduct from the total cart.

3. Compatible with Gift Card

With the Gift Card integration, it allows showing more on the total, including the amount of discount due to Gift Card code or Gift Card Credit:

Quick View & Ajax Cart

Overview

When customers want to view the product detail page, they have to click on the product and wait for a while to see it. So, if they want to view a product, they have to open more tabs and take more time to know more details about that product. That’s why Mageplaza Quick View module is released. It helps you save more time surfing the web, see more details and increase sales for your store. Customers don’t need to visit the Product Detail page to view product details, just click on the icon or label on the image, then they can view full product information through the popup displayed on the screen. This allows customers to view multiple products without spending a lot of time. Not only that, when customers add products to the cart, the popup about product details information is also displayed and that product will automatically fly into the cart quickly.

How to download and install

• Download Mageplaza Quick View
• How to Install

How to use

1. Quick View Popup

1.1. Display the icon on the product

1.2. Display the label on the product

1.3. Display the popup

2. Ajax Cart

2.1. When clicking on Add To Cart button

2.2. When clicking on Add To Wishlist

2.3. When clicking on Add to Compare

How to configure

From the Admin Panel, go to Store > Settings > Configuration > MAGEPLAZA EXTENSIONS > Quick View

Configuration

1. General

• Enable: Choose “Yes’ to use the feature of this module.

2. Quick View Configuration

• Enable: Choose “Yes” to display the popup of Quick View
• Apply for:
  • Choose the page to display the popup of Quick View. For example: Select Apply for = Home Page, then when customers click on the icon or label on the products on homepage, it will display the popup of Quick View only. On the other pages, it will not display.
  • The popup can be displayed on many pages
  • It’s compatible with Widget
• Display:
  • Display = Icon: Allow showing the icon on the product’s image
  • Display = Label: Allow showing the label on the product’s image
  • Button Icon: You can use the default icons or upload the icons. This icon will display on the product’s image.
  • Button Label:
    • Enter the label that display on the product’s image
    • The default label is Quick View
  • Text Color: Choose the color for the labels displaying on the product’s image. The default color is #000000
  • Background Color: Choose the background color for Button Label. The default color is #FFFFFF
  • Animate: Allow choosing the animation displaying in the popup
  • Popup Information:
    • Choose the product information displaying on the popup when you click on the icon or button label on the product
    • Allow displaying many product’s information on the popup
  • Edit Cart Item Popup Information:
    • Choose the information of the product displaying on the popup when you click on the icon or button label on the Cross-Sells product added to the cart on the Shopping Cart page. Or when you click on the edit icon on the product added to the cart
    • Allow displaying many product’s information on the popup

3. Ajax Cart Configuration

• Enable: Choose “Yes” to display the popup of Ajax Cart
• Apply for:
  • Choose the display page the popup of Ajax Cart. For example: Choose Apply for = Home Page, when customers click on the icon or the label or click on Add To Cart button on the product on homepage, the popup of Ajax Cart will be displayed. On other pages, the popup will not be displayed.
  • Allow displaying the popup on many pages
• Apply for Actions:
  • Apply for Actions = Add To Cart: Display the popup of Ajax Cart when customers press on Add To Cart button
  • Apply for Actions = Add To Compare: Display the popup of Ajax Cart when customers press on Add To Compare button on Quick View Popup
  • Apply for Actions = Add To Wishlist: Display the popup of Ajax Cart when customers press on Add To Wishlist button on Quick View Popup
• Enable animate Add To Cart: Choose “Yes” to use the animation feature of the products. It will auto-fly into the cart after pressing the Add To Cart button
• Countdown time:
  • Enter the number of seconds displaying for the popup of Ajax Cart
  • The default Ajax Cart popup is 10 seconds
• Show Mini Cart instead when an item is added: When there is only 1 item is added to cart, display the mini cart instead. From the second item, display the ajax popup

4. Increasing Sales Options

• Block to show in the pop-up: Select blocks displayed at Ajax popup when customers add to cart
  • Block to show in the pop-up = None: Do not show additional block
  • Block to show in the pop-up = Related: show Related Product block on on Ajax popup. After selecting this option, you will see Title and Possible Qty Limit fields
  • Block to show in the pop-up = Cross-sell: show Cross-sell Product block on Ajax popup. After selecting this option, you will see Title and Possible Qty Limit fields
  • Block to show in the pop-up = CMS Static Block: show CMS Static Block on Ajax popup. After selecting this option, you will see Block field
• Title: Type in the title for the block. This filed is displayed only when Block to show in the pop-up = Related or Cross-sell
• Possible Qty Limit: type in the limit number for showing products on the block. This filed is displayed only when Block to show in the pop-up = Related or Cross-sell
• Block: Choose the block displayed from the droplist. This filed is displayed only when Block to show in the pop-up = CMS Static Block

5. Visual Settings

• Button Text Color: select the text color for button on Ajax popup
• Continue Button Color: select the color for Continue button on Ajax popup
• View Cart Button Color: select the View Cart button on Ajax popup
• Proceed to Checkout Button Color: select the color for Proceed to Checkout button on Ajax popup
• Custom CSS: you can customize the display with CSS here

6. Compatible with Widget

To insert the code, you use the following code:

{% raw %}

{{block class="Mageplaza\QuickView\Block\QuickView\Popup"template="Mageplaza_QuickView::quickview/widget/button.phtml"}}

{% endraw %}

then add it into anywhere you want to display Quick View Popup.

You can add it on one page or one block by going to Content > Page. Also, you can insert it into .phtml, .xml files of Magento as well as other extensions that you want to display the popup.

Quick Order

Overview

Making a quick order has never been easy for any customer, especially for wholesale customers. To solve this problem, Magento experts from Mageplaza have released Magento 2 Quick Order extension. Thanks to this extension, customers can order quickly by searching for the product name or SKU of that product. Ordering process becomes easier than ever for your customers.

Quick Order extension can be used by both the Customer who has an account at the store and the Guest who has no account. We believe that with the help of this module, you can improve the revenues and profits dramatically.

Download & Install

• Mageplaza Quick Order
• How to install

How to use

To use this module, customers need to click on the Quick Order link or the button in the frontend. There’re 3 positions that customers can find the Quick Order link or the button:

• Top Menu

• Next to Search Box

• Footer Link

After clicking on the button/link of Quick Order, customers can access to the Quick Order page that its interface is displayed as below:

• 1 - Add to cart button:
  • This button allows customers to add all products that they have selected in the virtual cart (in area 4) into the real cart of the store in order to checkout.
  • If there’s an error in this process, the system will take the page back the Quick Order page and all products in the virtual cart won’t be lost.
• 2 - Checkout button: Similar to 1 - Add to cart button, the only difference is, instead of going to Shopping Cart Page, customers will be redirected to the Checkout page.
• 3 - Instant Search Box:
  • Customers can look for the product that they want to purchase by SKU or the product name when filling in this box.
  • The result will show the information and the images of the product that can adapt to the conditions customers enter.
  • The number of the result will be controlled in the configuration by the admin.
  • When admins change Currency or other information of the products, maybe ‘Search’ will make the information display incorrect. Therefore, admins need to access pub/media/mageplaza, remove Search item and Refresh the Quick Order page to update the information for the system. You need to runthe command php bin/magento index:rein after creating a new product.
• 4 - The virtual cart:
  • This the place where can store temporarily the products customers want to purchase.
  • At this field, customers can see all information of products, change options of the attribute, modify the quantity or add a new product as well as delete those products from the virtual cart.
  • The price displaying in the virtual cart is the original price of each product, not count Tax.
• 5 - Add to cart button: Similar to 1 - Add to cart button
• 6 - Checkout button: Similar to 2 - Checkout button
• 7 - Add multiple products by SKU box:
  • When customers have known SKU and the attributes of the products, it’s so easy for them to add these products to the virtual cart by SKU box.
  • Customers only need to fill the information of products as the following format: SKU, qty, size:M, color: Black
  • Customers need to line up to add other products.
  • Finally, customers click on 9 - Add to list to add products to the virtual cart.
  • For example: MH02, 9, size:M, color:Red
• 8 - Add multiple products by CSV file and XML file:
  • Customers need to download sample CSV file or XML file at first import by CSV or XML to know the format in the CSV file or XML file.
  • With the eligible CSV file or XML file, all products listed in that will be added into the virtual cart after clicking Upload Now
• 9 - Add to list button:
  • After customers enter the information into SKU box or upload the CSV file, they need to click on this button to add them into the virtual cart.
  • This button only works if the SKU box has the information.
• 10 - Clear All List: When clicking this button, the virtual cart will be empty. All products in the virtual cart will be deleted.

How to configure

After logging into Magento admin, go to Store > Settings > Configuration > Mageplaza Extensions > Quick Order.

General Configuration

• This is the general configuration, which can be applied for the module.

• Enable:

  • Choose Yes to enable this module
  • Quick Order link/button only displays if the module works well

• Route name: The URL of Quick Order page is the content that is filled in this field.

• Page title: Page Title of Quick Order page is the content that is filled in this field.

• Allow Customer Group: Only selected customers in this field can view the button/link of the Quick Order page.

• Message: The notification filled in this item will be displayed with unselected customer group in the item above when they try to access on the Quick Order page.

• Quick Order label: The label of Quick Order page will be formated in this item.

• Show Quick Order Link: There are 3 positions that Link/button of Quick Order page can be shown:

  • Top Menu

  

  • Next to Search Box

  

  • Footer Link

  

• Quick Order Button label: Label Quick Order button is shown next to cart which is set in this section

Search

• Auto search minimum character:
  • The number entered here specifies the minimum number of characters that customers must enter to display the search result.
  • If this field is empty, the default is 2.
• Limit search results:
  • Enter the number of search result that you want to show in the search result grid
  • If this field is empty, the default is 10.
• Display product image: Choose Yes to display the image of the product in the Search Result field.

Design

• Heading Background Color: This field specifies the color of the Heading.
• Heading Text Color: This field specifies the text color of the Heading Text.
• Heading Background Button: This field specifies the color of buttons in the frontend.
• Background Color Button Quick Order: Set the color for Quick Order button.

Rest API

Mageplaza Quick Order extension support the use of REST API to view information of products in quick order. Besides, extension supports adding and deleting products to/from quick order directly via API requests.

View details here

View guidelines to create Integration tokens here.

GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-quick-order-graphql

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

To start working with Quick Order GrahpQL in Magento, you need to follow these requests:

• Use 2.3.x. Take the site back to Developer mode
• Place GraphQL endpoint as http:///graphql on URL field, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql)

View details of queries supported by Mageplaza Quick Order here

Request For Quote

Overview

How can your loyal and wholesales customers can make a bagain on your stores if they buy product in large quantity? With Mageplaza Request For Quote, customers and admin can create quote prices for a request. A chat channel established, helping admin and customer to discuss with each other. Besides, button request for quote displayed on the category page, product detail page, view cart page helps customer make a quote easily at anywhere. Moreover, the extension also notifies customers when the request is about to expire and has expired already so that customers can track their quote again.

In addition, we also support Request For Quote compatible with Quick Order extension, SMTP. This extension helps you quickly handle customer requests and take care of your customers better.

Download and Install

• Download Request For Quote
• Install Mageplaza extension

How to Use

With this extension Customer can perform the following actions:

1. Customer creates Request for Quote:

To create a Request for Quote, customer can follow these steps:

Step 1: Add Product(s) to Quote Cart.

When Guest click on Add to Quote icon, a popup shown requiring login to your account.

Customer can add products to Quote Cart at locations below:

• Categories Page

• Product Detail Page

• Shopping Cart Page
• Note: Customer can add all products in the cart to the quote by clicking on the Add All To Quote button.

Step 2: Submit Quote Cart

After adding product(s) to the Quote Cart, customer click the mini Quote Cart icon (next to the Shopping Cart icon) and then click View Quote Cart.

The system automatically redirects to My Quote Cart page. Here, display information of the product that has been added to quote.

• Customer can add one or more products by entering the SKU at Add Product By SKU.

Note: Products that use Customizable Options (required) will not be added here.

• Customer makes the quote for product(s) by changing Quote Price and Qty, click Update Quote Cart to complete the change.
• Click Add Comment to enter and send a message to the admin when submitting the quote. Attachments for messages must not exceed 2Mb.
• Click Submit Quote Cart to complete the Request creation.
• Requests created by customer are all displayed in Pending status

.

2. My Quotes

• Customer can view quote information such as: ID quote, Submitted Date, Expired Date, Quote Total, Status, Action.
• In addition, customer can perform actions in the Action column such as:
  • Select View: To view the Quote details.
  • Add to Cart: The products included in approved quotes will be added to the cart.
  • Duplicate: The products included in the duplicate are automatically added to quote.
  • Cancel: Cancel the request for quote.
  • Delete: Delete the quote.

• In View Quote, customer can only edit the quote when the quote has Status = Pending.
  • In addition, customers can Delete, Cancel, Add to Cart, Print Quote and send a message to the admin at Conversation.

3. Customer add quote to cart

• Customer adds the quote to the cart when the quote is approved. This quote has already added to cart in this order. Each quote is added to cart once per order.
• In order for customers to easily distinguish the product in quote from other products, the extension supports displaying Quote Label item in each product belonging to quote.

• Customer view order

How to Configure

I. Configuration

Login to the Magento Admin, go to Marketing > Quote Request List > Configuration.

Admin can also go to Stores> Configuration > Mageplaza > Request For Quote to configure the module.

1. General

• Select Enable = Yes: The Request For Quote module is enabled.
• Quote Request Icon: Admin click Choose File to select the image for the icon. If left blank, the icon will be the module’s default icon.
• Allow By Categories:
• Select All Categories: Request for quote will be applied to all products in all categories.
• Select Specific Categories: The module automatically displays the Select Categories field. Admin selects the categories so that the products in that category are applied Request for quote.
• Enable For Customer Group: Admin selects a group of customers that can request for quote.
• Display For Guest: Select Yes to allow customers who do not have an account to make a request. When the customer clicks on the Add To Quote button, the system will ask the customer to loggin.
• Allow Requesters To Attach Files: Choose Yes to allow customers to upload the file for the request.
  • Allow File Types: Admin enters file formats for the file to be uploaded in the message area. This field only shows up when Allow Requesters To Attach Files = Yes
  • Add-to-cart Redirect Page**: Admin selects the redirected page when clicking Add to cart to the My Quote Cart page.
• Auto-approve Quotes: If select Yes, quote will be approved automatically with a discount smaller than the fixed amount (%)
• Once Percentage Discount is No More Than: The percentage discount (%) is applied for the whole quote excluding tax (only shown when Auto-approve is set as Yes)

2. Expiration Setting

• Approved Quotes Expire After: Admin enter the number of expiration dates for the quote. Leaving the request blank mean that no expiration limited.
  • Note: When quote expires, the system will automatically send notification email to customer.
• Quote RemindersSend Before: Admin enter the number of days to send a reminder email before the quote expires.

3. Email Setting

• Sender: Admin selects the email sender to the customer.

3.1. Quote Confirmation & Update Emails To Requesters

• Enable Emails After Quotes Submitted: Select Yes to send mail to customers when the quote has been successfully submitted. Admin chooses submission email template at Submission Notice Template.
• Enable Emails After Quotes Approved: Select Yes to allow sending mail to customer when quote has been approved. Admin chooses approve email template at Approval Notice Template.
• Enable Emails After Quotes Edited: Choose Yes to send mail to customers when the quote has been edited by admin. Admin chooses edit email template at Editing Notice Template.
• Enable Emails After Quotes Disapproved: Select Yes to allow sending mail to customer when the quote has been rejected by admin. Admin chooses disapproval email template at Disapproval Notice Template.
• Enable Admin Create Quote Email: Select Yes to allow sending mail to the customer when the quote has been admin created. Admin chooses create quote email template at Create Notice Template.

3.2. Quote Reminder & Expiration Notice Emails To Requesters

• Enable Expiration Reminder Emails: Choose Yes to send email reminders to customers. Admin chooses reminder email template at Expiration Reminder Template.
• Enable Emails When Expiration: Select Yes to send customers an email to notify the end of quote. Admin chooses expire email template at Expiration Notice Template.

3.3. Admin Notification Email

• Admin Email(s): Enter admin’s email to receive notifications. The email is separated by commas.
• Report Email To Admin: Admin chooses the time to send statistics of the number of quotes created to the admin. Admin select the report email template at Report Email Template.
• Enable Customer Edited Quote Email: Select Yes to send an admin notification email when the quote has been edited by customer. Admin chooses edit email template at Customer Edited Quote Email Template.
• Enable Customer Canceled/ Deleted Quote Email: Choose Yes to send admin notification emails when the quote is canceled/deleted by customer. Admin chooses cancel/delete email template at Customer Canceled Quote Email and Customer Deleted Quote Email.

II. Manage Request For Quote

• This is where all the Request For Quote is saved.
• On the form grid, Admin can view all the basic information of Request For Quote such as ID, Status, Customer, Customer Groups, Store View, Quote Total, Expired Date, Action.
• The admin can perform the following actions:
  • Edit: Click Edit in the Action column to edit the information on the Edit Request For Quote page.
  • Change Status: Change the Request For Quote status.
  • Create New Quote: Create New Request For Quote.

1. Create New Quote

The admin support module creates a new Request Quote for existing and existing Customer accounts. Admin, follow the steps below. The steps to create a new quote are similar to the admin for creating a new order.

Step 1: At Manage Quote Request Grid, admin click the Create New Quote button.

• Customer grid displays, admin select an account to create quote for that account.
• You can click Back to return to the grid Manage Quote Requests

Step 2: Admin select Store, Quote created will be applied to that store.

Click Cancel to cancel the action.

Step 3: Admin creates quote.

• Click the Add Product button to select a product to apply to the quote. Then, select Add Selected Product(s) to Quote to display the selected products on the Quote Item.
• Click Update items and Quantities after editing Price and Qty. - Select quote currency at Quote Currency.
• Account Information: Here shows the Customer’s Group and Email created quote, admin cannot edit this information.
• Conversation: Admin enter the message for quote. Attached files in messages must not exceed 2Mb.
• Quote Totals: Displays the total Quote Price.
• Click Submit The Quote to finish creating the quote for the customer. The admin-created quote will be in Approve status.
• Click Cancel to cancel the action.

2. Edit Request Quote

• Quote Information: Displays information of quote such as Created Date, Status, Expired Date, Create From, Place From IP.
  • Expired Date is only displayed when the quote is in Approve, Reject, and Expired states. Admin can change the quote’s expired date
• Account Information: Display account information such as Customer Name, Email, Customer Group.
• Quote Items: Displays the product information contained in the quote.
  • Add Product By SKU: Admin enter SKU to add product to quote, the SKUs are separated by commas. Products that use Customizable Options (required) will not be added here.
  • Admin changes the price and qty for the product at Quote Price and Qty.
  • Click Delete to delete the product in the quote.
• Conversation: Admin enter the message for quote
  • Attachments for messages must not exceed 2Mb.
  • Click the Send email to Customer checkbox: The message is emailed to the customer.
  • Click the Visible on Frontend checkbox: The message is sent via the frontend.
  • Click the trash icon to delete the message.
• Additional: Select the additional Discount/ Surcharge for quote Note: After editing the quote, the admin should Save/ Save and Continue Edit before Approve or Reject.

III. Emails

1. For Customer

1.1. Emails After Customer Submitted Quote

1.2. Emails After Admin Submitted Quote

1.3. Emails After Quotes Approved

1.4. Emails After Quotes Rejected

1.5. Emails After Admin Edited Quote

1.6. Quote Reminder Email

1.7. Quote Expiration Email

2. For Admin

2.1. Customer Edited Quote Email

2.2. Customer Canceled Quote Email

2.3. Customer Deleted Quote Email

2.4. Quote Report Email

IV. Compatible with Quick Order extension

The Add To Quote button is displayed on the Quick Order page when you use the Quick Order and Request For Quote extensions together. This support helps customers’ operations more quickly.

III. Rest API

Mageplaza Request For Quote extension allows customers to use Rest APi to practise requests realted to Quote such as adding products to quote, deleting items in the quote, updateting quote, canceling/deleting quotes that have been summited, uploading files, creating reply for conversations, getting quote/conversation information. Moreover, when you using both Quick Order extension and Request for Quote extension, you can add items form the quote to Quick Order.

See details request Rest API supported by Mageplaza here.

View Rest API Guidelines for Magento 2 here.

See guidelines to create tokens here.

Required Login

Overview

Mageplaza Required Login which can be applied to any page you want is used to force visitors to log in or register accounts. As a result, you can restrict visitors from accessing the site without logging in as well as generate and manage customer information. After login, admin can redirect customers back to the previous page or to any page you want. And especially with this new Required Login extension, if the number of customer account registrations is sufficient, you can turn off the account creation feature to ensure your site’s security.

Download and Install

• Mageplaza Required Login
• How to Install

How to use Required Login

How to configure

1. Configuration

Login to the Magento Admin, choose Stores > Configuration > Required Login.

1.1. General

• Enable: Select Yes to enable the module
• Disable Create Account: Select Yes to disable the Create Account feature. This will prevent customers generating accounts to access to your security sites.
• Login Message:
  • Enter the message shown after visitors access the selected pages, they will be automatically redirected to the login page
  • If you leave it blank, the default message is: This page requires login to access. Please take some minutes to login first

1.2. Configuration

• Apply for:
  • Select the page you want to apply required login. You can choose to apply multiple pages at once. The pages unselected will not be applied login requests.
  • You can leave this field blank
• Apply for CMS Page:
  • Select the CMS page you want to apply required login. You can choose to apply multiple CMS pages at the same time. The CMS pages unselected will not apply login requests.
  • You can leave this field blank
• Include Custom Page: Show a field as text for entering the URL paths which must be separated by a / in the field. Required Login with all pages including the url links entered below. Fro example: /blog, /men/top/t-shirt,…
• Exclude Custom Page:
  • Show more fields as text. Enter the URL paths which are separated by a / in the field. Required Login with all pages not including the url links entered below.
  • If insert the same URL to both Include Custom Page and Exclude Custom Page, the system will not apply required login to those URLs (means that Exclude Custom Page is prioritized)
• Redirect To:
  • Select the page you want visitors to be redirected to after successful login
  • Select Custom URL, a text field will appear letting you insert URL. They must be separated by a /
  • Home page: Redirect to home page after successful login
  • Customer dashboard: Redirect to Customer dashboard after successful login
  • Previous Page: Redirect to Previous Page (the page that is required login) after successful login. For example: required login for Home page means that customers will be redirected to Home page after logging in
  • This is a required field. If the URL is wrong, there will be a notification: Please enter a valid URL. Protocol is required (http://, https:// or ftp://).
• Apply Redirect for:
  • Only require login: Only apply redirecting for the website which is restricted and required to login
  • All login on site: Apply redirecting for all of the pages when customer login to their account. This also apply to the page that does not have login requirment such as Sing In.

Review Reminder

Overview

Customer reviews have tremendous influence over making a purchase of other consumers, especially for local business. Positive feedback is great but also negative one certainly has its place. In conclusion, the more reviews you can collect, the more initiatives you can implement for your business to ensure the e-commerce relationship. Boosting product’s credits means boosting sales and revenues.

Magento 2 Review Reminder would like to lend you a hand in delivering friendly reminders your customers to come back and write some words for your products. This oh-so handy extension will show the way how you can flexible engender review claim email chains, follow the sending procedure and its detail reports supported by Google Analytics effortlessly.

*Note: Mageplaza Review Reminder is totally compatible with Mageplaza SMTP extension

How to configure

Login to Magento Admin, go to Stores > Configuration >  Mageplaza Extensions > Review Reminder

1. Configuration

1.1 General Configuration

A bunch of fundamental configuration will assist you in modifying reminder email chains which can be accomplished just a few click. Follow this path Go to Admin Panel > Stores > Configuration >  Mageplaza Extensions > Review Reminder > Configuration then expand the General Configuration

• In Enable field: select “Yes” to enable Mageplaza Review Reminder extension
• In Only Send Emails to Subcribers field: select “Yes” to only send reminder emails to customers who have subcribed newsletter.
• In Email Configuration
  • Click the Add button to add a reminder email
  • Click the trash can icon to delete a email
  • Send After to change the email delivery time. The counting will be started from the last updated cart time, a reminder email will be sent to customers.
  • In Sender to choose sender’s entitle. You will have 5 choices: General Contact, Sales Representative, Customer Support, Email Custom 1, Custom 2 Email
  • In Email Template column, you can find some pre-made email templates. Otherwise, you can customize your own template by creating a new one at sidebar Marketing > Email Template. The newly created template will automatically appear in this section.

Note:

• When the order becomes Complete, the requested emails will be automatically generated with Pending status at Logs (see item 3). Emails will be sent automatically at the set time at Send After or as soon as Send Now button is hitted.
• For orders with Closed status, the requested email will not be sent.

1.2 Analytics

To keep track statistics of sent reminder emails, Magento 2 Review Reminder is well-integrate designed for Google Analytics to let you have a comprehensive overlook for SEO staffs. This function helps store admins follow and determine from where shoppers get the link back to the completed order.

Go to Admin Panel > Stores > Configuration >  Mageplaza Extensions > Review Reminder > Configuration, choose Analytics:

It manifests in this direct link in the frontend like

In the backend, this is Google Analytics’s configuration

• In Enabled field: Select “Yes” to use Google Analytics tool. Then, the Source, Medium, Name, Term, Content items will be displayed automatically
• In Source field: the data of Source will appear in the Link back to Cart if it’s available. If you leave it blank, Source on frontend won’t be displayed
• In Medium field: the data of Medium will appear in the Link back to Cart if it’s available. If you leave it blank, Medium on frontend won’t be displayed
• In Name field: data of Name will appear in the Link back to Cart if it’s available. If you leave it blank, Name on frontend won’t be displayed
• In Term field: the data of Term will appear in the Link back to Cart if it’s available. If you leave it blank, Term on frontend won’t be displayed
• In Content field: the data of Content will appear in the Link back to Cart if it’s available. If you leave it blank, Content on frontend won’t be displayed

1.3 Order Configuration

In this section you will be able to limit which products can be sent review invitation by determine its particular SKU.

Please go to Admin Panel > Stores > Configuration >  Mageplaza Extensions > Review Reminder > Configuration

• In Exclude SKUs field
  • Products which have SKU in this field won’t be received review reminder
  • You can add multiple SKUs by a comma and a space, for instance 24-UG06, 24-UG07
• In Include SKUs field
  • Products which have SKU in this field will be received review reminder
  • You can add multiple SKUs by a comma and a space, for instance 24-UG06, 24-UG07

An example of the Review reminder sent to a customer

2. Reports

This is the place to store a number of sent Review Sent Email successfully and failed for a specific period of time. Keep track at Admin Panel > Marketing > Review Reminder > Report. There are two Report Time modes

• DAY
  • When you select the DAY mode, adjust the From and To entries, the Report Time will be displayed on a daily basis
  • If the distance between From and To is too far apart, the distance between two days in Report Time will be increased

• MONTH: When you select MONTH mode, adjust the From and To entries, the Report Time will be displayed on a monthly basis

3. Logs

This is the place archiving abandoned cart emails which have been sent, including their ID, Order, Subject, Receiver, Sequence Number, Schedule At, Create At, Status (Sent / Error) và Action (Preview/Delete/Send Now)

• Action = Preview: a pop-up window showing the email which has been sent will appear
• Action = Delete: the selected emails will be deleted. You can choose multiple emails at the same time
• Action = Send Again: the selected email will be sent to customers again. This email has the same content as the selected email
• Clear Logs button: Click the Clear Logs button to quickly delete all the emails stored in the logs. The next email’s ID has nothing to do with the deleted one

RMA

Overview

Are you looking for a solution to help customers return products and the store owner make rules about product returns or exchanges with ease? You can find the answer with Mageplaza RMA extension. Customers can request a return or exchange of one or all products in their order placed earlier. At the same time, they are also allowed to reject, manage and view requests sent to admins. On the admin side, admins can manage and approve(or refuse) to process customer requests. Admin and customers talk to each other via email which is made with available templates. This extension will help you better handle your products and bring greater customer experience.

How to download and install

• Download Mageplaza RMA
• How to Install

Table of Contents

• I. Configuration
  • 1. General
  • 2. Request Configuration
  • 3. Email Configuration
• II. Manage RMA Request
  • 1. Add New Request
  • 2. Edit Request
• III. Manage RMA Status
• IV. Manage RMA Rule
• V. Manage Shipping Label
• VI. Frontend
• VII. Email

I. Configuration

Login to the Magento Admin, go to Sales > RMA > Configuration.

Admin can also access Stores > Configuration >  Mageplaza > RMA to configure the module.

1. General

1.1. General

• Select Enable = Yes to enable the module.
• Show RMA for Guest: select Yes to apply to customers who do not have an account but have already ordered so that they can return the item.
• Display RMA Link at: Select the position of RMA link display.
  • Note:
    • If customers logged in, the link leads to the request management page.
    • If customer not logged in, the link leads to the filter order page to submit the request. If Enable RMA for Guest = No, hide this link.
• RMA Policy Page: Select the page to display RMA policy.

• Show RMA Policy Link on: Select the page to display the RMA policy link. This link is only visible when the admin selects the RMA Policy Page.

1.2. RMA ID Increment Pattern

Admin selects the ID increment type for RMA

• Only ID: Only display ID and does not show prefixes or suffixes.
• Custom: Display ID with prefix and suffix

2. Request Configuration

• Allow RMA for Each Item of An Order: Select Yes to create RMA for each item in the order.

• Allow Uploading Attachments: Select Yes to allow attachments for RMA request.

• Allow Files Format: Show the file format allowed

• Google Recaptcha: choose Yes to allow request compatible with Google Recaptcha extension

• Default Request Status: Select the default status when customer has just submitted the request.

• Customer can Cancel Request in Status: Select status in which allow customer to cancel the request.

• Admin reply under Name: Admin chooses the presenting name when replying.

  • Admin Argent Name: Displays the name of the admin account when replying the request.
  • Default Name: Displays the admin name when replying to the request.

• Default Name: Admin will enter the name to display when replying to the request.

  • Note:
    • This is a required field, the system will report an error if you leave it blank.
    • Default Name only displays Admin reply under Name = Default Name.

• Order Condition: Admin selects the order condition for applying. If left blank, the conditions for all orders apply.

• RMA Information:

  • Reason: Admin creates reason for RMA. You can make multiple reasons.
  • Solution: Admin creates solution for RMA. You can make multiple solution.
  • Additional Field: Admin creates additional fields for RMA. You can make multiple additional fields.
    • Title: Set name for the new field
    • Type: Choose field type.
    • Is require: Click to checkbox if you want that field is required
    • Validation Class: Add the validation class for the field
      • For example: Inserting Validation Class = validate-email means that the value filling in this field must be email. An error message will be shown if filling the wrong value.
    • Sort Order: Select the priority for the field. The smaller the sort order is, the higher priority it has.

  

3. Email Configuration

• Select Enable = Yes: Allow sending mail. RMA is compatible with SMTP extension
• Sender: Select the representative to send mail.

• Admin Email: Enter the email that admin will receive the request from customer.
  • Note:
    • The emails will be separated by commas (,).
    • When a customer sends a request, an email notification will be sent to the admin via this address.
• Notice Admin About A New Reply: Displays notification for Admin when there is a new reply.
  • All above address: Allows for all email addresses.
  • No: Disallow notifications when having new replies.
  • Only request argent: Only allowed when requested.
• Notification Email Template to Customers: Choose the Notification emails sending to customers
• Notification Email Template to Admins: Choose the Notification emails sending to admin.

II. Manage RMA Request

• This is where all RMA Requests are saved.
• At the grid, Admin can view all the basic information of Status such as ID, Request Increment ID, Order Increment ID, Status, Customer Email, Item(s), Last responded by, Store View, Created Date, Updated Date, Action.
• Admin can perform some of the following actions:
  • Edit: Select Edit in the Action column to edit the information on the edit RMA Request page.
  • Delete: Select the request to delete, choose Action> Delete .
  • Change Status: Change the request status.
• Add Request: Create new request.

2.1. Add New Request

Admin can create request at backend.

• Status RMA: Admin select status to apply for RMA request.
• Comment: Admin enter the message for RMA request.
• Attach File(s): Click Browse to download the file for request.
• Order Information:
  • Order Increment ID: Admin chooses to order RMA request.
  • Select: Admin click to Select, order grid will be shown. Here, admin choose order to make new RMA request.

• Load: After choosing order and filling the order Increment ID, please click the button Load to allow showing order information

• At RMA Information, you can click to checkbox at select column to create new RMA request for the corresponding product.

2.2. Edit Request

To edit RMA Request, admin select Edit at Manage RMA Request or click Save and Continue Edit when creating RMA Request.

• Here, RMA Request displays additional Return Shipping Label and Conversation.
• Return Shipping Label: Admin select shipping label for return request.
• Conversation: This is the fields containing the messages exchanged between the admin and the customer.
• Attach File: Download the file for the message.
• Reply Template: Click here when the admin wants to send the message to the guest in a premade template.
• Select Create new to create a Reply Template. Admin enter name and message template for template.

• Select Edit to edit the Reply Template.
• Select Insert to apply the template message to the reply. - Click the trash icon when the admin wants to delete the reply template.

• Select Send email to Customer: The message will be sent to the customer’s email.
• Select Visible on Frontend: The message will be displayed outside the frontend.
• Click Submit to send the message.

• The conversation between admin and customer will be displayed in this area. We use colors to distinguish messages.
  • Note:
    • Orange is admin’ s private message. The customer cannot view this message.
    • Dark blue is the message sent by the admin to the admin
    • Light blue is the information that the admin sends to guests and customers can view it at the frontend. With news of a mail icon, the message will be sent to the email to the customer.

III. Manage RMA Status

• Here saved all RMA Status.
• At the grid, admin can view all the basic information of Status such as: ID, Status Title, Active, Created Date, Update Date, Action.
• Admin can perform some of the following actions:
  • Edit: Select Edit in the Action column to edit the information on the edit page RMA Status.
  • Delete: Select the rule to delete Action > Delete.
  • Change Status: Select Status to change status type
  • Add Status: Create new Status.

3.1. Add/ Edit Status

3.1.1. General

• Status Name: Name the status.
• Select Active = Yes: Allow the status to be enabled
• Description: Write Description for status.
• Select Allowed Action:
  • Create New Credit Memo: Enables new credit created at the edit RMA Request page.
  • Reorder: Enables reordering at the edit RMA Request page.
  • Add Shipping Label: Allow adding shipping labels at the edit RMA Request page.

3.1.2. Label

• Default Label:
  • Default Status Label for All Store Views: Set the default label for all stores.
  • Note: This is a required field. The system will display an error message if left blank.
• Store View Specific Labels: Set the label for each store view. If this field is blank, it will automatically get Default Label.

3.1.3. Default Comment/ Reply

• Select Enable Default comment = Yes, the Default comment/ reply will be applied. If you select No, this feature will be hidden.
• Default Comment:
  • Default Comment for All Store Views: Set a default comment for all stores.
  • Note: This is a required field. The system will display an error message if left blank.
• Store View Specific Comment: Set a comment and show it for each store view when there is a change in the request status. If this field is blank, it will automatically be taken as Default Comment.

IV. Manage RMA Rule

• Here stored all the RMA rules created.
• At the form grid, Admin can understand all the basic information such as ID, Name, Status, Website, Customer Group, Created Date, Update Date, Priority, Action.
• Admin can perform some of the following actions:
• Edit: Select Edit in the Action column to edit the information on the edit RMA rule page.
• Delete: Select the rule to delete Action > Delete.
• Change Status: Select the rule to change the status.
• Add Rule: Create new RMA rule.

4.1. Create New/ Edit RMA Rule

4.1.1. General

• Name: Enter a name for the RMA rule
• Description: Add Description of RMA rule.
• Status: Select the status for the rule.
• Website: Select the website to which the rule applies.
• Customer Group: Select the group of customers to apply the rule.
• Priority: Enter the priority for the rule
• Note: The smaller the Priority value, the higher the priority.

4.1.2. Condition

Admin chooses conditions to apply the RMA rule based on Product Attribute.

4.1.3. RMA Information

• Reason: Select the reason to apply the rule.
• Solution: Select the resolution for the rule.
• Additional Information: Select additional information for the rule.

V. Manage Shipping Label

• This is where all the created labels are saved.
• At the form grid, Admin can understand all the basic information of shipping labels such as: ID, Label, Status, Store View, Return Shipping Address, Created Date, Update Date, Action.
• Admin can perform some of the following actions:
  • Edit: Select Edit in the Action column to edit the information on the edit shipping label page.
  • Delete: Select label to delete Action > Delete.
  • Change Status: Select label to change status.
  • Add Shipping Label: Create new label.

5.1. Create New/ Edit Shipping Label

5.1.1. General

• Label Name: Name the label
• Status: Select the status for label. Select Yes, label applied.
• Description: Add Description of label.
• Return Shipping Address: Admin adds the shipping address.
• Store View(s): Select store to apply label.
• Logo: Upload the logo for label.
• Barcode Value: Select barcode value to apply label.
• Information: Select the information to display shipping label
• Priority: Admin enters the priority for label. The lower the input value, the higher the priority.

5.1.2. Condition

Choose the condition of Return Address of Product based on Order Attribute: Shipping Postcode, Shipping Region, Shipping State/Province, Shipping Country.

5.1.3. Default Comments

• Default Label:
  • Default Shipping Label for All Store Views: Set the default label for all stores.
  • Note: This is a required field. The system will display an error message if left blank.
• Store View Specific Labels: Set the label for each store view. If this field is blank, it will automatically get the label name the same as the Default Label.

VI. Frontend

6.1 Display RMA link and RMA Policy link

• Shown in Top Link

• Displayed in Footer Link

6.2. Form Request Filter

At Find Order By, in addition to entering Email, customers can enter and enter the zip code used for order by clicking on the arrow and selecting Zip Code.

6.3. Create New RMA Request Form (for customer who has Login)

• Request All Items

• Request Each Item

6.4. Create New RMA Request Form (for Not-Logged in customers)

• Request All Items

• Request Each Item

6.5. My RMA Request

• See Details

• Print Shipping Label

VII. Email

• Admin can check email sent to customers or view messages sent by customers by going to Stores > SMTP > Emails Log.

• Message template sent to admin when RMA status has been changed

• Admin message template sent to customers when their RMA status has been updated

VIII. API

Mageplaza’s RMA extension supports the use of the Rest API to view detailed list of information; create and delete rules, status, requests, shipping labels, and all info that admins and customers have created.

• Details can be viewed here.
• Instructions for creating Integration tokens here.

IX. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-rma-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

To start working with RMA GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• The queries and mutations that Mageplaza support can be used to view the details that customers have requested, create requests, request cancel by customers, ect. Details can be viewed here.

Sage Pay

Overview

Sage Pay is the leading payment service provider (PSP) in Europe. Mageplaza Sage Pay extension will help you integrate this payment gateway with your store. Sage Pay supports online payment via card and customers can save credit card information at the first payment to save time at the next purchase. Also, customers can manage saved credit card information and delete card information at any time. In particular, the admin will be able to create backend order with Sage Pay.

Your customers can use all debit cards, credit cards, Visa, etc. And also be protected by authorizes, capture and 3D secure as well as AVS/CV2. Stores can choose to redirect customers to Sage Pay Payment page or process all the purchase right on your checkout page.

Mageplaza Sage Pay is fully compatible with our One Step Checkout, Magento Instant Purchase and Reports which helps customers to order, make reports on the sales quickly and conveniently.

How to download and install

• Download Mageplaza Sage Pay
• How to Install

Table of Contents

• How to use Sage Pay
• How to Configure
  • 1 Configuration
    • 1.1 General Setting
      • 1.1.1 Credential
      • 1.1.2 Security and Feature
    • 1.2 Sage Pay Direct/PI Integration
    • 1.3 Sage Pay Form Integration
    • 1.4 Sage Pay Server Integration
  • 2 Manage Transactions
  • 3 Admin Order
    • 3.1 View Order
    • 3.2 Admin Order
  • 4 Order Frontend
  • 5 Compatible with Instant Purchase
  • 6 Refund Order
  • 7 Sage Pay Extra Fee

How to use

Register Account on Sage Pay:

To register for a Sage Pay account, visit this link.

• Note: After registering an account, Sage Pay will send mail for authentication and after completing the registration, Sage Pay will send information of Vendor Name, Username, Password. You need to save the above information to connect with Sage Pay.
• Access to Sage Pay, sign in by the account you registered before. Then go to Settings > Administrator, stick to I understand that this will create new credentials and may break any existing Sage Pay API implementations. then click Create API credentials button to get the Integration Key, Integration Password. Here, you also can get the information of Form Integration Encryption Password.

• Checkout page: choose the payment method with Sage Pay. Enter credit card information including Credit Card Number, Expiration Date, Card Verification Number. Here the customer can save credit card information for subsequent payments. Support 3 Sage Pay payment methods including Sage Pay Direct/PI Integration, Sage Pay Form Integration, Sage Pay Server Intergration.

• Magento Default: Displays payment by Sage Pay by default of Magento

• Drop-in Checkout: display Sage Pay payment in 2 types:

  • Drop-in Checkout Inline: display when Use Pop-up is turned off

  

  • Show Drop-in Checkout Popup: Display popup when Enable Use Pop-up and if you want to display popup at checkout page, then click on Place Order.

• Stored Payment Methods: Here shown the credit card information that the customer has saved before. If they do not want to save the old or unused credit cards, click Delete

Test card numbers:

 

Payment Method	Card Number	Card Type	3-D Secure object status
Visa	4929000000006	Visa	Authenticated
Visa	4929000005559	Visa	CardNotEnrolled
Visa	4929000000014	Visa	IssuerNotEnrolled
Visa	4929000000022	Visa	Error
Visa Corporate	4484000000002	Visa	CardNotEnrolled
Visa Debit	4462000000000003	VisaDebit	Authenticated
Visa Electron	4917300000000008	VisaElectron	Authenticated
MasterCard	5404000000000001	MasterCard	Authenticated
MasterCard	5404000000000043	MasterCard	CardNotEnrolled
MasterCard	5404000000000084	MasterCard	IssuerNotEnrolled
MasterCard	5404000000000068	MasterCard	Error
Debit MasterCard	5573470000000001	DebitMasterCard	Authenticated
Maestro (UK Issued)	6759000000005	Maestro	Authenticated
Maestro (German Issued)	6705000000008	Maestro	Authenticated
Maestro (Irish Issued)	6777000000007	Maestro	Authenticated
Maestro (Spanish Issued)	6766000000000	Maestro	Authenticated
American Express	374200000000004	AmericanExpress	N/A
Diners Club / Discover	36000000000008	Discover	N/A
JCB	3569990000000009	JCB	N/A

• The securityCode (CV2/CVV) is always: 123
• The billingAddress.address1 is: 88
• The billingAddress.postalCode is: 412
• Any expiryDate can be entered as long as it is in the future

Testing 3-D Secure Authentication

You can use some following sample account to test 3D secure:

• vendorName: sandboxEC
• integrationKey: dq9w6WkkdD2y8k3t4olqu8H6a0vtt3IY7VEsGhAtacbCZ2b5Ud
• integrationPassword: hno3JTEwDHy7hJckU4WuxfeTrjD0N92pIaituQBw5Mtj7RG3V8zOdHCSPKwJ02wAV

To aid the implementation and testing of the 3-D Secure authentication functionality, each card will provide you with a specific 3-D Secure authentication result. This is indicated by the status value in the 3-D Secure object status column.

• To successfully authenticate the transaction, enter password into the password field during the 3-D Secure authentication process.
• You can enter E:N:06 into the password field to simulate the scenario where an error occurred during authentication and you will receive the 3-D Secure status: Error
• You can enter A:D:06 into the password field to simulate the scenario where the cardholder is not enrolled in scheme and you will receive the 3-D Secure status: AttemptOnly
• You can enter U:N:06 into the password field to simulate the scenario where the 3D Secure authentication is not available and you will receive the 3-D Secure status: Incomplete

For more cases and information, please access here

How to Configure

1. Configuration

Login to the Magento Admin, choose Sales > Payment Settings > Payment Method > Sage Pay.

1.1. General Setting

1.1.1. Credential

• Vendor Name:
  • Enter the registered Sage Pay account name.
  • If you leave blank, you cannot use Sage Pay.
• Environment:
  • Admin can choose Sandbox environment to test Sage Pay function.
  • When you want to apply for online payment, please change to Production.
• Form Integration Encryption Password:
  • Enter the password of Sage Pay. Used for Sagepay Form/ Server Integration.
  • If left blank or incorrectly entered, it will not integrate with Sage Pay.
• Integration Key:
  • Enter the Key received from Sage Pay. It is used for Sagepay PI/ Direction Integration.
  • If left blank or incorrectly entered, Sage Pay will not be connected.
• Integration Password:
  • Enter the received Password from Sage Pay. Using for Sagepay PI/ Direction Integration.
  • If left blank or incorrectly entered, Sage Pay will not be connected to your store.
• Test Credential button: Admin can check Sage Pay connection by clicking the Test Credential button.

1.1.2. Security and Feature

• 3D Secure Setting: Select the authentication type with 3D Secure to verify the card of Customer:
  • Use default MySagePay settings: Use 3d Secure by installing my Sagepay by default to verify Customer’s card, thereby preventing payment fraud
  • Apply authentication even if turned off: Use 3d Secure authentication even when turned off to verify Customer’s tags

• Disable authentication and rules: turn off using 3d Secure authentication and ignore rules in the Sage Pay installed to verify Customer’s tags
• Apply authentication but ignore rules: authenticate 3d Secure but ignore the rules to verify the card of Customer.
• Note: For rules that can be configured when accessing MySagePay: Settings > 3D Secure > click Add rule, then select the condition where you want to apply the rule to verify.

• AVS/CV2 Setting: Choose the AVS/CV2 Verification for payment address of customers:
  • Use default MySagePay settings: Use AVS/CV2 verification for payment address as SagePay default setting.
  • Apply authentication even if turned off: Use AVS/CV2 verification for payment address even if it is turned off. Access to MySagePay to set up.

• Disable authentication and rules: Disable AVS/CV2 authentication for payment info and rules configured in Sage Pay.
• Apply authentication but ignore rules: Apply AVS/CV2 authentification for customers payment information but ignore the rules.
• Note: For configuring the rules, you can go to MySagePay page choose Settings > AVS/CV2 > Add rule, then choose the authentification conditions you want to apply for the rules.

• Enable Admin Orders:
  • If you choose Yes admin can create new order Sage Pay.
  • Admin can only create an order with the customer who has saved the card information.
• Display Logo on Frontend: Select Yes to display the Sage Pay logo on the Checkout page.

• Enable Gift Aid: If selecting Yes, the checkbox will be displayed to allow the customer to choose Donate Tax to Gift Aid. This feature only works when the Sage Pay account is enabled for Gift Aid. Only registered charities can use Gift Aid through the Sage Pay platform.

• Note: For Gift Aid, in some countries like the UK, customers can get back some of the tax fee when making payments by donating through Gift Aid, a tax rebate incentive created to benefit organizations and Charity and Community Amateur Sports Club (CASC). Gift Aid Details will be sent to Customer and Store Admin. They can check the information of their Gift Aid at Sage Pay page when access to Transaction > Transaction Report > Daily, click to the related order and choose Additional Details to view more.

• Sage Pay Payment Page Language: Select the language for Sage Pay page to be able to set the language appropriate for each country to make payment process faster and more convenient.

Example: The following picture shows Sage Pay Payment Page with French language:

• Surcharge Notice:

  • Admin sets a notification on checkout page about additional charges when paying via Sage Pay.
  • If left blank, the message will not appear on Frontend.

  

1.2. Sage Pay Direct/ PI Integration

• Enable: Select Yes to use Sage Pay Direct/ PI Integration. See more information of this Integration method here

• Title: Enter the title of the method which is displayed on the checkout page.

• New Order Status: Select status when customer order successfully:

  • Processing: Display status with Processing when order is successful. You can change the status in the backend with each order.
  • Suspected Fraud: Displays status with Suspected Fraud when order is successful. You can change the status in the backend with each order. With this status, admin can accept payment or reject payment and then transfer status to Processing.

• Payment Action: - Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, the Customer’s card will pay for the order and the Invoice will be created

  • Authorize: Payment will only be captured when admin creates an Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card

• Cart Types:

  • You can choose one or multiple cart types
  • Cards will be verified after customers fill in card ID at checkout page. For other cards not be selected here, there will be an error message of invalid card shown to customers. Also, those cards will not be shown at Checkout page and Backend order.

  

• Display Checkout: choose the display type of Sage Pay Payment on checkout page:

  • Magento Default: Displays payment by Sage Pay by default of magento

  • Drop-in Checkout: Show Sage Pay methods at checkout as Drop-in Checkout type. Choosing this type show the additional field:

    • Use Pop-up:

      • Choose Yes showing SagePay methods in Popup form

      

      • Choose No, showing SagePay methods in Inline form

      

• Allow Customer Credit Vault:

  • If you select Yes, information about the credit card will be saved to the customer account and you can use it for payment instantly. If you want to save the card with your account, please contact Sage Pay.
  • Displays the checkbox to check whether you want to save or not. Not applicable for Not Log In account.

• Vault Title:

  • Enter an alternate name in the Vault Title field. This name will be displayed when customer order is completed and using the previously saved credit card.

• If left blank the default name will be used.
• Payment from Applicable Countries:
  • Select All Countries to allow Card payment available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: the Card payment method will be shown only in the selected countries.
• Sort Order:
  • Specify the display position of this payment method compared to other payment methods
  • 0 is the highest number. The smaller the number, the more priority the method is displayed first.

1.3. Sage Pay Form Integration

• Enable: Select Yes to enable this payment function and redirect to the payment page of Sage Pay Form Integration. See more information of this Integration method here
• Title: Enter the title of the payment method which is displayed on the Sage Pay Form Integration page.
• New Order Status: Select status when customer order successfully:
  • Processing: Display status with Processing when order is successful. You can change the status in the backend with each order.
  • Suspected Fraud: Displays status with Suspected Fraud when order is successful. You can change the status in the backend with each order. With this status admin can accept payment or reject payment and then transfer status to Processing.
• Payment Action: - Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, the Customer’s card will pay for the order and the Invoice will be created
  • Authorize: Payment will only be captured when admin creates an Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Card payment available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: the Card payment method will be shown only in the selected countries.
• Confirmation Email: Select the Confirmation Email sent to:
  • Send to both admins and customers: Will send Confirmation Email to both customer and admin when customers pay via Sage Pay Form Integration page
  • Not sending to anyone: do not send Email Confirmation when customer pays via Sage Pay From Integration
  • Send to admins only: send Confirmation Email to admin only when customer pays via Sage Pay Form Integration.
• Admin Email: - Enter the admin email receiver to send the confirmation email to them when customers pay via Sage Pay.
  • Allow multiple emails to send at once and they must be separated by comma (,).
• Sort Order:
  • Specify the display position of this Sage Pay Form Integration compared to other payment methods
  • 0 is the highest number. The smaller the number, the more priority the method is displayed first.

1.4 Sage Pay Server Integration

• Enable: Select Yes to enable this payment function and redirect to the payment page of Sage Pay Server Integration. See more information of this Integration method here

• Title: Enter the title of the payment method which is displayed on the Sage Pay Server Integration page.

• New Order Status: Select status when customer order successfully:

  • Processing: Display status with Processing when order is successful. You can change the status in the backend with each order.
  • Suspected Fraud: Displays status with Suspected Fraud when order is successful. You can change the status in the backend with each order. With this status admin can accept payment or reject payment and then transfer status to Processing.

• Payment Action: - Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, the Customer’s card will pay for the order and the Invoice will be created

  • Authorize: Payment will only be captured when admin creates an Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card

• Profile: Select the payment type of Sage Pay, click on Place Order will show popup with 2 types:

  • Low: redirect to simple payment pages with only one step and minimal format which is designed to run in iframe.

  

  • Normal: Displays the normal card selection page

  

• Payment from Applicable Countries:

  • Select All Countries to allow Sage Pay Server Integration available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: the Sage Pay Server Integration method will be shown only in the selected countries.

• Sort Order:

  • Specify the display position of Sage Pay Server Integration method compared to other payment methods
  • 0 is the highest number. The smaller the number, the more priority the method is displayed first.

2. Manage Transactions

This section records the customer or admin orders information and the customers’ card information (including the order with the new card or the previous card saved at the Integration Type field. Here, Statistics Status and Order Status will be reported when customer order with Sage Pay payment methods.

• View Transaction: Record card information of customer or admin orders.
• Click View Order: Redirect to the view order page to see the information and card of paid orders.

- Compatible with Mageplaza Reports extension: Support additional Reports of Order Status and Transaction Status in the filterable time.

3. Admin order

3.1. View Order

This section records the information of Credit Card (Sage Pay) that customers have ordered and paid.

3.2. Admin Order

Admin can order by Sage Pay method with the cards that customer has saved.

4. Order Frontend

This section saves the card information that the customer has ordered.

5. Compatible with Instant Purchase

This customer part can use Instant Purchase to execute orders conveniently and quickly

Note: Instant Purchase only shows when you have saved the payment cards. Also, to use Instant Purchase, you should turn off 3D Secure because the card verification was done during customer save and fill in the payment card information.

Compatible with One Step Checkout

6. Refund Order

Here admin can Refund Online/ Offline all order or an individual one.

7. Sage Pay Extra Fee

When paying via Sage Pay with some cards like American Express, customer will have to pay an extra fee. Sage Pay extra fee is displayed at the view order page when customer order is completed.

Admin needs to install Surcharge at MySagePay page to add extra fee for each card type. Visit MySagePay and go to Settings > Surcharges, click Add button to install Surcharge with each card.

Save Cart And Buy Later

Overview

Normally, customers access to your store to see your product but they cannot buy it right away for many reasons such as insufficient butget, not enough in stock or out of stock, etc. Next time, when they come back to buy, they have to remember the product name, search and add the quantity they want to buy. Repeating this process creates much inconvenience for customers, consequently can lead to customers abandoning that purchase.

Mageplaza Save Cart And Buy Later allows customers to save shopping carts/ products they want to buy in the future, thereby saving time and providing a better experience for customers. With this extension, customers can manage and perform some actions at Customer DashBoard such as Save Cart/ Product, Restore, Delete and Share by Link.

How to download and install

• Download Mageplaza Save Cart And Buy Later
• How to Install

How to Configure

1. Configuration

From the Admin Panel, go to Stores > Configuration > Mageplaza Extensions > Save Cart And Buy Later > General Configuration

• Enable: Select Yes to turn on the module
• Button Title: Set a title for the button which the customer will click to use this feature. Leaving this field blank will receive the default value which is Save Cart.
• Show Button for Guest: By clicking to this button, Guest customers will be asked to login so that they can save their cart.
  • Select Yes to allow this button to be shown for Guest.
  • Otherwise, select No.
• Show Buy Later Cart Page Link: Select the position to display the link to Buy Later Cart. There are 2 positions that are Top Link and Footer Link.
• Allow Sharing:
  • Select Yes to allow customers to copy this link and share Buy Later Cart to others. When customer accesses the link shared, Cart/ Product saved at the link will be automatically added to the new cart
  • Otherwise, select No.
• Upload Buy Later Product Icon: This feature allows you to select icon to replace for “Buy Product Later” phrase when your website is at “Responsive” or “Mobile mode”

2. Edit Customer Form

From the Admin Panel, go to Customers > All Customers > Edit Customers > Buy Later Notes

• Here, Admin will see 2 grids: Saved Carts and Saved Products
• In Saved Carts Grid, Admin can view all Saved Carts basic information such as Cart ID, Created Date, Cart Name, Item(s), Description, Total Price, Action.
  • In the Action column, admin can delete any Saved Cart.
• In Saved Products Grid, customers can capture all basic information about Saved Products such as Image, Name, SKU, Amount Change, Quantity, Action.
  • In the Action column, admin can delete any Saved Product.

3. REST API

Mageplaza Save Cart And Buy Later supports using REST API to perform requests such as admin can get information of configuration of Save Cart And Buy Later; customers can use requests related to Save Cart and Save Product sections.

View requests supports by Mageplaza Save Cart And Buy Later here

View REST API guidelines of Magento 2 here.. View create tokens guidelines here.

4. GraphQL

4. 1 How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-save-cart-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Note: Magento 2 Save Cart GraphQL requires installing Mageplaza Save Cart in your Magento installation.

4.2. How to use

To perform GraphQL queries in Magento, please do the following requirements:

• Use Magento 2.3.x or higher. Set your site to developer mode
• Set GraphQL endpoint as http://<magento2-server>/graphql in url box, click Set endpoint. (e.g. http://dev.site.com/graphql)
• To view the queries that the Mageplaza Save Cart GraphQL extension supports, click here

Frontend

1. Link to Dashboard

To use this feature, you are required to login to the store’s Website.

1.1. Top Link

1.2. Footer Link

2. View Cart Page

When customers want to come back next time to buy the product they are choosing, click on Buy Product Later, this product will be moved to Buy Later Notes Tab at Customer Dashboard

To save the cart, click the Save Cart button. After clicking, a Popup will appear so that you can enter the Cart Name and Description information for this Cart.

When clicking Save, you will be redirected to the Buy Later Notes page and successfully saved this Cart.

3. Buy Later Notes Tab

3.1. Saved Carts

• From Saved Carts tab, customers can capture all Saved Carts basic information such as Cart ID, Date, Cart’s Name, Cart Total, Item (s), Description, Action.
• In the Action column, customers can perform actions such as View, Share, Restore, Delete.
  • Action View: Customers can view details of Buy Later Cart.
  • Action Copy Link: Customers can copy the link and share Buy Later Cart for another person.
  • Action Restore: Customers will transfer all Items in Saved Cart to the current Shopping Cart.
  • Action Delete: Customers can delete Cart.

3.2. View Buy Later Carts

• From View Buy Later Cart Tab, customers can capture all the basic information about existing shopping cart products: Product Name, SKU, Image, Price, Quantity, Subtotal.
• In addition, right here, customers can perform 2 Actions, which are:
  • Back: Return to the Buy Later Carts page originally
  • Restore: Transfer all Items in Saved Cart to the current Shopping Cart.

3.3. Saved Products

• From Buy Later Products tab, customers can capture all the basic information of Buy Later Products like: Product Name, SKU, Image, Price, Quantity, Subtotal, Action.
• In the Action column, customers can perform Actions: Share, Restore, Delete.
  • Action Copy Link: Customers can copy the link and share this Saved Product to another person.
  • Action Restore: Customers will transfer Items in the Saved Products to the current Shopping Cart.
  • Action Delete: Customers can delete this Saved Product.

Recent Sales Notification

Overview

Mageplaza’s Recent Sales Notification Extension allows Magento 2 websites to automatically show the message relating to current purchase by orther customers, updating the shopping trends of people via Popup. This module support displaying 3 types of Popup: Recent Sales, Checkout Total, Up-sell Product on pages: Home Page, Category, Product, View Cart, Checkout, so on. Popup can be displayed on both Desktop and Mobile at 4 different positions.

Mageplaza Recent Sales Notification extension is fully compatible with Mageplaza Quick View, One Step Checkout, which supports viewing the full product details through the popup displayed on the screen and checkout more conveniently.

How to use

• Recent Sales Notification extension supports display on Desktop and Mobile with 4 positions:

  • Top Left: displays a popup at the top left of the page.

    • Desktop

    

    • Mobile

    

  • Top Right: A popup is displayed with the top right of the page.

  • Bottom Left: displays the popup at the bottom left position of the page.

  • Bottom Right: displays the popup at the bottom right of the page.

• Choose popup type to display:

  • Recent Sales Popup: Displays products ordered in a certain period of time:
  • Checkout Total Popup: Displays total number of checked out customers:
  • Up-sell Product Popup: Displays often bought together products:

How to configure

1. Configuration

Login to the Magento Admin, choose Marketing > Recent Sales Notification > Configuration.

1.1. General

• Enable: Select Yes to enable the module feature.
• Show Close Button:
  • If you select Yes, a Close button will be displayed when hover to popup so customers can turn off popup. After clicking Close, the popup will not appear again and only display again when reloading the page.
  • Selecting No, popup does not have a Close button when hover to popup. This popup only can be turned off when the popup timeout configured at Popup Display Time is over.
• Show Image Top: If you select Yes will display the image on the top of the popup and this extra field is shown:
  • Upload image: ClickChoose File button to upload the image and it will be displayed at the top of the popup page.
• Popup Display Time: Select the time to display popup. After the timeout, popup will automatically be turned off. Time is counted when displaying the final product according to the setting in the Number of Recent Order field
• Break Time: Select the time period in which a popup can be auto turned off then turned on again. Note: if you click Close button to turn off the popup, it will not show the popup again and only display it again when reloading the page.
• Note: When hovering the mouse over the popup, it will stop the popup at that time. After dragging the mouse out, the time runs from the beginning until the end.
• Popup Animation Effect: Select an effect to display a popup. Including the following options:
  • Fade Out:
  • Slide up:
  • Zoom Out:
• Popup Sound: If you select yes, it will sound when popup appears.

2. Manage Popups

Login to the Magento Admin, choose Marketing > Recent Sales Notification > Manage Popups.

2.1. Grid

Here records information of different types of popup: Recent Sales, Checkout Information, Up-sell Product of Parent popup including information of fields: Name, Status, Customer Groups, Store View, Popup type, Position, Priority, Total Views.

2.2. Create new popup

2.2.1. General

• Name: Enter a name for popup. This is a required field
• Status: Select “Enable” to turn in the selected popup.
• Store Views: Select Store views to display this popup. You can select one or more store views at the same time.
• Customer Groups: Show popup only for selected customer groups. You can choose one or more customer groups.
• Priority:
  • Enter priority for the popup. If left blank, the default is 0.
  • Popups that have a smaller number have a higher priority.

2.2.2. Display

Where to Display

• Display on: Choose to show popup on:

  • Desktop and Mobile: displays popup on both mobile phones and computers.
  • Desktop: only displays popup on desktop, not on mobile.
  • Mobile: Only show popup in mobile.

• Note: The admincan configure multiple popups to be displayed on the same page. If there are multiple popups displayed at the same location, they will be shown alternatively depending on the time admin set for each popup.

• Display Position: Choose to show popup on Desktop or Mobile with 4 positions:

  • Top Left: The popup is displayed at the top left of the screen.

  

  • Top Right: A popup is displayed at the top right of the screen.

  

  • Bottom Left: displays a popup with the bottom left.

  

• Bottom Right: The popup is displayed at the bottom right.

• Display On Page: Select the page that can display popup on:
  • All Pages: display popup on all pages.
  • Specific Pages: popup displayed on specific pages which can be selected. Show extra fields:
    • Select Page(s): Select the page to display the popup. You can select one or more pages in the Select Page field (s) to display a popup. Select Not Select if you do not want to display popups with certain pages in this field.
      • Shopping Cart Page: The Shopping Cart page will display a popup.
      • Checkout Page: show popup at checkout page.
      • The extension is fully compatible with Mageplaza One Step Checkout, which helps customers pay quickly and conveniently in one page with all six steps. Display the popup at the checkout page of One Step Checkout:

• Select CMS Page(s): Select the CMS page to display the popup. You can select one or more pages at the same time to display the popup. Typically the following CMS pages:
  • 404 Not Found
  • Home Page
  • Enable Cookies
  • Privacy Policy
  • About us
  • Customer Service
• Select Category Page(s): Select one or more Category pages to display a popup. Any Category page that is not selected will not display a popup within it.
• Display On Product Page: If you select Yes, there will be an additional Select field to select the popup display condition on the product page.
  • Select: Click ‘+’ to choose the condition for displaying popups on the product page. If left blank or unchecked the condition, it will display a popup for all product pages.

How to Display

Recent Sales popup

• Select Order Conditions: Select the conditions of the real order. Orders that satisfy the selected condition will be shown in the popup. If left blank, display all orders in the popup.

• Number of Recent Orders: Enter the number of orders shown in the popup. Even though there are a lot of orders satisfies the condition, it will only be displayed the number of orders selected. Leaving this blank will not limit the order number shown in the popup.
• Check Order Time: Enter the number of hours after which, the system will auto check and update the products from the new order.
• Content: Enter the content to display information of the order in the popup. The default value is {{customer_name}} has just purchased {{product_name}} {{time}} ago.

Checkout Total popup

• Image: Click Choose File button to upload the image for the popup. If you want to delete photos, select Delete Image.

• Content: Enter the content to display with Checkout total popup, data will be auto checked within 24 hours. Orders recorded for more than 24 hours will not be shown on popup. For example: {{customer_count}} have checked out for the last 24 hours!

Up-sell Product popup

• Content:
  • Enter the content to display related products that customers often buy along with the current product. For example: Customers often buy {{upsell_product_name}} along with {{product_name}}
  • If left blank, the default popup information will be Customers often buy {{upsell_product_name}} along with {{product_name}}

• Background Image:
  • Click Choose File button to upload the image and the image will be set as the background for the popup
  • If left blank, no background image will appear in the popup
• Border Color: Enter or click in the Border Color field to select the border color for the popup. If left blank, the default is gray (#d4d4d4).
• Text Content Color: Select the color for the content displayed in the popup. If left blank or unchecked will default to black (#333333).
• Hover Link Color: Select the color for product link in the popup, when touching or hovering, the link will display the color of the hover link. If left blank or unchecked,it will default to blue (#006bb4).

Popup Settings

In this section, you can configure each popup and the features similar to those in the Configuration parts above by choosing Use Config option in each field.

2.2.3. Report

After Save or Save and Continue edit or edit popup will display Statistics on General tab including View(s), Click(s), Close(s) of Total Statistics, Parent Statistics, Child Statistics.

General Report

Total Statistics: This section records all the number of View(s), Click(s), Close(s) including Parent Statistics and Child Statistics.

A/B Testing Report

After Click Add A/B Testing to create a Child popup and then will display more A/B Testing Report tab in Parent popup to report chart by View(s), Click(s), Close(s) of Parent popup and Child popup.

• Click Add A/B Testing to create a new popup called Child popup with information fields available from parent popup. You can then change the child popup information such as the content, location, images, etc., from the entered values. Click Save or Save and Continue edit to save the newly created popup.
• Child popup information will depend on the Parent popup like Status, Display On Page, Customer Groups, Store Views, Priority, etc. For example, if the Parent popup is off, the child popup will also be turned off in the Frontend.
• When both popup types are enabled, they will work and run alternately.
• Selecting Parent will display A/B Testing Report as Pie-chart to compare Percentage of View, Click, Close amount between Parent and Child popup. Also, add Parent Statistics, Child Statistics fields to make reports of View, Click, Close. The statistics of the pie chart will be completely based on the information of Parent Statistics, Child Statistics.

3. Compatible Quick View

Recent Sales Notification is fully compatible with the Mageplaza Quick View extension that will support viewing the full product details via the popup when clicking on the image of the product at popup.

4. API

Mageplaza’s Recent Sales Notification extension supports the use of the Rest API to view a detailed list of all popup that the admin has created.

• Details can be viewed here.
• Instructions for creating Integration tokens here.

5. Graphql

Run the following command in Magento 2 root folder:

composer require mageplaza/module-sales-pop-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

To start working with Recent Sales Notification GraphQL in Magento, please do the following requirements:

• Use Magento 2.3.x. Reture your site to developer mode.
• Install chrome extension (currently does not support other browsers)
• Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
• Mageplaza-supported queries are fully written in the Description section of Query.RecentSalesNotification.items
• To get the popup information by id and information of all popups, learn more here.

Security

Overview

Security issues for Magento have left a big question mark in the community of online stores. This problem is specially cared when Magento-based stores which own critical information and huge transactional volume can easily become ideal prey for blackhat hackers to attack. To help online stores prevent brutal break-ins, Mageplaza has developed the Security extension.

Magento 2 Security extension gives store owners the ability to detect the IP addresses that are intentionally attacking their store at any given time. Therefore, they have timely measures to prevent this issue such as blocking those IP addresses or sending warning emails to store owners.

Download & Install

You can download from the following resouces:

• Mageplaza Security Extension
• Magento Marketplace
• How to Install

How to use

You can review login records from the dashboard when entering the backend. The log displays the newest 5 logins and you can click on the login name to view the details.

How to configure

After logging in Magento backend, go to System > Security. We will provide detail guides to these bellow configuration

• Login Log
• Checklist

I. Configuration

1.1. General

After entering Store > Settings > Configuration > Mageplaza Extensions > Security, expand the General configuration

• In the Enable field: Choose “Yes” to turn the Security module on.
• In the Send warning emails to field:
  • Enter the email address to be able to receive warning emails.
  • You can fill multiple emails separated with commas ,

1.2. Brute Force Protection

Follow System > Security > Configuration > General > Brute Force Protection

• In the Enable field: Choose “Yes” to enable this function.
• In the Maximum number of failed login attempts field:
  • Enter an allowable number of failed logins.
  • Default number of maximum failed login attempts is 5 when you enable Security module.
  • If you leave it blank or enter 0, after a failed login happens, an email will be sent.
• In the Allowed Duration field:
  • Enter the number of minute(s) which presents the length of a session. During this session, If the Maximum number of failed login attempts is reached, warning emails will be sent.
  • Default number of allowed duration is 10 minutes when you enable Security module.
  • If you leave the field blank or enter 0, no warning emails will be sent even if the maximum number of acceptable logins is reached.
• In the Locked User Alert field: Select “Yes” to send the alert email when the admin account is locked due to failed login attempts is exceeded.
• In the Email Template field:
  • Choose the template for the warning email.
  • You can edit/customize one at Marketing > Email Template.

Here’s an example of a warning emails:

1.2. Blacklist/Whitelist IPs

• In the Blacklist(s) field:
  • All IP addresses filled in this section will be blocked whenever accessing the admin login page.
  • You are able to block one IP address, multiple IP addresses, an IP address range or multiple IP address ranges. IP addresses are separated with commas ,.
  • You can also block IP addresses as wildcard masks as below:
    • 10.0.0. *
    • 10.0. *. *
    • 10.0.0. * - 123.0.0. *
    • 12.3. *. * - 222.0. *. *
• The mark * is in the 0 - 255 range.*
• In the Whitelist(s) field:
  • All IP addresses that are filled in this section will be allowed whenever accessing the admin login page.
  • You can allow one IP address, multiple IP addresses, an IP address range or multiple IP address ranges. IP addresses are separated with commas ,.
  • You can also allow IP addresses as wildcard masks as these follows:
    • 10.0.0. *
    • 10.0. *. *
    • 10.0.0. * - 123.0.0. *
    • 12.3. *. * - 222.0. *. *
• The mark * is in the 0 - 255 range.*

Blacklist(s) has higher priority than Whitelist(s) which means if a IP address is in the Blacklist, it will be blocked even it's in the Whitelist as well. So please make sure that you add your IP address in the Whitelist only. 

II. Checklist

Checklist is a bunch of outlines pointing out which factor(s) can be the possible vulnarablity for your stores. Go to System > Security > Checklist

• In the Check admin’s username box: Check the name of the admin account, if the default name is too obvious to guess or popular to name, the message will alert the store owner.
• In the Check captcha box
  • Check if captcha is enabled outside the frontend or in the backend.
  • Notify if store owner has enabled captcha. If not, message will warn store owner to enable captcha.
• In the Check Magento Version box: Check the version of Magento that the store owner is using. If this is not the latest version, the checklist will alert store owners to update to the latest version.
• In the Check database prefix box:
  • Check if the store owner has used the database prefix or not. If not, the checklist will alert store owners to use them for database security.
  • If the store owner uses a database prefix, the checklist will notify them that their database is working properly.

For possible low-key factors that are not good for your security, they will be marked a red X. We'd highly recommend you should upgrade Security module to Professional edition to learn the detail way how to fix it throughoutly. 

III. Login Log

From the admin panel, make your way to System > Security > Login Log. All logins and login attempts will be recorded here.

Click View to see login details. Here’s an example:

• Once an admin account has exceeded the allowed login attempts (which is configured at Store> Settings> Configuration> Advanced> Maximum Login Failures to Lockout Account), there will be a mail notification to the store owner that this account has been lock up. Store owner should review this case again to reset safety settings. You can refer this article to learn how to unlock an admin user account.

• Also, store owners can check the last login of a specific administratore. You can follow System > Permissions > All Users

• The Last login column records the newest recent login attempt of an admin.
• The IP Address column records the IP address corresponding to the newest recent login attempt of an admin. Clicking on an IP address, it will redirect to the Traceip page.

Reset Command line

• If store admins mistakenly enter their IP addresses in the Blacklist, this following command lines can be run first:

bin/magento security:reset blacklist 

Next, run this command line:

bin/magento cache:flush

• After you have finished running those above command lines which reset the Blacklist(s) field, you will be able to access the admin page again. Note that the Blacklist(s) field is reset now so don’t forget to reenter the blacklist IPs.
• Similarly, the Whitelist(s) can be reset using these command lines:

bin/magento security:reset whitelist
bin/magento cache:flush

• If you run the command bin/magento security:reset, both Blacklist(s) and Whitelist(s) will be reset.

Must-have extensions for your Magento stores

• Increase website traffic: SEO
• Build leads
• Increase conversion rates: One Step Checkout, Layered Navigation
• We believe that you can sell more: Gift Cards, Auto Related Products, Frequently Bought Together, Free shipping bar, Daily Deal , Product Feed
• Keep customers return: Reward Points
• Let your customer become raving fans
• Optimize your stores: PDF Invoice, Custom Order Number, Stop return items issue

SecurePay

Overview

SecurePay is an online payment specialist and an Australian Post business that provides e-commerce payment solutions for businesses worldwide. Among many online payment solutions, Mageplaza does offer SecurePay - a complete online payment solution that will help users pay online by card or Paypal easily and securely. SecurePay extension offers customers more payment options such as Visa, MasterCard, American Express, Diners Club, JCB, Bankcard and PayPal. It also allows them to make online purchases instantly, which can help businesses convert more sales.

Mageplaza SecurePay extension is fully compatible with Mageplaza One Step Checkout

Download and Install

• Installation guide

How to use

• SecurePay: to register SecurePay account, please access this link, click Sign up and fill in the required information below:

• After registration, the system displays thanks and requests for confirmation via registered mail:

• Open your registered mail, click Activate Now:

• At the main interface of SecurePay, get the information of Merchant ID, Publishable Key, Private Key to fill in Configuration (will be guided below):

• Click Manage > Paypal Settings to get Merchant Account ID and Transaction Password:

• SecurePay has a sandbox environment accessible to the public. Please see public testing account details below.
  • Test Merchant Login URL: https://test.login.securepay.com.au/v3/
  • Merchant ID: ABC
  • Username: test
  • Password: abc1234 !!
  • Test integration details
  • Merchant ID: ABC0001
  • Test Transaction Password: abc123
• You can check the checkout process with the following Cards:

Test card numbers

 

STANDARD
Visa	4111111111111111
Visa	4012888888881881
Visa	4222222222222 Note : Different character count than the other test numbers, but still functional
MasterCard	5555555555554444
MasterCard	5105105105105100
Discover	6011111111111117
Discover	6011000990139424
American Express	378282246310005
American Express	371449635398431
American Express Corporate	378734493671000
Diners Club	30569309025904
Diners Club	38520000023237
JCB	3530111333300000
JCB	3566002020360505
INTERNATIONAL
Australian BankCard	5610591081018250
PROCESSOR-SPECIFIC CARDS
Dankort (PBS)	76009244561
Dankort (PBS)	5019717010103742
Switch/Solo (Paymentech)	6331101999990016

Note:

• You can simulate approved and declined transactions by submitting alternative payment amounts.
• If the payment amount ends in 00, 08, 11, or 77 the transaction will be approved once card details are submitted. All other options will cause a declined transaction.

How to Configure

Login to the Magento Admin, choose Stores > Configuration > Sale > Payment Methods:

At SecurePay Payment Method, click Configure:

1. Credentials

Login to the Magento Admin, choose Stores> Configuration> Sale> Payment Methods, at SecurePay Payment Method, click Configure > Credentials:

• Environment:
  • Admin can choose Sandbox environment to check the payment function of the methods.
  • When applying for online payment, the admin needs to switch the environment to Production.
• Merchant Account ID:
  • Enter the Merchant Account ID that was got from SecurePay (5 or 7-character merchant ID supplied by SecurePay).
  • If left blank or entered incorrectly, it will not connect to SecurePay.
• Transaction Password:
  • Enter the Transaction Password that was got from SecurePay.
  • If left blank or entered incorrectly, it will not connect to SecurePay.
  • The password can be changed via ** SecurePay’s Merchant Management** facility.

2. XML Integration

Login to the Magento Admin, choose Stores > Configuration > Sale > Payment Methods, at SecurePay Payment Method, click Configure > XML Integration

• Enable: Select “Yes” to enable the use of payment by XML Integration.
• Title: Enter the title of the method. The payment method name will be displayed on the checkout page.
• Payment Action: - Authorize and Capture: Payment will be captured as soon as customers place orders are successful. At that moment, customer’ s card will pay for the order and invoice will be created.
  • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer’s card.
• New Order Status: Select status when customer order is successful:
  • Processing: Display status with Processing when the order is successful. Admin can change the status in the backend for each order.
  • Suspected Fraud: Display the status with Suspected Fraud when the order is successful. Can change the status in the backend for each order. With this status, admin can accept payment or decline payment and then change status to Processing.
• Card Types:
  • Choose 1 or more cards to pay.
  • Cards will be verified when customer enter card number in checking out. For cards not selected in this section, there will be a notice of invalid card for customers. Unselected cards will not be displayed on the Checkout page and when ordering the backend.
• Payment from Applicable Countries:
  • Select All Allowed Countries so the card payment method can be applied in all countries.
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to be able to use this payment method
    • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
• Minimum Order Total:
  • Enter the minimum order amount to display and apply for payments using XML Integration.
  • If the order amount is less than this field value, payment methods will not be displayed.
• Maximum Order Total:
  • Enter the maximum amount of order to display and apply payments using XML Integration.
  • If the order amount is greater than this field value, the payment method will not be displayed.
• Debug Mode:
  • If choose Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Select the display position of this payment method compared to other payment methods
  • 0 is the largest number. Smaller numbers will be preferred to show in the first position.

3. Direct Post Integration

Login to the Magento Admin, choose Stores > Configuration > Sale > Payment Methods. at SecurePay Payment Method click Configure > Direct Post Integration

• Note: The method only works on https sites, it cannot work on http.
• Enable: Select “Yes” to enable the use of payment by Direct Post Integration.
• Title: Enter the title of the method. The payment method name will be displayed on the checkout page.
• Payment Action: - Authorize and Capture: Payment will be captured as soon as customers place orders are successful. At that moment, customer’s card will pay for the order and invoice will be created.
  • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer’s card.
• New Order Status: Select status when customer order is successful:
  • Processing: Display status with Processing when the order is successful. Admin can change the status in the backend for each order.
  • Suspected Fraud: Display the status with Suspected Fraud when the order is successful. Can change the status in the backend for each order. With this status, admin can accept payment or decline payment and then change status to Processing.
• Card Types:
  • Choose 1 or more cards to pay.
  • Cards will be verified when customer enter card number in checking out. For cards not selected in this section, there will be a notice of invalid card for customers. Unselected cards will not be displayed on the Checkout page and when ordering the backend.
• Payment from Applicable Countries:
  • Select All Allowed Countries so the card payment method can be applied in all countries.
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to be able to use this payment method
    • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
• Minimum Order Total:
  • Enter the minimum order amount to display and apply for payments using Direct Post Integration.
  • If the order amount is less than this field value, payment methods will not be displayed.
• Maximum Order Total:
  • Enter the maximum amount of order to display and apply payments using Direct Post Integration.
  • If the order amount is greater than this field value, the payment method will not be displayed.
• Debug Mode:
  • If choose Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Select the display position of this payment method compared to other payment methods
  • 0 is the largest number. Smaller numbers will be preferred to show in the first position.

4. Paypal Integration

Login to the Magento Admin, choose Stores > Configuration > Sale > Payment Methods, at SecurePay Payment Method, click Configure > Paypal Integration

• Merchant ID:
  • Enter the Merchant ID received from SecurePay.
  • If left blank or entered incorrectly, it will not integrate with SecurePay.
  • Follow this link to obtain credentials.
  • Using for SecurePay Paypal Integration.
• Publishable Key:
  • Enter the Publishable Key that was received from SecurePay.
  • If left blank or entered incorrectly, it will not connect to SecurePay.
• Private Key:
  • Enter the Private Key received from SecurePay.
  • If left blank or entered incorrectly, it will not connect to SecurePay.
• Enable: Select “Yes” to enable the use of payment by Paypal Integration.
• Title: Enter the title of the method. The payment method name will be displayed on the checkout page.
• Payment Action: - Authorize and Capture: Payment will be captured as soon as customers place orders are successful. At that moment, customer’s card will pay for the order and invoice will be created.
  • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer’s card.
• New Order Status: Select status when customer order is successful:
  • Processing: Display status with Processing when the order is successful. Admin can change the status in the backend for each order.
  • Suspected Fraud: Display the status with Suspected Fraud when the order is successful. Can change the status in the backend for each order. With this status, admin can accept payment or decline payment and then change status to Processing.
• Card Types:
  • Choose 1 or more cards to pay.
  • Cards will be verified when customer enter card number in checking out. For cards not selected in this section, there will be a notice of invalid card for customers. Unselected cards will not be displayed on the Checkout page and when ordering the backend.
• Payment from Applicable Countries:
  • Select All Allowed Countries so the card payment method can be applied in all countries.
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to be able to use this payment method
    • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
• Minimum Order Total:
  • Enter the minimum order amount to display and apply for payments using Paypal Integration.
  • If the order amount is less than this field value, payment methods will not be displayed.
• Maximum Order Total:
  • Enter the maximum amount of order to display and apply payments using Paypal Integration.
  • If the order amount is greater than this field value, the payment method will not be displayed.
• Debug Mode:
  • If choose Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Select the display position of this payment method compared to other payment methods
  • 0 is the largest number. Smaller numbers will be preferred to show in the first position.

5. View Order

5.1. Admin

5.2. Frontend

6. Compatible with One Step Checkout

Security Professional

Overview

Security issues for Magento have left a big question mark in the community of online stores. This problem is specially cared when Magento-based stores which own critical information and huge transactional volume can easily become ideal prey for blackhat hackers to attack. To help online stores prevent brutal break-ins, Mageplaza has developed the Security extension. Magento 2 Security extension gives store owners the ability to detect the IP addresses that are intentionally attacking their store at any given time. Therefore, they have timely measures to prevent this issue such as blocking those IP addresses or sending warning emails to store owners.

Security Professional grants store owners the ability to forbid all login attempts at a period of time, which is called Away Mode. Furthermore, they can keep track and spot out all changed files, activities of other admin users as well as back up logs for the record purpose.

How to use

You can review login records from the dashboard when entering the backend. The log displays the newest 5 logins and you can click on the login name to view the details.

How to configure

After logging in Magento backend, go to System > Security. We will provide detail guides to these bellow configuration

• Login Log
• Checklist
• Action Log
• Action Log Backup
• File Change Log

I. Configuration

1.1. General

After entering Store > Settings > Configuration > Mageplaza Extensions > Security, expand the General configuration

• In the Enable field: Choose “Yes” to turn the Security module on.
• In the Send warning emails to field:
  • Enter the email address to be able to receive warning emails.
  • You can fill multiple emails separated with commas ,

1.2. Brute Force Protection

Follow System > Security > Configuration > General > Brute Force Protection

• In the Enable field: Choose “Yes” to enable this function.
• In the Maximum number of failed login attempts field:
  • Enter an allowable number of failed logins.
  • Default number of maximum failed login attempts is 5 when you enable Security module.
  • If you leave it blank or enter 0, after a failed login happens, an email will be sent.
• In the Allowed Duration field:
  • Enter the number of minute(s) which presents the length of a session. During this session, If the Maximum number of failed login attempts is reached, warning emails will be sent.
  • Default number of allowed duration is 10 minutes when you enable Security module.
  • If you leave the field blank or enter 0, no warning emails will be sent even if the maximum number of acceptable logins is reached.
• In the Locked User Alert field: Select “Yes” to send the alert email when the admin account is locked due to failed login attempts is exceeded.
• In the Email Template field:
  • Choose the template for the warning email.
  • You can edit/customize one at Marketing > Email Template.

Here’s an example of a warning emails:

1.2. Blacklist/Whitelist IPs

• In the Blacklist(s) field:
  • All IP addresses filled in this section will be blocked whenever accessing the admin login page.
  • You are able to block one IP address, multiple IP addresses, an IP address range or multiple IP address ranges. IP addresses are separated with commas ,.
  • You can also block IP addresses as wildcard masks as below:
    • 10.0.0. *
    • 10.0. *. *
    • 10.0.0. * - 123.0.0. *
    • 12.3. *. * - 222.0. *. *
• The mark * is in the 0 - 255 range.*
• In the Whitelist(s) field:
  • All IP addresses that are filled in this section will be allowed whenever accessing the admin login page.
  • You can allow one IP address, multiple IP addresses, an IP address range or multiple IP address ranges. IP addresses are separated with commas ,.
  • You can also allow IP addresses as wildcard masks as these follows:
    • 10.0.0. *
    • 10.0. *. *
    • 10.0.0. * - 123.0.0. *
    • 12.3. *. * - 222.0. *. *
• The mark * is in the 0 - 255 range.*
• To learn how to reset Blacklist/Whitelist IPs, please refer this Reset command lines

Blacklist(s) has higher priority than Whitelist(s) which means if a IP address is in the Blacklist, it will be blocked even it's in the Whitelist as well. So please make sure that you add your IP address in the Whitelist only. 

1.3. Action Log Backup

• In the Enable field: Choose “Yes” to back up the Action log.
• In the Frequency field: Choose one of avalable time options
  • Frequency = Daily: Action log will be backed up daily.
  • Frequency = Weekly: Action log will be backed up weekly.
  • ** Frequency = Monthly**: Action log will be backed up monthly.
• In the Clear Log After Backup field: Select “Yes” to clear the log in Action Log after the log has been backed up.

1.4. Amway Mode

• In the Enable field: Choose “Yes” to forbid all login attempts in this configured time.
• In the From Time field: Choose the start time you want to set Away Mode.
• In the To Time field: Choose the end time you want to set Away Mode.

Away Mode time will be set between "From Time" and "To Time". Other admin users can't access backend in this period.

• In the Day of Week field:
  • You can select to forbid some specific the whole day(s) weekly.
  • You can select multiple days.
• To learn how to reset Away Mode, please refer this Reset command lines

Configured Away Mode time will follow the store's timezone.

1.5. File Change

• In the Exclude folders field: This will exclude folders which are
  • Paths have / at the start is permanent links. E.g: /var means magento_root_directory/var/
  • If paths don’t have / at the start line, all folders having entered name in this field will be excluded. E.g: all folders named git will be excluded.
  • Normally, folders which can’t be accessed from the store frontend should be excluded.
• In the Exclude File Type field:
  • Entered file types will not be scanned to keep track possible changes.
  • You can enter multiple file types separated by commas ,.
• In the Create Master Hashes field:
  • Important note: You must click Save Config before proceeding to click Reindex button, to prevent the directory or files added, modified, deleted to be automatically converted the file type into Deleted status.
  • When Security module is turned on/off, or when new folders/files have been added to the system, you should click Reindex button to scan all the files again.
• In the Enable Cron field:
  • Choose “Yes” to turn on the send email function while running Cronjob.
  • After being run the Cronjob program, changed files will be backed up.
• In the Email Template field:
  • Choose the template for the File Change Notification email.
  • You can edit/customize one at Marketing > Email Template. To see how the File Change Notification looks like, please check this below image

III. Login Log

From the admin panel, make your way to System > Security > Login Log. All logins and login attempts will be recorded here.

Click View to see login details. Here’s an example:

• Once an admin account has exceeded the allowed login attempts (which is configured at Store> Settings> Configuration> Advanced> Maximum Login Failures to Lockout Account), there will be a mail notification to the store owner that this account has been lock up. Store owner should review this case again to reset safety settings. You can refer this article to learn how to unlock an admin user account.

• Also, store owners can check the last login of a specific administratore. You can follow System > Permissions > All Users

• The Last login column records the newest recent login attempt of an admin.
• The IP Address column records the IP address corresponding to the newest recent login attempt of an admin. Clicking on an IP address, it will redirect to the Traceip page.

II. Checklist

Checklist is a bunch of outlines pointing out which factor(s) can be the possible vulnarablity for your stores. Go to System > Security > Checklist

• In the Check admin’s username box:
  • Check the name of the admin account, if the default name is too obvious to guess or popular to name, the message will alert the store owner.
  • Click Fix it to be redirected to the Edit User page
• In the Check captcha box
  • Check if captcha is enabled outside the frontend or in the backend.
  • Notify if store owner has enabled captcha. If not, message will warn store owner to enable captcha.
  • Click to Fix it, CAPTCHA will be enabled automatically and the confirmation message will be delivered.
• In the Check Magento Version box:
  • Check the version of Magento that the store owner is using. If this is not the latest version, the checklist will alert store owners to update to the latest version.
  • Click to Fix it to be redirected to the Update version guidance.
• In the Check database prefix box:
  • Check if the store owner has used the database prefix or not. If not, the checklist will alert store owners to use them for database security.
  • If the store owner uses a database prefix, the checklist will notify them that their database is working properly.
  • Click Fix it to display the Add table prefix, enter the table prefix name to add them.

III. Action Log

From the admin panel, go to System > Security > Action Log

Here records all the actions of admin users when they logged into the admin page. Clicking on any IP address will redirect the store owner to the Trace IP page. Click View to display detailed information of that log. All logs at this directory will be deleted if the store owner chooses to delete the log after the log has been backed up.

IV. Action Log Backup

You can go to System > Security > Action Log Backup.

In this section, all logs in the Action Log are automatically backed up as a csv file. Clicking on any file will automatically be downloaded.

V. File Change Log

Please check at System > Security > File Change log

This section records all created, modified, deleted files. All files are scanned and recorded daily at 0:00 PM according to the store’s configuration time and automatically. Email alert will also be sent to the store owner about the change of files. Clicking View to display information for the log.

When the store owner clicks on Check File Change, it will check whether the current has been modified, created or deleted instead of waiting until 00:00. If there are too many recorded logs that the store owner does not want to store anymore, they can click on Clear Log to clear all the logs are stored here

Reset Command line

• If store admins mistakenly enter their IP addresses in the Blacklist, this following command lines can be run first:

bin/magento security:reset blacklist 

Next, run this command line:

bin/magento cache:flush

• After you have finished running those above command lines which reset the Blacklist(s) field, you will be able to access the admin page again. Note that the Blacklist(s) field is reset now so don’t forget to reenter the blacklist IPs.
• Similarly, the Whitelist(s) can be reset using these command lines:

bin/magento security:reset whitelist
bin/magento cache:flush

• When admin users want to access backend in the period of Away Mode suddenly, follow two command lines to turn Away Mode off.

bin/magento security:reset awaymode
bin/magento cache:flush

• If you run the command bin/magento security:reset, both Blacklist(s), Whitelist(s) and Away Mode will be reset.

Same Order Number

Overview

With the ID configuration of the current Magento 2, when you view the ID of the Invoice, Shipment, or Credit Memo, you will not know clearly whether that ID belongs to any order. To improve this problem, Mageplaza developed the Same Order Number extension. This extension allows you to set the ID configuration of Invoice, Shipment, Credit Memo with increment ID similar to Order and especially, it can also be used with Multiple Stores.

How to install

• Download Same Order Number extension
• See installation guide here.

How to configure

From the Magento Admin, choose Store > Settings > Configuration > Mageplaza Extensions > Same Order Number

1. General Configuration

• Enable: Choose Yes to use this module

• Apply for: Choose the object to apply for the extension. You can apply simultaneously to Invoice, Shipment, Credit memo.

  • Apply for Shipment: Shipment ID will be configured according to Order ID. In the case of multiple shipments for an order, the second shipment’s ID will be followed by a suffix. For example: Order’s ID is Order #003, Shipment’s ID is #003, the second Shipment’s ID is #003-1.

  

  • If you don’t apply the extension for Shipment, the Shipment ID will increase based on the Main Website.

  • Apply for Invoice: The ID of Invoice will be configured according to Order ID.

    • Same Order Number is also available for the case as automatic Invoice creation when paying with Paypal.
    • In the case of multiple Invoices for an Order, the second Invoice ID onwards will be followed by a suffix. For example, the Order ID is Order #003, the Invoice ID is #003, the 2nd Invoice ID is #003-1.

    

  • If you don’t apply the extension for Invoice, the Invoice ID will increase based on the Main Website.

  • Apply for Credit Memo: Credit memo ID will be configured according to Order ID. In the case of multiple credit memos for an order, the second credit memo onwards will be followed by a suffix. For example: Order ID is Order #003, Credit Memo ID #003, the 2nd Credit Memo is #003-1.

  

  • If you don’t apply the extension for Credit Memo, the Credit Memo ID will increase based on the Main Website.

2. Apply the extension for multiple stores

• The stores is set as the default under Default Config.
• To change the extension’s configuration for each store, please go to Store View > Select Store, then untick in the Use Website of each option.
• The configuration in each store will be applied for that store without affecting other stores.

3. Frontend

3.1. Invoice after applying Same Order Number extension

3.2. Shipment after applying Same Order Number extension

3.3. Credit Memo after applying Same Order Number extension

Selling More

Overview

Mageplaza Selling More is an instant sales-boosting solution for all stores. Capturing great features of three powerful extensions, the package allows you to:

• Create, sell, control and montinize gift cards efficiently
• Streamline the checkout process with a simplified interface
• Auto-send abandonment cart emails to follow-up
• Keep customers coming back to store for back-in-stock products
• Boost sales and reduce abandonment cart rate ultimately

Download & Install

• Download Mageplaza Selling More
• How to Install

How to use

This solution contains 3 extensions. Please click on each link to see the User Guide of each extension:

• Mageplaza Gift Cards - User Guide
• Mageplaza One Step Checkout Ultimate - User Guide
• Mageplaza Product Alerts - User Guide

SEO-Friendly URL

Introduction

SEO Friendly URL helps store owners generate search engine friendly URLs for any pages filtered by the layered navigation or any category page.

Why do you need SEO-friendly URL?

• Filter options can create unoptimized filtered pages URLs. For example, when customers select “Allweather” and “price”, the filtered results will be : yourstore.com/men/tops-men/hoodies-and-sweatshirts-men.html?climate=201&price=50-60

• Filtered pages, therefore, created duplicate content, as they have the same meta and description as the category page. If Google is allowed to index or follow these pages, your ranking will be highly affected. This SEO-friendly URL can solve the problem by stopping Google from doing that.

1. Configuration

Login to your Magento 2 backend, then select Stores > Settings > Configurations > Mageplaza Extension: SEO friendly URL and follow our given guide below to complete SEO configurations:

• General Configuration
• SEO-friendly URLs for Attributes
• Add Attribute code
• Add Filter Key
• Allow Google to index the Category Page with the Filter Applied
• Allow Google to follow links on the Category Page with the Filter Applied
• Attribute URL Alias

1.1. General Configuration

• Select Enable = Yes to activate the module to optimize the store URLs by making URLs short and clean.

• For example, when filtering Men > Tops > Jackets > Climate > All weather, this is the result if you set Yes - the selected attribute is included and can be easily located.

• If you set No:

1.2. SEO-friendly URLs for Attributes

• Select Yes to apply the SEO-friendly feature for attributes. To configure more in detail, please go to Stores > Attributes > Product > {attribute_name} > SEO friendly URLs to set for each attribute you want.

1.3. Add Attribute Code

• Select Yes to add attribute code to the URL scheme.
• For example: “allweather” > “climate_allweather”

1.4. Add Filter Key

• Customers enter filter key to add to the URL scheme if necessary,
• For example: climate/allweather -> shopby/allweather

2. SEO friendly URL for Attributes

2.1. Generate SEO friendly URL

• Use Config Settings: Apply selection in the configuration section
• Select Yes: Generate SEO friendly URL for this attribute. If filtering based on the attribute Heavy Duty, URL will be optimized, for example, jackets-women/heavyduty.html instead of jackets-women.html?style_general=121

2.2. Allow Google to index the Category Page with the Filter Applied

• Select No: Stop Goolge from indexing pages with filters applied by handling meta-tag robots.

2.3. Allow Google to follow links on the Category Page with the Filter Applied

• Select No: Stop Goolge from crawling filtered pages by handling meta-tag robots.

2.4. Attribute URL Alias

• Customers can enter custom URL alias for this attribute if necessary. If you leave the field blank, the attribute code value will be used instead.

2.5. Add rel=“nofollow” to filter links

• The field is set as No by Default. It is only activated when installing Mageplaza Layered Navigation Pro module.
• Select Yes to add rel as “nofollow” to the URL of filtered option.

Share Cart

Overview

Share Cart allows customers to share their shopping carts with friends and family. It helps expand the supply of product information through a customer without much effort on your part. Promoting your products through customers is the best marketing campaign because you know, people usually trust the suggestions from their friends and relatives. With the help of this module, we believe you can surely increase your sales and profitability, bringing your products closer to consumers. All are included in Mageplaza Share Cart extension.

How to configure

1. Configuration

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Share Cart > Configuration, choose General Configuration section.

1.1. General

• Enable: Choose Yes to enable this module. If the module enables, all features will work as usual. If not, all options on the user interface and the module will not work.
• File Name: Fill the name for PDF file. The PDF file will display the order information of customers
• Add Timestamp suffix: Select Yes to display current time when uploading PDF documents.

1.2. Business Information

• Company Name: Enter your company name in the Company Name field
• Address: Enter your company address.
• VAT Number: Enter your company’s VAT information.
• Phone: Enter your phone number
• Email: Enter the email address.
• Registered Number: Enter your company registration number.
• Warning Message: Fill in the warning message you want to show on PDF orders. Eg: All prices are correct at time of generation, prices may have been changed since.

2. Frontend

After enabling the module, customers can use the Share Cart button to send the URL to others sharing their shopping cart. After sharing, using the shared URL, it will automatically add the product to the shopping cart of the person whom the customer has sent.

• Show the Share Cart button on the Minicart page when adding to cart:

• Show the Share Cart button on the Shopping Cart page when using the URL to share

• Customers can choose Update Shopping Cart to update again the information that you have edited
• Click Text button to view the information of each product and the total price

• Choose PDF button to view the order information

Instructions for installing the PDF library

You need to delete the generated file and run the following command to install:

composer require mpdf / mpdf

3. API

Mageplaza’s Share Cart extension supports using the Rest API to share your shopping cart with everyone, via the Rest API to download and view order information.

Details can be viewed here.

Instructions for creating Integration tokens here.

4. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza / module-share-cart-graphql
php bin / magento setup: upgrade
php bin / magento setup: static-content: deploy

Mageplaza’s Share Cart extension supports store admins to get share cart information via GraphQL

To start working with Share Cart GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Supported GraphQl requests can be viewed here

Search

How to change cron job time

On current version, we have not suport custom cron job time in configuration. We will implement this in next version.

Simple change in XML file.

Go to file: app/code/Mageplaza/Searchplus/etc/crontab.xml line 6

In this example, change to 2 AM server time:

<schedule>0 2 * * *</schedule>

Content of crontab.xml file:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
    <group id="default"> <!-- Doesn't need to be unique -->
        <job name="cron_searchplus" instance="Mageplaza\Searchplus\Cron\Job" method="execute">
            <schedule>0 2 * * *</schedule>
        </job>
    </group>
</config>

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Overview

Search extension for Magento 2 was launched by Mageplaza is a perfect solution that improves your searching system. Our Search extension brings the most benefits for your customer in terms of finding preferred product. The relevant searching results will be shown immediately after customer enter the first letter of product name. Thus, this extension will help to save your customer’s time, make customer satisfaction and make your sale increase definitely.

Mageplaza Search for Magento 2 User Guide will provide detailed instructions to know How to use on the frontend and How to Configure on the backend.

Note

• This extension can be used in multiple stores.
• All stores will be configured under Default Configuration.
• To change the configuration of each store, admins have to uncheck “Use Website” at the left of each Option.
• Extension’s configuration in each store will be applied to the selected store.
• Configuration of this store won’t take impact on the other store’s configuration.

How to use

On the frontend, the search box will be shown on the upper-right corner Customers only click on the search box. It will display 10 New Products or Most View Products or Best Seller Product immediately.

• Customers are able to enter the character of product name on this box to search their preferred product.

• Depends on the configuration in the backend, the search result will display product name, product thumbnail image, price and short description.
• The number of search result(s) will be set up in the backend.
• Customers will click on the result that they are finding, then be redirected to its product page automatically.

Algolia

• To register an Algolia account, please visit https://dashboard.algolia.com/users/sign_in.

• After logging in your new account, please go to Settings > Applications and click on Create Application. Fill in the required information to create the application based on your address.

• Next, choose API Keys to collect information from the fields of Application ID, Search-Only API Key, Admin API key to connect with your website.

How to configure

After logging in to your Magento Admin, choose Store > Settings > Configuration > Mageplaza Extensions > Search

Open General Settings section and do the following:

• In Enable field: Select “Yes” to enable this module.

• In Maximum Number of Search Results field:

  @@ -48,35 +53,61 @@ Open General Settings section and do the following:

• In Limit number of characters in description section field:
  • Indicates the maximum character of a product’s short description that display on Search Result pages.
  • After changing this field, remember to click Save COnfig, Reindex Search Data to apply changes on the frontend.
• In the Information Display field: Chosen information will display on Search Result pages.
• In the Reindex Search Database field, select one of the following
  • Cronjob: If your store has more than 3,000 SKUs, you should choose Cron job, it runs daily at 0AM your server time.
  • After Product Save: This option is a good choice for store has less than 3,000 products
  • Manually (used reindex button bellow): You have to click Reindex button everytime product’s information changes.

Open Search by category configuration section and do the following:

• In the Search by category configuration field: This field allows customer the ability to search by Product and Category’s name
  • In the Enable Search by Caetgory field: Choose “Yes” to display Category search on the frontend. At that time, Maximal Depth will be shown in the backend.
  • In the Maxiamal Depth field: The entered number represents the level of displayed Category in the search box.

Open Search Suggestion section and do the following:

• In the Enable Search Suggestion field: Choose “Yes” to allow products displaying when customers click on the search box.
• In the Sort By field: * Only display this field if Enable Search Suggestion = Yes * There’re 3 types to sort the products: New Product, Most View Products, and Bestsellers

Algolia Search

Enable: Choose Yes to synchronize the Search product to Algolia with each store view when an event occurs like Reindex Search Data( Manually), Cron job, and After Product Save.

Insert the key just created above to enter values into these fields: Application ID, Search-Only API Key, Admin API key.

Index Name Prefix: Insert a name for synchronizing to Algolia.

The search product are now synchronized to Algolia.

That’s all about the user guide of Mageplaza Search extension for Magento 2. If you still have any question, please feel free to contact us.

Expert’s recommendations

Tip

Must-have extensions for your Magento stores

1. One Step Checkout
2. Layered Navigation
3. PDF Invoice
4. Social Login FREE
5. Automatic Related Products
6. Blog FREE
7. Shop by brand
8. SEO FREE
9. SMTP FREE
10. Abandoned Cart Email

Shop By Brand

By Mageplaza you can find many extensions that will help online stores improve customer search such as Magento 2 Layered Navigation and Magento 2 Advanced Search extension, and Magento 2 Shop by Brand extension is also one of such great tool. Similar to the navigation, Shop by Brand allows filtering by product attributes, but they are neither color or material or any physical features of the product. The plugin bases on brands (manufacturers) the products are made by.

In this helpful Mageplaza documentation, you will achieve the guide of How to use and How to config on the frontend and backend of Shop by Brand Magento 2 module.

I. How to use

As soon as installing Shop by Brand completely, your customers can easily search all products under the favorite brands in your inventory. Especially, on its interface, there are 4 ways of shopping by brand:

• Mega menu
• Search Box
• Alphabet Search
• Search Category

You will follow these ways here.

1.1 Brands on Mega menu

Right from the top of the Brand page, you’ll able to give a quick overview by a drop-down list brands are available on your storage. The result displays brand with its provided Logo and Label

1.2 Search Box

The search box on Magento 2 Shop by Brand has some functionalities that are alike to Magento 2 Ajax Search by Mageplaza. In the box, entering some words of the brand name and achieving the drop-down results instantly on the current page.

The brand results come with Brand Logo, Brand Name, and Brand Description.

1.3 Alphabet Search

Alphabet Search, placed under Search Box, is represented including “Show All” and the alphabets. Depending on the first characteristic of the brand name, the user will tap on the respective button.

1.4 Search by Category

You can generate specific categories for brands which direct your customers’ minds to gravitate toward some certain brands, with fetching categories like “Feature Brands”, “Best Seller Brands”, “Mageplaza’s Brand”, etc. Do not hesitate to plan to promote brands you desire!

1.5 Related Brand

You can display different brands related to your brand. This helps you promote more products and at the same time allow customers to find suitable products.

II. How to configure

2.1. Configuration

Go to Catalog > Shop by Brand > Configuration is a bunch of the basic configuration you need to set up firstly.

2.1.1 General

At the Configuration tab, expand General section, please do the following:

• Enable the module when choosing “Yes” to allow customers shop by brand
• From the existing list of the product attribute, set Brand Attribute to the correct choice. In this guide, Manufacturer is the option you have to select
• Enter Brand Route, if passing it, the default (brands) is applied
• Enter Brand Link Title or leave it as the default (Brands)
• In Show Brand Link In field choose the position of putting brand link: Toplink, Footer link and Category
• In Position Brand Link In Category field: Select the position of the Brand on the Category section
• In Show Brands in Category Menu: includes No, Drop-down type và Grid type
  • No: Brands are not shown
  • Drop-down type: show additional fields - What to show, Maximum brands to show, Show brands without products on menu

• What to show: select the elements to display

• What to show = Logo Only : show the brand logo only
• What to show = Label Only: show the brand label only
• What to show = Logo and Label: show both brand logo and label
• Maximum brands to show: enter the maximum number for brands displayed in the menu
• Show brands without products on menu: Select Yes to display the brands with no products in the menu. If No is selected, the brands with no products will not be displayed

• Grid type: show additional fields - What to show, Brand Menu Gird Layout, Maximum brands to show, Show brands without products on menu

• In What to show select elements to display

• What to show = Logo Only: Brands are shown with logos only
• What to show = Label Only: Brands are shown with lables only
• What to show = Logo and Label: Brands are shown with logos and lables
• In Maximum brands to show: fill in the number of brands to show in the menu
• In Brand Menu Grid Layout: choose the number of columns to show brands

• In Show brands without products on menu: Select Yes to display the brands with no products in the menu. If No is selected, the brands with no products will not be displayed

• Show Brand Info on Product Listing Page: Display Product Brand Info at product listing page such as category, Catalog Search
• Show Brand Info in Product Page:
  • Show Brand Info in Product Page = Not show: Not show brand information at product page in frontend
  • Show Brand Info in Product Page = Brand Name: Allow showing brand information at product page in frontend
  • Show Brand Info in Product Page = Brand Description: Allow showing brand description at product page in frontend
  • Show Brand Info in Product Page = Brand Logo: Show brand logo at product page in frontend. Show more fields: Brand Logo Width in Product Page and Brand Logo Height in Product Page.
    • Brand Logo Width in Product Page: Set the width for brand logo shown at frontend
    • Brand Logo Height in Product Page: Set the height for brand logo shown at frontend
• Show Brand Info in Product Admin Grid: Display information of brand at the Product Admin Grid page, including:
  • Brand Logo Only: Only display the brand logo at the Product Admin Grid
  • Brand Name Only: Only display brand name at the Product Admin Grid
  • Brand Logo & Brand Name: Allow showing brand logo and brand name at the Product Admin Grid respectively
  • Brand Name & Brand Logo: Allow showing brand name and brand logo at the Product Admin Grid respectively
• Show Brand Info of Related Products: Select the Brand Info displayed with Related Products on the Product Page. You can select one or multiple info of the brand such as: Brand name, Brand Logo, Brand Description. If you do not want so, you can select Not Show.
• Show Brand Info of Upsell Products: Select the Brand Info displayed with Upsell Products on the Product Page. You can select one or multiple info of the brand such as: Brand name, Brand Logo, Brand Description. If you do not want so, you can select Not Show.
• Show Brand Info of Cross-sell Products: Select the Brand Info displayed with Cross-sell Products on the Product Page. You can select one or multiple info of the brand such as: Brand name, Brand Logo, Brand Description. If you do not want so, you can select Not Show.
• Show Brand Info on Checkout Page: Select the Brand Info displayed with products on Cart Page, Mini Cart, Checkout Page and Mageplaza One Step Checkout Page extension. If you do not want so, you can select Not Show.
• Brand Logo Width in Product Page: Enter the pixel(px) for the width of the Brand Logo on the Product Page. If left empty or 0, the default value is 30px.
• Brand Logo Height in Product Page: Enter the pixel(px) for the height of the Brand Logo on the Product Page. If left empty or 0, the default value is 30px.

2.1.2 All Brands Page Settings

Expand All Brands Page Settings section

• In Brand list name type your prefered name for the Brand Page title
• In Style of Brand List Page includes options to choose the specific order of the brand list * List View * Alphabet Style
• In Display Option supports 3 kinds of performance * Logo only * Logo and Label * Label only
• Brand Logo Width: Set logo width
• Brand Logo Height: Set logo height
• In Style Color select relevant color of the Shop by Brand’s interface
• In Show Brand Short Description set up to show the brand’s description or not
• In Show brands without products: Choose Yes to show brands having no products or No to not show them
• In Show Brand Description set up to show the brand’s description or not
• In Show Brand Product Quantity option to enable/disable the number.
• In Show Brand Quick View Popup select “Yes” if you want to have it opened in Popup style
• Add Custom Css for your own style

2.1.2.1 Brand Filter Function

• In Show Brand Categories Filter: choose “Yes” to enable Category filter
• In Show Brand AlphaBet Filter “Yes” is the default option
• In Brand Alphabet is where you rule the specific alphabet to be filtered, each of alphabet separated by a commas
• Character Set means encode key for your store’s language

2.1.2.2 Brand Search Setting

• In Show Search Block select “Yes” to enable Instant Search at the Brand page
• In Min char default minimum number is 1
• In Number of Search result 0 will show unlimited drop-down search result
• In Show Thumbnail Image decides to display thumbnail image or not

2.1.2.3 Feature Brand Settings

• At Show Feature Brands choose to “Yes” to display.
• In Display Featured Brands Style we support 2 styles
  • Slider View
  • Simple View
• In Title, type a name for your feature brands block
• In Display Information allows
  • Logo only
  • Logo and Label
• In Embedded Code is where you show feature brand block in any place you want.

2.1.2.4 Brand Related Products

• In Show Related Products “Yes” means display brand related products block
• In Title, type a name for your brand related products block
• In Limit field, enter your prefer maximum number of products in the block

2.1.3 Brand Information

Click to expand Brand Information

• In Default Image choose a custom stock for Brand. If passing, the product placeholder default image will be used.
• In Default Block, choose an available product block to be displayed
• Choose to Show Brand Image On Brand Page, Show Brand Description On Brand Page, and Show Brand Static Block On Brand Page or not.

2.1.4 Sidebar

2.1.4.1 Feature Brand Settings

• In Show Feature Brands option “”Yes”” is the default option.
• In Title, “Feature Brand” is the default name
• In Show title choose “Yes” to show the title you named

2.1.4.2 Brand List Thumbnail

• In Show Brand Thumbnail: “Yes” is the default option
• In Title, “Feature List” is the default name
• In Brand’s Qty Limit: 7 brand names in the list is the default number

2.1.4.3 Category Brand

• In Show Category Brand: “Yes” is the default option to display the block
• In Title, “Brand Category” is the default name
• In Category’s Qty Limit: 7 categories in the list is the default number
• In Show Brand Category Quantity “Yes” is the default option

2.1.5 SEO

This is a new sweet treatment for marketing purpose, choose “No” if you don’t wish search engines index pagination pages.

2.2. Categories

This is a separated module to manage Categories on filter searching. Also you can customized some crucial meta data tags like Meta Title, Meta Description, Meta Keywords or Meta Robot

Go to Catalog > Shop by Brand > Categories

To create brand new category, click New Category red button.

To massively set brands into a specific category:

• Follow Catalog > Shop By Brand: Categories
• Select the category you want to apply changes navigate, click Edit
• Choose Brands at the left sidebar, a multi-select available brand list will show up.
• Click Save Category

2.3. Manage Brands

This module provide a short-cut way for navigating to “manufacturer” workplace, from here you will manage all available brands and create new one. Make you way to Catalog > Shop By Brand > Manage Brands

To generate a new brand, follow these steps

• All brands are listed under Manage Options section, click on Add option on the bottom of the list, right after, a new row will appear.

• Click on Save Config to save the new brand.

• Tap Setting to open the “Brand Information” page for configuration.

• Under Brand Information section,

  • Set Page Title for the new brand
  • Create URL Key
  • Upload Brand Image from your computer
  • Set the brand to be displayed on featured brand slider or not in Featured field
  • Enter Short Description (appear on the search result) and Description (appear on Brand Listing)
  • Choose the CMS Block to show brand as a static block on anywhere of your page. You can disable it by leave it blank.
  • Related Brands: Select related brands to the brand you are setting.
  
  • Branded Products: Add multiple products to the brand at once.
    • Action > Add Products > Submit: Add selected products to the brand.
    • Action > Remove Products> Submit: Remove selected products from the brand.
  

• Expand Meta Information section, you can complete all fields for your better SEO, including:

  • Meta Title
  • Meta Keywords
  • Meta Description

• Save Brand to ensure that the configuration for the new brand is successful.

  Note

  For the existing brands, you can edit their information via Setting button.

Brand Revenue Report

• Show Report: Click on the Show report button to show the Brand Revenue Report popup.

• Brand Revenue Report popup: Display the detailed reports on sales of each brand. Thanks to this report, stores can identify which brands are selling well, especially the report of different time period. The Report includes information as follows: Brand, Ordered Item Quantity, Order Count, Total Revenue, Refunder, Discount, Tax.

2.4. Bulk import brands

Shop by Brand extension from Mageplaza supports Magento 2 stores to bulk import brands via CSV file.

Go to System > Data Transfer > Import > Import Settings > Entity Type field, choose “Mageplaza Shopbybrand” to expand Import Behavior and File to Import fields.

Sample csv file:

• Online: https://goo.gl/VqbZ5o
• Offline: Files/Sample/mageplaza_brand.csv

Follow those steps next

• In Import Behaviour fiels, choose Import Behaviour as “Add/Update”
• In File to Import field, browse your brand’s CSV file in Select file to Import
• Copy the file contains Brands in the csv file to the pub/media/import section of the site. (Note: For magento 2.3.3, you need to copy image file of brands and paste at the folder /var/import/images)

Back to the Import page, click Check data button

After Check Data is completed, select Import near footer to import brand to Shop By Brand. If the brand name in the csv file is included in the file to import, the import will be successful

And a report will inform this. Now you’ve done all the step to import brand by a CSV file.

2.5. Export Brand

Go to System > Data Transfer > Export > Export Settings > Entity Type field, choose Mageplaza Shopbybrand to expand Entity Attributes.

2.6. Assign product to brand

This guide helps you classify what brand a product is made by.

• On the Admin Panel, Product > Inventory > Catalog.
• Select an exact product you want to assign, and open Edit mode under Action column.
• On the settings page of the product, you will see ` Manufacturer` field that allows assigning a corresponding brand to that product.

• Save the change to complete the brand attachment.
• When finish all, the brand logo will display on both Brand Listing Search and the product detailed page of the assigned product.

On Brand Listing

On Product Page

2.7. Brand Widget

Get access to Content > Widget > Add Widget to add on brands that you want to display on your website.

2.7.1. Brand Advanced Widget

Show on the frontend:

2.7.2. Brand Category ID Widget

Show on the frontend:

2.7.3. Brand Option ID Widget

Show on the frontend:

2.7.4. Featured Brand Widget

Show on the frontend:

2.8. API

Shop By Brand Extension form Mageplaza does support API which allows users:

• Get brand list
• Add/ edit/ delete brand
• Add products into brand
• Remove brand assigned for product
• Get the product list of brand
• Get the brand’s information assigned to the product according to the product’s sku
• Get a list of feature brands
• Search for brands by name

• Get brand configuration

Guide to create token, please see here

You can see more of how to get API Request by Shop By Brand Extension via this document

2.8. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-shop-by-brand-graphql

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

Mageplaza’s Shop By Brand extension supports store admins to get rule’s information via GraphQL.

To start working with Shop By Brand GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Supported GraphQl requests can be viewed at this link: https://documenter.getpostman.com/view/10589000/SzRxXr2y?version=latest

Shipping Cost

Overview

The Mageplaza Shipping Cost extension supports block of estimated shipping method and shipping fee according to the location selected by the customer before checking out.

Shipping fee is calculated according to each product and its quantity. In addition, the extension also supports calculating the shipping cost of the product along with the products currently in the cart right on the product detail page.

Mageplaza Shipping Cost is fully compatible with extensions: Mageplaza Multiple Shipping Flat Rates, Mageplaza Table Rate Shipping, Mageplaza Shipping Rules, Mageplaza Shipping Restrictions, Mageplaza GeoIP

How to Use

With the extension, customer can do the following actions:

Estimate shipping fee for each product

Estimate shipping fee for the product by product Qty

Estimate shipping fee for the product along with the products available in the cart

How to Configure

Go to Store > Settings > Configuration > Mageplaza Extensions > Shipping Cost

1. Configuration

1.1 General

• Enable: Select Yes to enable the module
• Shipping Calculator Title: Set the title for the estimated calculator and show the shipping cost on the product page.
• Shipping Calculator Description: Set the description for the estimated calculator and show the shipping price on the product page.
• “Not Found” Message: Set a notification to display when no shipping method is found to be satisfied.
• Apply For Country: Set the countries that support estimated calculator of shipping on the product page.

• Show Shipping Calculator: Set the position to display shipping cost. The extension is currently supported in 2 positions: Under Product Description and in the Additional tab
• Display Address Fields: Select the fields related to the address allowed to be displayed for shipping.
• Use Popup: Select Yes to use popup add/change shipping address.
• Apply to Product Pages: Set condition to select the product pages displayed shipping calculator. Leave it blank, default shipping calculator is displayed on all product detail pages.

1.2 Default Address

• The default Address value displayed on the product detail page recorded according to the customer’s Default Address, IP Address and the value set on this tab.
• To be able to get customers’ addresses by IP Address, please install GeoIP Mageplaza.
• Country: Select the default Country
• State/Province: Choose the default State/Province
• Zip/Postcode: Select the default Zip/Postcode

2. Frontend

Display Shipping Cost under Product Description

Show Shipping Cost at Additional Tab

Use Popup to display the Address fill form

Display the Address form directly

Customers can calculate shipping fee by product quantity

Customers can calculate shipping fee of the product they are viewing with the products currently in Cart

Shipping Pro

Overview

Mageplaza Shipping Pro is an effective a solution for all Magento 2 stores to fully control the shipping process. With this package, you can:

• Optimize shipping strategy to maximize profit
• Please customers with suitable shipping rates
• Creata enticing promotion campaigns with Free Shipping rules
• Build customer loyatly ultimately

Download & Install

• Download Mageplaza Shipping Pro
• How to Install

How to use

This solution contains 5 extensions. Please click on each link to see the User Guide of each extension:

• Mageplaza Shipping Restrictions - User Guide
• Mageplaza Shipping Rules - User Guide
• Mageplaza Product Labels - User Guide
• Mageplaza Product Alerts/Out of Stock Notification - User Guide
• Mageplaza Order Attributes - User Guide

Shipping Rules

Overview

Default Magento only allows fixed shipping fees for item or order, admins can only set rules to free items/orders that can not custom the shipping price. Mageplaza Shipping Rules module provides some solutions for admins to change, add or subtract shipments by the item or order. Or admins can create rules to apply shipping fees for certain days or time frames or apply shipping fees to each store or different customer groups.

How to use

• The rule is applied on the frontend

• The rule is apllied in the backend

How to configure

From the Admin Panel, go to Sales > Shipping Rules > Configuration

1. Configuration

General

• Enable: Choose Yes to use the features of this module
• Apply for Backend Order: Choose Yes to apply the rule when admins create a new order
• Apply Multi rules in a shipping method: Choose Yes to apply multiple rules for shipping method

2. Manage Rules

How to add a new rules

• Step 1: Enter the full General information
• Step 2: Set the conditions to apply the rule in the Conditions section
• Step 3: Set up shipment calculation in Actions section

Step 1: Enter the full General information

• Name: Enter the name of the rule
• Description: Enter a description for the rule
• Status: Select “Enable” to apply the rule
• Select Shipping Methods
  • Select the delivery method
  • You can choose from a variety of delivery methods
• Store Views
  • Only the products in the selected store will be applied the rule
  • Multiple stores can be selected at the same time
• Customer Groups
  • Apply the rule to the customers of the selected group
  • Multiple groups can be selected at the same time
• From: Choose the date/month/year to start applying the rule
• To: Select the date/month/year to end applying the rule
• Select Days
  • Select the day of the week to apply the rule
  • Multiple dates can be selected at the same time
• Time From
  • Select the hours of the day to start applying the rule
  • For countries located in different time zones, they will apply according to the hours configured for those countries. For example: Viet Nam is in GMT +7. America is in GMT -5. Time From is 8:00 AM, then 8:00 AM of Vietnam and 8:00 AM of America will start applying the rule when there are buyers.
• Time To:
  • Select the hours of the day to finish applying the rule
  • For countries located in different time zones, they will apply according to the hours configured for those countries. For example: Viet Nam is in GMT +7. America is in GMT -5. Time From is 17:00 PM, then 17:00 PM of Vietnam and 17:00 PM of America will not apply the rule when there are buyers.
• Priority   - Enter the priority for synchronizing objects
  • The smaller the number, the higher the priority
  • For rules with equal priority, the priority will be based on what rules are created first.
• Discard Subsequent Rules: Choose Yes to discard the application of rules with lower priority. For example, the priority of the first rule = 1 while that of the second rule = 2. If in the first rule Discard Subsequent Rules = Yes, only the first one will be applied.

Step 2: Set the conditions to apply the rule in the Conditions section

• Select conditions to apply the rule
• You can set the conditions for Cart or Product section as Subtotal greater than 50, Total Items Quantity less than 5, etc
• The condition to apply Shipping Rules will depend on Cart Price Rules.
  • Active if Cart Price Rules applied
    • Select the created rule in the Cart Price Rules to activate the rule for shipping
    • Multiple rules can be selected at the same time
    • If the customers use a coupon or purchase and satisfy the conditions of the selected rule in the Cart Price Rules, this rule will be applied to shipping without checking the applicable conditions of the selection above.
  • Inactive if Cart Price Rules applied
    • Select the created rule in the Cart Price Rules to activate the rule for shipping
    • Multiple rules can be selected at the same time
    • If the customers use a coupon or purchase and satisfy the conditions of the selected rule in the Cart Price Rules, this shipping rule will not apply without checking the applicable conditions of the selection above.
    • If one or more rules is selected in the Active if Cart Price Rules applied fields and Inactive if Cart Price Rules applied fields, the Inactive if Cart Price Rules applied field will be checked based on the Inactive if Cart Price Rules applied

Step 3: Set up shipment calculation in Actions section

Configure Calculation Shipping Fee

• How to apply fee

• How to apply fee = Re-calculate shipping fee: Replace the old shipping fee calculation
• How to apply fee = Add extra fee: Add the extra fee for the shipping
  • Minimal fee change: Enter the minimum change fee
  • Maximal fee change: Enter the maximum change fee
• How to apply fee = Subtract extra fee: Discount the shipping surcharge
  • Minimal fee change: Enter the minimum change fee
  • Maximal fee change: Enter the maximum change fee
  • For example: Admins configure Minimal fee change is $5. After calculating the shipping fee will be $20. Original shipping fee is $10. The actual shipping fee will be $10 + $5 (if How to apply fee = Add extra fee) or $10 - $5 (if How to apply fee = Subtract extra fee). It’s the same as with Maximal fee change
• Minimal of Total Shipping Fee: Enter the minimum shipping charge that the customers must pay
• Maximal of Total Shipping Fee: Enter the maximum shipping charge that the customers will pay
  • For example: Admins configure Minimal of Total Shipping Fee is $15. After calculating the shipping fee will be $12. The actual shipping fee will be $15. Similar to the Maximal of Total Shipping Fee, the Maximal of Total Shipping Fee is $25. After calculating the shipping fee is 30. The actual shipping fee will be $25.

Configure Order Scope: Shipping fee is calculated for the Order

• Type

• Type = Disable: The shipping fee is not calculated for the Order

• Type = Fixed Amount: The shipping fee is a fixed amount per order

• Type = Percentage of original shipping fee: The shipping fee is the percentage of the original shipping fee. For example, you fill in 5%, the original shipment fee is $20, so the shipping fee is $1 (if the configuration of the How to apply fee = Re-calculate shipping fee)

• Type = Percentage of cart total: Shipping fee is the percentage of total amount. For example: you fill in 5%, cart total is $200, so shipment fee is $10 (if configuration of How to apply fee = Re-calculate shipping fee)

  • Cart Total includes:

    • Cart Total includes = Tax: Shipping fee is calculated based on the total amount of the purchase including Tax
    • Cart Total includes = Discount: Shipping fee is calculated based on the total purchase amount after discount
    • Cart Total can be selected including Tax and Discount

    

• Fee Amount

  • Enter fixed shipment or percentage to charge ship
  • This field is not empty

Configure Cart Items Scope:

• Type

• Type = Disable: The shipping fee is not calculated for each product

• Type = Fixed Amount: The shipping fee is a fixed amount per each order

• Type = Fixed amount with each of weight unit: Shipping fee is calculated as a certain amount per unit weight. For example: you fill in $5, weight of item is 2kg, so shipping fee is $10 (if configuration of How to apply fee = Re-calculate shipping fee)

• Type = Percentage of cart total: Shipping fee is the percentage of total amount. For example: you fill in 5%, cart total is $200, so shipping fee is $10 (if configuration of How to apply fee = Re-calculate shipping fee)

  • Item price includes

    • Item price includes = Tax: Shipment fee is based on the price of each product included Tax
    • Item price includes = Discount: Ship charges are calculated based on the price of each item after discount
    • You can choose the price of each product including Tax and Discount

    

• Fee Amount

  • Enter fixed shipment or percentage to charge ship
  • You are not allowed leaving this field blank

• Select the conditions for applying the rule to each product. Only when you purchase the selected products here, shipping fee is applied for each product. You can see the selected products in the PREVIEW PRODUCTS section

  • Apply for free shipping items
    • Select Yes to apply the rule to the products that are shipped free if the selected products are also in the same rule and that rule has a free shipping configuration when purchasing these products.

3. Compatible with Mageplaza One Step Checkout

Shipping Restrictions

Overview

In fact, shop owners often would like to limit the shipping methods based on specific condition such as the storeview, customer group, cart condition, product attributes, time limit or the compatibility with sales rules. Thanks to Mageplaza Shipping Restrictions extension, your store will be able to perform this and take full control of shipping methods and improve sales efficiency.

The Shipping Restriction module is fully compatible with Mageplaza’s One Step Checkout.

How to download and install

• Download Mageplaza Shipping Restrictions
• How to Install

How to Configuration

From Admin Panel, go to Stores > Shipping Restriction > Configuration

1. Configuration

From the Admin Panel, go to Stores > Shipping Restriction > Configuration, select General

Choose Enable = Yes to turn on the module

2. Manage Rule

2.1. Grid

• From the Admin Panel, go to Stores > Shipping Restriction > Manage Rules

• From Manage Rules, admin can capture basic information such as ID, Name, Status, Method, Store View, Customer Groups, Sort Order, Action.
• Action:
  • Delete: Select the rule you want to delete
  • Change Status: Change the status of the selected rules
  • Edit: Navigate to the edit page of the rules created before
• Also, admin can Filter, Change Store view, Hide/Show Columns.

2.2. Create New Rule

From the Admin Panel, go to Stores > Shipping Restriction > Manage Rules, select Add new

2.2.1. General

• Name: Name the rule, which is the required field.
• Description: Enter the description for the rule.
• Status: Select Enabl to allow the rule to be applied.
• Store View(s):
  • Select store view. Only apply rules for products on selected stores.
  • Many store views can be selected at the same time to display the rule.
• Customer Group(s): Select one or more customer groups at the same time to use the rule. Non-selected customer groups will not apply the rule.
• From: Click on the calendar icon to select the date/month/year. The rule will start from the date/month/year you selected.
• To: Click the calendar icon to select the date/month/year to complete the rule application.
• Select Day (s): Select the days of the week. The rule will be applied to the days of the week with the date/month/year you selected. The remaining days will not apply the rule.
• Time from:
  • Select the time of day to start applying the rule.
  • For countries located in different time zones, they will be applied according to the time selected for those countries. For example: Vietnam is in GMT +7, US in GMT -5. Time from 8 am, so 8 am in Vietnam and 8 am in the US will begin to apply the rule when customers buy goods.
• Time to:
  • Choose the time of day. The rule will end at the time you selected.
  • For countries located in different time zones, they will be applied according to the time selected for those countries. For example: Vietnam is in GMT +7, US in GMT -5. The end time is 19h in Vietnam and 19h in the US will not apply the rule when customers buy goods.
• Priority:
  • Enter the priority for the rule.
  • The smaller the number of priority rules, the higher the priority. 0 is the highest priority.

2.2.2. Conditions

• Apply the rule only if the following conditions are met (leave blank for all products)

Set conditions to apply the rule. All products that meet the conditions will be applied with the rule.

• Apply the rule depending on Cart Price Rules (This will override the conditions above)
  • Active if these Cart Price Rules are applied:
    • Select the rule created in Cart Price Rules to activate the Shipping rule.
    • Many rules can be selected at the same time.
    • If a customer uses a coupon or their purchase meets the conditions of the rule selected in the Cart Price Rules, this rule will be applied to Shipping without checking the applicable conditions of the above option.
  • Inactive if these Cart Price Rules are applied:
    • Select the rule created in Cart Price Rules to activate the Shipping rule.
    • Many rules can be selected at the same time.
    • If a customer uses a coupon or their purchase meets the conditions of the rule selected in the Cart Price Rules, this rule will not be applied to Shipping without checking the applicable conditions of the above option.
    • If one or more rules are selected at the same time in both Active if these Cart Price Rules are applied and Inactive if these Cart Price Rules are applied, system will prioritizely check the rule in Inactive if these Cart Price Rules are applied first then check Active if these Cart Price Rules are applied.

2.2.3. Actions

• What To Do:
  • Show: Show the chosen shipping methods
  • Hide: Hide the chosen shipping methods
• Select Shipping Methods: Select the shipping method to apply the rule. You can choose multiple or all shipping methods to show/hide them all.
• Action: Select Show to display the selected shipping method.
• Location: Select the location to apply the rule on:
• Backend Order
• Frontend Order
• Where To Apply: Select the place to apply the rule on:
  • Orders Backend
  • Storefront Purchases
• Note: If you want to hide/show Shipping Rule in holidays, please go back to setup the date/month you want to hide/show it. And noted to set Priority at the lowest number to get the highest priority.

Size Chart

Overview

There is an obvious fact that every brand, every region has a different size regulation. Thanks to Mageplaza Size Chart Extension, it makes it easy for administrators to display the size chart for each product on the frontend. From there, customers can quickly determine the size to suit themselves, avoid the case of product return.

Size Chart will be displayed as a popup or inline or in the Product tab according to the choice of the Admin. With intuitive HTML customization, admins can edit charts become user-friendly, boosting sale revenues effectively.

Download & Install

• Mageplaza Size Chart
• How to Install

How to Configure

Login to the Magento Admin, choose Catalog > Size Chart

1. Manage Rules

1.1. Basic management interface

This field allows admins to stipulate the Size Chart display according to each of certain rule.

• This is a place where stores all Size Chart created.

• From the Grid, admins can capture the basic information of the rule as ID, Name, Display Type, Priority, Create Date, Update Date, Active, and Action.

• Admins can take some actions the following:

  • Delete: Admins need to choose the Size Chart Rule that they want to delete, then choose Delete in the Action box (in the left corner of the Grid) to remove. A confirmation dialog will be displayed, you choose OK to continue deleting.
  • Change Status: Admins need to choose the Size Chart Rule that they want to change the status, then choose Change Status > Enable/Disable in the Action box (in the left corner of the Grid) to change the status. Immediately, selected Size Chart rules will return to the selected status.
  • Edit: To edit a rule, admins choose Edit in the Action box (the last column on the right of the Grid).
  • Quick Edit: Admins can edit some fields of the rule on the Grid by clicking the mouse to the field you want to edit. The Grid will change as the following:

  

• Also, admins can filter, change store view, hide or appear the columns or Export Grid.

1.2. Create a new rule

After logging into the Manage Rules page, admins choose Add Rule to create a new template. After you Save and Continue Edit, the page will be auto-returned to the Edit Rule page.

1.2.1. Information

• Name:
  • Set the name for the rule. This name only displays in the backend to distinguish between the different rules.
  • This is a required field.
• Description:
  • Describe about the rule in the simple way
  • The content of this field will not display on the frontend
• Active: Choose Yes so that the rule can work well. However, the product can apply it or not, this will depend on the condition, store view, and the priority.
• Store view: This is Store View that Size Chart rule will be applied. A website can have multiple store views. When admins choose Store View in this item, Size Chart rule will be applied in that Store View.
• Priority: When there’re many rules applied on a product, the rule with a higher priority (smaller number) will be applied

1.2.2. What to Show

• Template HTML: With this customizable HTML, it is easy for you to design your desired template with the HTML command line.
• Template CSS: You can add CSS in this field so that your template becomes beautifully.
• Demo Template: We have available 6 templates for your reference. After choosing the desired template, please click on Load Template so that the content of the template is displayed in Template HTML and Template CSS field.

1.2.3. Where to Show

• This is a place that you select the conditions for the rule. The new rule will be applied when these products can satisfy the selected conditions.
• You can add/delete the condition by clicking on + or x
• • You can change the status True/False of the condition by clicking on the bold text.

1.2.4. How to Show

• How to display: We offer 3 ways for you to show Size Chart in the frontend. You can allow displaying many positions at the same time, however, at the same position shows 1 size chart only.

  • Popup: Size Chart will display as the popup when you click on the Size Chart button. The position of the popup button depends on the attribute you enter in the Attribute Code field. This button will display when the Attribute Code is entered as a swatch/dropdown attribute.

  

  • Inline:Under Add to Cart button: Size Chart is displayed on the frontend under the Social Link button.

  

  • Product Tab: Size Chart is displayed as a tab in the Product information block.

  

• Attribute Code:

  • Only show this field when you choose How to display = Popup
  • You need to fill in the attribute code of the Swatch/dropdown attribute to display the popup button just after that attribute.
  • To know the attribute code of swatch/dropdown attribute, you can go to the stores from the admin panel, choose Attribute > Product.

2. Configuration

From the Admin Panel, please go to Catalog > Size Chart > Configuration

2.1. General Configuration

• Choose Yes to Enable this module.
• Choose Icon for Size Chart popup so that it can display on the frontend.

3. Size Chart in Products

• To install a particular product without a rule, admins can select Catalog > Product > Edit Product and set the size chart rule for the product by using the attribute size chart

• Attribute Size Chart includes 3 main options:
  • Inherit from Category/Rule: When this option is picked, Size Chart which is applied for the product will follow the Size Chart rule of the Category which the product belongs to (according to Breadcrumbs on Frontend)

Example: Product A belongs to two categories which are Women and Jackets.

Case 1: Customer reaches product A by the path: Home > Women > Tops > Jackets > A In this particular case, the size chart for product A will be applied by Rule of category Jackets

Case 2: Customer reaches product A by the path: Home > Women > A In this particular case, the size chart for product B will be applied by Rule of category Women

In case the option Inherit from Category/Rule is set for both categories Jackets and Women, all rules in Manage Rule will be filtered to meet the conditions, and the rule with higher priority will be applied on product A

• No: The products won’t apply the Size Chart Rule
• Select a rule created in Manage Rules: Select any other Size Chart Rule and it is applied even if that rule’s status is Disable

4. Size Chart in Categories

• To set all products in the category by one certain Size Chart Rule, admins can select Catalog > Categories, and set the attribute Size Chart similar to when setting Size Chart in Edit Product.

• If you select Size Chart = Inherit from Rule, the selected products (Inherit from Rule in the Edit Product) in the Category will be applied the rule with the satisfied condition and the highest (smallest) Priority.

5. API

Mageplaza’s Size Chart extension supports the use of the Rest API to add size charts’ data to individual products or all products. Also, through the Rest API, you can retrieve, create and delete rule information.

• Details can be viewed here.
• Instructions for creating Integration tokens here.

6. GraphQL

Run the following command in Magento 2 root folder:

composer require mageplaza/module-size-chart-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Mageplaza’s Size Chart extension allows admins to get rule’s information through GraphQl.

To start working with Size Chart GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Supprted GrapQL requests can be viewed here

Frontend

• Size Chart extension is displayed in the frontend with 3 positions:
  • Popup: Size Chart will appear as a popup when you click on the Size Chart button. The position of the popup button depends on the attribute you enter in the Attribute Code field. The button will display when the Attribute Code is entered as a swatch/dropdown attribute

• Inline:Under Add to Cart button: Size Chart is displayed in the frontend under the Social Link button.

• Product Tab: Size Chart is displayed as a tab in the Product Information block

Must-have extensions for your Magento stores

• Increase website traffic: SEO
• Build leads
• Increase conversion rates: One Step Checkout, Layered Navigation
• We believe that you can sell more: Gift Cards, Auto Related Products, Frequently Bought Together, Free shipping bar, Daily Deal , Product Feed
• Keep customers return: Reward Points
• Let your customer become raving fans
• Optimize your stores: PDF Invoice, Custom Order Number, Stop return items issue

SMS Notification

Today, the use of email to send notifications to customers is very popular, but the effectiveness is not high. The reason is because customers do not regularly check email and they must have an internet connection to do it. Understanding this disadvantage, Mageplaza has launched SMS Notification extension, which helps to notify activities from store or related order via SMS to customer and admin more quickly and conveniently.

In addition, we also support SMS Notification compatible with One Step Checkout.

Moreover, this extension allows sending SMS notifications by integrating a 3rd party SMS gateway such as Twilio, Amazon SNS.

Download and Install

• Download Mageplaza SMS Notification
• Installation guide

How to use

1. Customer registers to receive incoming notifications by SMS

• Customer enters OTP to verify phone number upon request

2. Customer enters the phone number at Billing/Shipping to receive SMS of Order notification

How to Configure

I. Configuration

Login to the Magento Admin, go to Stores> Configuration> Mageplaza> SMS Notification.

1. General

• Select Enable = Yes to enable the module.
• Available Country Codes: Allows displaying the country prefix number.

• Sender Phone Number: Type in the phone numer of the sender given by Twilio (Available only when SMS Service Provider = Twilio)
• Default Phone Code: Select the country that you want to be displayed as default
• SMS Delivery: Choose the third-party for SMS integration (Twilio, Amazon SNS)
  • Twilio Account SID: Admin enter Account SID to be integrated SMS gateway. If left blank, Twilio will not be applied.
  • Twilio Account Token: Admin enter Account Token to be integrated SMS gateway. If left blank, Twilio will not be applied.
  • Access Key ID: Admin enter Access Key ID to be integrated SMS gateway. If left blank, Amazon SNS will not apply.
  • Secret Access Key: Admin enter the Secret Access Key to be integrated SMS gateway. If left blank, Amazon SNS will not apply.
• OTP Format: Admin chooses the format for the OTP code. This field will only display when Verify Phone Number = Yes
  • Alphanumberic: The OTP code segment will contain both letters and numbers.
  • Alphabetical: OTP code segment will contain only words.
  • Number: The OTP code segment will only contain each number.
• Recipient Phone Number: Enter the phone number of the recipient to notify the admin and this is also the phone number for you Send Test SMS.
• Send Test SMS: Click the button to check if SMS has been sent.

1.1 OTP

• Select Verify Phone Number = Yes: Customers will verify the phone number with OTP

*Note: ALL of the following fields show up only when the Verify Phone Number = Yes

• OPT Format: Admin chooses format for the OTP
  • Alphanumeric: OTP includes both numbers and letters
  • Alphabetical: OTP includes letters only
  • Numeric: OTP includes numbers only
• OTP Length: Enter the length of the OTP. This field will only display when Verify Phone Number = Yes.
• OTP Resend Times: The number of times OTP is sent back to the customer. The system will send a notification when the number of OTP sent exceeds the allowed limit
• Resend after over-limit in: The time amount (in hours) the OTP will be resent in case it is sent over the allowed times above

2. Cusstomer Notification

2.1 Order Subscription

• Enable: Choose Admin selects the options to allow sending SMS to the customer.
• Check by Default: If Yes, after a new account is created, the subscription is auto-checked at the My account section.
• Order Created Subscription: Choose Yes to enable SMS sent to customers when they finish order successfully
  • Order Created Message shows up when Order Created Subcription = Yes. Fill in the message content
  • For example:

Hello {{billing_address.firstname}}
Your order {{order_number}} has been placed.

• Supporting variables: {{order_number}}
• Invoice Created Subscription: Choose Yes to enable the SMS sent to customers when admin creates invoice successfully
  • Invoice Created Message shows up when Invoice Created Subscription = Yes.. Fill in the message content
  • For example:

Welcome to {{store_name}}
Thank you so very much for joining our store! Have a nice experience with our store!

• Order Created: Enter content for SMS sent to customer when customer order is successful
  • For example:

Hello {{billing_address.firstname}}
Your invoice has been generated for the order {{order_number}}.
Please visit {{customer_email}} to check.

• Invoice Created: Enter content for SMS sent to customer when order is created successfully invoice
  • For example:

Hello {{firstname}}
Your invoice has been generated for the order {{order_number}}.
Please visit {{customer_email}} to check.

• Supporting variables:
  • {{invoice_number}}
  • {{order_number}}
• Shipment Created Subscription: Choose Yes to enable the SMS sent to customers when admin creates the shipment successfully.
  • Shipment Created Message shows up when Shipment Created Subscription = Yes. Fill in the message content.
  • For example:

Hello {{billing_address.firstname}}
The order {{order_number}} has been shipped.

• Supporting variables:
  • {{shipment_number}}
  • {{order_number}}
• Credit memo Created Subscription: Choose Yes to enable the SMS sent to customers when admin creates the credit memo successfully.
  • Creditmemo Created Message shows up when Creditmemo Created Subscription = Yes.. Fill in the message content.
  • For example:

Hello {{billing_address.firstname}}
Your credit memo for the order {{order_number}} has been generated.

• Supporting variables:
  • {{creditmemo_number}}
  • {{order_number}}

**NOTE: Supporting variable for Order, Invoice, Shipment, Credit memo

• {{customer_email}}
• {{billing_address.vat_id}}
• {{billing_address.vat_is_valid}}
• {{billing_address.vat_request_id}}
• {{billing_address.vat_request_date}}
• {{billing_address.vat_request_success}}
• {{billing_address.customer_address_id}}
• {{billing_address.prefix}}
• {{billing_address.firstname}}
• {{billing_address.middlename}}
• {{billing_address.lastname}}
• {{billing_address.suffix}}
• {{billing_address.company}}
• {{billing_address.street}}
• {{billing_address.city}}
• {{billing_address.region}}
• {{billing_address.region_id}}
• {{billing_address.postcode}}
• {{billing_address.country_id}}
• {{billing_address.telephone}}
• {{billing_address.fax}}
• {{billing_address.email}}
• {{shipping_address.vat_id}}
• {{shipping_address.vat_is_valid}}
• {{shipping_address.vat_request_id}}
• {{shipping_address.vat_request_date}}
• {{shipping_address.vat_request_success}}
• {{shipping_address.customer_address_id}}
• {{shipping_address.prefix}}
• {{shipping_address.firstname}}
• {{shipping_address.middlename}}
• {{shipping_address.lastname}}
• {{shipping_address.suffix}}
• {{shipping_address.company}}
• {{shipping_address.street}}
• {{shipping_address.city}}
• {{shipping_address.region}}
• {{shipping_address.region_id}}
• {{shipping_address.postcode}}
• {{shipping_address.country_id}}
• {{shipping_address.telephone}}
• {{shipping_address.fax}}
• {{shipping_address.email}}

2.2 Behavior Subscription

• Enable: Choose Yes to enable the SMS for behavior subscription section.
• Check by Default: If Yes after a new account is created, the subscription is auto-checked at the My account section.
• Sign Up Confirmation: Choose Yes, to enable SMS sent to customers when the system sens the Sign-in verification.
  • Sign Up Confirmation Message shows up when Sign Up Confirmation = Yes. Fill in message content
  • For example:

Hello {{firstname}}
Please access {{confirmation_link}} below to confirm your registration before you can login to {store_name}

• Supporting vaariables:
  • {{confirmation_link}}
  • {{store_name}}
  • {{firstname}}
  • {{middlename}}
  • {{lastname}}
• Sign Up Success: Chọn Yes, cho phép gửi SMS đến customer khi customer đăng ký tạo account thành công.
  • Sign Up Success Message shows up when Sign Up Success = Yes. Fill in message content
  • For example:

Welcome to {{store_name}}
Thank you so very much for joining our store! Have a nice experience with our store!

• Supporting variables: {{store_name}}
• Contact Delivered Subscription: Choose Yes to enable SMS sent to customer when customer contact delivered successfully
  • Contact Delivered Message shows up when Contact Delivered Subscription = Yes. Fill in message content
  • For example:

Hello {{firstname}}
Your inquiry has been sent successfully! We will respond to your request shortly.

• Supporting variables:
  • {{name}}
  • {{telephone}}
  • {{email}}
  • {{comment}}
  • {{store_email}}
  • {{store_phone}}
• Share Product Link Subscription: Choose Yes to enable SMS sent to customers when they share link product successfully.
  • Share Product Link Message shows up when Share Product Link Subscription = Yes. Fill in message content

Hello {{firstname}}
Thanks for sharing our product.

• Supporting variables:
  • {{firstname}}
  • {{middlename}}
  • {{lastname}}
  • {{store_email}}
  • {{store_phone}}
  • {{email}}
• Share Wishlist Subscription: Choose Yes, to enable SMS sent to customers when they share wishlist successfully.
  • Share Wishlist Message shows up when Share Wishlist Subscription = Yes. Fill in message content

Hello {{firstname}}
Thanks for sharing your wishlist. We look forward to your purchase soon.

• Supporting variables:
  • {{firstname}}
  • {{middlename}}
  • {{lastname}}
  • {{store_email}}
  • {{store_phone}}
  • {{email}}
  • {{sharing_code}}
• Subscribe Subscription: Choose Yes to enable SMS sent to customers when they subscribe successfully.
  • Subscribe Message shows up when Subscribe Subscription = Yes. Fill in message content

Hello {{firstname}}
You have successfully subscribed to our newsletter! You will receive our next newsletter.

• Supporting variables:
  • {{firstname}}
  • {{middlename}}
  • {{lastname}}
  • {{email}}
• Unsubscribe Subscription: Choose Yes to enable SMS sent to customers when they unsubscribe successfully
  • Unsubscribe Message shows up when Unsubscribe Subscription = Yes. Fill in message content

Hello {{firstname}}
You have unsubscribed to our newsletter! Please feel free to register again at any time.

• Supporting variables:
  • {{firstname}}
  • {{middlename}}
  • {{lastname}}
  • {{email}}
• Product Price Change Subscription: Choose Yes to enable SMS sent to customers when admin changes the product price.
  • Product Price Change Message shows up when Product Price Change Subscription = Yes. Fill in message content

Hello {{firstname}}
Product {{product_name}} has just updated the price. Visit {store_name}} to view more details!

• Supporting variables:
  • {{first_name}}
  • {{product_name}}
• Product Back To Stock Subscription: Choose Yes to enable SMS sent to customers when product is back to stock
  • Product Back To Stock Message shows up when Product Back To Stock Subscription = Yes. Fill in message content

Hello {{firstname}}
Product {{product_name}} has just been taken to stock. Visit {store_name}} and take it soon!

• Supporting variables:
  • {{first_name}}
  • {{product_name}}

3. Admin Notification

• Enable SMS For: Admin choose among options to send SMS to itself
• Sending Frequency: Admin choose the frequency to send SMS to itself

• Total New Accounts: Fill in content for SMS sent to admin suming up the number of newly created accounts
• For example:

Hello Admin
Today/This week/This month, your store has a total of {{number_new_customer}} new customers registering accounts.
Congratulations!

• Supporting variables: {{number_new_customer}}
• Total New Orders: Fill in content for SMS sent to admin summing up the number of newly created orders

	Hello Admin
Today/This week/This month, your store has a total of {{number_new_order}} new orders placed.
Congratulations!

• Supporting variables: {{number_new_order}}
• Total New Invoices: Fill in content for SMS sent to admin summing up the number of newly created invoices

Hello Admin
Today/This week/This month, your store has a total of {{number_new_invoice}} invoices created.

• Supporting variables: {{number_new_invoice}}
• Total New Shipments: Fill in content for SMS sent to admin summing up the number of newly created shipments

Hello Admin
Today/This week/This month, your store has a total of {{number_new_shipment}} shipment processed.

• Supporting variables: {{number_new_shipment}}
• Total New Credit Memos: Fill in content for SMS sent to admin summing up the number of newly created credit memos

Hello Admin
Today/This week/This month, your store has a total of {{number_new_memo}} memos generated.

• Supporting variables: {{number_new_memo}}
• Total Order Canceled: Fill in content for SMS sent to admin summing up the number of order canceled

Hello Admin
Today/This week/This month, your store has a total of {{number_order_cancel}} orders that have been canceled.

• Supporting variables: {{number_order_cancel}}
• Total New Inquiries: Fill in content for SMS sent to admin summing up the number of newly created inquiries

Hello Admin
Today/This week/This month, your store has received {{number_new_contact}} new inquiries.
Check your email to update and respond soon!

- Supporting variables: {{number_new_contact}}

• Currency Update Warnings: Fill in content for SMS sent to admin when there is an error warning

Hello Admin
There is something wrong with the currency update. Please check and try again.

• Cron Error Warning: Fill in content for SMS sent to admin when there is a cron error warning

Hello Admin
There is something wrong with your cron job. Please check and try again.

• Sitemap Generation Warning: Fill in content for SMS sent to admin when there is a sitemap generation error warning

Hello Admin
There is something wrong with the sitemap generation. Please check and try again.

II. Admin register for customers to recieve SMS notification

Admin can help customers to register to receive notifications by entering customer phone number at backend.

III. Notify Customer by SMS

Admins can send SMS to customers from View Order Admin page.

IV. REST API

Mageplaza SMS Notification supports using REST API to perform some requests: Register Notification, Check Verify, Send OTP, Verify Telephone

View requests supported Mageplaza SMS Notification here.

View REST API guidellines of Magento 2 here. View create token guidelines here.

Social Share

Overview

Today, social media is growing strongly and having tremendous influence on human life. Thanks to thousands of people accessing social networking sites every day, most online businesses take advantage of this opportunity to promote their brands and products closer to customers as well as increase the amount of interaction on their websites. With the new Social Share extension of Mageplaza, it will help you to do the above tasks and especially help you save time and advertising costs.

Download & Install

• Mageplaza Social Share
• How to Install

How to use

Frontend - Floating:

Frontend - Inline

How to configure

1. Configuration

Login to the Magento Admin, choose Store > Configuration > Mageplaza > Social Share.

1.1. General

• Enable: Choose Yes to activate the module
• Icon Color:
  • Select icon color. This field only applies for default icons.
  • Choose Custom option, an extra field appears for selecting among multi colors
• Button Color:
  • Select button color. This field only applies for default icons.
  • Choose Custom option, an extra field appears for selecting among multi colors
• Background Color:
  • Select background color. This field only applys for default icons.
  • Choose Custom option, an extra field appears for selecting among multi colors
• Border Radius: Insert the % value for Border Radius field, with the value range from 0 - 50% ( 0 is square, 50 is round by default). For example when you insert the value of 50%:

• Enable Share Counter: Select yes to count the Share number in the URL links

• Enable Thank You Popup: Select yes to show Thank you popup after sharing

• Enable: Select Yes to enable social share on specific social networks
• Image: click Choose File button to upload the file image of those social networks

• Enable: Choose “Yes” to show more services for sharing. It will allow icon + to display more Services on Frontend.
• Display Menu Type: Choose the Menu displaying method

• Hover: Allow showing Menu when mouse over
• Click: Allow showing Menu when clicking to Service symbol and show the field:
• Display Full Menu: Choose Yes to show full Menu. Choose No, the field Number of Services appears allowing you to choose the service number that you want to display.
• Number Of Services:
  • Enter the number in Number Of Services field, when clicking to “+”, it will allow showing Services by your chosen number
  • If it is left blank, the system will notify that This is a required field and the number will start from 1 by default.

1.2. Floating Configuration

• Apply For:
  • Choose the position to display Services at Floating Configuration
    • All Pages: Displays services on all pages
    • Select Pages: Show 2 more fields: Apply for Select Page and Apply for CMS Page to choose the location to display services:
      • Apply for Select Page: Select the page to display services. You can choose to apply multiple pages at once. Pages not selected will not display services.
      • Apply for CMS Page: Select CMS page to display services. You can choose to apply multiple CMS pages at the same time. CMS pages that are not selected will not display services.
• Style: Select the style for displaying Menu
  • Horizontal: Icons are arranged horizontally.

• Vertical: Icons are arranged vertically.

• Position: Choose the position to show Menu at 2 sides:

  • Left: Icons are on the left side of pages

  

  • Right: Icons are on the right side of pages

  

• Margin Top:

  • Choose the size of services to decide the margin top of sharing button block. Only show this field when choosing Vertical style
  • The default number is 150 px

• Margin Bottom:

  • Choose the size of services to decide the margin bottom of sharing button block. Only show this field when choosing Horizontal style
  • The default number is 0 px

• Button Size: Choose the button size for Icons. The default size of icons is 32x32

1.3. Inline Configuration

• Apply For:

  • Choose the position to display Services at Inline Configuration
  • Enable showing in multi positions

• Position: Choose the position to show Menu at:

  • Top content: Icons shown at the top of page

  

  • Bottom content: Icons shown at the bottom of page

  

• Show under Add To Cart on Product detail Page: Select Yes to display under Add To Cart on Product Detail Page

  

• Button Size: Choose the button size for Icons. The default size of icons is 32x32

Special Promotions

Overview

Customers always love shopping with sales and promotions. Having various and appealing promotion programs is an required features for online store thesedays. Understanding that need, Mageplaza Special Promotions for Magento 2 provides additional 18 rules can be applied on extra Customer Attribute and Order Attributes. The module also has popup suport allowing customers to choose coupon to apply. Especially, Discount Hint will be shown for customers to make them great suggestion of the quantity purchase so that they can get special discount.

Mageplaza Special Promotions is fully compatible with Banner Slider and Better Coupon extensions.

How to download and install

• Download Mageplaza Special Promotions
• How to Install

How to use

• Cart Hint (Coming soon): Displays suggestions for discounts on shopping cart if customer add to cart with the product is in the discount program but not enough in quantity for a discount. For example: Buy 2 more bag to get 20% discount for whole order.
• Display Discount Detail: display discount information for each rule and details in collapsible form.

• Coupon Pickup: Choose coupon code on the pop-up

How to Configure

1. Configuration

Login to the Admin Magento, choose Stores > Settings > Configuration > Mageplaza > Special Promotion.

1.1. General

• Enable: Select yes to activate the module features
• Display Discount Details: If choose Yes, discount will be divided by rules and display details in collapsible form.

• Max. Discount Base: Apply maximum discount for all products in cart for all rules with:
  • No: there will be no discount for the entire cart.
  • Fixed amount: apply maximum discount for the entire cart for rules with Maximum Discount Type is Fixed amount. Choose Fixed amount will show an extra field:
    • Max. Discount Amount: Enter the maximum discountable amount according to Fixed amount to apply the discount for the entire cart
  • Percent of cart subtotal: Maximum discount for all shopping carts in rules with Maximum Discount Type is Percent of cart subtotal. Choose this will show an extra field:
    • Max. Discount Amount: enter the maximum amount that can be discounted by Percent of cart subtotal to apply the discount for the entire cart

Note: It is preferable to consider the smaller maximum discount amount if the maximum discount amount for the entire cart and for each rule both are selected.

Example: For each rule Maximum Discount Type = Fixed amount and Maximum Discount Amount is $ 10. But at *Configuration of this module, Maximum Discount for the Whole Cart is also selected as Fixed amount and Maximum Discount Amount with only $ 5. So when customers order, the maximum discount for the entire cart is only $5.

1.2. Popup and coupon

• Enable Coupon Pickup: Choose Yes to allow selecting coupon code on popups at the frontend

1.3. Cart Hint Message (coming soon)

• Enable: Select Yes to display Cart Hint Message to notify customers about the discount program.
• Upsell Cart Hint: If you select Yes, it will display a suggestion message in the shopping cart for discount programs if customer add to cart with the product or the amount is in the discount program but not yet eligible for a discount. For example: Buy 2 more bag to get 20% discount for whole order.

• Display cart hints on coupon invalid: Select Yes to enable displaying of message suggesting cart when coupon is invalid.

1.4. Skip Special Discount/Tier Price

• Enable: select Yes to allow bypassing Cart Price Rules for products that have Special Price, Tier Price
• Not Apply For: Select the event that discounts are not available from the Cart Price Rule
  • Special Price: Products that have Special Price
  • Tier Price: Products that have Tier Price
  • Bundle Items when Child has Special Price: Bundle products of which children products have Special Price

1.5. Developer

• Developer Mode: select Yes to enable Developer Mode. When it is enabled, you can see discounts applied to specific products in your shopping cart via Developer Mode. If you leave this blank, all the promotions programs will be accessable for every IP Address.

• White List IP(s): Enter the IP address which can see Developer Mode. It is possible to enter multiple IP addresses at the same time and they must be separated by a comma (,). For example: 192.168.1.20,192.168.2. *

2. Manage Rules

Login to the Magento Admin, choose Marketing > Promotions > Cart Price Rules.

2.1. Grid

• Besides Magento available fields, there are also other information such as Discount Type, Discount Amount, Item Action so that admin can know the details of each rule and filter information easily.
• Admin can also perform some actions: Delete rules, Change Status with Activate/ Inactivate for each rule or all rules.

2.2. Create new Rules

2.2.1. Rule Information

Enter and select all rule information such as Rule Name, Coupon, Coupon Code, etc. to start creating promotions.

Choose Enable Coupon Pickup = Yes to show discount on popup for selecting coupon on the frontend

2.2.2. Conditions

Beside the existing conditions of Magento, we also add a number of conditions to create various promotions for your customers. If customers order satisfies the selected conditions, discounts will be applied.

Click (+) to select conditions for rules with Orders subselection.

• Choose different conditions here. Example: “If total paid amount equals or greater than $50 for a subselection of orders matching ALL of these conditions (leave blank for all orders)”. If only the condition is selected here - without the extra conditions, it will apply to all orders.

• Admin can choose to add extra conditions to attract your customers. Example: “If total paid amount equals or greater than $50 for a subselection of orders matching ALL of these conditions (leave blank for all orders) and Order Status contains Complete”. If customer order satisfies the selected conditions, discount will apply.

2.2.3. Actions

• Apply: Select Discount Type for promotion rules.
  • Percent of product price discount: Discount by a percentage from the original price. Discount applies to each eligible item in the cart. Example: Discount Amount is 10. So if any product meets the conditions, it will get a 10% discount from the original price.
  • Fixed amount discount: Discount for each product when purchasing a specific number of products in the same category. Example: Discount Amount is 10, Discount Qty Step (Buy X) is 3. If the customer buys 3 bags of Driven Backpack then they will receive a discount for each bag of $10. So the total discount is $30.
  • Fixed amount discount for whole cart: The discount is fixed amount if only the total amount for the whole shopping cart meets the conditions for buying the required amount. Discount Amount is 10, Discount Qty Step (Buy X) is 30. So if the total amount of the entire cart is $ 30, the discount is $ 10.
  • To-fixed amount discount: Discount only fixed amount if you buy enough quantity of selected products. Example: Discount Amount is 10, Discount Qty Step is 3. If customers buy 3 Driven Backpack bags and the amount paid for each bag is now only $10. So the amount of money you have to pay when buying 3 bags of Driven Backpack is only $30
  • Buy X get Y free (discount amount is Y): Set the quantity that customers must buy to receive free quantities. For example: Discount Amount (get Y) is 1, Discount Qty Step (Buy X) is 3. So if the condition is satisfied, when customers buy 3 products of the same type, if you buy the fourth product, it is still that product. If you buy Buy 3 tee shirts, you will receive a fourth product for free.
  • For each $X spent, get $Y discount: Set the amount that customers have to buy with each product to receive a discounted amount. Example: Discount Amount (get $Y) is 1, Discount Qty Step (Buy X) is 30. So when you have a cart with each Subtotal product is $30, you will get a discount of $1. Subtotal products price is smaller than $30 will not be applied discount.
  • For each $X spent, get $Y discount for the whole cart: Set the amount that customers have to buy to receive a discounted amount over the whole cart. For example: Discount Amount (get $Y) is 1, Discount Qty Step (Buy X) is 30. So the entire cart has a Subtotal of $30 and will be discounted by $1.
  • Buy X get Y: Determine the quantity a customer must buy in order to receive a free quantity. With X & Y are difference product. Example: Buy 3 tee shirts and get 1 bag.

Fields that will be shown:

• Buy product X with:
  • Enter the number of items in Buy product X with field. If you buy an enough number of item X, you will get Y items. If you don’t you won’t get Y.
  • If left blank, there will be no limit to buy X and receive Y.
• Get product Y with:
  • Enter the number of items in Get product Y with field. If you buy an enough number of item X, you will receive a number of items Y selected.
  • If left blank, when purchasing an enough number of item X, you will not receive Y.
• Choose product X: Select the condition when buying item X, if the condition is met when purchasing item X, you will receive item Y.
• Choose product Y: customers will receive Y in the selected condition range. Make sure that items Y and X will not be the same.
• Discount Amount: Enter the discounted amount in the Discount Amount field.
• Maximum Qty Discount is Applied To: Enter the maximum number of same products that can be eligible for a discount in the same cart. If the quantity of the same product exceeds the maximum permitted quantity, the discount will not be applied. If you leave this field blank or fill in 0 here, there will be no limited for same product quantity eligible for discount.- Discount Qty Step (Buy X): Enter the amount in the Discount Qty Step (Buy X) field that the customer must purchase to receive the discount. For example: If you choose to apply a discount type For each $ X spent, get $ Y discount, Discount Qty Step (Buy X), then 30, you must buy with the Subtotal of each product in the cart to reach or exceed $ 30. Discount will apply. If the Subtotal is not reached $ 30, there is no discount for that product.
• Maximum Discount Type: Choose the maximum discount for each rule:
  • No: there is no limit to the discount according to each rule.
  • Fixed amount: apply maximum discount for rules with Maximum Discount Type is Fixed amount. Choose this will show an extra field:
    • Maximum Discount Amount: Enter the maximum discount amount according to Fixed amount to apply the discount for the whole cart. Example: Maximum Discount Amount is 10. So the maximum discount amount is no more than $10 of the whole cart value.
  • Percent of cart subtotal: Maximum discount for all shopping carts in rules with Maximum Discount Type is Percent of cart subtotal. Choose this will show an extra field:
    • Maximum Discount Amount: Enter the maximum amount that can be discounted by Percent of cart subtotal to apply the discount for the whole cart. Example: Maximum Discount Amount is 10. So the maximum discount amount should not exceed 10% of the whole cart value.
• Note: It is preferable to consider the smaller maximum discount amount if the maximum discount amount for the entire cart and for each rule both are selected.
• Skip Special Price/Tier Price: Choose Yes to bypass Cart Price Rule when there is a product having Special Pricce/Tier PRice. NOte: To disable this feature, choose Skip Special Price/Tier Price > Enable =Yes in the configuration.
• Calculate Discount: only shown when Apply = Percent of product price discount
  • Using Special Price/Tier Price: calculate discount based on Special Price/Tier Price of products
  • Using Original Price: calculate discount based on original prices of products

- Apply to Shipping Amount: Select yes to apply the discount for Subtotal and Shipping Amount.

• Discard Subsequent Rules: Select Yes to stop applying other rules after this rule is applied
• Free Shipping: If the order is satisfied with the rule, select the option for Free Shipping configuration:
  • No
  • For matching items only
  • For shipment with matching items

• Addition Item Action: Choose additional conditions to apply product discounts:
• Cheapest item: apply discount for the product with the lowest price in cart. Show an extra field:
  • Qty of applied products:
    • Enter the number in the field Qty of applied products. Example: The input value for the field is 3. In the cart there are 4 products: A ($ 10), B ($ 20), C ($ 30), D ($ 40). So disocunt will be applied for products A, B and C.
    • If left blank or fill in 0, there is default one product is applied for discount.
• Expensive item: apply discount for the most expensive product in cart. Show an extra field:
  • Qty of applied products:
    • Enter the number in the field Qty of applied products. Example: The input value for the field is 3. In the cart there are 4 products: A ($ 10), B ($ 20), C ($ 30), D ($ 40). So disocunt will be applied for products B, C and D.
    • If left blank or 0, there is default one product is applied for discount.

3. Example Cases

Login to the Magento Admin, choose Marketing > Promotions > Cart Price Rules, click Add new button ti create new promotion program.

Please look at the below table, we will guide you to set up some typical rules by Special Promotions extension.

4. REST API

Mageplaza Special Promotions supports using REST API to show information of discount promotions and details about the discount in cart.

View REST API requests supported by Mageplaza Special Promotions here.

View REST API guidelines of Magento 2 here. View create token guildlines here..

Starter Pack

Overview

Mageplaza Starter Pack is a must-have solution for all New Magento 2 stores. By providing the most basic important features, Starter Pack enables your store to:

• Rank at the high position on Google Search Engine Result Pages
• Allow customers to quickly find products without whole-page loading through layered navigation
• Help buyers to seamlessly add to cart then checkout successfully without any hesitation
• Boost sales with subtle promotion campaigns

Download & Install

• Download Mageplaza Starter Pack
• How to Install

How to use

This solution contains 5 extensions. Please click on each link to see the User Guide of each extension:

• Mageplaza One Step Checkout Ultimate - User Guide
• Mageplaza Layered Navigation Ultimate - User Guide
• Mageplaza Quick View & Ajax Cart - User Guide
• Mageplaza SEO Utimate - User Guide
• Mageplaza Special Promotions - User Guide

Store Locator

Overview

Developed by Mageplaza experts, Store Locator is one of the best extensions that allows customers to purchase the desired products in the nearest store with ease. Integrated with Google Maps and GPS, everything becomes easier for customers in finding the nearest shop location.

Especially, if customers want to be active in getting their orders. Store Pickup function allows them to choose the nearest store and time to pick their purchased items. Moreover, it comes with many powerful functions, we sure that you will be satisfied with the benefits that this module brings. Let’s experience it right now!

Download and Install

• Download the module
• Install Mageplaza extension

How to use

• Customers can see a list of all the addresses of the store branches

• Customers can quickly search any store in a certain area. For example, when a customer searches in Washington, all stores in the selected radius in Washington will be displayed.

• Customers can zoom in, zoom out Map as well as can change the store search radius

• By clicking on the detail, customers will see detailed information about the Store and can use the directions to the selected store

• Checkout page: show the detail information including store location, shipping fee and pickup time after that customer can get their items. Please make sure that the products in cart have the same addresses as store locator. If not, the error message will be shown. coressponding to the ordered products. Click Select Store to show popup.

• Click Select Store to show popup. In here, customer should choose the location and time to pick their items up.
• Note: Only show the opening time of stores. The time waiting for order is available or the closing time of store will be hiden, customers cannot choose them. Then click Submit button to confirm the store location and time to pickup items. Click Cancel to quit the popup.

• Frontend Order: Record the order data: time, location, shipping fee customers choose to get their items.

How to configure

• There’re 2 ways to access the menu of the extension:

  • 1. Content > Store Locator

  

  • 1. Enable Mageplaza Menu, all extensions of Mageplaza you are installing will be displayed in this menu:

  

1. Configuration

1.1. General

• Enable: Choose Yes to enable this module
• Title:
  • Enter the title for the page
  • Title plays a role as label of the link that accesses the page
  • If you leave this field blank, the default is Find a store
• Description: Enter the desciption for the page
• Default website: Enter the default website for the store. With stores that have multiple branches, admins can quickly synchronize the website with this item
• Head Background Image: Upload the background for the head block
• Head Icon: upload icon for the head block
• URL Key:
  • Enter the link to access the page
  • If leaving this field blank, the default is find-a-store
• Display Link On: Select where the link can be displayed on the frontend
• Enable Get Direction: Select Yes to enable the directions to the store when customers want
• Enable Pagination: If Yes, pagination will be displayed when you have thousands of stores. It will improve customer experience significantly.
• Enable Search By Area: If Yes, the Search By Area feature will be displayed in the store information map, enabling customers to search for stores more quickly based on where customers are, including fields such as Store Name, Street Address, Country, City, Zip/Postal Code, State/ Province. Click the Reset button to reset and display all stores.

• Enable Favorite Store Bookmark: If Yes, will display a star next to the store locations so customers can bookmark their favorite store, which will be displayed first to reduce the time to find and choose the right store.

• Image: Upload image to replace the star marking the favorite store
• Show Product quantity at relevant store locations with Assigned MSI Stock: If Yes, will display the product quantity and stock status at each store location of the selected product on the product page. To show the quantity of the products at each store as below, store owner needs to turn on the MSI Stock and Assign Source in each product’s setting.

• Enable Store Locator when the product is out of stock: If Yes, will display the store locator when the product is running out of stock on the product page.

1.1.1. Filter store

• Enable: Select Yes to enable the search feature.
• Auto-Filter by current position: Select Yes so that customers can move the maps back to their position by one click in the search box:

1.1.2. Store Pickup Option

• Enable Store Pickup Option Checkbox: If Yes, will display a checkbox for customers to check if they want to pick items up at a convenient location, in case of difficult-to-find store location or distant contact requirements.
• Store Pickup Option Label: Show label of the Store Pickup Option Checkbox
• Enable Store Pickup Notes and Conditions: If Yes, will display the necessary information about pickup procedures, contact information, etc. to customers for better preparation.
• Content:
  • Custom Content: Show the Custom Content field for the store owner to edit the content in the Store Pickup Notes and Conditions section.
  • CMS Static Block: Show the CMS Static Block field for the store owner to select the available blocks for the content in the Store Pickup Notes and Conditions section.

1.2. Map Settings

• Google Map API Key: In order for Google Map to obtain the coordinates of the locations that admins have added, admins need to enter the Google Map API Key into this section.
• Map Style:
  • We provide 4 most popular Style Maps for admins to choose
  • Admins can only select one style at the same time
  • Admins can also custom the maps as they want by themselves. Admins can add Map Style as the guide in the last section of this page.
• Zoom Default:
  • Set map zoom factor (count by %)
  • We recommend a zoom factor as 12%
• Filter Radius:
  • Install the search radius store from the customer location that they can use
  • Radiuses are separated by commas
  • For example: 10,20,50,100
• Default Radius:
  • Set default search radius store from customer location. When the client accesses the page, the map will filter the stores near them in this radius
  • This number may be different from the number entered in Filter Radius field
  • If you leave this field blank, the default radius is 6731 miles (the same as the radius of the earth)
• Distance Unit: Admins can choose the unit distance as Mile or Kilometer depending on the local
• Marker Icon:
  • Select the icon representing the location of the store on the map
  • As it doesn’t resize itself, admins need to put the icon with the size as 20x20 px before uploading

1.3. Store Time Default

• Admins can set the timezone and opening time for each item of the week for all stores. These values are only default values. They are only applied when admins click the Use Config button when they Add New Location

1.4. SEO

You can configure the meta that is useful for your better SEO

• Meta Title: Set Meta title for posts list page (Blog Page)
• Meta Description: Set Meta description for posts list page
• Meta Keyword: Set Meta keywords for posts list page
• Enable Local SEO:

2. Locations

2.1. Grid

• This is a place to store all store locations that are created
• From the Grid, admins can capture the basics of Store Location such as ID, Name, Visibility, Store View, City, Zip Code, Country, Sort Order, Create Date and Action that can be done with Store Location.
• In the Actions dialog, admins can execute the following actions:
  • Delete: Admins need to tick Store Location to delete, then select Delete in the Actions (upper left of the Grid) to delete. A confirmation dialog will appear, select OK to continue deleting
  • Change Visibility: Admins need to tick Store Location to change the status, then select Change Visibility > Yes/No in the Actions dialog (top left of the Grid) to change. A confirmation dialog will appear, select OK to confirm the change
• In the Action column, admins can click on Edit to modify the Store Location
• In addition, admins can Filter, Change Store View, hide/show Columns, Export Grid or edit inline

2.2. Add New/Edit Store Locator Order form

2.2.1. General

2.2.1.1. General

• Name: The name entered here is displayed in both the backend and the frontend
• Visibility: Select Yes so that store locator is displayed on the frontend
• Description: Record a short description for the store
• URL Key:
  • Enter the link to access the location
  • If left blank, after you Save, based on the Name field, URL key will automatically create (unless Name is a hieroglyphic as Russian, Japanese, Korean, Chinese, etc)
• Store View: Store Location is only available in the selected Store View
• Sort Order:
  • Stipulate the display order of the Store Location on the Frontend
  • 0 is the highest position

2.2.1.2. Store Pickup Option

• Enable Store Pickup Option Checkbox: If Yes, will display a checkbox for customers to check if they want to pick items up at a convenient location, in case of difficult-to-find store location or distant contact requirements. If you select Use Config, that Store Location will take the value you set in the Configuration section.
• Store Pickup Option Label: Show label of the Store Pickup Option Checkbox
• Enable Store Pickup Notes and Conditions: If Yes, will display the necessary information about pickup procedures, contact information, etc. to customers for better preparation.
• Content:
  • Custom Content: Show the Custom Content field for the store owner to edit the content in the Store Pickup Notes and Conditions section.
  • CMS Static Block: Show the CMS Static Block field for the store owner to select the available blocks for the content in the Store Pickup Notes and Conditions section.

2.2.2. Location

2.2.2.1. Address Information

• Fill in the store location’s address information in these fields
• After entering the correct address, admins click on Get GPS coordinates to automatically get coordinates and display on Maps

2.2.2.2. Review Map

• The coordinates of the store location are shown here
• They can be obtained automatically when admins Get GPS coordinates, admins can also manually fill
• The coordinates change with the marker icon when it moves to another location, however the information on the address above (street, city, etc.) will not change.

2.2.3. Time

2.2.3.1. Open Hours

2.2.3.2. Holiday

• Holidays created under Content > Store Locator > Holidays will be displayed in this section
• The selected holidays will be applied for the store. Opening times on the Frontend will change from Open to Close on holidays

2.2.4. Contact

• Admins can enter their contact information to display on the frontend
• Basic information includes: phone number, website address, fax number and email address

2.2.5. Images

• Admins can upload typical images of the store to display on the Frontend.
• The uploaded first image is displayed on the store locator page, the remaining images is displayed as a slider when the customer clicks on the location detail.

2.2.6 Available Products

• Show on Product Page: Select Yes to allow showing specific store can be picked up on Product Page. For each Product page, customer can click to See available pickup stores to check in which stores that product is available.

• Selected Product: This part records the information of products within related stores. Admin can search, filter product ID, SKU, Price in the Grid. Admin can add products to each store locator.

2.3. Manage Holidays Grid

• This is a place to store all the Holidays that admins installed for store
• From the Grid, admins can capture basic Holiday information such as: ID, Name, Status, No. of Locations, Create Date and Action that can be done with Holiday
• In the Action dialog, admins can execute the following actions:
  • Delete: Admin need tick tick Holiday to delete, then select delete in the Actions (upper left of the Grid) to delete. A confirmation dialog will appear, select OK to continue deleting
  • Change Status: Admins need tick tick Holiday that they want to change status, then, choose Change Status > Yes/No in the Action dialog (top left of the Grid) to change. A confirmation dialog will appear, select OK to confirm the change
• In the Action column, Admin can click Edit to modify Holiday information
• In addition, admins can Filter, Change Store View, hide/show Columns, Export Grid or edit inline

2.4 Add New/Edit Form

2.4.1. General

2.4.2. Locations

• The created locations in the Content > Store Locator > Locations section will be displayed in this section
• Selected stores will be applied for this holiday. Opening times on the Frontend will change from Open to Close on holidays.

How to add Map Style

• Step 1: Choose Map Style = Custom

• Step 2: Click here in the comment. The link will be lead to https://snazzymaps.com/

• Step 3: Click on Map Style that you want. For example: Lost in the desert

• Step 4: Expand Code and Copy JAVASCRIPT STYLE ARRAY into the Custom checkbox in the configuration

• Step 5: Save and check on the frontend

Mageplaza Store Pickup

1. Configuration

Login to the Magento Admin, choose Stores > Configuration > Sales > Shipping Methods > Mageplaza Store Pickup.

• Enable: Select Yes to enable using the Shipping Methods feature with Mageplaza Store Pickup.
• Title:
  • Enter the title for the Shipping Methods type with Mageplaza Store Pickup.
  • If left blank, the default is Select Store to pickup.

• Method Name:

  • Enter a name for this Shipping methods type and will appear on Shipping methods when the customer checkout.
  • If left blank, the default is Store Pickup.

  

• Price: Enter the price for shipping methods. If left blank, the ship price will default to 0.

• Calculate Handling Fee: Select the Handling Fee for the shipping methods, this price will be added to the Price field and displayed in shipping methods when the customer checkout. With two Handling Fee types:

  • Fixed: Shipping methods will be calculated according to the price and handling free fields as follows: Price + Handling Fee. For example: Price: 5, Handling Fee: 6, so the total ship charge is: 5 + 6 = 11.
  • Precent: Shipping methods will be calculated according to the free and handling price fields: Price + Handling Fee. For example: Price: 5, Handling Fee: 6, so the ship’s total charge is: 5 + 5 * 6/100 = 5.3.

• Handling Fee: Enter the price for Handling Free. If left blank, the default is 0.

• Pickup ready after:

  • Enter the number of days after ordering at least how many days customers can pick up the goods.
  • If left blank means that the product is always available in the store so customers can pick it up during business hours at any time.

  

• Displayed Error Message: Enter the message to notify errors when shipping method is not applied to several addresses that customers selected. Display message when Show Methods if Not Applicable = Yes.

• Ship to Applicable Countries:

  • All Allowed Countries: Apply the store pickup method to all countries.
  • Specific Countries: Apply the store pickup method to certain countries.
    • Ship to Specific Countries: Select countries to apply the store pickup method. Unselected countries will not allow this delivery method.

• Applied Payment Methods: Select payment method to apply to store pickup method.

• Show Methods if Not Applicable: If Yes, the store pickup method will still be displayed even when not applicable to some addresses or countries that customers selected, and the Displayed Error Message will be shown.

• Sort Order:

  • Enter the number in the Sort Order field. Display sort order for Shipping method when customer pays. The higher the number, the more priority the shipping method has. With 0 being the highest.
  • If left blank, the default is 0.

2. Form Add New/Edit Product

Login to the Magento Admin, choose Catalog > Products Add new/Edit any product

• Available Store Pickup:
  • Select store locator to display product on that store locator.   - If left blank, the product will not display and be in any store locator.
• Note: If the Form Add New/Edit Store locator has been selected, in this part the product will be selected for that store locator. Or you can edit the store locator for each product here.

3. Orders Backend

This section records the store locator’s address information, after ordering for how long the customer can come to pick up the goods and the amount of additional charges customers have to pay as shipping,…

API

Store Locator developed by Mageplaza supports the use of Rest API to view the information of locations data by store, configuration by store, get map config by style, location information by quote,etc.

More details can be seen from here

Get instruction on creating Integration tokens from here

GraphQL

Run the following command in Magento 2 root folder

composer require mageplaza/module-store-locator-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

To start working with Store Locator GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Set GraphQL endpoint http:///graphql in URL section, click on Set endpoint. For example, http://develop.mageplaza.com/graphq
• Mageplaza supports query and mutation to view the information by locations data by store, configuration by store, pickup config, etc. That can be seen from here

Notation

If you want to uninstall the extension, please use composer to run the command bin/magento module:uninstall Mageplaza_StoreLocator

Find the follow table to delete extension mp_mageplaza_storelocator_holiday, mp_mageplaza_storelocator_location, mp_mageplaza_storelocator_location_holiday attribute in your data base.

Go to data base > table eav_attribute. At attribute_code, delete attribute mp_pickup_locations

Next, go to mp_cms_block then delete mp-storelocator-block

Store Switcher

Overview

Store Switcher will automatically guide international customers to the respective store, providing a language and currency that is appropriate for their country. Also, it brings more convenience for customers when they go shopping on your online store with great experiences. All are integrated into a new extension of Mageplaza. It’s Store Switcher for Magento 2.

In particular, with the support of Mageplaza’s Geo IP extension, it will help you identify your customer’s countries and then redirect customers to the relevant store views. This feature of Geo IP will improve the shopping experience of customers when they can purchase at the appropriate store views.

Download and Install

• Download Store Switcher extension
• Install Store Switcher extension

How to configure

1. Configuration

From the Admin Panel, go to Stores > Store Switcher > Configuration > Mageplaza Extension > Store Switcher, choose General Configuration section.

• Enable: Select Yes to enable the Module.

• Allow visitors save switched store view:

  • Choose “Yes” to use the feature Allow visitors save switched store view.
  • If Yes is chosen, a popup will be shown to visitors to ask if they want to save the switched store view for the next visit. Save customer choice (popup when manually changing store view)

  

2. Manage Rules

2.1. Grid

From the Admin Panel, go to Stores > Store Switcher > Manage Rules.

• This section will record all created rules with the basic info as: Name, Status, Type, Countries, Created Date and Update Date, etc.
• Admins can perform some actions:
  • Delete: Choose the rule that you want to remove
  • Change Status: Tick to choose the rules that you want to change the stauts, select “Running” to use the rules
  • Edit: Click to choose “edit” on the rules that you want to edit the content
  • Also, admins can filter, change the store view, hide/show the grid. Choose Add New button to create a new rule

2.2. Create New Rule

How to Create New Rule

From the Admin Panel, go to Stores > Store Switcher > Manage Rules, select Add New button in the right corner.

2.2.1. General

• Name: Enter the name of the rule
• Status: Choose “Enble” to use the rule
• Priority:
  • Enter the priority for the rule
  • The lower the priority, the higher the priority. 0 is the highest priority.

2.2.2. Conditions

• Countries: Select the country to apply the rule. Multiple countries can be selected at the same time.
• Page Type: Select the page you want to display the rule:
  • Specific Pages: Select the specific page to display rules. It will show 2 more fields:
    • Apply by path of URL: Enter the Url path to apply the rule. For example: /blog/, /onestepcheckout/.
    • Exclude by path of URL: Enter the Url path to exclude the rule from displaying the selected path.

Note: If the rule is both Apply by path of URL and Excluded by path of URL, then the rule will not be applied.

• All pages: Show rules in all pages.
• Home pages only: Show only rules at Home page.
• Exclude IPs: Enter the IP address in the Exclude IPs field. The IP address that you entered will not apply the rule to that IP address.
• Search engines to ignore: Enter the browser type and user agents to ignore and not apply rules to that browser. It is possible to enter multiple browsers at the same time and separated by (,).

2.2.3. Actions

• Type: Choose the type that you want to redirect to the rule
  • Redirect to a URL: It will show more fields:
    • Redirect to a URL: Enter the Url into the Redirect to a URL field. The rule will be redirected to the selected Url.
    • Store Views: Select Store View that you want to redirect to
    • For example: If you enter as https://mageplaza.com or mageplaza.com, your website will be redirected to https://mageplaza.com.
  • Redirect to a Store View/Change Currency: It will show more 3 fields:
    • Redirect to a store: Choose the store view. The rule will be redirected to show on the selected store. Multiple stores can be selected at the same time.
    • Change Currency to: Choose the currency in this field and show the currencies with the selected store.
    • Redirect Only For The First Access Time: Only apply for redirecting Store Views and Currency one time at the first access
    • How to change Store View: This field allows choosing the store view.
      • Manually: If Manually is selected, a notice will be shown to ask if visitor wants to change the store view which suits with the current location.
        • Notice customer to manually change store view.

  - `Automatic`: If Automatically is selected, the appropriate store view will be auto-switched without any advanced notice or permission.

Geo IP

From the Admin Panel, go to Stores > Store Switcher > Configuration > Mageplaza Extension > Geo IP Configuration, choose Geo IP Configuration section.

• Enable Geo IP: Select “Yes” to enable the Geo IP feature that helps you identify the customer’s country, and then redirect the customers to the relevant view store.
• Download Library button: Click on Download Library button to download the library of Geo IP. Please download library before you enable.

Store Credit

Overview

Mageplaza Store Credit extension allows customers to recharge their store account with certain discounts/bonuses. All transactions will be stored and managed in My Account/Store Credit of Customer (Frontend) and in the admin. Credits are used to make purchases at the store. Admins can also use credit for customers when creating New Order. This extension provides admins credit products. Customers can purchase this product to add credit to the balance. In addition, admins can refund customer orders in store credit to customer accounts in your store instead of returns and customers will be able to use it for future purchases. Customers can see the balance on the toplink, see the usage history and receive an email when the balance is updated. This extension encourages shoppers to purchase and increase the performance of the payment on your website. Through this module, you can increase the number of customers and their satisfaction.

Mageplaza Store Credit extension is fully compatible with Mageplaza One Step Checkout and SMTP.

How to use

• Thanks to this extension, customes can perform some actions:

  • Manage Balance

  

  • Purchase Store Credit Product

  

  • Use Credit to pay the order

  

How to configure

From the Admin Panel, go to Marketing > Store Credit

1. Configuration

1.1. General Tab

• Enable: Choose “Yes” to use the features of this module
• Enable for Customer Groups: Only customers in the selected groups is used this extension
• Display Balance on Toplink: Choose “Yes” so that the balance value of customers is displayed on the toplink
• Allow Refunding Orders to Credit Balance: Choose “Yes” to display the text box filling the amount that the shop owner wants to refund the credit balance when the order is refunded
• Allow Refunding Store Credit Products: Choose “Yes” so that customers can refund Store Credit Product.

1.2. Spending Configuration

• Enable Spending On: Choose Credit that can use in the backend or frontend
• Apply for:
  • Choose product types that Credit can pay
  • Multiple product types can be selected
• Apply for tax: Choose “Yes” so that Credit can be used to pay the tax fee
• Apply for Shipping Fee: Choose “Yes” so that Credit can be used to pay the Shipping fee
• Limit Spend Amount: Set the number of Credit that is applied for each order
  • No: No apply the credit to pay for the order
  • Percenatge of Subtotal (exclude Tax): The number of credits that Customers can use will be equal to x% of the subtotal of the Order (exclude Tax)
  • Fix Amount (exclude Tax): Customers is only used up to x$ for each order (exclude Tax)
  • x% (or x$) is set in the Limit Value field
• Limit Value:
  • Set the number of credit that customers can use for the order
  • The unit of the value will be based on the admin option selected in Limit Spend Amount By
  • This limit applies only to the subtotal, excluding tax and shipping charges
• Allow Refunding: Choose “Yes” so that the number of credit customers use for order will be transferred to Credit Balance when the order is refunded

1.3. Email Configuration

• Enable : Select “Yes” to use this feature
• Subcribe Customers by Default: Select “Yes” so that customers who signup a new account will automatically accept the email when credit balance is updated
• Sender: There are 5 default Magento Senders for admins to choose: General Contact, Sales Representative, Customer Support, Custom Email 1, Custom Email 2
• Update Balance Email Template:
  • The extension is installed the available Email notification for customers when their credit balance is updated
  • To change the Update Balance Email Template, admins can create another Email Template under Marketing > Email Template.
  • How to create a new email template here

2. Transaction

2.1. Grid

• This is a place to save all transactions on the store
• From the Grid, admins can capture the basic information of the generated transactions such as ID, Title, Customer, Status, Action, Amount, Balance, Create Date and view Transaction when click to View at Action column
• In addition, admins can filter, hide/show Columns or Export Transaction

2.2. Add New/Edit Form

From the Admin Panel, go to Marketing > Store Credit > Credit Transactions > Create New Transaction

• Select Customer
  • When you click on this item, the popup displays a list of all the customers in the store. Admins only select a customer in the list.
  • The name of customers selected by admins in this section will be added to the credit into their Store credit balance
  • If leaving this field blank, customer will have an error message
• Amount Note
  • The number that is filled in this section is the credit number added to customers
  • If you enter a negative number or leave this field blank, it will give an error
• Customer
  • This is the section for admins to fill out a comment for this transaction
  • The content filled out in this section will be displayed to customers
• Admin Note
  • This is the section for admins to fill out comments for themselves
  • The content filled in here will only be visible by admins

3. Manage Store Credit at Admin Customer

• Admins can manage Store Credit Balance, Transactions and Notification of customers by going to Customer > Edit Customer > Store Credit
• The Credit Information tab tells the administrators to know the total amount of Credit that customers has, and shows the status of the email receipt action when the balance update of the customers. Admins can also change the status of this action.
• The Update Balance tab allows admins to change the balance by filling in the Amount Change field and adding a comment to the customers or admins. Customer Note will be displayed for customers.
• The Transaction tab displays information about all of the transactions performed by customers: ID, Title, Customer, Status, Action, Amount, Balance, Create Date.
• The Balance, Notification and Transaction information in the admin will sync with the customer’s Frontend My Account/My Store Credit

4. How to create a Store Credit Product

• To create a Store Credit Product, admins need to access Product > Catalog > Add New Product > Store Credit Product

• After filling in the basic information of Store Credit Product such as Name, SKU, Qty and Category, admins need to configure the following options:

• Allow Amount Range:

  • Select “Yes” so that customers can change the Amount of Credit as their wish within the Amount Range From - To that admins have set.

  

  • Select “No” to set the Fixed Amount for the Credit Credit Store

  

• Price: The price displayed on Frontend = Price Percentage * Amount entered by customers. If you leave it blank, Price Percentage = 100%

5. Email Update Balance

6. API

Mageplaza’s Store Credit Extension supports users to use API to make some requests such as getting customer information with store credit, get transaction, product, order, invoice, creditmemo data. Customers can also use store credit and admin can create transactions through API.

• You can view the Rest Api request we support here.
• See how to create token-based authentication here.

7. GraphQL

7.1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-store-credit-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

7.2. How to use

• Mageplaza’s Store Credit Extension supports getting customer information and transactions, retrieving product information and using credits through GraphQL.
• Note: To perform GraphQL queries in Magento you need to use Magento 2.3.x and return the site to developer mode.
• Refer to the GraphQL requests we support here.

Stripe

Overview

Stripe is a US payment gateway that allows e-commerce sites to receive payments on their sales website. Stripe has no setup fees, no monthly fees and no hidden costs. Mageplaza Stripe extension will help you integrate this payment gateway with your store. Your customers can use all debit cards, credit cards, or local payment methods like Alipay, Giropay, Bancontact, Przelewy24, etc. This extension also includes authorize, capture and 3D secure. These settings can be easily done by admin at the backend.

Mageplaza Stripe extension is fully compatible with Mageplaza One Step Checkout

How to download and install

• Download Mageplaza Stripe
• How to Install

How to use

For Customer

• Pay by Card
• Pay by Alipay
• Pay with Giropay
• Pay with Bancontact
• Pay with Przelewy24
• Payment by SOFORT**
• Pay with EPS
• Pay with iDEAL Bank
• Pay with Google Pay
• Pay with Apple Pay
• Pay with Microsoft Pay

• Verify by 3D Secure when paying by Card
• Allow customers to save card information at their first payment to use for next payments.
• You can check the payment by using following test card information:

Test card numbers

Use any of the following test card numbers, a valid expiration date in the future, and any random CVC number, to create a successful payment. Each test card’s billing country is set to U.S

 

NUMBER	BRAND
4242424242424242	Visa
4000056655665556	Visa (debit)
5555555555554444	Mastercard
2223003122003222	Mastercard (2-series)
5200828282828210	Mastercard (debit)
5105105105105100	Mastercard (prepaid)
378282246310005	American Express
371449635398431	American Express
6011111111111117	Discover
6011000990139424	Discover
30569309025904	Diners Club
38520000023237	Diners Club
3566002020360505	JCB
6200000000000005	UnionPay

3D Secure test card numbers

Not all cards support 3D Secure or require the customer to be redirected to their card issuer’s authentication page. Use the following card information to test 3D Secure payments.

 

NUMBER	3D SECURE USAGE	DESCRIPTION
4000000000003220	Required	3D Secure 2 authentication must be completed for the payment to be successful. By default, your Radar rules will request 3D Secure authentication for this card.
4000000000003063	Required	3D Secure authentication must be completed for the payment to be successful. By default, your Radar rules will request 3D Secure authentication for this card.
4000008400001629	Required	3D Secure authentication is required, but payments will be declined with a card_declined failure code after authentication. By default, your Radar rules will request 3D Secure authentication for this card.
4000000000003055	Supported	3D Secure authentication may still be performed, but is not required. By default, your Radar rules will not request 3D Secure authentication for this card.
4242424242424242	Supported	3D Secure is supported for this card, but this card is not enrolled in 3D Secure. This means that if 3D Secure is requested by your Radar rules, the customer will not go through additional authentication. By default, your Radar rules will not request 3D Secure authentication for this card.
378282246310005	Not supported	3D Secure is not supported on this card and cannot be invoked. The PaymentIntent will proceed without performing authentication.

All other Visa and Mastercard test cards do not require authentication from the customer’s card issuer.

International test card numbers and tokens

You can use any of the following test cards to simulate a successful payment for different billing countries.

For America

 

NUMBER	COUNTRY	BRAND
4000000760000002	Brazil (BR)	Visa
4000001240000000	Canada (CA)	Visa
4012888888881881	Canada (CA)	Visa
4000004840000008	Mexico (MX)	Visa

For Europe, Middle East, and Africa

 

NUMBER	COUNTRY	BRAND
4000000400000008	Austria (AT)	Visa
4000000560000004	Belgium (BE)	Visa
4000002080000001	Denmark (DK)	Visa
4000002330000009	Estonia (EE)	Visa
4000002460000001	Finland (FI)	Visa
4000002500000003	France (FR)	Visa
4000002760000016	Germany (DE)	Visa
4000003000000030	Greece (GR)	Visa
4000003720000005	Ireland (IE)	Visa
4000003800000008	Italy (IT)	Visa
4000004280000005	Latvia (LV)	Visa
4000004400000000	Lithuania (LT)	Visa
4000004420000006	Luxembourg (LU)	Visa
4000005280000002	Netherlands (NL)	Visa
4000005780000007	Norway (NO)	Visa
4000006160000005	Poland (PL)	Visa
4000006200000007	Portugal (PT)	Visa
4000006430000009	Russian Federation (RU)	Visa
4000007240000007	Spain (ES)	Visa
4000007520000008	Sweden (SE)	Visa
4000007560000009	Switzerland (CH)	Visa
4000008260000000	United Kingdom (GB)	Visa
4000058260000005	United Kingdom (GB)	Visa (debit)

For Asia Pacific

 

NUMBER	COUNTRY	BRAND
4000000360000006	Australia (AU)	Visa
4000001560000002	China (CN)	Visa
4000003440000004	Hong Kong (HK)	Visa
4000003920000003	Japan (JP)	Visa
3530111333300000	Japan (JP)	JCB
4000004580000002	Malaysia (MY)	Visa
4000005540000008	New Zealand (NZ)	Visa
4000007020000003	Singapore (SG)	Visa

For other cases, please access more here.

For Admin

• Turn on/off 3D Secure
• Set up the countries using the Payment Method
• Specify Payment Action
• Create Mobile or Telephone Order by the card information saved

How to Configure

1. Configuration

From the Admin panel, go to Stores > Configuration > Sales > Payment Method

1.1 Credential

• Environment:
  • Admin can choose Sandbox environment to test payment function with Stripe
  • When you want to apply for online payment, admin needs to change the environment to Production
• Publishable key: Admin needs to register a Stripe Account to be able to use the payment methods that Stripe supports. Admin needs to correctly insert the Publishable key of your Stripe Account
• Secret key: Comes with Publishable key, admin also need to fill in exactly Secret of Stripe Account
• Test Credential button: Admin can check your app by clicking the Test Credential button

How to create Stripe account and get API keys:*

• Visit https://stripe.com to register a Stripe account. Then Sign In with the account you just registered successfully.
• In the Dashboard page of Stripe, select Get your test API keys to get the API keys test for Sandbox Environment.
• With the Production Environment, you need Activate account to get live API keys.

1.2 Card

• Enable: Select Yes so that Customer can pay by Card
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Credit Card Types:
  • Choose 1 or more cards for payment
  • Cards will be authenticated when customer completes the card number at check out. For cards not selected in this section, there will be an invalid message for the customer.
• 3D Secure: Select Yes to use 3D Secure to verify Customer’s card, thereby preventing payment fraud. Showing extra field Force using

• Force Using: Select Yes to compulsorily verify the card. Showing additional field USing 3D secure when. Only successful 3D Secure verified cards can process orders
  • There are 5 types of cards that can be verified by 3D Secure:
    • Required: 3D Secure authentication must be completed for the payment to be successful
    • Recommended: 3D Secure is supported and recommended but not required on this card. Payments succeed whether 3D Secure is used or not.
    • Optional 1: 3D Secure is supported but not required on this card. 3D Secure authentication may still be performed, but is not required. Payments succeed whether 3D Secure is used or not
    • Optional 2: 3D Secure is supported for this card, but this card is not enrolled in 3D Secure. This means that if 3D Secure is invoked, the customer is not asked to authenticate. Payments succeed whether 3D Secure is invoked or not.
    • Not_supported: 3D Secure is not supported on this card and cannot be invoked.
• Using 3D Secure When
  • 3D Secure is recommended: Force using 3D secure with recommended card type
  • 3D Secure is optional: Force using 3D secure with optional card type
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

1.3 Alipay

• Enable: Select Yes so that Customer can pay by Alipay
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

1.4 Giropay

1.5. Bancontact

• Enable: Select Yes so that Customer can pay by Bancontact
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

1.6. Przelewy24

• Enable: Select Yes so that Customer can pay by Przelewy24
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

1.7. SOFORT

• Enable: Select Yes so that Customer can pay by SOFORT
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

1.8. EPS

• Enable: Select Yes so that Customer can pay by EPS
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

1.9. iDEAL Bank

• Enable: Select Yes so that Customer can pay by iDEAL Bank
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

1.10. Google Pay

• Enable: Select Yes so that Customer can pay by Google Pay
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

1.11. Apple Pay

• Enable: Select Yes so that Customer can pay by Apple Pay
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

1.12. Microsoft Pay

• Enable: Select Yes so that Customer can pay by Giropay
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

• Enable: Select Yes so that Customer can pay by Microsoft Pay
• Title: Enter the title of the payment method. This title will replace the name of the method to display in Frontend
• Payment Action:
  • Authorize and Capture: Payment will be captured immediately after the Customer place order successfully. At that moment, customers’ card is deducted for the order payemnt and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates Invoice for Customer’s order. When the Invoice is successfully created, admin can receive money from Customer’s card
• Payment from Applicable Countries:
  • Select All Countries to allow Stripe payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries can show the Card payment method
• Instruction: A simple description of this payment method. The instruction will be displayed at Frontend to instruct Customer how to use this payment method
• Sort Order:
  • Choose display position of this payment method compared to other payment methods
  • 0 is the highest number

2. Admin create order at backend

• Go to Sales > Orders > Create New Order > Select Customer > Select Store.
• After choosing product to make order, please fill the Address Information and choose Shipping Method. At Payment Method, choose Credit Cards(Stripe), then select one card which has been saved to process the payment.
• Mageplaza Stripe extension only support admin to create backend order with the saved card information previously.

3. Frontend

3.1. Stripe payment at checkout page

3.2 Saved Card Management and Use Saved Card for Next Payment

Subscription & Recurring Payment

Introduction

To attract customers to the subscription and recurring payment method, Mageplaza developed the Subscription and recurring payments extension. Its main feature is to enable store owners to sell products under the payment of the subscriptions, and customers to track and manage their subscription history. The Subscription and recurring payments module for Magento 2 is compatible with Mageplaza One Step Checkout Extension

How to Use

1. Customer

• Customers can buy a product or service using the subscription and recurring payments method.

• Customers can manage their subscriptions on the My Subscription page.

2. Admin

• Admins can set up the configuration for the Subscription
• Admin can create and manage Subscriptions
• Admin can manage and track customers’ subscriptions

3. How to configure a key for Paypal Subscription

3.1. How to create a webhook at Paypal

• Sign in to your account at developer Paypal, then go to My Apps & Credentials > Create App

• Enter App Name > App Type = Merchant > Select Business Account

• After the App is created, there will be Client ID and Secret, which are used for the Configuration section of Mageplaza Subscription and recurring payment extension.
• It is necessary to create a webhook to launch the subscription. In the App you have created, scroll down to the WEBHOOK section > click Add Webhook.
  • Enter Webhook URL: https://<base_url>/mpsubscription/webhook/paypalexpress
  • Select Event Type: You can select All events
  • Click Save to save the webhook

• To track Subscriptions on Paypal, log into your Business Account, which was selected when creating the App > go to Pay & Get Paid > click Subscriptions.

• In the Subscription tab, the details of Subscriptions can be displayed and managed.

3.2. How to configure a Paypal key in Magento 2

From the Admin panel, go to Stores > Settings > Configuration > Sales > Payment Methods > PayPal Express Checkout > Required Paypal Settings > Mageplaza Subscription

• Client ID: Enter the Client ID of the webhook created at Paypal.
• Client Secret: Enter the Client Secret of the webhook created at Paypal.
• Button Test Connection: Check the connection with Paypal

4. How to create a webhook in Stripe

• Log into your Stripe account > go to Developers > Webhook

• Complete the following information:
  • Endpoint URL: https://<base_url>/mpsubscription/webhook/stripe
  • Select events to listen to: Choose all events or necessary ones only, but the following events are compulsory: customer.subscription.created, customer.subscription.updated , invoice.created, invoice.payment_succeeded
  • Click Add endpoint to complete the settings.

• To manage Subscriptions on Stripe, go to Payment > Subscriptions

How to Configure

1. Configuration

Go to the Admin panel, select Sales > Subscription and Recurring payments > Configuration; or from the Admin panel, select Stores > Setting > Configuration > Mageplaza > Subscription and recurring payments

1.1. General

• Enable: Select Yes to enable the extension
• Select Payment Gateways: Choose the payment method for subscription-based payment
• Display the Start and End Date of the Subscription: Select Yes to allow customers to choose the start and end date of the subscription
• Free Shipping to Subscription Products: Select Yes to enable free shipping and display the Free Shipping Text
• Free Shipping Text: Enter the notice text if you allow free shipping for subscription products. This will be shown if Free Shipping to Subscription Products = Yes
• Allow only one subscription item in Cart: If selected Yes, the customer’s cart can only contain one subscription-based product. If there is one subscription-based product in the cart, they cannot add any other items. In case there is one one-time payment product in the cart, they can add one-time payment products freely, but cannot add any other subscription-based product.

1.2. Subscription Configuration

• Subscription Style:
  • Radio: The options of Subscription and Recurring Payments in the Product Detail Page frontend will be displayed in radio buttons.

• Dropdown: The options of Subscription and Recurring Payments in the Product Detail Page frontend will be displayed in dropdown style.

• Subscription Text: The text is shown on the Product Detail Page

• Tooltip for Subscription and Recurring Payments: Enter information for the tooltip, which will be shown on the Product Page when customers hover the icon next to the Subscription Text

1.3 Subscription option

• Only buy products through subscription: Set up the purchase method options:
  • Only buy products through subscription = No: It is possible to buy subscription and recurring payment products through subscription and one-time payment.
  • Only buy products through subscription = Yes: It is only possible to buy subscription and recurring payment products through subscription
• Label for Subscription and Recurring Payments: Enter the label for Subscription and Recurring Payments option on Product Page
• Label for One-Time Payment Option: Enter the label for the One-Time Payment option on the Product Page

1.4. Paypal Express Checkout

• Limit The Number of Failures Payments: Set the maximum number of failed payments for recurring orders. If left empty or zero, there is no limitation.
• Customer Cancel Subscription: Select Yes if allow customers to delete subscriptions paid via Paypal Express. This is only applicable if the Rule Subscription allows cancellation.
• Notice: With Paypal, you can only pay for 1 subscription product per transaction

1.5. Stripe

• Customer Cancel Subscription: Select Yes if allow customers to delete subscriptions paid via Stripe. This is only applicable if the Rule Subscription allows cancellation.
• To use Stripe, you need to install Mageplaza Stripe Extension

1.6. Email Configuration

• Enable Email Notification: Select Yes to allow emails sent to customers
• Email Sender: Select the sender of emails. This will be visible when Enable Email Notification = Yes
• Email Notify Customers Upon Subscription: Select templates for emails when customers buy subscription products

1.6.1. Reminder Email Template

• Enable: Select Yes to send emails to remind customers of the next payment
• Next Billing Email Reminder Template: Choose email template. Only visible when Enable = Yes
• Send Reminder About Next Invoice (Days): Enter the number of days before the next payment deadline to send an email to remind customers. If left empty or zero, the default value will be 2. Only visible when Enable = Yes

1.6.2. The Trial Ends Email Template

• Enable: Select Yes to send emails when the trial period expires.
• Email template notifies the customer when the trial ends: Select the email template. Only visible when Enable = Yes

1.6.3. Remaining Trial Time Email Template

• Enable: Select Yes to send emails when the trial period is about to expire
• Email template to notify the remaining trial time: Choose email template. Only visible when Enable = Yes
• After the remaining trial period (days): Enter the number of days before the trial time ends to send emails to remind customers. If left empty or zero, the default value will be 1. Only visible when Enable = Yes.

1.6.4. Subscription is Cancelled Email Template

• Enable: Select Yes to send emails to customers when the subscription is cancelled.
• Notify Customers When Subscription is Cancelled: Select email template. Only visible when Enable = Yes.

1.6.5. Subscription Expiration Email Template

• Enable: Select Yes to send emails to customers when the subscription expires.
• Notify Customers When Subscription Expires: Select email template. Only visible when Enable = Yes.

2. Manage Subscription

From the Admin panel, go to Sales > Subscription and Recurring payments > Subscription Plans.

2.1. Grid

• Display information of Subscription rules: ID, Name, Status, Free Product Trials, Initial Subscription Fee, Discount Prices To Subscribers, Frequency, Frequency No., Action
• Action:
  • Edit: direct to the Edit Subscription information page.
• Mass Action:
  • Delete: remove Subscription
  • Change Status: edit status of Subscription
    • Enable
    • Disable
• Admins can also filter the grid information by using Filters or Sort details according to columns, show or hide columns, set views.

2.2. Add New Subscription

2.2.1. General

• Name: Enter the name of the subscription. This is compulsory so you cannot leave it blank.
• Status: There are 2 subscription statuses: Enable and Disable
• Frequency: Set the frequency of subscription. Available options include Day, Week, Month, Year
• Frequency No.: Enter the frequency number. For example: If Frequency = Day, Frequency No.=10, the subscription period will be 10 days.
• Free Product Trials: Select Yes to allow a trial period of the product.
• Trial Period (Days): Enter the number of days for the product trial, counting in days. This is only visible when Free Product Trials = Yes.
• Customer Cancel Subscription: Select Yes to allow customers to cancel subscriptions
• Initial Subscription Fee: Set up how the initial subscription fees are calculated.

• No: No fee is charged. However, to take payment online, we will leave the default as $1.
• Fixed Amount: The initial fee will be calculated as a fixed amount, which will be entered in the Initial Subscription Fee Amount field.
• Percent of Product Price: The initial fee will be calculated as a percentage of the product price, which will be entered in the Initial Subscription Fee Amount field.
• Initial Subscription Fee Amount: Enter the initial fee of the subscription. Only visible when Initial Subscription Fee = Fixed Amount or Percent of Product Price. The way how fees are calculated will be set up in the Initial Subscription Fee field.
• Discounted Prices to Subscribers: Offer discounts for customers purchasing products using Subscription and recurring payments (not applicable for the initial subscription fee)

• No: No discount
• Fixed Amount: The discount amount will be calculated as a fixed amount, which will be entered in the Discount Amount field
• Percent of Product Price: The discount amount will be calculated as a percentage of the product price, which will be entered in the Discount Amount field.
• Discount Amount: Enter the discount amount. Only visible when Discounted Prices to Subscribers = Fixed Amount or Percent of Product Price. The way how fees are calculated will be set up in the Discounted Prices to Subscribers.
• Minimum Quantity for Discounted Prices: Enter the minimum product quantity for customers to get the discounts. Only visible when Discounted Prices to Subscribers = Fixed Amount or Percent of Product Price.

2.2.2. Select Product

• Configure which products can be purchased by Subscription and recurring payments
• Click icon to select product
• Click the Preview Products button to view the list of products that can be ordered by Subscription.

3. Subscription Log

From the Admin panel, go to Sales > Subscription and Recurring payments > Subscription Log.

• Display information of Subscription Log: ID, Order ID, Subscription ID, Product Name, Status, Customer Email, Payment Method, Start Date, End Date, Created At, Action
• Action:
  • View: direct to the Subscription information page.
• Mass Action:
  • Change Status: Edit the Subscription status
    • Active
    • Inactive
    • Cancel
• Admins can also filter the grid information by using Filters or Sort details according to columns, show or hide columns, set views.

4. Frontend

4.1. Product Page

• Customers can pay for the products in 2 ways:
  • One-Time Payment
  • Subscription to buy this product
• The subscription options applied to products can be shown in the radio buttons or dropdown lists, according to the admin’s configuration. When customers choose to purchase the product by subscription method, the following information will be displayed on the frontend:
  • Start Date: select the start date of the subscription
  • End Date: select the date to end subscription
    • Never: Subscription only ends when there is a request to the store owner, or when it is cancelled.
    • After … Cycles: In the textbox, enter the number of cycles to apply Subscription. After the entered number of cycles, the Subscription will automatically end.
    • Custom Date: Customize the end date from the calendar. After the stated date, the Subscription will automatically end.
• There are also details about Product Trials, Trial Period, Initial Subscription Fee (Excl. Tax), Discount amount upon subscription, Frequency

4.2. Shopping Cart Page

4.3. Checkout Page

4.4. My Subscriptions page

Go to My Account > My Subscriptions.

• Includes the Subscription list of customers.
• Includes the following information:
  • Order ID: ID of the order that contains subscription-based products
  • Subscription Name: Name of the subscription plan
  • Product Name: Name of the product
  • Status: Status of the subscription
  • Subscription End Date: The end date of the subscription
  • Trial Subscription Due Date: The end date of the trial subscription
  • Payment End Date Upon Subscription: The date when customers make payments for the subscription
  • Next Payment Date: The date of the next payment
  • Next Payment Amount: The amount customers have to pay in the next payment (including subtotal and discount of the subscription), excluding shipping fees and tax.
• Action:
  • View: Show popup that contains Subscription information
  • Cancel: Cancel Subscription
• When the Invoice of the subscription order is created, the subscription status will be Active, and the subscription starts.

Table Rate Shipping

Overview

Mageplaza Table Rate Shippin, supports merchants to create an unlimited number of flexible shipping methods with their own shipping rates. Magento 2 admin can use a combination of conditions: destination, cart weight, subtotal cart, quantity cart and shipping group of products to calculate shipping accurately. These methods and rates are displayed flexibly at the frontend, making shopping and shipping options of customers more convenient, helping merchants to bring the best services to customers.

The extension is fully compatible with Mageplaza One Step Checkout, Mageplaza Shipping Rules and Mageplaza Shipping Restrictions.

How to Use

With this extension, customers can perform the following actions:

Create new shipping methods with certain shipping rates

Display shipping values at the order frontend

Displays the shipping values at the backend order

Set the volume weight value for the products

Set Shipping Group for the products

How to Configure

1. Configuration

Go to Sales > Table Rate Shipping > Configuration

• Enable: Select Yes to activate the extension
• Carrier Title: Enter the title that you want to appear for the shipping rate table at checkout. The default title is Table Rate.
• Ship to Applicable Countries: Select the country that you want to apply the shipping table rate. There are 2 options:
  • All Allowed Countries: Customers in any country will be allowed to ship according to the table rate.
  • Specific Countries: Customers in certain countries are eligible for ship rate according to table rate. When selecting this option, the Ship to Specific Countries field will appear for you to select specific countries.
• Include Virtual Products in Price Calculation: Choose Yes to calculate shipping costs for Virtual products if they exist in the order.
• Use Volumetric Weight Calculation: Configure to calculate the volume weight for the product. The value of volumetric weight can be calculated directly or indirectly through the volume value of the product. The general formula for calculating the value of volumetric weight is: Volumetric Weight = Volumetric/Shipping Factor.

• Select Weight Attribute: The extension currently supports three ways of calculating volume values:
  • Volumetric Weight: Directly determine the volume value of a product. Selecting this option will display the Select Weight Attribute field, which allows you to select the corresponding attribute of the product containing the volume weight value.
  • Volumetric: Indirectly determine the volume weight value through the product’ s volume value. Selecting this option will display two additional fields: Select Volumetric (V) Attribute and Shipping Factor.
    • Select Volumetric (V) Attribute: Allows selecting the corresponding attribute of the product containing the volume value. The extension currently supports two types of inputs, namely direct V value or volumetric value via 3-dimensional LxWxH measurements (LxWxxHigh). For example, the product has a measurement of length, width, height is 10; 10; 10, respectively, the total volume is 1000, you can fill 1000 or 10x10x10.
    • Shipping Factor: The ratio to convert from the volume value to the value of volumetric weight.
  • Volume Attribute: Indirectly determining the value of volumetric weight by measuring the length, width, height of the product. Selecting this option will display four additional fields: Attribute 1, Attribute 2, Attribute 3 and Shipping Factor.
    • Attribute 1, Attribute 2, Attribute 3 allows you to select attributes corresponding to 3 measurements of Length, Width, and Height of the product.
    • Shipping Factor: The ratio to convert from the volume value to the value of volumetric weight.
• Show Method if Not Applicable: Select Yes to still display the table rate shipping method on View Cart and Checkout page when the order does not meet the conditions for using this shipping rates. At that time, the message in the Displayed Error Message field will be displayed to the customer.
• Sort Order: Specify the display position of the shipping methods in the list that satisfy the order, with 0 being the first position.

2. Manage Shipping Methods

2.1. Shipping Methods Grid

• The grid shows the shipping methods with information of ID, Name, Status, Customer Groups and Store Views applied, Shipping Method Image. At Grid, it is possible to edit inline Name and Status of shipping method; Massaction Delete or Change status of multiple shipping methods at once.
• From the Grid, you can create a new shipping method by clicking the Create New Method button or editing the existing shipping method details by clicking to corresponding “Edit” action.

2.2 Create New/Edit Shipping Method

2.2.1 Information

• Name: Set name of shipping method. The variable {{delivery_days}} is supported to show the estimated delivery time, this value will be taken from the corresponding shipping rate.
• Internal Note: Admin’s note about shipping method.
• Status: Select Enable to allow the method to apply shipping fees for the cart.
• Calculation Shipping Rate Rule: Choose how to calculate the shipping fee for the cart if it satisfies multiple method rates at once. Extension supports 3 calculation methods:
  • Sum up rates: Ship fees will be equal to the sum of all rates.
  • Choose the lowest rate: Ship fee will be calculated according to the lowest rate
  • Choose the highest rate: Ship fee will be calculated according to the highest rate
• Image: Choose the image for the shipping method.
• Store View (s): Set Store View to allow shipping method to be applied
• Customer Group (s): Choose the Customer Group that is allowed to apply the shipping method

2.2.2 Labels

On the Label tab, the admin can set the display of the shipping method Label and shipping method Description according to each store view. If the Label and Description fields are left blank, the shipping method name will be the name on the default Information and Description tab.

2.2.3 Shipping Rates

On the Shipping Rates tab, the admin can view the list of rates, add, edit or delete any rates. A rate of shipping method is determined by two main parts: condition for a cart to apply that rate and how to calculate shipping fee when the cart satisfies the condition.

2.2.3.1 Add new rate

The extension now supports 3 ways to add a rate to the shipping method:

• Manually add a new rate

• Add a new rate by importing the csv file

• Add a new rate by importing rate from another shipping method

• Type 1: New Rate: At Grid Shipping Rates, click New Rate, popup and add a new shipping rate will be shown

  • General > Name: Set Name for Shipping Rate

  • Conditions: There are 5 main conditions that admin can set for 1 rate: Ship destination, weight of cart, total amount of cart, number of items of cart and shipping group of products in cart.

    • Ship destination is determined by Country, State/ Region (only applies to some countries), Zip/ Postcode. In which, Zip/ Postcode supports String format or Range format. To use Range format, admin only need to select the Zip / Postcode Range checkbox and fill in the corresponding postcode value.
    • Note: Extension supports 2 types of strings using “%” and “dash” characters. “%” is used to replace a string of indefinite length while “dash” used to replace a character.
    • For example:
      • Shipping location is Aberdeen in the UK with Postcode code starting with AB, you need to set Country = United Kingdom, uncheck the Zip/ Postcode Range checkbox and enter the value of the Zip/ Postcode = AB%.
      • Shipping location is Aberdeen in the UK with Postcode code starting with AB12, you need to set Country = United Kingdom, uncheck the Zip/ Postcode Range checkbox and enter the value of the Zip/ Postcode = AB12 ___, which is equivalent to all postcodes with 7 characters, starting with AB12, ending with any 3-character cluster, 2 characters are separated by a space “ “ will satisfy.
      • Shipping location is Michigan in the US with Zipcode from 48001 to 49971, you need to set Country = United States, select the Zip / Postcode Range checkbox and enter the Zip / Postcode From = 48001 and To = 49971 .
    • Cart weight: The weight of a cart is determined by the weight of each product in the cart. Conditions by weight are included under the From and upper limits To. When you do not want to set a limit, you can leave it blank or enter *.
    • For example: For an order weighing less than 10kg to apply the shipping rate, the Weight From = 10 and To = Blank/*

    

    Note: For each cart, if the product has volumetric weight (according to the setting method calculated in section 1. Config), the weight will vary between the weight (to be set in each product) and the volumetric weight. The one with the higher value will be taken to compare with the value set in this field.

    • Total amount of cart: Total amount of cart calculated in Subtotal excluding Tax, including lower limit From and upper limit on To. When you do not want to set a limit, you can leave it blank or enter *.
    • For example, for orders under $ 100 that apply a shipping rate, Price From = Blank/0/* and To = 100 are required.

    

    • Number of cart items: including the limit From and the limit on To. When you do not want to set a limit, you can leave it blank or enter *.
    • For example: For orders with 3-5 items that apply a shipping rate, Qty From = 3 and To = 5 should be set
    • Shipping Group: Products can be assigned a certain shipping group to classify goods when shipping. For each type of goods can be assigned a certain shipping rate. Instructions for setting up the Shipping Group for the product will be detailed below.

  • Settings: Here we will set the rate level to calculate ship fee. There are 4 basic types of rates:

    • Product Fixed Rate: The fixed rate for each product in the cart
    • Product Percentage Rate: The percentage of each product price, based on which the rate is counted
    • Weight Unit Fixed Rate: The fixed rate for each weight unit. Each unit of weight will be calculated according to the weight or volumetric weight of the product, whichever is greater will receive that value.
    • Order Fixed Rate: The fixed rate for the whole order Ship fee will be equal to the sum of the rates corresponding to the cart combined. If you do not want to apply any rate for shipping, just leave that field blank. Leaving all fields blank is equivalent to the freeship for the cart. Also in the Settings tab, you can set the estimated shipping date in the Estimated Delivery Time field, this value will be displayed in the frontend to notify customers by variable {{delivery_days}} in the shipping method name.

  • After filling all the above information as desired, click Save to save the shipping rate you have just set.

• Type 2: Import Rates

You can use csv file to import multiple rates at the same time. You just need to click the Import Rates button above the Rate management grid, the Import Shipping Rates popup will be shown. Please Choose File with csv format and its content matches the columns format as shown below and click Import (Note: the postcode field corresponding to the case of unchecking Zip / Postcode Range):

We currently support 2 sample import files available for the United States/ United States zip/ postcode countries and string/ alphanumeric countries (United Kingdom), you can see more details here. You can download the sample file and edit it as you want, then completely import it as usual.

In addition, you can export the rate of any shipping method to import the shipping method you want.

Type 3: Import From Others

The extension supports allowing adding the existing rates of one shipping method to another. Just click Import From Others, the Select Shipping Rates popup will display, allowing you to select the desired shipping rates. Then you just need to click Import, the newly selected shipping rates will be added to the shipping method you are creating or editing.

2.2.3.2 Edit rate

To edit a rate, go to the Shipping Rates tab, select the Rate you want to edit, and click Action Edit accordingly. Then, the edit rate popup will display with the same fields when creating a new rate manually, the information of the rate is already loaded on the popup for you to edit.

2.2.3.3 Delete rate

To delete one or more rates, you go to the Shipping Rates tab, in the grid Rate, select the rate you want to delete, click Massaction Delete, the Submit button will display. You just need to click Submit to delete the selected rate.

2.3 Setting Shipping Group for the product

Go to Store > Attributes > Product > mptablerate_shipping_group

In Tab Properties> Manage Options (Values of Your Attribute), click the Add Option button to add a new option, you can set the label for the option according to the corresponding store view. Click Delete if you want to delete an option. Then click Save Attribute to save the changes.

Visit any product editable page, select a value for the Shipping Group field to assign Shipping to each product. This Shipping Group will be used to set which shipping rate the product applies.

2.4 Freeship Setting for products according to Shipping Group

To set the Freeship for products under the Shipping Group, make sure the setting of the mptablerate_shipping_group attribute has enabled the Use for Promo Rule Conditions feature.

Go to Marketing > Cart Price Rule > Add New Rule / Edit Rule, set information and condition as desired. On the Action tab, select the attribute for the condition is Shipping Group, select the desired Shipping Group. At the Free Shipping field:

• Select the value of For matching items only to apply free shipping only for products of the selected shipping group.
• Select the value For shipment with matching items to apply free shipping to both invoices containing products of the selected shipping group.

3. Frontend

View Cart page

Checkout page

Checkout with Multiple Addresses page

One Step Checkout page

Table Category View

Overview

In order to shorten the shopping time and drive more conversions for Magento 2 stores, Mageplaza develops the Table Category View extension. The module supports a new way of displaying a category page in a more detailed table compared to Magento 2. The table shows more fields: SKU, Short Description, Stock Status, Stock Alert, Qty. In addition, Mageplaza Table Category View also allows customers to add multiple products at the same time from the category page.

Mageplaza Table Category View is fully compatible with Configurable Product Grid View, Configurable Preselect, Layered Navigation.

Donwload and Install Guide

• How to install Magento 2 extensions

How to use

With the extension, customers can perform the following actions:

Click the button to switch View

Add All To Cart: displays the Add button on the top right

Add Each Product To Cart: display the Add button in each product

Popup when clicking Select Options

Popup when adding products to the cart

How to Configure

1.Configuration

From the Admin Panel, go to Stores > Configurable > Mageplaza Extensions > Table Category View

1.1. General

From the Admin Panel, go to Stores > Configurable > Mageplaza Extensions > Table Category View, select General

• Enable: Select “Yes” to enable the module features
• Apply for Customer Group: Select the customer group to which the category will be applied, can select multiple customer groups.
• Use Table View As Default: If Yes, when loading the Category page will default to open Table View Mageplaza.

Beside using Use Table View As Default at Configurable to default show Mageplaza Table View, admin can also go to Catalog > Categories to set default displaying for each Category page. This configuration will be applied as priority.

1.2. Display

From the Admin Panel, go to Stores> Configurable > Mageplaza Extensions > Table Category View, select Display

• Show Add To Cart Button:

• Add All To Cart: display the Add to cart button at the top right of Category, customers can add multiple products at the same time.

• Add Each Product To Cart: display the Add to cart button on each product on the Category page, only add 1 product to the cart.

• Button Text: enter the name displayed in Frontend, do not enter the default “Add to cart”
• Button Text Color: Select the font color for the button displayed at the Frontend, leaving the display blank according to the system color.
• Button Background Color: Select the font color for the button displayed at the Frontend, leaving the display blank according to the system color.
• Table Options:
  • Show Product Image: Select “Yes” to display the product image on the Category page in the Product Image column.
  • Show Product Short Description: Select “Yes” to display more Product Description columns on the Category page.
  • Show Product Review Rating: Selecting “Yes” displays another Review Rating column on the Category page.
  • Show Stock Status: Selecting “Yes” displays the Stock Status column on the Category page.
• “No Review” Label: Set the name for Review Rating column at Frontend when product has no review. Default name is No Review.

• Show Configurable Product Grid View:
  • Select “Yes” to display grid view with the configurable products.
  • If the Configurable Product Grid View is not installed, you can download here.
• Enable Popup Options For: Select the type of product that displays the popup with products with optional options:

2. Compatible with Configurable Product Grid View

After installing the Configurable Product Grid View module, for products under the Configurable Product, clicking on the Select Option will display a Popup that allows selecting multiple sub-products of the parent product at the same time. To find out the Product Grid View extension see here.

3. Compatible with Configurable Preselect

After installing the Configurable Products Preselect module, helping display pre-selected choices saves time for customers on the Category page. Learn more about the extension see here.

4.Compatible with Layered Navigation

After installing the Layered Navigation module, help filter the desired items and buy them quickly.

Thank You Page

Overview

With the help of Mageplaza Thank You Page, you can impress your customers with ease. They can completely check their orders including various information such as order number and status, order date, shipping address, payment method, and so on. This will help the customers know that they have successfully placed orders. Also, it helps customers feel your respect and concern. Moreover, you can insert useful information into the Thank You Page such as coupon, product slider, FAQ, and social sharing buttons that allow customers to share with their friends. This gives customers many interesting benefits during the payment process. It is a great way to bring satisfaction to grumpy customers. More interestingly, this is a way to promote your brand in the memory of the customer.

We also support the Newsletter Success page with similar features.

How to use

1. Display Thank You Page after customers complete the order

2. Display Thank You Page after customers click on subscribe

How to configure

From the Admin Panel, go to Marketing > Thank You Page > Configuration

1. Configuration

1.1 General Configuration

• Enable: Select Yes to enable the module
• AddThis API key
  • Enter the key of AddThis to refer to the friends via AddThis

1.2 Order Success Page

Enable: Select Yes to show Thank You Page after customer placed orders

1.3 Newsletter Success Page

• Enable: Select Yes to show Thank You page after customers click to subcribe
• Route
  • Add the route for Thank You Page
  • If you leave this field blank, the default route applied is: subscribe

2. Manage Templates

From the Admin Panel, go to Marketing > Thank You Page > Manage Rules

2.1 Order Success Page

2.1.1 General

• Name
  • Enter a name for the template
  • This is a required field
• Status: Select Enable to use the template
• Store Views
  • Select storeview to apply the template
  • You can choose multiple stores once
• Customer Group(s)
  • Only customers of the selected group can see the product that has been applied to the rule
  • You can select multiple groups at the same time
• Priority   - Enter the priority order for applying templates
  • The smaller the number, the greater the priority. If different templates have equal priority, the priority will be considered by ID

2.1.2 Condition

• Select the condition to apply the rule
• You can set the conditions for the Cart or Product section like: Subtotal greater than 50, Total Items Quantity less than 5 …

2.1.3 Display

• Select Style:

  • Choose the style for Thank You Page
  • The default style is Simple Style

• Custom Style:

  • Custom Style = Use Default Style:

  

  • Page Title:
    • Enter the title for Thank You Page
    • The default title is Thank you for your purchase
  • Page Sub-title:
    • Enter the sub-title for Thank You Page
    • The default Sub-title is Your order has been placed and will be processed as soon as possible.
  • Page Description:
    • Enter the information that needs to display on Thank You Page
    • The default information is *Your order number, Amount, Order Create at
    • You can use many availale variblies by clicking on Insert Variable link
    • Support HTML
  • Show Continue Shopping Button: Choose “Yes” to display Continue Shopping button
  • Enable Block(s):
    • Choose the block that displays on Thank You Page as Order Details, Social Sharing, Coupon, Register Account Form, Subscribe Email Form
    • Multiple blocks can be displayed at the same time.
  • Custom Style = Edit Default Style:

  

  • Load Template button: After clicking on this button, the code of the selected style in Select Style field will be loaded and displayed on Page HTML field and CSS of the selected style is also loaded and displayed on the Custom CSS field.
  • Page HTML:
    • Allow editing the code of the selected style
    • You can use the available variablies that we have supported by clicing on the Insert Variable link
  • Custom CSS: You can edit the color, font text, etc of the selected style
  • Static Block 1:
    • Choose Static Block that will display on the Thank You Page
    • Static Block 1 = No display: This means that there’re no any block to display on Thank You Page
  • Static Block 2:
    • Choose Static Block that will display on the Thank You Page
    • Static Block 2 = No display: This means that there’re no any block to display on Thank You Page

2.1.3.1 Coupon Block

• Select Rule:

  • Choose the rule (The rule is created at Marketing > Promotions > Cart Price Rules)
  • Only display the rules that have Coupon = Specific Coupon and use Use Auto Generation.

• Coupon Pattern:

  • Enter the pattern for the coupon
  • Coupon code after being created automatically will adhere to thí pattern
  • If you leave this field blank, the default pattern is [12AN]
  • How to create Pattern:

  [4A] - 4 alpha, [4N] - 4 numeric, [4AN] - 4 alphanumeric.

For example: GIFT-[4AN]-[3A]-[5N] => GIFT-J34T-OEC-54354

• Coupon Label:
  • Enter the label for created coupon codes
  • The default label is Use this coupon code: {{ coupon.code }} to get {{ coupon.discount_amount }} on your next order
  • You can use multiple available variables that are supported by clicking on the Insert Variable link
  • HTML is supported

2.1.3.2 Product Slider Block

• Enable : Choose Yes to display Product Slider Block on Thank You Page
• Title:
  • Enter a tilte for Product Slider Block
  • The default title is You may also like
• Limit the number of products
  • Enter the number of product to dispaly
  • The default number is 10
• Display Information
  • Select the information to display in the Product Slider Block. That can be Add To Cart button, Add To Compare button, Add To Wishlist button, Review information section,etc.
  • You can choose to display multiple information

2.1.3.3 Mageplaza FAQ block

Install Mageplaza FAQs Extension to activate these features.

• Enable: Choose “Yes” to display FAQ on Thank You Page
• Title:
  • Enter the title for FAQ
  • The default title is Frequently Asked Questions
• Select Category:
  • Choose Category to apply for displaying FAQ
  • For example: choose Select Category = Category 1 of FAQ, then FAQ will be displayed at Category 1.
• Limit:
  • Enter the number of FAQ that will display
  • The default number of display is 5

2.2 Newsletter Success Page

2.2.1 General

• Name
  • Enter a name for the template
  • This is a required field
• Status: Select Enable to use the template
• Store Views
  • Select storeview to apply the template
  • You can choose multiple stores once
• Customer Group(s)
  • Only customers of the selected group can see the product that has been applied to the rule
  • You can select multiple groups at the same time
• Priority   - Enter the priority order for applying templates
  • The smaller the number, the greater the priority. If different templates have equal priority, the priority will be considered by ID

2.2.2 Display

• Select Style: Select the style for the Thank You page after the customer has subscribed
• Page Title
  • Enter the title for Thank You Page
  • The default title is Thank you for signing up!
• Page Sub-title:
  • Enter the title for Thank You Page
  • The default title is Welcome you to our exclusive newsletters with every updates
• Page Description:
  • Enter the information that needs to display on Thank You Page
  • The default detailed description is: You would be the first to reach our latest arrivals, news, events, various special promotions, giveaways and more. Stay tuned and keep updated. All the best!
  • HTML is supported
• Enable Block(s):
  • Choose the block that displays on Thank You Page as OCoupon, Social Sharing
  • Multiple blocks can be displayed at the same time.
• Static Block:
  • Choose Static Block that will display on the Thank You Page
  • Static Block = No display: Not allow displaying any block oon Thank You Page
• Mageplaza Product Slider:
  • Choose the block of Product Slider extension displaying on Thank You Page
  • Mageplaza Product Slider = No display: There’re no any block to display on Thank You Page
• Custom CSS: You can edit the color, font text, etc of the selected style

2.2.2.1 Coupon Block

• Select Rule:

  • Choose the rule (The rule is created at Marketing > Promotions > Cart Price Rules)
  • Only display the rules that have Coupon = Specific Coupon and use Use Auto Generation.

• Coupon Pattern:

  • Enter the pattern for the coupon
  • Coupon code after being created automatically will adhere to thí pattern
  • If you leave this field blank, the default pattern is [12AN]
  • How to create Pattern:

  [4A] - 4 alpha, [4N] - 4 numeric, [4AN] - 4 alphanumeric.

For example: GIFT-[4AN]-[3A]-[5N] => GIFT-J34T-OEC-54354

• Coupon Label:
  • Enter the label for created coupon codes
  • The default label is Enter coupon code: {{ coupon.code }} when you make your next purchase enjoy {{ coupon.discount_amount }} off
  • You can use multiple available variables that are supported by clicking on the Insert Variable link
  • HTML is supported

2.2.2.2 Mageplaza FAQ

Install Mageplaza FAQs Extension to activate these features.

• Enable: Choose “Yes” to display FAQ on Thank You Page
• Title:
  • Enter the title for FAQ
  • The default title is Frequently Asked Questions
• Select Category:
  • Choose Category to apply for displaying FAQ
  • For example: choose Select Category = Category 1 of FAQ, then FAQ will be displayed at Category 1.
• Limit:
  • Enter the number of FAQ that will display
  • The default number of display is 5

3. The guide to install the library

Install via composer

• Run the following command to install the library:

composer require liquid/liquid
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

4. API

Mageplaza’s Thank You Page extension supports the use of the Rest API to get information about rules, create rules, delete rules, and the admin can also get information when Subcribe Newsletter Success and Order Success.

• Details can be viewed here.
• Instructions for creating Integration tokens here.

6. GraphQL

How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-thank-you-page-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

How to use

Mageplaza’s Membership GraphQL supports to get the rule’s template when making subscribe newsletter and order through GraphQL

To start working with Membership GraphQL in Magento, you need to:

• Use Magento 2.3.x. Return your site to developer mode
• Refer to the GraphQL requests we support here

Twitter Widget

Overview

Twitter is a popular social networking for people and stores who all need to advertise there. Therefore, Mageplaza builds a new module called Twitter Widget. It allows owners to easily insert Twitter Timeline widgets. This makes stores more accessible to customers, less expensive and highly efficient. Not only that, the owner can manage tweets on any page you want. Twitter Widget supports displaying your Instagram images on the home page, product page or on any CMS page. Besides, it supports displaying your Twitter images on the home page, product page or on any CMS page. You can also configure the maximum number of tweets displayed and display the Twitter Block Follow at header button.

Download and Install

• Download Mageplaza Twitter Widget
• Installation Guide

How to use

Customers can see the twitter image of the stores at any page that the admin wants

How to Configure

1. Configuration

From Admin panel, go to Stores > Configuration > Mageplaza > Twitter Widget

1.1 General Configuration

• Enable: Select Yes to enable the module.
• Show Follow Button: Select Yes to display the button Follow a twitter account in the header widget
• Username:
  • Enter the Username of twitter account
  • Need to fill in the correct username if you want to display Follow Button

1.2 Display

• Theme: Select the Theme to display Twitter Widget. There are 2 themes to choose from: Light and Dark.
• Link color: Set the display color for links, mention @ and hashtag # appear in the content of a tweet.
• Border color: Set the border color of Twitter Widget.
• Widget width:
  • Widget width settings.
  • Minimum width is 180, maximum is 1200.
  • If left blank, the width will be set automatically.
• Height widget:
  • Setting the maximum height of the widget.
  • Maximum height should be greater than 200.

1.3 Snippet Code

• XML File: Copy and paste the code into a file that includes .xml where you want to display the Twitter Widget outside the frontend
• CMS Page, CMS Static Block: Copy and paste the code to the page or block the page you want to display the Twitter Widget outside the frontend
• Template .Phtml file template: Copy and paste the code into the .phtml file where you want to display the Twitter Widget outside the frontend.

2. Widget configuration

How to add Widget?

• Step 1: Select the Type
• Step 2: Complete the Storefront Properties section
• Step 3: Configure Widget options to display images of Instagram pages

Step 1: Select the Type

• On the Panel Admin, go to Content> Elements> Widgets
• In the upper-right corner of Widgets workplace, click on Add Widget button.
• In the Section Settings:
  • Choose Mageplaza Twitter Widget in the Type field.
  • Choose the current theme you are applying in the Design Theme.
  • Click Continue button.

Step 2: Complete the Storefront Properties section

• In the Storefront Properties section,

  • Enter Widget Title for the internal reference.
  • Assign the block to all store views in the Assign to Store View field or to any store view you want to apply the block.
  • Set the Sort Order if many blocks are placed at the same container. The block is at the top if the inserted value is zero.

  

• In the Layout Updates section, click on Layout Update to set the layout.

  • Choose the category, product, or page where shows the block in the Display on field.
  • If set to a specific page, you need to choose Page you want to the block to display and set Container that is the position of the page the block appears.

Step 3: Configure Widget Options to display Twitter Widget

• Title: Enter a title for the Twitter Widget displayed outside the frontend

• Description: Enter a description for Twitter Widget displayed outside the frontend display

  • Display = Use Config: Using the Theme, Link Color, Border Color, Widgets configurations, Widget height at Configuration to display Twitter Widget at the frontend.
  • Display = Custom: Admin sets the Twitter Widget’s display configurations at the frontend (Theme, Link Color, Border Color, Widget width, Widget height).

  

• Type

  • Type = Timeline: Display the latest tweets of an account in the form of timeline.
  • Twitter timeline URL: The link to the account timeline (public) wants to display on the widget.
  • Chrome: Install elements displayed on the widget
    • Noheader: Do not display widget headers
    • Nofooter: No footer display of widget
    • Noborder: Do not display the widget’s border
    • Transparent: Remove background color, only display background color when hovering over a certain tweet on the timeline
    • Noscrollbar: Do not display scrollbar on widget
  • Number of Tweet Display: Limit the number of tweets displayed. Can choose a value of 1-20. If left blank, the timeline will display as Show more Tweets.

• Type = Tweet: Display a related tweets and tweets.
• Twitter timeline URL: The link to the tweet wants to display on the widget.
• Hide thread: Select Yes to hide the relevant reply tweet of the tweet selected above.
• Hide Media: Select Yes to hide all photos, videos or link preview related to the selected tweet and tweet related replies.

Westpac PayWay

Overview

Westpac is Australia’s most trusted payment processing provider. Mageplaza Westpac PayWay extension will help you use Westpac to support online payment by card. Your customers can pay with Visa and Mastercard by default and can pay with American Express, Diners Club and JCB after being activated by Westpac. Mageplaza Westpac PayWay extension is fully compatible with Mageplaza One Step Checkout.

How to use

1. Guides on Account registration

• Westpac: to register for a Westpac account, access this link and filling in the required information below:
  • Note: At PCI-DSS, please select My system meets PCI-DSS compliance for storing credit card numbers to be able to use Westpac PayWay Classic Credit Card API.

• After registration, the system will send login name and password to the email you registered:

• Open your registered mail and get your login name and password.

• After Sign in, the system will ask you to change the password

Finally, the system will ask you to answer 2 security questions to finish logging in.

2. How to get REST API Publishable Key, REST API Secret Key and Merchant ID

• At the Westpac interface, click REST API > REST API Keys.

• Click View to get the REST API Publishable Key and the REST API Secret Key to fill in Configuration (will be guided below)

• At the interface of Westpac, continue to click Administration> Merchants then get Merchant ID to fill in Configuration (will be instructed below)

3. How to get Biller Code, Security Username, Security Password, Encryption Key

• At the Westpac interface, click Setup Net > Hosted Payment Page, then select Bill Payments/Shopping Cart and Next

• You continue clicking Next and follow the system requirements, then the system will send information of Biller Code, Security Username, Security Password, Encryption Key

• Continue selecting Next to end the action.

4. How to get API Security Username and API Security Password

• At the interface of Westpac, click Setup API > Security, the system displays the security information including username and password.

• Continue clicking Setup API > Certificate, at Choose your API Technology select PHP and download the file to fill in the Configuration section.

5. Page Checkout

• Checkout page: choose payment method with Westpac PayWay. Enter credit card information including: Card Number, Security Code, Name on Card, Expiration. There are 3 payment methods of Westpac PayWay: PayWay Net Trust Frame, PayWay Net Hosted Page, PayWay Classic Credit Card API.
• PayWay Trust Frame

• PayWay Net Hosted Page

• PayWay Classic Credit Card API

• You can check the checkout process with the following Cards:

Use the following credit card numbers with your test facility. The cardholder name does not matter.

 

Card Number	Security Code	Expiry	Response
4564710000000004	847	02/29	08 Visa Credit Approved
4564030000000007	847	02/20	08 Visa Debit Approved
5163200000000008	070	08/20	08 Mastercard Credit Approved
5163610000000008	847	02/20	08 Mastercard Debit Approved
2221000000000009	009	01/20	08 Mastercard Approved

• To find out more, please visit here.

How to Configure

Login to the Magento Admin, choose Stores > Configuration > Sales > Payment Methods

At Westpac PayWay Payment Method, click Configure

1. Credentials

• Merchant ID:
  • Copy and paste Merchant ID got before to this field.
  • If left blank or fill in incorrectly ID, the system will not connect to the payment methods.
• REST API Publishable Key:
  • Copy the REST API Publishable Key got before to this field.
  • If left blank or entered incorrectly, it will not connect to PayWay Net Trusted Frame.
• REST API Secret Key:
  • Copy the REST API Secret Key got before to this field.
  • If left blank or entered incorrectly, it will not connect to PayWay Net Trusted Frame, PayWay Net Hosted Page, PayWay Classic Credit Card API.

2. Westpac PayWay Net Trusted Frame

• Enable: Select Yes to enable PayWay Net Trusted Frame payment features.
• Title: Enter the title of the method. The name of the payment method will be replaced displayed on the checkout page.
• Payment Action:
  • Authorize and Capture: Payment will be captured as soon as customer place orders successfully. At that moment, customer’s card will always pay for the order and invoice will be created.
  • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer’s card.
• New Order Status: Select status when customer order is successful:
  • Processing: Display status with Processing when the order is successful. Can change the status in the backend for each order.
  • Suspected Fraud: Display the status with Suspected Fraud when the order is successful. Can change the status in the backend for each order. With this status, admin can accept payment or decline payment and then change status to Processing.
• Card Types:
  • Choose 1 or more cards to be used with this payment method.
  • Cards will be verified when customer completes card number when checking out. For cards not selected in this section, there will be invalid notice shown for customers. For cards that are not selected, they will not appear in Checkout page.
• Show Logo: Click Choose File to download the image displayed for the payment method on the Checkout page.
• Payment from Applicable Countries:
  • Select All Allowed Countries so the card payment method can be applied in all countries.
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to be able to use this payment method
    • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
• Minimum Order Total:
  • Enter the minimum order amount to display and apply PayWay Net Trusted Frame payments.
  • If the order amount is less than the value in this field, payment methods will not be shown.
• Maximum Order Total:
  • Enter the maximum amount of order to display and apply PayWay Net Trusted Frame payments.
  • If the order amount is greater than the value in this field, the payment method will not be shown.
• Debug Mode:
  • If Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Specify the display position of this payment method compared to other payment methods
  • 0 is the highest priority. Smaller numbers will be preferred to show first.

3. Westpac PayWay Net Hosted Page

• Enable: Select Yes to enable PayWay Net Hosted Page.
• Biller Code: Copy the Biller Code got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
• Security Username: Copy Security Username got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
• Security Password: Copy Security Password got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
• Encryption Key: Copy the Encryption Key got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
• Title: Enter the title of the method. The name of the payment method will be replaced displayed on the checkout page.
• Payment Action:
  • Authorize and Capture: Payment will be captured as soon as customer place orders successfully. At that moment, customer’s card will always pay for the order and invoice will be created.
  • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer’s card.
• New Order Status: Select status when customer order is successful:
  • Processing: Display status with Processing when the order is successful. Can change the status in the backend for each order.
  • Suspected Fraud: Display the status with Suspected Fraud when the order is successful. Can change the status in the backend for each order. With this status, admin can accept payment or decline payment and then change status to Processing.
• Card Types:
  • Choose 1 or more cards to pay.
  • Cards will be verified when customer completes card number when checking out. For cards not selected in this section, there will be invalid notice shown for customers. For cards that are not selected, they will not appear in Checkout page.
• Show Logo: Click Choose File to download the image displayed for the payment method on the Checkout page.
• Payment from Applicable Countries:
  • Select All Allowed Countries so the card payment method can be applied in all countries.
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to be able to use this payment method
    • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
• Minimum Order Total:
  • Enter the minimum order amount to display and apply PayWay Net Hosted Page payments.
  • If the order amount is less than the value in this field, payment methods will not be shown.
• Maximum Order Total:
  • Enter the maximum amount of order to display and apply PayWay Net Hosted Page payments.
  • If the order amount is greater than the value in this field, the payment method will not be shown.
• Debug Mode:
  • If Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Specify the display position of this payment method compared to other payment methods
  • 0 is the highest priority. Smaller numbers will be preferred to show first.

4. Westpac PayWay Classic Credit Card API

• Enable: Select Yes to enable PayWay Classic Credit Card API.
• API Security Username: Copy API Security Username got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
• API Security Password: Copy API Security Password got before into this field. If left blank or filled in incorrectly will not be connected to these payment methods.
• Upload Certificate File: Allowed upload file types: .pem. Leaving this blank will not allow payment by this method.
• Title: Enter the title of the method. The name of the payment method will be replaced displayed on the checkout page.
• Payment Action:
  • Authorize and Capture: Payment will be captured as soon as customer place orders successfully. At that moment, customer’s card will always pay for the order and invoice will be created.
  • Authorize: Payment will only be captured when admin creates invoice for customer order. Once invoice is successfully created, the admin can receive money from customer’s card.
• New Order Status: Select status when customer order is successful:
  • Processing: Display status with Processing when the order is successful. Can change the status in the backend for each order.
  • Suspected Fraud: Display the status with Suspected Fraud when the order is successful. Can change the status in the backend for each order. With this status, admin can accept payment or decline payment and then change status to Processing.
• Card Types:
  • Choose 1 or more cards to pay.
  • Cards will be verified when customer completes card number when checking out. For cards not selected in this section, there will be invalid notice shown for customers. For cards that are not selected, they will not appear in Checkout page.
• Show Logo: Click Choose File to download the image displayed for the payment method on the Checkout page.
• Payment from Applicable Countries:
  • Select All Allowed Countries so the card payment method can be applied in all countries.
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to be able to use this payment method
    • Payment from Specific Countries: The selected countries will be displayed with the payment method by Card.
• Minimum Order Total:
  • Enter the minimum order amount to display and apply PayWay Classic Credit Card API payments.
  • If the order amount is less than the value in this field, payment methods will not be shown.
• Maximum Order Total:
  • Enter the maximum amount of order to display and apply PayWay Classic Credit Card API payments.
  • If the order amount is greater than the value in this field, the payment method will not be shown.
• Debug Mode:
  • If Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Specify the display position of this payment method compared to other payment methods
  • 0 is the highest priority. Smaller numbers will be preferred to show first.

5. Admin View Order

This section records Credit Card information (Westpac) that customers have ordered and paid.

6. Customer View Order

This section stores card information that customers have ordered.

7. Compatible with One Step Checkout

WePay

Overview

Mageplaza WePay extension will help you integrate this payment gateway with your store. WePay supports online payment via card and customers can save credit card information at the first payment to save time on subsequent payments. Customer can manage saved credit card information and delete card information at any time. In particular, the admin can order in the backend by WePay payment with customers who have saved the card before. May change the payment method, including 3 different display types.

Mageplaza WePay extension is fully compatible with Mageplaza One Step Checkout and Instant Purchase which will help customers to place orders quickly and conveniently.

How to use

Wepay

• To register for a WePay account, access this link and fill in the required information below, then click Sign Up:

Choose the best option describe you to use WePay and fill in the information below, then click Next:

• Next, fill out the application information in the form below, click Next:

• After clicking Next, the screen displays API Keys. For full support, you need to Tokenize credit cards by visiting the API Key page, please click Apply Now:

• Select the Payment Card Industry Data Security Standards to Access To Credit Card Tokenization API, then click Submit:

• Finally, here you can get the Account ID, Client ID, Client Secret, Access Token to fill in Configuration (will be guided below):

• Checkout Integration Method: displays 3 integration types with payment via WePay:

  • Magento Default:

  

  • Redirect Checkout:

  

  • Iframe Checkout:

  

• Displaying Payment Method in Create Backend Order:

• Stored Payment Methods: Here save credit card information that customers have paid before in there account. If you do not want to save the old or no longer used credit cards, customers can delete them.

• You can test the payment process with the following Cards:

4003830171874018: VISA Test CC number.

4111111111111111: VISA Test CC number.

5496198584584769: Mastercard Test CC number.

2223000048400011: Mastercard Test CC number.

2223520043560014: Mastercard Test CC number.

378282246310005: Amex Test CC number.

371449635398431: Amex Test CC number.

6011111111111117: Discover Test CC number.

6011000990139424: Discover Test CC number.

3530111333300000: JCB Test CC number.

3566002020360505: JCB Test CC number.

30569309025904: Diners Club Test CC number.

38520000023237: Diners Club Test CC number.

• To find out and have more information to check, please visit here.

How to Configure

Login to the Magento Admin, choose Stores > Configuration > Sales > Payment Methods:

At WePay Payment Method, click Configure:

1. Credentials

• Environment:
  • Admin can choose Sandbox environment to check the payment features of the methods.
  • When applying for online payment, the admin needs to switch the environment to Production.
• Account ID:
  • Copy Account ID got from WePay and paste here.
  • If left blank or entered incorrectly, the payment method will not be connected.
• Client ID:
  • Copy the Client ID got from WePay and paste here.
  • If left blank or entered incorrectly, the payment method will not be connected.
• Client Secret:
  • Copy Client Secret got from WePay and paste here.
  • If left blank or entered incorrectly, the payment method will not be connected.
• Access Token:
  • Copy the Access Token got from WePay and paste here.
  • If left blank or entered incorrectly, the payment method will not be connected.

2. General

Login to the Magento Admin, choose Stores > Configuration > Sales > Payment Methods > WePay Payment Method > Configure > General

• Enable: Select Yes to turn on WePay payment.

• Title: Enter the title of the method. The name of the payment method will be replaced displayed on the checkout page.

• Checkout Integration Method: Choose the display type of payment by WePay Cards:

• Magento Default: Displays the payment method of WePay Cards on the default checkout page of magento.

• Redirect Checkout: Redirect payment to the WePay payment page. Display the Enable Bank Payment field.

• Enable Bank Payment = Yes, Wepay will display 2 forms of payment:

  • Pay with Credit Card:

  

  • Pay with Bank Account:

  

After filling all information -> Click Next -> enter email -> Confirm to complete the payment:

Enable Bank Payment = No, only pay by Credit Card:

• Iframe Checkout: Displays the payment method of Wepay Cards on the inline checkout page. Display the Enable Bank Payment field.
• Enable Bank Payment = Yes, show automatic payment link:
• Enable Bank Payment = No:

After filling all information -> Click Next -> enter email -> Confirm to complete the payment:

• Payment Action: - Authorize and Capture: Payment will be captured immediately after the order is placed successfully. At that moment, the customer’s card will be applied for the order and the Invoice will be created.
  • Authorize: Payment will only be captured when admin creates an Invoice for customer’ s order. When the Invoice is successfully created, admin can receive money from customer’ s card.
• New Order Status: Select status when customer order succeeds:
  • Processing: Display status with Processing when order is successful. You can change the status in the backend with each order.
  • Suspected Fraud: Displays status with Suspected Fraud when order is successful. You can change the status in the backend with each order. With this status admin can accept payment or reject payment and then transfer status to Processing.
• Vault Enabled: Select Yes to display previously saved cards.
• Vault Title: Enter the title of the method. The name of the payment method will be replaced displayed on Order Information:

• Fee Payer: Select who is charged for service fee

• Merchant pays all fees: Merchants pay both processing and setting fees
• Customers pay all fees: Customers pay both processing and setting fees
• Merchant pays setting fee, Wepay is charged for service fee: Merchants pay setting fee, Wepay pays processing fee
• Customers pays setting fee, Wepay is charged for service fee: Customers pay setting fee, Wepay pays processing fee
• Formola to claculate processing fee: (Order Total + Setting fee) * 2.9% + 0.3
• Setting Fee Amount: Enter the setting fee amount that you want to apply.
• Payment from Applicable Countries:
  • Select the All Allowed Countries to apply Card payment methods in all countries
  • To restrict this payment with more conditions, see Payment Restrictions module.
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries will be allowed to apply the Card payment method.
• Minimum Order Total:
  • Enter the minimum amount of order which allow applying specific payment by Worldpay Cards.
  • If the order amount is smaller than the value in this field, the payment method will not be displayed.
• Maximum Order Total:
  • Enter the maximum amount of order which allow applying specific payment by Worldpay Cards.
  • If the order amount is greater than the value in this field, the payment method will not be displayed.
• Debug Mode:
  • If select Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order:
  • Choose the display position of this payment method compared to other payment methods
  • 0 is the largest number. The smaller the number, the more priority will be displayed in the first position.

3. Admin order

3.1. Create New Order

3.2. View Order

4. Order Frontend

This section stores card information that customers have ordered:

5. Compatible

5.1. Compatible with One Step Checkout

5.2. Compatible with Instant Purchase

In this part, customers can use Instant Purchase to make orders conveniently and quickly.

After clicking Instant Purchase displays the popup, click OK to confirm the order:

6. Refund Order

Here admin can Refund Online/Offline all orders or each order.

7. WePay Extra Fee

When paying through WePay, customer will have to pay an Extra Fee and this WePay Extra Fee information is displayed in the view order page when customer order is completed.

Who Bought This Also Bought

Overview

Who Bought This Item Also Bought is a new extension developed by Mageplaza. By having this extension enabled, our team will help you provide your online store’s customers suggestions of the products related to the ones which they shoppers are viewing. This module is supposed to encourage buyers to keep purchasing other products in your online store. Hence, this satisfies your customers as well as boost your sales effectively

Download & Install

You can download from the following resouces:

• Mageplaza Who Bought This Item Also Bought
• Magento Marketplace
• How to Install

How to Configure

1. Configuration

Login to Magento Admin, go to Stores > Settings > Configuration > Mageplaza Extension > Who Bought This Item Also Bought

1.1. General Configuration

Go to Stores > Settings > Configuration > Mageplaza Extension > Who Bought This Item Also Bought, choose General Configuration

• In Enable field: Select “Yes” to enable Mageplaza Who Bought This Item Also Bought Extension, select “No” to disable the extension

• In Calculate Related Product Base On field:
  • Calculate Related Product Base On = Order: Related products displayed in the Who Bought block This Item Also Bought are the products purchased together by order.
  • Calculate Related Product Base On = Customer: Related products displayed in the Who Bought block This Item Also Bought are the products purchased by the same customer.

• In Process Order With Status field: Pick the order status which the module uses to suggest the products displayed in the block. You can select multiple order status at the same time.
• Suggest for free Items: Select Yes to allow free products to be displayed in the Who Bought This Item Also Bought block if they are reindexed to the Also Bought list in the Log section.

1.2. Display on Product Page

Go to Admin Panel > Who Bought This Item Also Bought > Configuration, select Display on Product Page.

When a product is chosen, the item will be used to relate to other orders with the same status selected in Process Order with Status. The products appearing in those orders will be displayed in the Product Page.

• In Enable field: Select “Yes” to enable and No to disable module in the Product Page.
• In Title of block field
  • Enter the name of suggested-products block displayed in the Product Page
  • The Block will be named Who Bought This Item Also Bought by default.
  • If you leave it empty, the block will be nameless.

• In Position field: Choose the position at where you put the block in the Product page. There are two options:
  • Main Content Top: The Block of the extension is displayed above the main content
  • Main Content Bottom: The Block of the extension is displayed at the bottom of the main content
  • Before Native Related Products Block: The Block of extension is displayed before Related Products Block
  • After Native Related Products Block: The Block of extension is displayed after Related Products Block
  • Before Up-sells Products Block: The Block of extension is displayed before Up-sells Products Block
  • After Up-sells Products Block: The Block of extension is displayed after Up-sells Products Block
  • Before Information Tab: The Block of extension is displayed before the Information Tab
  • Manually: Admin can adjust the location of Who Bought This Item Also Bought by using widgets

• In Layout:
  • Product Slider: Suggested products will be displayed in one line only, and all items will slip to the left in a period of time.
  • Multiple Lines: Suggested products will be displayed in a grid, with 5 items per line.
• In Show List: Allow multiple selections
  • Price: Allows displaying price under a product image
  • Add to Cart: Allows customers to add an item to their carts without showing the details
  • Review: Allows showing the product’s rating and leading customers to the Review section of the product when the Review button is clicked.
  • Add to Wish List & Add to Compare: Displays the Add to Wish List and Add to Compare buttons. When these buttons are clicked, the item will show up in the Wish List and Comparison List

• Number of products displayed:
  • This is the field to limit the number of products displayed on the product page at frontend
  • If you leave this blank, all qualified products will be shown in Frontend

1.3. Display on Category Page

Go to Admin Panel > Who Bought This Item Also Bought > Configuration, expand Display on Catalog Page section.

When a category is chosen, all the products in the current category will be used to relate to other orders with the same status selected in Process Order with Status. The products appearing in those orders will be displayed in the Category Page.

• In Enable field: Select “Yes” to enable and No to disable module in the Category Page.
• In Title of Block field
  • Enter the name of suggested-products block displayed in the Product Page
  • The Block will be named Who Bought This Item Also Bought by default.
  • If you leave it empty, the block will be nameless

• In Position field:
  • Main Content Top: The Block of the extension is displayed above the Main Content
  • Main Content Bottom: The Block of the extension is displayed under Main Content
  • Sidebar Main Top: The extension’s Block is displayed at the top of the sidebar
  • Sidebar Main Bottom: The Extension block is displayed on the side of the sidebar

• In Layout: Choose the layout of suggested items in the Category Page
  • Product Slider: Suggested products will be displayed in one line only, and all items will slip to the left in a period of time.
  • Multiple Lines: Suggested products will be displayed in a grid, with 5 items per line.
• In Show List: Allow multiple selections
  • Price: Allows displaying price under a product image
  • Add to Cart: Allows customers to add an item to their carts without showing the details
  • Review: Allows showing the product’s rating and leading customers to the Review section of the product when the Review button is clicked.
  • Add to Wish List & Add to Compare: Displays the Add to Wish List and Add to Compare buttons. When these buttons are clicked, the item will show up in the Wish List and Comparison List

• Number of products displayed:
  • This is the field to limit the number of products displayed on the Catalog page at frontend
  • If you leave this blank, all qualified products will be shown in Frontend

1.4. Display on Cart Page

Go to Admin Panel > Who Bought This Item Also Bought > Configuration, select Display on Cart Page section.

After adding to cart, customers go to View and Edit Cart. In this page, all the products in their cart will be used to relate to other orders with the same status selected in Process Order with Status. The products appearing in those orders will be displayed in the Cart Page.

• In Enable field: Select “Yes” to enable and No to disable module in the Cart Page.
• In Title of Block field:
  • Enter the name of suggested-products block displayed in the Cart Page.
  • The Block will be named Who Bought This Item Also Bought by default.
  • If you leave it empty, the block will be nameless

• In Position field:
  • Main Content Top: The Block of the Extension is displayed above the Main Content
  • Main Content Bottom: The Block of the Extension is displayed under Main Content
  • Before Cross-sells Product Block: The block of the extension is displayed before Cross-sells Product Block
  • After Cross-sells Product Block: The block of the extension is displayed after Cross-sells Product Block

• In Layout field: Choose the layout of suggested items in the Cart Page
  • Product Slider: Suggested products will be displayed in one line only, and all items will slip to the left in a certain period of time
  • Multiple Lines: Suggested products will be displayed in a grid, with 5 items per line.
• In Show List field: Allow multiple selections
  • Price: Allows displaying price under a product image
  • Add to Cart: Allows customers to add an item to their carts without showing the details
  • Review: Allows showing the product’s rating and leading customers to the Review section of the product when the Review button is clicked.
  • Add to Wish List & Add to Compare: Displays the Add to Wish List and Add to Compare buttons. When these buttons are clicked, the item will show up in the Wish List and Comparison List

• Number of products displayed:
  • This is the field to limit the number of products displayed on the Shopping Cart page at frontend
  • If you leave this blank, all qualified products will be shown in Frontend

2. Logs

Login to Magento Admin, select Store > Who Bought This Also Bought > Logs

At the Grid Also Bought Logs shown the information: Main Product, Main Product Qty, Also Bought, Associate Product Qty, Total Combo

Action: Update on Save & Update on Schedule

Go to Magento Admin > System > Tools > Index Management

• Update on Save: tick the Who Bought This Item Also Bought checkbox > Action = Update on Save
  • Also Bought Logs data is updated when Save
  • To update all data of Also Bought you can use the command line: php bin/magento alsobought:reindex-all
• Update by Schedule: Tick the Who Bought This Item Also Bought checkbox > Action = Update by Schedule
  • Also Bought Logs data is updated by schedule
  • To update all data of Also Bought you can use the command line: php bin/magento alsobought:reindex-all

3. Widget

• Step 1: Select the Type
• Step 2: Complete the Storefront Properties section
• Step 3: Configure Widget Options to display Who bought this item also bought block

Step 1: Select the Type

• On the Panel Admin, Content > Elements > Widgets
• In the upper-right corner of Widgets workplace, click on Add Widget button.
• In the Settings section:
  • Choose Mageplaza Also Bought type in the Type box.
  • Choose the current theme you are applying in the Design Theme.
  • Click Continue button.

Step 2: Complete the Storefront Properties section

• In the Storefront Properties section,
  • Enter Widget Title for the internal reference.
  • Assign the block to all store views in the Assign to Store View field or to any store view you want to apply the block.
  • Set the Sort Order if many blocks are placed at the same container. The block is at the top if the inserted value is zero.

• In the Layout Updates section, click on Layout Update to set the layout.
  • Choose the category, product, or page where shows the block in the Display on field.
  • If set to a specific page, you need to choose Page you want to the block to display and set Container that is the position of the page the block appears.

Step 3: Configure Widget Options to display Who bought this item also bought block

• Title of block: Enter the name of the block
• Layout: Select the product display type in the block. There are 2 types of display: Product Slider and Multiple Lines
• Show List: you can select multiple options
  • Price: allows to display the price of the Product
  • Add to Cart: allows the customer to select the Product into Cart without viewing Product details
  • Review: displays the Product Rating and allows the customer to move to the Product Review section when clicking Review
  • Add to Wish List & Add to Compare: displays the icons of Add to Wish List and Add to Compare. When clicking on the icon, allowing customer to add products to WishList (need to log in) and add Products to comparison list to compare

4. API

Who Bought Also Bought extension of Mageplaza supports using REST API to get a list of also bought products

• More details see here
• Instructions for creating tokens here

5.GraphQL

5.1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-who-bought-this-item-also-bought-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

5.2. How to use

• To perform GraphQL queries in Magento, you need to do the following requirements:
  • Use Magento 2.3.x. Return your site to developer mode
  • Install the ChromeiQL extension for Chrome browser (currently does not support other browsers)
  • Set GraphQL endpoint as http://<magento2-3-server>/graphql in url box, click Set endpoint. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
  • Perform a query in the left cell then click the Run button or Ctrl + Enter to see the result in the right cell
  • To see the supported queries for Who bought this item also bought GraphQL of Mageplaza, you can look in Docs > Query > mpalsobought in the right corner

• View Mageplaza supported GraphQl request here

Who Viewed This Also Viewed

Overview

Customers are more likely to make purchasing decisions when they see a product that other customers have seen. Mageplaza Who Viewed This Also Viewed extension provides an excellent solution for the owner to allow the most relevant product to be displayed on the Product Detail Page. By smart algorithms, the most viewed products will be automatically updated and proposed to customers. Thereby bring an amazing shopping experience for customers, while increasing revenue for store owners.

How to download and install

• Download Mageplaza Who Viewed This Also Viewed
• How to Install

How to use

• Products applied to this module is set by admin based on both Product Types and Categories that they belong to.

• This extension supports the recommendation of the most viewed products at the Product Detail page
  • At varous positions:
    • Top of Content
    • Bottom of Content
    • Replace Related Products
    • Before Related Products
    • After Related Products
    • Replace Up-sale Products
    • Before Up-sale Products
    • After Up-sale Products
  • Select way to display the block:
    • Grid
    • Slider
  • Based on many criteria:
    • With higher price
    • In stock
    • In the same category
  • Sort by:
    • Name
    • Price
    • Relevant
    • Stock Qty
  • Add the extra information:
    • Add to Cart button
    • Add to Wish list button
    • Add to Compare button
    • Review Information

How to Configure

1. Configuration

From the Admin panel, go to Stores> Configuration> Mageplaza> Who viewed this also viewed

• Select Enable = Yes to enable the module
• Block Title:
  • Name the Block which will be displayed in Frontend
  • If left blank, the default title is Who viewed this item also viewed
• Apply for: Select Product Detail Page which can show the Who viewed this also viewed block. The block can only be displayed on the Product Detail pages of the products that meet both the Product Type and Category selected by the Admin
  • Admin can choose multiple options at Product Types and Categories
• How to show: there are 2 ways to display blocks including:
  • AJAX Display: Who viewed this also viewed block is loaded after the page has finished loading and will need a period to display in Frontend. This option will be good for the page loading speed
  • Block Display: Who viewed this also viewed block will be loaded when loading the page and displayed as soon as the page is finished loading. This option helps improve SEO for the page
• Display Position: Choose the position to display the block

• Top of Content: Block is displayed above the Content of Product Page
• Bottom of Content: Block is shown below the Content of Product Page
• Replace Related Products: Block replaces the default Related Product Block of Magento
• Before Related Products: Block is displayed above the default Related Product Block of Magento
• After Related Products: Block is shown below the default Related Product Block of Magento
• Replace Up-sell products: Block replaces the default Upsell Products Block of Magento
• Before Up-sell Products: Block is displayed above the default Upsell Product Block of Magento
• After Up-sell Products: Block is displayed below the default Upsell Product Block of Magento
• Display Type: You can select Slider mode or Grid mode
  • Slider: Products are displayed on 1 line, customers can click the arrow or hold and move the cursor to view all products in the block quickly.
  • Grid: Products are displayed into multiple lines (if there are multiple products)
• Limit Number of Products:
  • Limit the number of Product displayed in the block
  • If left blank or = 0, the maximum number of Product shown is 10
• Show Products only with: Choose the condition for Most-viewed Products to be displayed in Block
  • With higher price: Most-viewed Products have a price higher than the price of the product that the customers are watching
  • In stock: Most-viewed products must be available in stock
  • In the same category: Most-viewed products must have the same category as the Products that the customers are viewing
  • Admin can select multiple criteria at once
• Sort by: Choose the way to organize the products displayed in the block
  • Name: sorted by Alphabet
  • Price: sorted by price from high to low
  • Relevant: Arrange products according to the frequency viewed together. The more frequency these products are viewd together, the priority they will be displayed first.
  • Stock Qty: show products with higher quantity in stock
• Check data in the last (days):
  • Set the amount of time that data is retrieved. Only products viewed during this period can be compared and displayed in the block (if they meet the conditions above).
  • The period is calculated in days
  • If left blank, default period = 30 days
• Display additional information: Allow admin to select the extra information on Product image in Block
  • Add to Cart button
  • Add to Wishlist button
  • Add to Compare button
  • Review Information

Webhook

Overview

Webhook is the configuration that allows sending the API request to another server with entities based on the event of Magento when some events occur. Thanks to Mageplaza Webhook extension, it will auto-activate an error email notification during the sending of the Hook to the customers when your store has some events as New Order, New Order Comment, New Invoice, New Customer, New Product, Subcribe, etc. Especially, the module allows sending data automatically by Every Minute, Daily, Weekly, Monthly. All will be done quickly and conveniently with the help of this great module. Let’s follow us to explore this plugin!

Download & Install

• How to Install
• Avialable On Github

Note: You can see the guide to integrate Webhook with various third party extensions and apps here.

How to configure

I. Configuration

Login to the Magento Admin, choose Store > Settings > Configuration > Mageplaza Extensions > Webhook.

1. General

• Enable: Choose “Yes” to enable this module or “No” to disable it.
• Abandoned Cart After: Set the hours for Abandoned CArt. We recommend the period time as 1, 6, 10, 12, 24.
• Keep Logs: Enter the number of keep logs. It will auto-delete the logs if it reaches to the selected number and keeps the number of selected logs. It will make the logs clear everyday.
• Alert on Error: Choose “Yes” to send the notification when sending an email. To avoid sending the email to the spambox, you should install SMTP extension

2. Schedule For Cron

• Schedule For Cron: Select the time to synchronizely send data:
  • Disable: will send the data right after the event occurs. For example: Create Hook with New order, after each new order, the data will be synchronized to the app. You can see the list that has been submitted at Logs.
  • Every Minute: data will be synchronized every minute.
  • Daily: data is synchronized every day.
  • Weekly: data will be synchronized on Monday every week
  • Monthly: data will be synchronized every month on the first day of each month.
• Start Time: Only show this field when selecting Daily/ Weekly/ Monthly. Choose the time to synchronize data. For example: Schedule For Cron is Daily, Start Time is 2:30:00, every day at 2:30:00 data will be synchronized
• Note: If the logs report Error on the time priod synchronized, the system will send email notification to admin.

II. Manage Hook

1. Grid

From the Admin Panel, go to System > Webhook > Manage Hooks.

• This section records created Webhooks with basic information as Name, Status, Store View, Entity, Created Date and Update date, etc
• Admins can perform some actions:
  • Delete: Choose Webhooks that you want to delete
  • Change Status: Tick to choose the Webhook that you want to change the status, choose “Enable” to use Webhook
  • Edit: Click “Edit” to edit the contend of Webhook.
• Also, admins can filter, change the Store View, hide/show columns on Grid.
• For Add New button, you can choose Trigger type to Create New Hook and activate the data to the server. Especially, Event Subscribe is also supported.

2. Create a Hook

How to Create New Hook

From the Admin Panel, go to System > Webhook > Manage Hooks, choose Add New button in the right corner with some options as New Order, New Product, Update Product, Delete Product, etc

2.1. General

• Name: Enter the name of the Hook. This name will display when sending the email to customers
• Status: Choose “Enable” to use Hook
• Store View: Choose Store View that Hook is displayed. With unselected Store View, Hook will not appear.
• Priority:
  • Enter the priority for Hook
  • The smaller the Hook priority, the higher its priority. O is the highest priority.

2.2. Actions

• Payload URL:
  • Choose Insert Variable button to choose the variable. You can insert a variable. For example: Method POST: https://domain.freshsales.io/api/leads, GET: https://domain.freshsales.io/leads/view/4000831345, etc or https://domain.freshsales.io/leads/view/4000831345 new shipment = {insert variable} with the domain is your API account name.
  • To signup API account, please access the link here and you also look at the API here
  • This is a field that is not allowed to be empty. If you leave it blank, it will show “This is a required field”.
• Method: Choose the method to send a selected HTTP request. This field can leave it blank and Payload URL will be the default according to Method GET.
  • GET: Get the data from the server
  • POST: Create a new object
  • PUT: Update an object
  • DELETE: Delete an object
  • HEAD: The same as GET, but it doesn’t require about Body section
  • CONNECT: Converts the requested connection into a transparent TCP/IP tunnel, usually to facilitate SSL encryption (HTTPS) communication through an unencrypted HTTP proxy.
  • OPTIONS: Describe the options. An OPTIONS request should return data describing other methods and operations on the server that supports at certain URLs.
  • TRACE: Repeats the request so that the customers can see any changes or additions (if so) that have been made by the intermediate server.
  • PATCH: Apply a modified part to an object.
• Authentication: Select the type of data access authentication you want from the server. When you send a request, you typically have to include parameters to make sure the request has access and returns the data you want. You should leave this field blank to avoid the access

• Basic: Display 2 fields as Username and Password. Enter the information to verify the access
• Note: In the process of being strictly enforced throughout the entire data cycle to SSL for security, authentication is transmitted over unsafe lines.
• Digest: Enter some verification information as the following image:

• Headers: Click Add button to add the values of headers such as Name and Value as required by the server to be able to call that API. For example: Name: Authorization, Value is Token token = "Your API Key"
• Content-type: Select the content type to send the information. For Method as GET, you can leave this field blank.

• Body: With the Method as POST or PUT, etc, you need to add the content into Content field to send a request. Click Insert Variable to choose the variable.

3. Logs

Here saved the change logs of the synchronization process of each Hook.

III. Logs

From the Admin Panel, go to Mageplaza > Webhook > Logs This section will record all the Webhooks change logs as Name, Status, Entity, Message, etc. When you click on any file, it will auto-open that file.

View Log

Click View, it will redirect the email receiver to the Logs page in order to view the detailed logs.

Guide to install the library

Please run the below command to install module library:

composer require liquid/liquid

Zoho CRM

Overview

Zoho CRM or Customer Relationship Management software is a cloud-based CRM service that helps you store and segment your customer data into different groups throughout the customer’s journey. Mageplaza Zoho CRM extension will help you integrate seamlessly with Zoho CRM to connect and synchronize single or bulk data from Magento including Customer, Product, Order, Invoice, Catalog Rules to Zoho CRM with Accounts, Contacts, Leads, Sales, Purchase Orders, Invoices, Products, Campaigns. That will help create a smooth flow to maintain customer relationships and organize your business well. Also, data to Zoho CRM can be sent manually or automatically synchronized whenever there is any update.

How to download and install

• Download Mageplaza Zoho CRM
• How to Install

How to use

Zoho CRM:

• To register a Zoho CRM account, visit the this link.

• After registering an account, visit this link to get your Zoho API login information when clicking Add Client ID. There provided with Client Id information, Client Secret you need to be able to connect with Zoho CRM.
• Fill in the information below to Create Zoho Client ID.

• With Authorized Redirect URIs of Zoho CRM, you need to get the available value at Authorized Redirect URIs field from Mageplaza Zoho CRM extension.

• After click Create button, you get the Zoho API, including Client Id, Client Secret, you need to save this information so you can connect to Zoho CRM.

How to Configure

1. Configuration

Login to the Magento Admin, choose Stores > Settings > Configuration > Zoho CRM.

1.1. General Configuration

• Enabled: Select Yes to activate the module and use the feature to support data synchronization from the Magento Objects to Zoho CRM.
• Client Id:
  • Enter the obtained ID in Zoho CRM into the Client Id field to connect to Magento.
  • If left blank or incorrectly entered Id, it will not synchronize data with Zoho CRM.
• Client Secret:
  • Enter the Client Secret obtained in Zoho CRM.
  • If left blank or filled incorrectly in the Client Secret, it will not synchronize data with Zoho CRM.
• Authorized Redirect URIs:
  • Copy value in this field and paste to the similar field in Zoho CRM Authorized Redirect URIs
  • Admin can get Access Token to check the connection with Zoho CRM by clicking Get Access Token button and Accept. After that, you will see a successful notification. You should close the current tab then return to Zoho CRM to configure the module

1.2. Queue Schedule

• Delete Queue Log After:
  • Enter the number of days into Delete Queue Log After. In which, for the queues synchronized having success will be auto-deleted after the time configured here. For example: You enter 6 days in this field, meaning that those queues with success status will be deleted after 6 days.
  • If empty, Log will no longer be deleted.
• Schedule: Select the time to send data to Zoho Module automatically. Any Magento objects changes will be sent to Zoho Module; otherwise, the unchanged data will not be sent to Zoho Module anymore.
• Number Of Objects Send Per Time:
  • Enter the number of objects limit each time sending data to Zoho Module. Any pre-added queues will be prioritized to be sent to the Zoho Module first. The value is allowed to range from 1 to 1000.
  • If you leave it blank or zero, the schedule is not run.

1.3 Developer

• Developer Mode: Choose the environment for data synchronizing. There are two options:
  • Sandbox: Only allow admins to synchronize data manually
  • Production: Allow admins to synchronize data manually and automatically

2. Manage Sync Rules

Login to the Magento Admin, choose Stores > Zoho CRM > Synchronization Rules.

2.1. Grid

• Here, the Sync Rules information includes the Name, Magento Object, Zoho Module, Website, Pending Queue fields, etc.
• Click Add new button to create a new rule. After creating rules, you can choose Edit to edit rules. Also admin can delete rules, change status (Enable / Disable), filter, and so on.
• Select Add Data to Queue if you want to add more data to Queue. Or with Mass Actions, admin can synchronize one or more rules at the same time when clicking Add To Queue.

Note: When installing Mageplaza Zoho CRM and creating the Synchronization Rules, click Add Data to Queue to put the previous data into Queue and synchronize data to Zoho CRM.

Mageplaza’s Zoho CRM extension is fully compatible with the Report extension, which provide reports on queue synchronized quickly and conveniently at three columns: Total Object, Total Pending, Total Request (include success and error statuses).

2.2. Create Sync Rule

• Magento Object: Select Magento Object to allow sending that Magento object data to Zoho CRM.
• Zoho Module: Here will display the Zoho Module corresponding to the selected Magento Object. For example: Magento Object is Customer, so the information corresponds from Zoho Module selectable are Account, Lead, Contact.
• Website: Select Website from which to get Magento Object data sending to Zoho Module.

After selecting the object, click Next to start filling at Form create/ edit Sync Rule

2.2.1. General

• Name:
  • Enter the name of Sync rules
  • This is a required field
• Status: Select Active to enable the rules to work and synchronize data to Zoho Module.
• Data of Magento Object, Zoho Module, Website are taken according to the object data above before creating sync rules and can only be changed when admin changes object information before creating.

2.2.2. Conditions

• Select the conditions to filter the data that the admin wants to sync to Zoho CRM. Those data that meet the conditions of each rule will be put into Manage Queue to synchronize data and vice versa.
• Note: Each rule will have different options and conditions.

2.2.3. Mapping Fields

Here select the corresponding Magento Fields to send data to Zoho CRM.

• Zoho Fields: Displays the fields managed by Zoho corresponding to the selected Magento Objects. Zoho Fields change depending on the change on selected Magento Object such as Customer, Product, etc.
• Magento Fields:
  • Enter the fields of the corresponding Magento object to upload data with the fields of Zoho Module.
  • Leaving this column blank will get the Default Value column to apply to Zoho Module.
• Internal Note: Enter an internal note for any note of this rule. This is for admin use only, not for data synchronization.
• Insert Variables: Select the fields of the Magento object corresponding to the fields of Zoho Module.

2.2.4. Queue Report

Here records Queue data by rules which include information of Object, Created On, Status, Updated On. etc. Also, there are reports of Pending Request, Total Object, Total Request (Queue number created).

Note: With Created On is the time that data are imported to Queue. Updated On is the time when the queue is synchronized to Zoho CRM.

3. Manage Queue

• This section records the information of Queue including Object, Sync Rule, Magento Object, Zoho Module, and so on.
• Here admin can synchronize all data or select specific data to add to queue and synchronize to Zoho CRM. All data changes such as create, update, delete are included in Queue.
• When you click on View, it will display Popup View Queue to see all information of each Queue. Select Delete to delete Queue and Resend to resend Queue.

4. Customer, Product, Order, Invoice, Catalog Rules

4.1. Grid

Here admin can synchronize multiple data or individual data by event: product, order, invoice, catalog rules, customers (Account, Lead, Contact). These data will be sent to Manage Queue to be synchronized. This feature will help admin synchronize selected data by each product, customer, etc., more quickly and conveniently.

4.2. Edit

With the available data before, admin can Add To Zoho Queue with As Account, As Lead, As Contact, Product, Order, Invoice, Catalog Rules to send data into Manage Queue and synchronize them.

• System will show a Zoho CRM tab when editing into customer account data, product, order, so on; which helps report and display a list of queues with each of that data information, including Status, Zoho Module, Event, Created On, Updated On, etc.
• Admin can filter, search those data from the available columns.

2Checkout

Overview

Mageplaza 2Checkout extension helps you integrate this payment method with your store to handle payments safely without users leaving the page. Customers can pay directly at checkout page (Magento Default/ Iframe Checkout) or redirect to 2Checkout page (Redirect Checkout). In addition, this extension allows customers to refund online. Admin can have access to a complete set of administrative tools to keep track of your transactions, customer tracking, refunds and fraud monitoring.

Your customers can use all credit cards such as Visa, Mastercard, American Express, JCB, etc. Admin can configure currencies and countries applicable to this payment method at each storeview. Moreover, information about transactions and detailed comments for each action (invoice, refund) with order payment via 2Checkout also be recorded at the View Order in the backend.

Mageplaza 2Checkout extension is fully compatible with Mageplaza One Step Checkout.

How to download and install

• Download Mageplaza 2Checkout
• How to Install

How to use

1. Sandbox:

This is the environment that helps you track transactions using the 2Checkout payment method and check the payment features with 2Checkout.

• To register for a Sandbox account, visit the following link.

• After registering the Sandbox account, please access Account> Site Management to fill in the information relating your Site Management. You need to enter Approved URL of your site here. Secret Word is the secret code that Sandbox provides for your account. You will use it to configure in the Credentials section which will be guided later.

• You must access the API section to get Publishable Key and Private Key and use it to configure in the Credentials section of this extension.

• In addition, you must access the Account symbol to get Account Number and configure at the Credentials section of this extension.

When you want to track transactions using the 2Checkout and check the payment features with 2Checkout on your website, visit the Sales section and check.

Test Cards

 

Card type	Card number
VISA	4111111111111111
MasterCard	5555555555554444
AMEX	378282246310005
Discover	6011111111111117
JCB	3566111111111113

Use the test payment information above, in conjunction with:

• Any billing currency
• Any card expiration date
• Any CVV code

2. Production

This environment is suitable when you want to apply for online payments with 2Checkout. To register an account at Production, you can visit here.

How to Configure

Login to the Magento Admin, choose Sales > Payment Method > 2Checkout.

1. Credential

Login to the Magento Admin, choose Sales > Payment Method > 2Checkout > Configure > Credentials Tab

• Environment:
  • Admin can choose Sandbox environment to check payment feature with 2Checkout. Access here to create an account and get the necessary information. Review the instructions in How to use> 1. Sandbox
  • When you want to apply for online payment, please change the environment to Production. Access here to create an account and get the necessary information.
• Merchant ID:
  • Enter your Account Number or Seller ID.
  • If left blank or incorrectly entered, it will not integrate with 2Checkout.
• Publishable Key:
  • Enter Publishable Key got from 2Checkout.
  • If left blank or entered incorrectly, 2Checkout will not be connected.
• Private Key:
  • Enter the Private Key got from 2Checkout.
  • If left blank or entered incorrectly, 2Checkout will not be connected.
• API Username: Enter your API Username at 2Checkout. Refer instruction to create a Username API for 2Checkout here.
• API Password: Enter your API Password at 2Checkout
• Test Credential button: Admin can check the connection with 2Checkout by clicking the Test Credential button.
• Approved URL: Enter Approved URL of your store. This field appears only when you select Environment = Sandbox.

2. General Configuration

Login to the Magento Admin, choose Sales > Payment Method > 2Checkout > Configure > General Tab

• Enable: Select Yes to turn on the module and use the 2Checkout features.
• Title: Set the title for this payment method at storeview.
• Payment Action: Use Payment Action here as Authorize and Capture. Payment will be captured immediately after the customer place order successfully. At that moment, the customer’ s card will pay for the order and the invoice will be created.
• New Order Status: Select status when customer orders successfully:
  • Processing: Display status with Processing when order is successful. You can change the status in the backend with each order.
  • Suspected Fraud: Displays status with Suspected Fraud when order is successful. You can change the status in the backend with each order. With this status admin can accept payment or reject payment and then transfer status to Processing.
• Transfer Cart Items To Payment Gateway: Select “Yes” to transfer the item list from the order to the payment gateway. In contrast, select “No”.

• Accepted Currencies: Admin can choose which currencies on the website are allowed to use this payment method

• Display Checkout: Select the type of checkout display for this payment method. There are 3 types of display:

  • Display Checkout = Magento Default: Displays the payment method of 2Checkout at Magento’s default checkout page. When choosing this type of payment display, admin can select Card Types to apply with 2Checkout payment method.
    • Card Types:
      • Choose 1 or more cards for payment
      • Cards will be authenticated when customer completes the card number when checking out. For cards not selected in this section, there will be an invalid message for the customer. With the card not selected it will not be displayed on the Checkout page and when ordering the backend.

  

• With this type of payment display, customers can make 2Checkout payment right at the checkout page of the store.

• Display Checkout = Redirect Checkout: When selecting this payment display type, after clicking the Place Order customer will be redirected to 2Checkout’s payment page as below:

• Display Checkout = Iframe Checkout: When selecting this payment display type, after the customer clicks Place Order, there will be an Iframe that appears right on your website so that the customer can make 2Checkout payment as below:

• Payment from Applicable Countries:
  • Select All Countries to have Card payment method available in all countries
  • Select Specific Countries to limit certain countries to use this payment method
    • Payment from Specific Countries: The selected countries will be shown the Card payment method
• Minimum Order Total: Enter the minimum value of the total order to be able to use this payment method. You can leave this field blank.
• Maximum Order Total: Enter the maximum value of the total order to be able to use this payment method. You can leave this field blank.
• Debug Mode: If Yes, diagnostic information is stored in log files on the Magento web server.
• Sort Order: - Specifies the display position of 2Checkout compared to other payment methods
  • 0 is the highest priority. The smaller the number, the more priority will be displayed in the first position.

View Order

1. Frontend View Order

This section saves the 2Checkout Payment Method information that the customer used to pay for the order.

2. Backend View Order

This section saves the 2Checkout Payment Method information that the customer used to pay for the order. Here, admin can click 2Checkout Order ID access Sandbox to manage details about this order on Sandbox.

3. Comment History & Transactions

This section displays information about transactions and detailed comments for each action (invoice, refund,…) with order paid via 2Checkout. Only admin can see this section.

4. Refund Order

Here admin can Refund Online/ Offline all or partially of the order. The information about Refund Online will be sent to the Sandbox and saved in the Comment History & Transactions section as below.