Thank you for purchasing our extension. If you have any questions that are beyond the scope of this document, please feel free to contact us, we will be happy to assist
Updated: 24th February 2020 2nd August 2021 | By: Magenest | Email: [email protected] | Support Portal: http://servicedesk.izysync.com/servicedesk/customer/portal/21
| Table of Contents |
|---|
Introduction
Shop by Brand for Magento 2 helps merchants to showcase products by brand, taking advantage of familiar brand names to customers to create more sales. Also, the extension shortens the buying journey by letting customers find out products of their favorite brands easily.
Key Features
For admin
- Show brands on brands page, brand detail page, product list and product detail page
- Create multiple brand groups to classify and manage
- Easily create new brands, including: brand name, logo, banner, description and more
- Add products to a brand
- Show brand with multiple display mode: icon, brand name or bothEdit the text and color for the brand search box
- Show featured brand list and featured product list
- Edit the title for featured list
- Add short description and detail description for brand
- Show number of products on each brand
- Set image for brand logo and banner and banner on brand page Arrange the brand order on featured brand list
- SEO setting for brands page
- Export Brands using MassAction and Magento’s Export function
For Customers
- View brands on brands page, brand detail page, product list and product detail page
- Hover to the brand icon to view brand short description
- View detail information of a brand on the brand detail page
- Search for brands by the search box or brand group
- View featured brands and featured product list
- View the number of product on each brand
- View products of the same brand on product page
System Requirements
Your store should be running on Magento 2 Community Edition Open Source version 2.23.x, 2.34.x or Magento 2 Enterprise Edition or Adobe Commerce version 2.23.x , 2.34.x.
Configuration
On the admin sidebar, go to Shop By Brand > Settings to set the general configuration for the extension. On the Configuration page:
General
This section contains the setting for the brands on the main menu and product pages.
- Add All Brands page Link to Main Menu
- category to main menu: Choose Yes to add Brands tab on the main menu. Menu
- Title of All Brands category on main menu: Enter the name of the brands tab on the main menu. The default title "
- Brands "
- will be shown if this field is left blank.
- Display brand icons in
- on product listing page: Choose Yes to display the brand icon on each product on product listing page. Show brands in product
- Display brand icons on product detail page: Select a layout for the brand information on product detail page. There are four options: No, Brand name only, Icon only, Brand name and icon.
- Front-end layout
International Brands tab could be renamed from the back-end
Brand icon 650pxon the product list
Brand icon on the product on product detail page
All Brand Page Setup
In this section, admin can set the layout for the brands list page.
- URL Key: Set url rewrite key for brand listing page. Customer can access the the page using the following format: <domain_name>/<url_key>/
- Meta Title: Set meta title for brand listing page.
- Meta keywords: Set meta keywords for brand listing page.
- Meta description: Set meta description for brand listing page
- Brand Tittle Of The Search Box: Set the title for the brand-search box.
- Title Color: Set color for the search box title. Background Color: Set color for the brand-search box
- .
- Display Featured Brands list: Choose Yes to display the most-popular-brand list on
- at the top of Brands listing page.
- Title of Featured Brands list: Name the title for the featured brands list.
- Display Mode
- All Brands list: Select the
- a layout for the brands
- brand information on featured brands
- brand list page.
- There are
2 - two options:
Icon - Brand name only and Brand name and icon.
- Title of Featured
- All Brands list: Enter the title
- Set header for the featured brands list.
- Display Brands List: Choose Yes to enable the list of all brands.
- Title Of Brand List: Enter the title for all-brand list.
- brand list section of Brand listing page
- Display product quantity of each brand Show Product Quantity Of Each Brand
- : Choose Yes to display the items quantity on
- along with each brand icon on the all-brand list.
- Sort order of All Brands list: Set sort order of the brand list.
- There are two options: Number first and Character first.
- Front-end layout
Brand Detail Page Setup
This section contains the settings for
brandthe Brand detail page.
- Display Features
- Featured Products list: Choose Yes to enable the featured products list on the brand
- Brand detail page.
- Title Of Featured Product list: Enter
- Name the title for the featured products list.
- Front-end layout
SEO Settings
This section contains the Search Engine Optimization settings for the brands page.
After finishing, click on Save button to save the configuration.
Manage Groups
Before creating new brands, admin need to create groups to classify the brands.
On the admin sidebar, go to Shop By Brand > Manage Groups.
On Brand Groups page, admin can delete or change status of the available groups.
To create a new group, click on Add Add New Group button.
On New Group page, set name and status for the new group. Then click on click Save Group button to save.
Manage Brands
On the admin site bar, go to Shop By Brand > Manage Brands.
On the Shop By Manage Brands page, admin can edit or delete the available brands on the list grid.
Import brands
- To import brands, click on Import button, go to Import Brands page.
- Click on Download Sample File to download the sample file. Then fill in the file with brands information.
- Click on Choose File button and select the completed file to import.
- Click on Upload button, then the brands will be add to the store.
MassAction can be used to delete, export, toggle status or Featured Brand attribute of multiple brands.
Create a new brand
To To create a new brand,
click onclick Add New Brand button. On the New Brand page:
General
- Title: Set a name for the new brand.
- Status: Choose Yes to activate the brand.
- Add to Featured Brands: If choose Yes, the brand will be added to the featured brands list.
- Display same-brand products in Product Page: Choose Yes to display other products from the same brand on Product page.
- Display limit:
- Only appear when Display same-brand products in Product Page is enabled.
- Set the maximum number of same-brand products displayed in the product page.
- Store Views: Select a store view for the brand.
- Group: Assign the brand to one or several groups.
- Sort Order: set the brand position on the featured brands list.
Note: If several brands are set in the same position, they will be arranged by alphabet order.
- Same brand section in Product Page (with Display limit of 10):
Images
Logo in Brand Page: Set the brand logo on brands page.
Logo in Brand Detail: Set the brand logo on brand detail page.
Banner: Set the banner on brand detail page.
Front-end layout
Products
Select products to add to the new brand.
When editing a brand, in case admin want to add more products to the available list, click on Add Product button then select products to add.
Brand Page
Setup the detail page for the brand.
Page Title:
Enter the titleTitle in the header html.
URL Key:
Enter theThe URL Key for marketing purposes.
Short Description:
Insert aA short description for the brand. This description will display when users hover on the brand icon.
Brand Description:
Enter aA detailed description for the brand using the.
Meta keywords, Meta description: Search Engine Optimization for the brands page.
Click Save to save the brand.
Related Brand
Select brands to add to the new brand. These brands will be displayed in the Related Brand section on the frontend.
When editing a brand, in case the admin wants to add more brands to the available list, click on the Add Brand button then select brands to add.
Click Save to save the brand.
Import Brand
On the admin site bar, go to Shop By Brand > Import Brand
Import Settings
Entity Type: Select Magenest Shop By Brand Import. Then press Download Sample File and modify the content accordingly.
Import Behavior
Import Behavior: Set Import Behavior to one of the following: Add/Update Replace Delete
Validation Strategy: To determine what happens when an error is encountered when importing data, choose one of the following: Stop on Error or Skip error entries
Allowed Errors Count: Enter the number of errors that can occur before the import is canceled.
Field separator: Accept the default value of a comma (,).
Multiple value separator: Accept the default value of a comma (,).
Fields enclosure: If you want to enclose any special characters that might be found in the data as an escape sequence, select the Fields Enclosure checkbox.
File to Import
Select File to Import: Find the CSV file that you prepared to import and click Open.
Images File Directory: Enter the relative path to the location on the Magento server where uploaded images are stored.
Then click the Check Data button and wait a few moments for the validation process to complete. If the import data is valid, the following message appears:
If the file is valid, click Import.
Export Brand
Aside from MassAction export in management grid, brands can be exported using Magento’s Export function.
On the admin sidebar, go to Shop By Brand > Export Brand
> Dashboard. On the dashboard page, admin can view the report about orders by brand.
list > select Magenest ShopByBrand in Entity Type.
Entity Attribute: Filter to-be-exported brands
- Filter column: Select an attribute to filter brand list.
- You have to select at least 1 filter for the export function. If you wish to export all brands, only select the Please select attribute in Brand Names attribute label.
- Exclude column: This is a reverse filter. Instead of exporting Brands that matched selected filters, Brands that don't match the selected filter will be exported.
- Example: If we select Nike brand in Brand Name
- Without exclude checkbox, only the brand Nike will be exported.
- With exclude checkbox, all brands except Nike will be exported.
- Example: If we select Nike brand in Brand Name
Select the filter you want, then click on Continue button to proceed.
Depending on the current Magento version, you will receive the export file right away, or the export request will be added to queue to be processed later.
- If export request is added to queue, admin should receive a notification once the export process is complete and the file is ready to download:
- The queue processor can be executed immediately with Magento CLI, using the following command:
bin/magento queue:consumers:start exportProcessor
Add brands list widget
On the admin site bar, go to Content > Widget.
Click Add Widget button
Type: Select List Brand
Design Theme: Select the theme to which the widget will be applied.
Then press the Continue button.
Storefront Properties: Config widget name and where the widget will show up.
Widget Options:
Number of Brand: Brand number will show up on widget.
Sort Brand By: Choose sort order brands. There are 2 options: Ascending and Descending.
On frontend layout:
Main functions on the front-end
View brands page
On the store, customer can view a separate page for all available brands.
Search for a brand
There is a search box on the brands page, which allows customers to search for a specific brand.
Search by brand name
: Customers enter a brand name on the search bar to find the brand.
Search by group
: Select a group and all the brands on the group will display on the list below list.
View featured brand list
The featured brands list is displayed on a slider.
View product quantity on each brand
Customers can view the number of products on each brand.
View brand detail page
Customers can click on a brand to view the detail page of it.
View detail description
Click on Learn More button on the banner to view full description about the brand. To close the description section, click on the Close icon.
View 
View featured product list
Customers can view a list of featured product on the brand page. This list is set by admin from the back-end.
View View brand icon and short description on products list
On the product list, the short description will display when customers hover on the brand icon of a product.
View View related brand
Customers can view a list of related brands on the brand page.
View brand icon and short description on product detail page
On the product detail page, the short description will display when customers hover on the brand icon.
Update
When a bug fix or new feature is released, we will provide you with the updated package.
All you need to do is repeating the above installing steps and uploading the package onto your store. The code will automatically override.
Flush the configure cache. Your store and newly installed module should be working as expected.
Support
We will reply to support request within 2 business days.
We will offer lifetime free update and 6 months free support for all of our paid products. Support includes answering questions related to our products, bug/error fixing to make sure our products fit well in your site exactly like our demo.
Support DOES NOT include other series such as customizing our products, installation and uninstallation service.