1. Overview

Magento 2 Instagram Feed extension allows admins to integrate Instagram feeds into the Magento storefront, to showcase attractive media & content from their accounts.

The Instagram Feed will look like this.

Note: If the post has multiple media, the first image/video will be chosen to display on the Instagram feed.

2. How Does it Work?

2.1. Module Configuration

 2.1.1. General Configuration

Here, you will enable the module and configure it to connect Instagram with your Magento store.

Navigate Stores ⇒ Configuration ⇒ BSSCommerce ⇒ Instagram Feed

• At Enable Module: Choose Yes to activate the module.
• At Instagram Access Token: Enter the user Token provided for your Instagram account. This token is necessary for calling API to get the images/videos from the Instagram feed.
  To get Instagram token, please follow this guide.

2.1.2. Advanced Token Settings

This is important as Token has expired dates and whenever you post something new, these settings will update automatically for you.

• API call interval minutes:  Set the interval time between 2 continuous API calls.
• Refresh Token: Choose Yes to automatically generate and update a new token, replacing the expired one.

Note: Usually, the token will expire after 60 days. If this configuration is enabled, 2-3 days before the token expires, the module will process to let the Meta for Developer system automatically generate a new token and update it to the Instagram Access Token configuration above. However, you need to run cron for your site. Or approximately every 60 days, you have to access and press the Save config button before the token expires to keep it running.

• Token Expired Date: show the expiration date of the current Access Token.

2.1.3. Media Popup Settings

This module allows a popup to show up whenever customers click on an Instagram feed.

• At Popup Auto Play: Choose Yes if you want the media to move to the next one automatically. Or No to disable it, and customers have to click the arrow to see the next posts.
• At Popup Auto Play Speed: Enter the amount of time (seconds) that the post takes to switch to the next one.

2.2. Instagram Feed Widget Configuration

The Instagram feed enabled by this module works as a widget in the Magento store, so that you can set the display pages, positions, titles, and layouts for the feed.

2.2.1. Add the widget

To add a new Instagram feed widget, navigate to Content > Widgets. Click the Add Widget button.

At Settings, in the Type field: Choose BSS Instagram Feed Widget. Then choose Design Theme & Click the Continue button to proceed.

2.2.2. Set up Storefront properties

• Widget Title: Enter the title for the widget in the backend.
• Assign to Store Views: Assign the widget to the selected store views.
• Sort Order: Set the order if there is more than 1 widget in the same container.

• In Layout Updates, you will choose the pages & positions on those pages to display the Instagram feed. You can put the widget on multiple places by clicking the Add Layout Update button to add more.
• At Display on: choose to display the widget on which page/product/category type. Then accordingly, you will see the options to choose which page or specifics or all products/categories.

• On the right, there’s a Container option: choose the container position for the widget.
• To finish, click on the Save button.

2.2.3. Widget Options: Label, Layout & Auto-play

• Widget Label: Enter the name of the Instagram feed widget on the frontend.
• Widget Layout: Choose the layout for the widget - Standard for grid layout and Slider for slide layout. If you choose the Slider layout, you will choose whether the widget auto-plays or not at Auto Play. Then set the auto-play time at Auto Play Time.
• Enable Repeated Images: Choose Yes to let the slider repeat the images after reaching the end.

1. Overview

Magento 2 Cookie Consent extension allows users to create a consent bar for customers to be informed and granted the right to accept or deny cookies explicitly. This is required to comply with the EU Data Privacy Policy. 

The consent bar will be displayed on the frontend like this:

 

2. How Does it Work?

Please navigate Stores ⇒ Configuration ⇒ BSSCommerce ⇒ Cookie Consent

2.1. Update GeoIP database

This module supports setting consent mode & cookie banner to specific countries. Therefore before that, you need to update the GeoIP country database.

In Upload Custom File, you can upload a custom file (such as a paid database version from MaxMind) to be the database. However, in case the uploaded file is larger than the limit of the server, this option will be not available.

* Note: When you upload the file, you need to rename it and use the right format so that the file can be uploaded successfully and then the system runs cron. The file format must be the .zip file (This .zip file includes CSV files). After finishing uploading, choose Save Config then click Upgrade Data.

In Upload Custom URL, you can fill in the URL of the database file if you cannot upload it in the Custom File option (when the file is larger than the limit of the server). After completing, choose Save Config then click Upgrade Data.

In Update Database from MaxMind, please click in Upgrade Data to automatically download the Database from MaxMind or to use the uploaded file. After the file is extracted, a notification “Waiting for Cron run!” will be shown, and please wait for the database to be updated.

*Note: If Upload Custom File and Upload Custom URL are left blank, the module will use the Country Lite Database in MaxMind page. Hence, not all IP countries are available in this database.
On the other hand, the extension also uses another tool named IPinfo to identify the IP country in case it cannot be found in the database.

2.2. Cookie Consent Configurations

2.2.1. General configurations

 

• In Enable, choose Yes to enable the extension, or No to disable it.
• In Auto Hide Message (seconds), enter a number to set the duration that the cookie consent bar is displayed. When the time is over, the notification is hidden automatically.
• In Position, select an option to set the position of the notice to be shown on your website pages. There are 4 available options: Bottom Left, Top Left, Bottom Right, and Top Right.
• In Country Restrictions, select the countries to apply consent mode. There are 3 options: All Countries, EEA Countries, and Specific Countries (EEA Countries will be auto-selected following this list).

• If you choose Specific Countries, a dropdown will appear for you to choose certain countries to apply consent mode.

2.2.2. Default Consent

Usually, the default status when visitors do not interact with the cookie bar/popup is “Denied”.

However, with this module, you can configure the default status for each of the consent types that will be sent to Google tools such as GTM, GA4, or Google Ads in case there’s no interaction from users with the consent bar.

At Default Status, with each consent type, Choose “Granted” or “Denied” at the Status column as you wish. Then click Save Config button to save this default setting. 

To learn more about the consent types, please check the Consent configuration article from Google.

2.2.3. Consent Style

• In Message Title, edit a title for the consent bar.
• In Title Text Color, select color text for Message Title.
• In Message, edit a message to offer information about your website cookies. Here you also can add links to text in the message. SPECIAL: Here, you can also add links to any text in the message. To do so, add this tag:
  <a href="https://...">Text</a>
• In Message Text Color, select the color for the message text.
• In Background Color, select the background color for the notification.

2.2.4.  Accept All Button Configs

An Accept All button is presented for customers to confirm that they have understood the notice. If they click this button, the notice will hide immediately, and they consent to cookies being collected. If they don’t, the notice will be displayed every time they change pages on the website or refresh a page.

• In Text, edit text on the Accept button.
• In Text Color, select the color for the text on the button.
• In Background Color, select the color for the button background.

2.2.5.  Deny All Button Configs

When clicking the Deny All button, customers will confirm that they do not consent to their cookies being collected & stored on your site.

• In Enable, you can set this button to be displayed or not on the consent bar.
• In Text, edit text on the Deny All button.
• In Text Color, select the color for the text on the button.
• In Background Color, select the color for the button background.

2.3. Set up cookie popup link on webpage by widget

By adding this link, even when already choosing the consent mode, customers can click it to show cookie popup again to reselect consent mode.

After enabling the module, navigate Content ⇒ Widgets  ⇒ Add Widget.

At Type: click to see the dropdown, choose “BSS Cookie Consent Setting”. Then choose Design Theme & Click Continue button.

Here you’ll see more configuration options. Set the Widget Title & Assign to Store View. & Then choose the Layout Updates to add the link to which page/position.

In Widget Options, fill in the title for this cookie banner link. This title will be displayed on store page. Then click Save to finish.

Note:
In this demo, we also install the Google Analytics 4 extension so that you can easily test if this module has impact on reports in GA4.

And Please follow the documents from Google to test the impact of consent mode on Google products:

• Google Analytics 4: https://support.google.com/analytics/answer/14275483?hl=en
• Google Tag Manager: https://support.google.com/tagmanager/answer/14218557?hl=en
• Google Ads: https://support.google.com/google-ads/answer/14218557?hl=en

1. Overview

Magento 2 ChatGPT extension enables you to integrate ChatGPT into your store to automatically generate high-quality & SEO-friendly content for all your pages.

2. How Does It Work?

Magento 2 ChatGPT module only helps integrate ChatGPT into Magento site. To use the ChatGPT service, you need an OpenAI account.

In your OpenAI account, on Billing overview, you will see what type of account (Free trial or Paid account), and Credit remaining.

To set up a paid account, click Add payment details and set the appropriate payment information.

2.1. Enable the extension

Please go to Stores ⇒ Configuration ⇒ BSS COMMERCE ⇒ ChatGPT ⇒ ChatGPT Configuration.

• Enable: Choose Yes to enable the module or No to disable it.
• API Key: Enter the API key provided by ChatGPT. To get the API key, please follow the ChatGPT API guide.
• Model Type: Choose the model type of the ChatGPT (ChatGPT-3.5 Turbo or ChatGPT-4). For more details, please follow the ChatGPT Model guide.
• Max Tokens (Store view): Enter the token limitation of the model. Only an integer greater than 0 is valid. For more details, please follow the ChatGPT Tokens guide.
  *Note:
  - You should enter an integer number greater than 1000 and less than the max tokens provided by ChatGPT.
  - The value in this field will automatically change to the default value of the respective ChatGPT model.
  - If the language you use is not English, you should input a lower number of Max Tokens because ChatGPT may not be able to tokenize your words in a standard way. You can test the token length of your prompt here.
  - Learn more about how to set Max Tokens value for Languages Other Than English (LOTE) here.
• Temperature: Enter a real number: 0 <= x <= 2. For more details, please follow the ChatGPT Temperature guide.
  *Note:
  Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. See: ChatGPT Temperature in FAQs.
• Call ChatGPT: Click the button to check the configurations after editing them.
  *Note: When you click the button, it will use the current configurations on the page to check. You don't need to save configs before calling it.

2.2. Default prompts

Default prompts appear when you use the Get Default Prompt config, which acts like the query to send to the ChatGPT system to command the AI to write content for you.

Go to Stores ⇒ Configuration ⇒ BSS COMMERCE ⇒ ChatGPT ⇒ Default Prompts.

Default Prompts are divided into smaller sections: Product Prompts, Category Prompts, CMS Prompts, and SEO Prompts. 

• ChatGPT System role: Each of these prompts will include the ChatGPT System role section to define the role of ChatGPT when generating answers for the section below. Example: A professional eCommerce advertisement content writer who is proficient in SEO, A professional SEO expert in eCommerce, ….

• Product Prompts: The default prompt to write content for long and short product descriptions.

• Category Prompts: The default prompt to write content for category descriptions.

• CMS Prompts: The default prompt to write content for CMS pages.

• SEO Prompts: The default prompt to write content for SEO elements, including:
  • • SEO Meta Title: The default prompt to write content for meta titles.
    • SEO Meta Keywords: The default prompt to write content for meta keywords
    • SEO Meta Description: The default prompt to write content for meta description.

To use custom prompts as the default prompts, uncheck the Use system value checkbox and enter your prompts.

2.3. Generate content

>> Watch the tutorial video here!

2.3.1. Generate content for product pages

Navigate to Catalog ⇒ Products. Choose to edit an existing product or create a new one.

Then scroll down to the Content section and expand it.

Click the ChatGPT Content button in the short description or long description section. A popup window will show up.

• ChatGPT System role: Enter the system role to define the role of Chat GPT when generating answers for this section.
  • • • If you delete the default role and then want to recover it, you can click on the refresh icon
      • If this configuration is left blank, ChatGPT will generate answers with its default role
• Prompt: Enter your custom prompt to generate content. If this box is left empty, the default prompt will be used.
• Get Default Prompt: Click the button to get the default prompt in the prompt field. You can edit it in the prompt field.
• Attribute Box: Choose one or multiple product attributes in the attributes box to give ChatGPT some input to generate content.
• Send to ChatGPT: Click the button to send your prompt to ChatGPT to get the result.

Next, scroll down to the Search Engine Optimization section and expand it.

Click the ChatGPT Content button to generate content for meta title, meta keywords and meta description.

*Note: On the product edit page, if you edit any product attribute, the Magento ChatGPT module can update the attribute in realtime to generate content accordingly without you having to save the product first.

2.3.2. Generate content for Category pages

Navigate to Catalog ⇒ Categories. Choose to edit an existing category or create a new one.

Then scroll down to the Content section and expand it.

Click the ChatGPT Content button in the description section. A popup window will show up.

• ChatGPT System role: Enter the system role to define the role of Chat GPT when generating answers for this section.
  • • • If you delete the default role and then want to recover it, you can click on the refresh icon
      • If this configuration is left blank, ChatGPT will generate answers with its default role
• Prompt: Enter your custom prompt to generate content. If this box is left empty, the default prompt will be used.
• Get Default Prompt: Click the button to get the default prompt in the prompt field. You can edit it in the prompt field.
• Keywords box: Enter some keywords in the keywords box to give ChatGPT some input to generate content.
• Send to ChatGPT: Click the button to send your prompt to ChatGPT to get the result.

Next, scroll down to the Search Engine Optimization section and expand it.

Click the ChatGPT Content button to generate content for meta title, meta keywords and meta description.

2.3.3. Generate content for CMS pages

Navigate to Content ⇒ Pages. Choose to edit an existing page or create a new one.

Then scroll down to the Content section and expand it.

Click the ChatGPT Content button in the description section. A popup window will show up.

• ChatGPT System role: Enter the system role to define the role of Chat GPT when generating answers for this section.
  • • • If you delete the default role and then want to recover it, you can click on the refresh icon
      • If this configuration is left blank, ChatGPT will generate answers with its default role
• Prompt: Enter your custom prompt to generate content. If left empty, default prompt will be used.
• Keywords box: Enter some keywords in the keywords box to give ChatGPT some input to generate content.
• Get Default Prompt: Click the button to get the default prompt in the prompt field. You can edit it in the prompt field.
• Send to ChatGPT: Click the button to send your prompt to ChatGPT to get the result.

Next, scroll down to the Search Engine Optimization section and expand it.

Click the ChatGPT Content button to generate content for meta title, meta keywords and meta description.

2.4. Generate SEO metadata

This tutorial shows you how to generate SEO metadata for all pages (product, category, CMS).

First, on the edit page, scroll down to the Search Engine Optimization section and expand it.

Click the ChatGPT Content button to generate content for meta title, meta keywords and meta description.

After clicking the button, a popup window will show up with similar configs (Keywords box/Attributes box, Prompt, Get Default Prompt, Send to ChatGPT). Follow the tutorial for generating content to get SEO metadata.

2.5. Mass Generate Content

Now you can select multiple products and perform mass action - generating content for descriptions & metadata, just by a few simple clicks.

Go to Catalog > Products. Here, select the products that you want to mass generate content.

At Action dropdown, choose Generate Content with ChatGPT.

Then choose which kinds of content you want the module to generate. There're Short Description, Description, Meta Title, Meta Keywords & Meta Description.

Then the Prompt settings popup will show up. Follow the same guide above for product content generation to continue.

After clicking Send to ChatGPT button, the module will do the work for you. And you will see a message to confirm your action.

To check if the action for certain product is successfully done, check in the Buik Actions Log by navigating: System > Action Logs > Bulk Actions.

The generated content will added right after the old content.

3. Set Max Tokens value for non-English language

Our module uses ChatGPT's fixed formula to calculate the max token for the answer (completion).

According to the ChatGPT's doc: A helpful rule of thumb is that one token corresponds generally to 4 characters of text for common English text. This translates to roughly ¾ of a word (so 100 tokens = 75 words).

For example: You're using Chinese (a non-English language).

Given that the max token input in ChatGPT configuration is 4097 tokens.

If your prompt has 260 characters, the module calculates that:

- The token number of the prompt is 260/4 = 65 tokens.

- The max tokens for the answer that the module request ChatGPT to generate is approximately 4097 - 65 = 4032 tokens.

However, because you're using Chinese, ChatGPT calculates the token number of the prompt as 434 tokens (test it here). The reason is that it takes a lot of tokens to tokenize figurative language (Chinese in this case) for ChatGPT to understand, increasing the prompt token significantly.

So after you use that prompt and call ChatGPT, ChatGPT will automatically generate an answer according to the max token value the module request sent (in this case, 3931 tokens), and then compare it with the model's max token.

An error occurred due to: 434 (prompt) + 3931 (completion) = 4365 tokens => Exceeded max token of the module => The module will report the error and did not print that completion in the Magento text field.

Thus, if the language is not English, you should input a lower number of Max Tokens.

1. Overview

Magento 2 Dynamic Category extension enables you to automatically associate products to categories according to your product conditions.

2. How Does It Work?

2.1. Enable the extension

Please go to Stores ⇒ Configuration ⇒ Catalog ⇒ BSS COMMERCE ⇒ Dynamic Category.

• Enable Module: Choose Yes to enable the module or No to disable it.
• Enable Category Reindexation Logging: Choose Yes to allow logging all reindexation of each dynamic category into the database. Otherwise, choose No.

Then click Save Config.

2.2. Setup the rule for each category

Category Magento 2 extension automatically associates products to categories based on product attributes and special conditions. By following this guide, you can set up any kind of condition with any degree of complexity. 

Please go to Catalog ⇒ Categories. Choose the category you want to setup a dynamic category rule then expand the Products in Category section.

• Dynamic Category: Choose Yes to allow the module to assign the products for the category based on the conditions you set up below. Choose No to use the default Magento settings for the category.
• Import Category Rules: Select the category that you want to import its dynamic category rules.

• Dynamic Category Rule: Set up the product conditions for the category as you want.

• Refresh matching products: After setting up the dynamic category rule, click this button to preview all products that meet the rule you set up in a product grid.

Then you click Save to save the dynamic category settings. The results are shown on the frontend now.

Note: When you have already assigned a product to a dynamic category, removing that category at that product’s detail page BE will not take effect.

1. Overview

Magento 2 Affiliate extension allows you to create and run various affiliate programs in your store. The affiliate programs help build a huge community to promote your products and you can gain more orders.

2. How Does It Work?

Please go to Stores ⇒ Configuration ⇒ BSSCOMMERCE ⇒ Affiliate to configure the module.

2.1 General Settings

• In Enable Affiliate Pro: Choose Yes to enable the module, No to disable it.

2.1.1 New Affiliate

• In Auto sign up new registered customers to Affiliate Program: If you choose Yes, new customers will be assigned as an affiliate automatically and the affiliate registration form will not be shown on Create account page. To disable this feature, choose No.
• In Extend default customer registration form to allow sign up box for Affiliate program: Choose Yes to display the Affiliate signup on the Registration Page. To disable this feature, choose No.

*Note: If there are already other extensions overwriting the registration page, please be aware that some conflict possibilities may happen.

• In Enable customer to voluntarily sign up for affiliate program on default customer registration form: Select among 3 options (Disable, Enable - signup checkbox, Enable - signup form).

• In Auto approve Affiliate registration: Choose Yes to automatically approve the affiliate registration. If choose No, you need to go to Affiliate Pro⇒Manage Members⇒ Pending Members to approve the registration manually.
• In Assign affiliate to group when registration auto-approved: If you enable affiliate registrations automatical approved, the affiliates will belong to the group that you assign here.
• In Length of the manual referral code (set # of characters): Enter the number of characters of the referral code.

2.1.2 Customers

• In Show manual affiliate referral code field on extended customer registration form: Choose Yes to display the referral code box on the account registration page. To disable this feature, choose No.
• In Extend shopping cart page to allow Affiliates to enter credit: Choose Yes to overwrite the shopping cart page. Otherwise, choose No.
• In Show manual referral code block on extended shopping cart page: Select Yes to allow customers to insert the referral code at shopping cart page. To disable this feature, choose No.
• In Reassign customer to new affiliate when they use new manual referral code: If you choose Yes, when a customer enters a new referral code, the system will change the parent affiliate of this customer to a new Affiliate who has that new referral code and update referral information. Otherwise, choose No.
• • In Do not display 'Share this page' link on following pages: List the page that you don’t want customers to share. The selected page will not have the Share this page option in the footer.

2.2 Manage Affiliate Commission and Customer Discount

• In Program Executing Priority: Choose one of 3 options (By maximum commission, By maximum discount, By priority)

• In Calculate affiliate Discount with Tax: Choose Yes for customers to get Discount with Base Price of Product incl Tax. Selecting No means that customers get Discount with Base Price of Product excl Tax. (Only use with Discount by Percent which set up in Programs)
• In Calculate affiliate commission: Choose between Before discount and After discount. This feature allows you to calculate affiliate discounts and commissions before or after Magento default discount.
• In Include taxes when calculating Affiliate commission: Choose Yes if you want to count affiliate commission and discount with tax. Otherwise, choose No.
• In Apply discount and commission for affiliates when they purchase themselves: Choose Yes to allow affiliates to receive discount and commission when they purchase products from store. Otherwise, choose No.
• In Add commission to account balance when order status is: Select an order status. When an order reaches that status, the commission will be added to Affiliate account balance. The Default is Complete.
• In Auto-subtract commission in case of customer refund: Select Yes to automatically subtract commissin when the order is refunded. Otherwise, select No.
• In Reverse commission from account balance when order status is: Select an order status. Then, when the order within the affiliate commission is changed to this status, the system will automatically subtract the commission that has been added before from the affiliate balance.
• In Hold commission in a number of days: Enter the number of days to hold back the affiliate’s commission.
• In Commission for referral visitor: You can set the amount of commission for referral visitor.

1. Overview

If you want to use the Hyva Compatibility package of some modules, you need to install Bss_HyvaCompatBase together. 

2. How Does It Work

Please go to Store  ⇒ Configuration ⇒ BSS COMMERCE ⇒ Hyvä Theme Compat Base.

2.1. General

• In Has Bss Modules Enabled? - Choose Yes to enable the module, No to disable it.

2.2. Rewrite Template

• In Block Product List Item - Choose Yes to enable rewrite template Block named product_list_item, No to disable it.
• In Block Header Content - Choose Yes to enable rewrite template Block named header-content, No to disable it.
• In Block Customer Menu - Choose Yes to enable rewrite template Block named customer.logged-menu, No to disable it.
• In Block Footer Static Link - Choose Yes to enable rewrite template Block named footer-static-links, No to disable it.

1. Overview

How to know your website performance in real-time, daily, weekly, monthly, etc.? Google Analytics 4 (GA4) is a savior here! Our Magento 2 Google Analytics 4 extension helps to directly integrate GA4 and your store by filling in the GA4 measurement ID. 

With just one step, you will be able to track, record, and view crucial data for your eCommerce business right in your Google Analytics account. Keep track of your purchases, cart additions, impressions, and overall user activity and confidently plan your next move.

2. How Does It Work?

Please go to Stores ⇒ Configuration ⇒ BSSCOMMERCE ⇒ Google Analytics 4.

IMPORTANT: To prevent duplicate events, disable native Magento GA4 if supported in your Magento version: Stores ⇒ Configuration ⇒ Sales ⇒ Google API.

2.1. General Config

• In Enable, choose Yes to enable or No to disable the module.
• Measurement ID: Fill in your GA4 Measurement ID. Check the instructions below (part 2.2)  to set up data streams and get the Measurement ID.

• Product Identifier: Allow store owners to choose attributes to identify products imported to GA4: ID or SKU. 
• Enable Brand: Choose Yes to add param item_brand to the item’s data; otherwise, choose No. (The default is No)
• Brand Attribute includes all product attributes (system and custom) on site. This config allows the store owner to choose identified attributes for the product’s brand. 

For example,

• Enable Affiliation: Choose Yes to add param affiliation to the item’s data; otherwise, choose No. (The default is No)
• Affiliation Attribute includes all product attributes (system and custom) on site. This config allows the store owner to choose identified attributes for the product’s affiliation. 

For example, 

Next, you can also customize the value of the transaction:

• Get price of bundle product by: There’re 3 options: min, max and average to choose from. This function helps admin to decide which bundle price will be listed on GA4. 
• Exclude Shipping From Transaction: Choose Yes if you don’t want to calculate shipping costs to transactions listed on GA4. Otherwise, select No. (The default is No)
• Exclude Orders with 0 value: Choose Yes if you don’t want to list Orders with 0 value on GA4. Otherwise, select No. (The default is No)

2.2. How To Get GA4 Measurement ID

2.2.1. Create an Analytics account if you haven’t had one yet

Step 1:  Go to Admin => Account column => Create Account.

Step 2: Fill out the account name and set up the data-sharing to monitor which data you share with Google.

Step 3: Click Next

2.2.2. Create a property

Step 1: In Admin => Property column => Create Property

Step 2: Enter a name for the property. Then, select the reporting time zone and currency. 

Step 3: Choose Next. Select your industry classification and company size.

Step 4: Click Create.

2.2.3. Add a data stream

Click Web => Enter your website URL => Enable enhanced measurement if you want to use eCommerce tracking => Create stream.

2.2.4. Get your measurement ID

Paste your "G-" ID into the Measurement ID field that the module provides. Your "G-" ID appears at the upper right.

* Note: Starting the data collection process could take up to 30 minutes. The real-time report or debug mode can confirm that you are receiving data.

2.2.5. Monitor events in DebugView

DebugView displays the events and user properties that Analytics collects from a user in real time, allowing you to troubleshoot issues as you install your tags or step through an external user's live activity.

First, you need to install and enable the Google Analytics Debugger extension to enable debug mode in your browser.

Then, to enable debug mode for all user devices, you need to update your configuration:

• Monitor all events

To monitor all the events on a page, add a 'debug_mode':true parameter to your config command, as follows:

gtag('config', 'G-12345ABCDE', { 'debug_mode':true });

• Monitor some events

To monitor certain events only, add a 'debug_mode':true parameter to just those events, for example:

gtag('event', 'xyz', { 'debug_mode':true });

• Disable debug mode

To disable debug mode, exclude the 'debug_mode' parameter; setting the parameter to false doesn't disable debug mode.

Once you enable debug mode on your devices, go to Admin > DebugView in the left navigation monitor the events as they're triggered.

The Seconds stream (the middle column) shows the events that have been logged in the last 60 seconds. The Minutes stream (the left column) shows a series of archives of events in the last 30 minutes. The right column shows the Top Events logged in the 30-minute period and the user properties for the currently selected device.

3. eCommerce Events Tracking

3.1. Recommended events for eCommerce stores

We recommend you to track these eCommerce events via Google Analytics 4 to measure sales on your Magento store:

Event	Trigger when	Parameters
add_payment_info	a user submits their payment information	See Google docs
add_shipping_info	a user submits their shipping information	See Google docs
add_to_cart	a user adds items to cart	See Google docs
add_to_wishlist	a user adds items to a wishlist	See Google docs
begin_checkout	a user begins checkout	See Google docs
purchase	a user completes a purchase	See Google docs
refund	a user receives a refund	See Google docs
remove_from_cart	a user removes items from a cart	See Google docs
select_item	a user selects an item from a list	See Google docs
view_cart	a user views their cart	See Google docs
view_item	a user views an item	See Google docs
view_item_list	a user sees a list of items/offerings	See Google docs

3.2. Payment methods for conversion tracking

Our module supports these following payment methods for conversion tracking:

• Paypal Express
• Braintree
• Klarna
• Stripe
• Check/Money order
• Bank Transfer
• Cash On Delivery
• Zero Subtotal Checkout
• Purchase Order
• Authorize.net Direct Post

3.3. Track Custom Product Attributes

Besides the predefined dimensions that Google Analytics already provides, users can also add customized parameters for better tracking. 

Our GA4 extension will support creating custom item-scoped dimensions in the backend for product attributes like color, size, product name, price, etc. within the items array of e-commerce events like 'purchase' or 'add_to_cart'.

3.3.1. How to set up

To do this, you have to (1) Add the custom event parameter to your website (which our module will do for you), then (2) Create item-scoped custom dimensions in your GA4 property.

First, in the backend, navigate Stores > Configuration > BSS Commerce > Google Analytics 4 > Custom Dimension.

At Enable Item-scoped, choose Yes to enable this function. 

At Related Product Attribute:

• • To add a custom dimension/parameter, click the Add button. You can add only up to 10 custom dimensions.

• • In Track Custom Attributes column, choose the product attributes you want to add to GA4 tracking.
  • In Parameter Label column, you name the dimension/parameter for the selected attribute. Note: this label must have the same name as the item parameter dimension you’re about to add to GA4.

Then click Save Config button to finish.

After that, create the custom dimension in your GA4 property following this guide from Google.

Note: 

• The product attributes to be tracked are only supported in these formats: 'text', 'textarea', 'date', 'date/time', 'dropdown', 'multi-select', 'price', 'boolean', 'swatch_visual', 'select', 'swatch_text'.
• With Dimension Name, you can't use hyphens in the name, but you can use underscores and spaces instead.

3.3.2. Expected Results

Note: It usually takes around 24-48 hours for custom parameters to be sent to Google Analytics. During this period, the value displayed will often be "not set".

To view all the dimensions added on GA4, by these ways:

(1) See the list of item-scoped dimensions you add by navigating: Admin > Data Display > Custom Definitions

 

(2) See the custom parameters in ‘purchase’ or 'add_to_cart' events in Google Analytics 4 reports or in Tag Assistant's Data Layer like this:

(3) Use in Explore function of GA4:

• Navigate to the Explore. Then select Create New Exploration.
• You will see the Dimensions tab on the left. Click the + button to see all the Dimensions.
• Choose the Custom tab. Then expand the Custom section, and you will see the added dimensions. Now, your custom dimensions are accessible for use in your report.

1. Overview

Keep improving your Magento 2 store to enhance customer experience and convince them to transact.

Use our Best Magento 2 Extension Combo to boost your company's performance without any effort.

What to expect?

• Convert Images to Webp
• AJAX Social Login
• Layered Navigation
• Popup
• One-Step Checkout

2. How Does It Work?

2.1. Magento 2 Convert Images to WebP

2.1.1. General Settings

Please go to Stores ⇒ Configuration ⇒ BSS COMMERCE ⇒ Convert Image Webp ⇒ General Configuration.

• In the Enabled section, choose:

- Yes: Enable Magento 2 webp online converter module. It starts the automatic conversion of webp image display in the frontend. - No: Disable the module. You don't want the automatic conversion and display of webp images in the frontend.

• Quality: The higher this value is, the higher the image quality will become. Our webp quality default is 75. * Note: This configuration can only be applied when uploading images or running commands., which means that the webp image quality displayed on the frontend will not depend on this value.
• Skip Folders:  You can pick the image folders that you do not allow automatic conversion to webp images in the frontend. Enter the relative path of an image in its original format (jpg, png..).
• Auto Generate Webp Image: Choose "Yes" to automatically convert images to webp format when loading pages that have images in jpg, jpeg, or png format. Choose "No" to keep images in jpg, jpeg, or png format.
• Clear All Webp Images: Delete all webp images that the module generated (used when updating new quality)

Note: In case you want to update quality using command, you can run php bin/magento bss_c_i_w:convert [<path>] [<quality>], with [<path>] is the image location and [<quality>] is the new quality index. (e.g. php bin/magento bss_c_i_w:convert pub/media 80). With this cmd, you would not need to wait for the system to delete old webp images.

2.1.2. Choose the place on-site to convert to webp images

Magento 2 Convert images to webp enables you to choose the pages you want the webp image online converting. There are 4 main places: Product Page, Category Page, Home Page, CMS Page.

Product Page

• Switch Enabled to Yes to enable the process of converting images to webp automatically at the Product Pages.
• Ignore IDs Products: For Product IDs inputted here, in the frontend, images in those product pages will be shown in the original format.
• Ignore Images: Input the image name in the original format. It's possible to input many images, each of them is separated by commas. The inputted images will be shown in the original format. This configuration is used when admin wants to display images with full size and quality on the frontend, which does not require to convert images into .webp format. * Note: In case you upload an existing image, Magento will auto-change the image name. So, please make sure to input the exact image name.

The same configurations are applied to the other page types.

Category page

Home Page & CMS Page

2.2. Magento 2 Social Login

Please go to Store  ⇒ Configuration ⇒ BSS COMMERCE ⇒ Ajax Social Login.

2.2.1.     General

In Enable, choose Yes to enable the extension or No to disable it. In Use Popup Ajax, choose Yes to enable popup for login and register. Otherwise, choose No to disable it. In Send Password, choose Yes to send customers an email that contains the password after they login using a social account. The customer then can use their email and password to log in to your site. Choose No to disable it. In Display Customer Photo, choose Yes to display the customer’s profile photo from the social account they used for signup, or choose No to not display customer’s social photo. In Redirect after Login, select the page on site or any particular URL you want to redirect after customer login successfully. In Redirect after Register, select the page on site or any particular URL you want to redirect after customer completed register process.

2.2.2. Social Button Block

In Display buttons social login on popup, decide to display social buttons on Login tab or Register tab of popup, or place it on both tabs. In Display buttons social follow class or id, enter class/id to place social button social login on. In Display buttons social register follow class or id, enter class/id to place social button social register on. In Number of button displayed, set the restriction of number of buttons to display on social login block. In Social Button Sorting, decide the arrangement of buttons in social login block.

2.2.3. ReCaptcha

In Site Key and Secret Key, click “Create a site key” and register reCaptcha. After registering, you will get the Site key and Secret key as below: In Theme, choose the theme of reCaptcha between: Light:  Dark:  In Type: Choose the type of robot checking between Image and Audio In Size: Choose the size of reCaptcha widget between Normal and Compact. In Popup Form: Choose the form(s) of popup on site to place the reCaptcha widget. A form of popup includes Login, Register and Forgot Password?

2.2.4. Configure specific social account

2.2.4.1.     Facebook

Take Facebook account as the example: In Enable, choose Yes to enable Facebook account for login and register on the site, or choose No to disable it. In App ID and App Secret, click on “click here” below Enable dropdown box, you will be redirected to a page to set up new API like below. After completing register step, you will see a page as below. Click on Get Started in Facebook Login. Click on Dashboard, you will see your App ID and App Secret - copy them and paste correspondingly into App ID and App Secret box in the backend configuration. In URI redirection valid OAuth– copy the Valid OAuth redirect URIs like below and paste into the box URI redirection valid Oauth. In Small Icon, upload the file for the icon of this account displayed in the frontend. In Login Button Text, customize the text in social login button. In Registration Button Text, customize the text in social registration button. Note: In case you run into the error “Blocked URL” use URI at the link to re-setup the configuration, as follow: For other social accounts, follow similar steps like the setting for Facebook:

2.2.4.2.    Twitter

2.2.4.3. Google

2.2.4.4. LinkedIn

To get Client ID, Client Secret and Redirect URL, please click on "click here" link and follow steps as below: + Create new application: + Set up Authentication for application: You get Redirect URLs in this step: + Copy Client ID and Client Secret to the configuration:

2.2.4.5. Window-Live

To get Application ID, Application Secret and Redirect URL, please click on "click here" link and follow steps as below: + Click on "click here" link to be redirected to Microsoft App register page: + Copy & Paste Redirect URL(s) to the app detail page: + Copy & Paste Application Id and Secret to Social Login configuration:

2.2.4.6. Instagram

Note: You need to edit the email after the 1st login. To get Application ID, Application Secret and Redirect URL, please click on "click here" link and follow steps as below: + Create New Client ID: + Fill in web information: + Get Client ID and Client Secret: *Note: - Client status must be Authorized, then you can get the real Instagram account. In case you use sandbox mode, sandbox account is only accepted. - Sometimes, you might face up to the error like this. The solution is to copy the Redirect URIs and paste it in the client info page:

2.2.4.8. Vkontakte

Finally, click Save Config and to complete setting process.

2.3. Magento 2 Layered Navigation

Before going into details of the configuration, we want to remind you about some terms we will use in the User Guide. About Attributes: Attributes are the building blocks of your product catalog, and describe specific characteristics of a product. There are 2 terms will be used in the User Guide: Attribute Block and Attribute Option.  

2.3.1. Layered Navigation Configs

Please go to Stores ⇒ Configuration ⇒ BSSCOMMERCE ⇒ Layered Navigation and start configuration.  

In Enable, choose Yes to enable the module, otherwise choose No. In Rating, choose Yes to enable filter by rating attribute, otherwise choose No. Multiple select is disabled for rating attribute block, and users can only select one rating attribute option at a time.  

In Category Tree Level, enter the number of category tree level to be displayed in Category attribute block. Enter 0 to display the default Category. Let’s take the following example:  

• If you enter 0: only show category A
• If you enter 1: show category A and sub-categories of the category A (B and C)
• If you enter 2: show category A, B, C and also sub-categories of category B.

In Use Ajax, choose Yes to enable loading layered navigation result by Ajax, otherwise choose No. In Apply Button, choose Yes to display Apply Filter button on the frontend, otherwise choose No. If you choose Yes: customers can select wanted attribute options, and click Apply Filter button. Then, customers can get corresponding search results with their selected options. For example:

• Customer select options as below:

• Results are generated:

To clear filters, customers click to Clear All. *Note: We will have some logic for filtering here:

• • Filter by category: If you select 2 categories, only products belonging to either of 2 categories are displayed in the filter results (OR condition).

  Eg: You select Jackets and Tees categories. Product A belongs to Jackets. Product B also belongs to Tees

  → Hence, product A and B will be displayed after filtering.

  • Filter by attribute input type (Multiple select, Dropdown, and Swatch):

  If you choose 2 options in an attribute, the results will show all products satisfying 1 or 2 of these 2 options (OR logic).

  Eg. You select Insulated and Hooded in the style option. After filtering, you will get all products with Insulated OR Hooded style.

  If you choose 2 options in 2 different attributes, the results will show all products satisfying both of these 2 options (AND logic).

  Eg. You select Mesh and Fleece in the material option and select XS in the size option. After filtering, you will get all products with Fleece OR Mesh material AND with size XS.

  • Filter by Price: you are allowed to filter Price by the only one range.

  Eg: you can filter products with price from $20 to $50. It is impossible to filter products with 2 price ranges: $20-S50 and $70-$100.

Note:

+ Function Filter by price DOES NOT depend on the config default Price Navigation Step Calculation - set up 3 options in the configuration will not result in bug of displaying price in Layer Navigation.

+ If Price is set to be seen as List, the price range will not be influenced by default config set up at Configurations. However, it will get influenced by the config "Layered Navigation Price Step" set up at the backend Category page.

• Filter by Rating: you are allowed to filter by the only one rating option.

In Expand/Collapse, choose Expand to expand the attribute options after loading the page or filtering results. Choose Collapse to collapse the attribute options. In Show More/Less, fill in a number (X). If the number of attribute options is bigger than X, the Show More/Show Less buttons will be displayed. Enter 0 if you want to disable the Show More/Show Less button.

2.3.2. Product Attribute Settings

Please go to Stores ⇒ Attributes ⇒ Product Edit Product Attribute and start configuration.  

2.3.2.1.Storefront Properties

In Storefront ⇒ Properties Use in Layered Navigation, choose one of the two options below

• Filterable (with results): Layered navigation includes only those filters for which matching products can be found. Any attribute option that already applies to all products shown in the list does not appear as an available filter. Attribute options with a count of zero (0) product matches are also omitted from the list of available filters.
• Filterable (no results): Layered navigation includes filters for all available attribute options and their product counts, including those with zero (0) product matches. If the attribute option is a swatch, the value appears as a filter, but is crossed out.

Please note that Use in Layered Navigation is only available to catalog input type Dropdown, Multiple Select and Price.

2.3.2.2. Storefront Proper

Go to Attribute ⇒ Information ⇒ BSS Layered Navigation to start configuration. In Display Option Settings, there are 8 display options to choose. But the options are available to specific catalog input types, here are how you can set up.

Display Option	Catalog Input Type
Label with checkbox	Multiple Select + Dropdown
Label with radio box
Visual swatch	Dropdown
Visual swatch with label
Text swatch
Price slider (from-to)	Price
Price range (automatic calculator)
Price input box (from-to)

  In Show More/Less, there are 2 options:

• No: disable Show More/Show Less button of the attribute block.
• Use General Setting: follow the general settings at Stores Configuration ⇒ BSSCOMMERCE Layered Navigation ⇒ Show More/Less.

In Expand/Collapse, there are 3 options:

• Expand: expand the attribute options after showing filtered results.
• Collapse: collapse the attribute options after showing filtered results.
• Use General Setting: follow the general settings at Stores ⇒ Configuration BSSCOMMERCE Layered Navigation ⇒ Expand/Collapse.

Click Save and flush the cache to complete the configuration. NEW UPDATE: Show/hide count in the layer by following this path config Catalog > Catalog > Layered Navigation > Display Product Count.

2.4. Magento 2 Popup

2.4.1 General Configuration

Please go to Stores ⇒ Configuration ⇒ BSSCommerce ⇒ Pop-up General Configuration. In Enable, choose Yes to enable the extension, or No to disable it.

2.4.2 Manage Pop-up Grid

Go to Marketing ⇒ BSSCommerce ⇒ Pop-up ⇒ Manage Pop-up. Manage Pop-up grid shows all pop-up you have created with full information, including Pop-up Name, Enable, Display Rule, Displayed Pages, Content, Store Views, Customer Groups, Start Date and End Date. The Manage Pop-up grid works just like standard grid in Magento 2 default with features such as mass action (delete, enable, disable), filter and column display.

2.4.3 How to Create New Pop-up

Please click on the Create New Pop-up button located on the top right of the grid. You will be redirected to the New Pop-up Page, which has 3 tabs:

• General
• Display Rule
• Content and Design

There are 4 buttons to support creating a new pop-up:

• Back
• Reset
• Save and Continue
• Save Pop-up

2.4.3.1 General

In Enable, choose Yes to enable the new pop-up. In Name, enter the pop-up’s name. In Store Views, select which store views to display the pop-up. In Customer Groups, choose the customer groups to view pop-up. In Start Date, select a date in the calendar view to begin showing the pop-up. In End Date, select a date in the calendar view to stop displaying the pop-up. In Priority, enter a number to decide the priority of the pop-up when multiple pop-ups are created on a page.

2.4.3.2 Display Rule

In Display Rule, choose one of the four following conditions to set conditions for displaying the pop-up:

• After customers spend X seconds on the page.
• After customers scroll page by X percent.
• After customers view X pages.
• Immediately when customers visit the page.
• Exit Intent

In X equals, enter a number to decide the value of X. In Display Animation, choose one of the six following options to set display effects for the pop-up:

• Zoom
• Horizontal Move
• Move from Top
• 3D Unfold
• Zoom-out
• None

In Position, select the position to display the pop-up on the page.

• Top Left
• Top Center
• Top Right
• Middle Left
• Middle Center
• Middle Right

In Auto Close Pop-up After, enter the amount of time (seconds) for the pop-up to automatically close. Ex: 10. Enter “0” to disable auto close of Pop-up In Display Frequency, determine the frequency of pop-up display by selecting one of the following options:

• When all conditions are satisfied: the pop-up appears if the above rules are executed.
• Only once: the pop-up only appears once.
• Only once per session: the pop-up appears once in a session. If you choose this option, you need to set Cookie Expires.

For example, if you choose Display Frequency as “Only once per session” and set the 2 minutes for the Cookie Expires, the pop-up is displayed when the conditions are satisfied, then it won’t be shown in the next 2 minutes (until the session ends or the cookie expires). In Enable Floating Pop-up, choose Yes to display Floating Popup (Popup still appear on product page after being closed by customer). After choosing Yes, you need to implement these configurations: In Floating Pop-up Type: Alter Popup into Icon/Button by selecting one.

• If you choose Icon, in Floating Icon, you can choose one of 8 available icon designs: 
  • Contact Form
  • Hot Deal
  • Newsletter
  • Notification Bell
  • Promotional
  • Promotions
  • Social Media 
  • Warning. 

• If you choose Button, you can customize the text and color of the popup in Floating Button Text and Floating Button Fill Color. 

In Floating Pop-up Position, select the position to display the floating pop-up on the page: 

• Middle Left
• Middle Right
• Bottom Center
• Bottom Left
• Bottom Right

In Display "Close" button, select No to not allow customers to close Floating Popup. Otherwise, select Yes. In Layout Updates: In Display on, select pages to show the pop-up, including the following types of pages:

• Category Pages
• Product Pages
• Generic Pages

When you choose each type of page, you can select all pages or specific pages depending on your demand. For example: + Category page: + Product page: + All pages: (You can exclude specific pages from displaying a popup when you select the option as All pages) Furthermore, it is easy to add more layout updates to show popup in more pages by clicking the button. After selecting the position and page, you can check the result on the front end.

2.4.3.3. Content and Design

Content and Design In Content, use the WYSIWYG editor to create content for the pop-up. You can use this tool to insert widget, image or video for the pop-up’s content. In Pop-up CSS, use CSS to change the design of the pop-up. If leaving blank, the default pop-up will be applied. Or, you can use our default template to quickly render your pop up. There are 5 templates to choose from:

• Contact Form
• Age Verification
• Newsletter
• Hot deals (product listing)
• Social sharing

After choosing your template, click on the Load Template button to make the template appear in the Content edit interface. In the Content edit, you can make any modification if needed. In Popup CSS, you can enter CSS code to change the popup design. If leave blank, the default design will be used. Note: After any change to the pop-up configuration, either  Save, Delete, Mass delete, Mass active, is made, a cache notification will appear. You then must go to SYSTEM -> Tools -> Cache Management ->Flush Magento Cache for those changes to be applied to the front end.

2.5. Magento 2 One Step Checkout

Please go to Stores ⇒ Configuration ⇒ BSSCOMMERCE ⇒ One Step Checkout.

2.5.1 In General

In Enable:

• Choose Yes to enable Magento 2 One Step Checkout extension.
• Choose No to disable this module.

In Allow Creating Account On Checkout Page:

• Choose Yes to allow customers to create their accounts right on the checkout page.
• Choose No to disable this function.

In Title: Write your wanted title for the checkout page. In Router Name: Choose an URL name for your checkout page.

2.5.2 In Fields Display

In Show Order Comment:

• Choose Yes to show a text box for customers to leave their comments for orders.
• Choose No to exclude this box from the checkout page

In Show Discount Code:

• Choose Yes to display a discount code box for entering coupon codes.
• Choose No to hide it.

2.5.3 In Newsletter

In Show Subscribe Newsletter:

• Choose Yes to allow customers to subscribe to the newsletter on the checkout page.
• Choose No to disable this function.

In Auto Check Newsletter Sign up Box: Choose Yes to automatically tick the Newsletter Sign up box or choose No to uncheck.

2.5.4 In Tracking Address by Google

In Enable Tracking  Address by Google:

• Choose Yes:  Auto-detect and pre-fill customers' country, state/province, city - Google Suggest to autocomplete shipping address while typing.

• Choose No: Customers have to find all street addresses and location information themselves.

In Google API Key: Fill in your API Key. In case you haven’t yet had an API Key, please click the link after this configuration to get it. In Tracking  Address from Applicable Countries: This configuration determines which countries to apply auto-suggesting customer addresses. There are 2 options to select:

• If you choose All Allowed Countries: auto-suggesting address function is applied to every country.
• If you choose Specific Countries: there is a list of countries in Tracking Address from Specific Countries and the maximum number of countries you can select is 5. Moreover, when you choose this option, Google just auto-suggests city name and country, not street name. This is the default function of Google auto-suggest.

*Notes:

• Admin has to work with Google and pay for Google Maps to activate the address autocompleting feature.
• Your websites must be "https://" to run the auto-fill function.
• Your login customers can checkout with multiple addresses.

2.5.5 In Order Delivery Date

In Show Delivery Date:

• Choose Yes to display Order delivery date in the Shipping method section that allows customers to choose their own suitable dates and times to receive orders.
• Choose No to disable this function.

In Show Delivery Comment:

• Choose Yes to display a Delivery comment box in the Shipping Method section.
• Choose No to hide it.

*Install M2 Order Delivery Date to see more premium features of this function:

• In case M2 Order Delivery Date is installed: All features of M2 Order Delivery Date will be active. Customers can choose the delivery date and admin can give them certain delivery time slots:

• In case M2 Order Delivery Date is not installed: All features of One Step Checkout delivery date will be active. Customers can choose whatever delivery date and time they want:

2.5.6 In Gift Message

In Show Gift Message on Order Level: 

• Choose Yes to allow customers to send a gift message to other people.
• Choose No to disable this function.

* Gift Message config is applied only when the corresponding default config is enabled. To enable the default config, please go to Stores ⇒ Sales ⇒ Sales ⇒ Gift Options and choose Yes to the suitable gift message level:

2.5.7 In Gift Wrap

In Enable:

• Choose Yes to allow customers to request a gift wrap for their order.
• Choose No to disable this function.

In Type: This function currently supports gift wrap for each order only, so the value is Per Order by default. In Gift Wrap Fee: Fill the price for gift wrap service. The entered value is a positive number and automatically rounded to two decimal places. If left empty or filled with a negative number, the value would turn to be 0.

2.5.8 Additional Add-on

M2 One Step Checkout is already compatible with multiple related modules: M2 Customer Attributes, M2 Checkout Custom Field, M2 Reward Points, M2 Pre-Select Shipping/Payment. Install the suitable modules to better optimize M2 One Step Checkout.

• M2 Customer Attributes: Carefully config the Customer Attributes function to give your customers the best shopping experience! Go to Customers ⇒ Customer Attributes. In each customer attribute, go to Display Configuration:
  • In Display on Checkout Page: Choose Yes to make customer attributes be shown on the checkout page, choose No to disable this function.
  • In Hide If Filled Before: Choose Yes so that if customers fill the customer attribute for the first time, it will not display after that. Choose No to always display the customer attribute whenever customers go to the checkout page.

• M2 Checkout Custom Field: Go to Sales ⇒ Bss Commerce ⇒ Manage Checkout Custom Field ⇒ Add New Field to create a custom field for the checkout page.

• M2 Pre-select Shipping/Payment: Go to Stores ⇒ Configuration ⇒ BSS COMMERCE ⇒ Pre-select Shipping/Payment to config the default shipping/payment method when customers enter the checkout page.

2.5.9 In Custom Style

In Checkout Step Number Color: you choose the color for the checkout number steps. In Checkout Step Background Color: Choose a color for the background of checkout number steps. In Custom Code: you can add more code to customize about background color for the checkout page, “Sign in” button or text color and so on.

2.5.10 Somes notes

• Notes about custom code

+ Change background of the checkout page, you need to add more code:

body { background-color: #333333; 

}

(#33333 is the color code which is corresponding to Black). + Change text color of the checkout page, you need to add more code:

body { color: #ffffff; 

}

(#fffff is the color code which is corresponding to White). + Change Sign in to a button, you add more code:

.authentication-wrapper button{

 padding: 15px;

 background: #6D268A;

 color: #fff;

}

.authentication-wrapper button:hover{

 text-decoration: unset;

 background: #FF0000;

 color: #fff;

}

• Note about configuring payment method

+ You need to configure all payment methods that default Magento supports. + Current support payment methods:

• Amazon Payment
• Paypal, Paypal Braintree, Paypal Express Checkout, Paypal Payflow Pro & PayPal Payment Flow CreditCard
• Pay by Credit Eway
• Splitit Card-Based Installment Payment Solutions
• NMI payment Direct Post
• NEW! Sagepay payment (Ebizmarts_SagePaySuite
• Zalopay
• Pay by Card (Stripe), Credit Card
• Online banking, etc.
• Stripe official

• Note about adding payment trust badge

Step 1: Go to Content ⇒ Blocks ⇒ Add New Block to create a new block for payment trust badge. Step 2: Go to Content ⇒ Widgets ⇒ Add Widget to choose certain place to display the block of payment trust badge.

• Note about adding header/footer for the checkout page: Upload folder bss_onestepcheckout to app/design/frontend/theme_space/theme.
• To log in to Amazon Pay on the One step checkout page, you need to check and change the URL so that the URL of Router Name config in BSS One Step Checkout extension is the same as Magento Checkout Url Path one in Amazon.

Follow the steps: Amazon config: Configuration > Sales > Payment Methods > Amazon Pay > Advanced > Developer Options > Magento Checkout URL Path.

Bss config: Configuration > Bss Commerce > One Step Checkout > General > Router Name      

*Note: This module supports the site that does not install Klarna payment method.

2.5.11. API Support

We provide you lists of Restful API and GraphQL  API that our Magento 2 One Step Checkout extension supports. *Note: 

• Restful API support is included in the main module package (from One Step Checkout v2.1.9).
• GraphQL API support is included in the GraphQL package, acting as an add-on for anyone who needs to use GraphQL.

2.5.11.1. Restful API 

No	API	URL	Method
1	Update cart information in One Step checkout when customers change product quantity (for Not logged-in customers)	{{base_url}}/rest/V1/bss-osc/guest-carts/:cartId/update-item	POST
2	Update cart information in One step checkout when customers change product quantity (for logged-in customers)	{{base_url}}/rest/V1/bss-osc/carts/mine/update-item	POST
3	Apply Gift Wrap	{{base_url}}/rest/V1/bss-osc/giftwrap/apply/0	POST
4	Validate Gift Wrap	http://one-step-checkout.demom2.bsscommerce.com/rest/V1/bss-osc/giftwrap/validate/:fee/:use	POST
5	Add information about Order delivery date and delivery comment to orders when getting orders via /V1/orders/:id (default)	{{base_url}}/rest/V1/orders/:id	GET
6	Add information about Order delivery date and delivery comment to invoices when getting invoices via /V1/invoices/:id (default)	{{base_url}}/rest//V1/invoices/:id	GET
7	Add information about Order delivery date and delivery comment to credit memo when getting credit memo via /V1/creditmemos/:id (default)	{{base_url}}/rest/V1/creditmemos/:id	GET
8	Add information about Order delivery date and delivery comment to shipment  when getting shipment via /V1/shipment/:id (default)	{{base_url}}/rest/V1/shipment/:id	GET
9	Get Store config of the module	{{base_url}}/rest/V1/bsscommerce/osc/storeconfigs/:storeview	GET
10	Add information about Order delivery date and delivery comment to the payment extension corresponding to the customer's current cart	{{base_url}}/rest/V1/bsscommerce/osc/deliveryinfo	PUT
10.1	Add information about Order delivery date and delivery comment to the payment extension by GUEST	{{ api_base }}/V1/bsscommerce/osc/deliveryinfoguest	PUT
11	Get information about Order delivery date and delivery comment from Quote	{{base_url}}/rest/V1/bsscommerce/osc/deliveryinfo/cart/:id	GET

2.5.11.2. GraphQL API 

No	GraphQL API	URLs	Method
1	Add information about Order delivery date and delivery comment to orders when getting orders via customerOrders default	{{base_url}}/graphql	POST
2	Add information about Order delivery date and delivery comment to the payment extension	{{base_url}}/graphql	POST
3	Get information about Order delivery date and delivery comment from Quote	{{base_url}}/graphql	POST

1. Overview

Magento 2 Administration Package is a comprehensive solution to assist admin in carrying out essential tasks and managing activities in the backend of a Magento 2 website. It includes 13 extensions:

+ Admin Email Notification + Admin Action Log + Admin Product Preview Plus + Inventory Report + Guest to Customer + Custom Order Number + Auto Invoice

+ Product Grid Inline Editor + Duplicate CMS Page/Block + Delete Order + Reindex from the Backend + Custom Product Attribute Export + Disable Compare

2. How Does It Work?

2.1. Admin Email Notification

Please go to Store ⇒ Configuration ⇒ BSSCommerce ⇒ Admin Email Notification.

2.1.1. Select Email sender

In Email Sender: choose an email from your system to send notification emails.

2.1.2. New Order Notification Email

In Enable Notification: choose Yes to enable notification email when a new order has been placed, or Not to disable it.

In Email Template: select email template for new order notification email. This module has a default email template but you can create your new email template to apply to this config. (Marketing → Email Templates)

In Email Receiver: enter email addresses to receive the notifications, the emails are separated by commas (,). This module supports sending multiple emails.

• Output Email (default template)

2.1.3. Low stock products

In Enable Notification: choose Yes to enable notification email when a product becomes low stock, or Not to disable it.

In Notify When Product Qty Falls Below: enter a number to set as low stock value. The notification email will be sent if product quantity falls below this value.

In Email Template: select email template for low stock notification email. This module has a default email template but you can create your new email template to apply to this config. (Marketing → Email Templates)

In Email Receiver: enter email addresses to receive the notifications, the emails are separated by commas (,). This module supports sending multiple emails.

• Output email (default template)

2.1.4. Order status change

In Enable Notification: choose Yes to enable notification email when order status has been changed, or Not to disable it.

In Email Template: select email template for order status change notification email. This module has a default email template but you can create your new email template to apply to this config. (Marketing → Email Templates)

In Status: select statuses that you want to receive email when order status change to what you selected.

In Email Receiver: enter email addresses to receive the notifications, the emails are separated by commas (,). This module supports sending multiple emails.

• Output email (default)

2.1.5. New review

You can customize this section the same as New Order Notification Email.

• Output Email (default template)

2.1.6. New customer registration

You can customize this section the same as New Order Notification Email.

• Output email (default template)

2.1.7. Customer newsletter subscription

You can customize this section the same as New Order Notification Email.

• Output email (default template)

2.1.8. Customer newsletter unsubscription

You can customize this section the same as New Order Notification Email.

• Output email (default template)

2.1.9. New wish list

The new wish list notification email will be sent only when customers add products to wishlist the first time. You can customize this section the same as New Order Notification Email.

• Output email (default template)

***Note: After setting, you need to press Save Config button to save your configuration then flush cache to start using the module.

2.2. Admin Action Log

2.2.1 General configs

Please go to Store ⇒ Configuration ⇒ BSSCommerce ⇒ Admin Action Log.

In Enabled: choose Yes to enable the module, or No to disable it.

In Automatically Clear Action Logs after…Days: enter a number (days) to set how long the log records will be deleted automatically.

In Enable Objects: Select objects to log actions related to.

2.2.2. Admin action log

2.2.2.1 Action Logs Grid

Please go to Amin Panel ⇒ Admin Action Log ⇒ Admin Logs Grid.

In Date column: the date and time when action is performed.

In User Name column: show user name of the admin.

In IP Address column: the IP Address of the corresponding admin user.

In Action Name column: full name of the action.

In Action Type column: display type of action, including Delete, Mass Delete, Save, Edit, Flush, View, Login, Print,…

In Object column: object of the action, this extension only logs actions related to objects selected in the General Configuration above.

In Specific Object column: the specific object was affected by the action.

In Result column: the result of the action, it can be “Success” or “Failure”.

In View column: click on “View” link to preview action log detailed page.

2.2.2.2. Action Log Details Page

The Action Log Details page displays:

• The general information of the action displayed in the grid
• A table shows all detailed information about the action, including:

+ Source data (it is the line Magento\Catalog\Model\Product in the screenshot above)

+ Name column: name of item attributes

+ Old Value column: the value of attributes before performing the action

+ New Value column: the value of attributes after performing the action. The changed value is highlighted to realize easily.

***Note: The table showing detailed changes in attribute value will be disabled for some action types such as Login, View, Flush, Delete, Mass Delete, Create,...

• Revert action

This extension allows you to revert actions affecting configs of System Configuration object change in case these modifications are incorrect. Please notice that you can only restore the changes of configs in Store → Configuration.

2.2.3. Login action grid

Please go to Admin Panel ⇒ Admin Action Log ⇒ Login Action Grid. The Login action Grid displays all login attempts of administrators to your store backend.

In Date column: the specific date and time when the user logins to the backend.

In User Name column: the name of the user who logins to the backend.

In IP Address column: IP address of the admin user.

In User Agent column: web-browsers that admin uses to login.

In Status column: the result of login action such as Success Failure, Auto Logout.

2.2.4. Page visit history

2.2.4.1. Page Visit History Grid

Please go to Admin Panel ⇒ Admin Action Log ⇒ Page Visit History The Page Visit History grid shows the browsing history of admins in each session.

In User Name column: the user name of the administrator.

In Full Name column: full name of admin account.

In IP Address column: IP Address of the admin user.

In Session Start column: the specific time when a session started.

In Session End column: the specific time when the session ended. In case the session is currently active, the Session End field will be blank.

In View column: link to Page Visit Details of each session.

2.2.4.2. Page Visit Details

Please click on “View” link in View column to see the Page Visit Details of a specific session. The first part is the general information displayed in the Page Visit History Grid.

A table lists all pages that the user visited in a session:

• In Page Name column: the title of the visited page
• In Page URL column: the URL link of this page
• In Stay Duration column: the duration time that the admin user stayed on the page.

2.2.5. Active session grid

Please go to Admin Panel ⇒ Admin Action Log ⇒ Active Sessions

The Active Sessions Grid lets you know who is online in your backend store.

In Login At column: specific date and time that user logins to the backend.

In User Name column: user name of the admin.

In Full Name column: full name of the admin.

In IP Address column: IP Address of the admin user.

2.2.6. Admin user roles

Please go to System ⇒ Permissions ⇒ User Roles, press Role Resources tab In the tree, mark the checkbox related to this module to allow the admin to access the module and action log pages, or don’t mark the checkbox related to this module to disable module settings and action log pages with the admin.

When complete, tap the “Save Role” button.

2.2.7. Email notification when quantity changes

2.5.1 General configs

In Enabled: set Yes to enable or set No to the module.

In Assign Orders with The Same Checkout Email to Customer: Choose Yes to enable this function and choose No to disable it. The logic of this config is presented as follow:

Config status	Customer behaviors	Result
Yes	Create an account right after the purchase using this button on the checkout success page:	The order gets assigned to the customer profile both frontend and backend.
Yes	Create an account using after the purchase using the button on the header:	Due to complications regarding time delay between orders and the relation with the invoice, credit memo,... outside of a sheer order => Currently, in this case, the extension doesn't support assigning orders with the same email to the new account.
Yes	Checkout using the registered email but not login	The order gets assigned to the customer profile both frontend and backend

• Config: Yes. The customer creates an account right after their purchase using the button => The orders get assigned to the customer profile both frontend and backend.
• Config: Yes. 

In Sync address, choose Yes to synchronize customer's address when the billing address and shipping address are the same.

In Auto Convert to Customer: there are 2 options to select.

+ If you set Yes, guests are automatically converted to real customers after they finish their checkout.

In Customer Group: select customer group to assign converted customers.

+ If you set No, guest users after checkout will be included in a Guest Management grid table. Then, you can make mass actions to assign them to customer groups. This action also means that you manually convert them to real customers and create accounts for them.

For guests placing orders before you install this extension, you can still import them to the Guest Management grid, and convert them into customers automatically or manually.

Accordingly, pick a period time to import guest in From and To.

Then, click Import button to import guests.

2.5.2. Guest Management

You go to Customers ⇒ Guest ⇒ Guest Management to check this table: If you want to convert any guest to a customer, you tick in the box and then choose Assign a Customer Group. Specific customer groups are displayed to select: After choosing customer group and submit the request by click OK in the popup, guests are converted to customers.

2.5.3. Notification email

In Enable Notification Email to Customer: choose Yes to enable this function or choose No to disable it.

In Email Sender: select one store email to send notification emails to customers. These emails confirm customer account information to login into store website.

In Email Templates: select email template. This extension provides a default email template and you can easily customize in Marketing ⇒ Communications ⇒ Email Templates.

After converting, new customers will receive an email with templates as configured:

2.6. Custom Order Number

Please go to Stores ⇒ Configuration ⇒ BSSCommerce ⇒ Custom Order Number

2.6.1. Custom order number configuration

In Enable: choose Yes to enable customized order number, or No to disable it (the order number is default order number).

In Number Format: enter a format containing letters, numbers as well as variables for the order number.

+ The variables that you can add to the order number format:

• {counter}: an incrementing number, is set up in the below configs.
• {d}: date with no 0 leading.
• {dd}: date, always has 2 digits
• {m}: month with no 0 leading
• {mm}: month, always has 2 digits
• {yy}: year with 2 digits
• {yyyy}: year with 4 digits
• {storeID}: ID of the Store that customer placed the order in. It should be used in case your website has multiple stores.
• {rndNumbers**}: random a number, replace ** by a number to set the padding for a random number. For example, you enter {rndNumber01}: the output of this variable will be the one-digit number, {rndNumber02}: the output of this variable will be the two-digit number...
• {rndLetters**}: random letters, replace ** by a number to set the padding of this variable. For example, you enter {rndLetter01}: the output of this variable will be one letter (a, b, c...), {rndNumber02}: the output of this variable will be two letters (ab, mn...)
• {rndAlphanumberic**}: random both number and letters, replace ** by a number to set the padding of this variable.
• Configuration of {counter} variable:
• In Start Counter From: enter a number to set which number the {counter} variable begins counting.
• In Counter Increments: enter a number to set the {counter} variable increases by for every new order made. For example, if you set the increments to 5 and the last counter number is 004, the next counter number will be 009.

***Note: After setting the new increments, you should reset the counter to be not confused when managing the order document.

• In Number Counter Padding: enter a number to set the total of digits for the counter number. For example, if the counter is at 9 and you set padding is 6, it would output 000009 (there are 5 numbers “0” added into the front of the counter number).
• In Reset Counter Number: choose an option to reset counter numbers automatically daily (By Day), weekly (By Week), monthly (By Month), yearly (By Year) or choose Never to never reset the counter.

***Note: This module will reset counter depending on the time of sever and please make sure that cron job in your website always operates (refer Configure and run cron in MagentoDev Docs).

• In Reset Counter Number Now: click on the Reset Now button to reset the {counter} variable immediately. It is just reset for the next increment number.

***Note: If your website has multiple store views, you can customize the order number for each store view.

In Configuration Store View, please select a store view. The config “Use Different Counter Numbers for Different Store Views” will appear.

In Use Different Counter Numbers for Different Store Views:

+ Choose Yes to use an individual sequence of the counter for each store view, which means each store view has own sequence. For example, your website has 2 store views A and B.The first order is placed in store A and the sequence of {counter} variable of order number in this store is 1. After that, an order is placed in store B and the sequence of {counter} variable also is 1, because it is not depended on the store A.

+ Choose No to use the sequence of the counter for all store views (like default). In case the below example, the sequence of {counter} of order number in store B is 2, not 1.

***Note: If the order number is duplicated, a random number will be added to this number.

2.6.2. Custom invoice number configuration

In Enable: choose Yes to enable the customized invoice number, or No to disable it (use the default invoice number).

In Similar to Order Number:

+ Choose Yes to use the invoice number same as the order number, which means that the invoice number will use the transaction the order number belongs to. You can replace letters part in order number format by other letters that are more suitable (you can’t replace the variable in order number format:

• In Replace Part of Order Number: enter a letters part of order number format that you want to replace it
• In Part of Order Number is Replace by: enter the letters that replace with the above part.

+ Choose No to not use the invoice number same as the order number. You can customize an individual invoice number like customizing order number above.

2.6.3. Custom shipment number configuration

It is the same as the Custom Invoice Number Configuration.

2.6.4. Custom credit memo number configuration

It is the same as the Custom Invoice Number Configuration.

***Note:

- Because the scope of the module configuration is store view, you can customize the numbers for each store view.

- After setting, you need to save your configuration then flush cache to start using the module.

2.6.5. Set User Role to manage the module

Please go to System ⇒ Permissions ⇒ User Roles ⇒ Role Resources. 

2.7. Auto Invoice

Go to Admin Panel ⇒ Store ⇒ Settings ⇒ Configuration ⇒ BSS COMMERCE ⇒ Auto Invoice.

In Enabled, choose Yes to enable the extension or No to disable it.

2.7.1. Select payment method

In Select Payment Methods, select one, multiple or all payment methods to apply auto invoice/shipment generation. When a customer has successfully placed an order, this order has the order state as "new".

Based on the "new" order state and the selected payment method, Magento 2 Auto Invoice extension will automatically export the order invoice.

This means some online payment methods such as PayPal, Credit Card...which create order state as "processing" and "pending payment" won't work for this logic of Auto Invoice for Magento 2 extension.

***Note:

• When customers use Amazon Pay with payment action Charge on Order, the module works as normal.
• However if the payment actions is Charge on Shipment, request to create Invoice will get denied by Amazon. Hence, our module does not support this payment action.

NEW: The Magento 2 Auto Invoice extension is now:

• Compatible with Klarna payment

• Compatible with Paypal express method with action: Sale, Order, Authorize

2.7.2. Enable automatic invoice/shipment generation

In Enable automatic invoice generation, choose Yes to enable the function then invoices will be generated automatically after orders are completed.

In Select capture status for online payment method(s), choose capture with auto invoice for online payment:
+ Capture Online: Once auto invoice is created, the amount captured will transfer from customers account to your business account.
+ Capture Offline: The order amount will not be processed via payment channel , invoice status = Paid
+ Not Capture: Orders that have not been paid, invoice status = Pending

In Attach PDF File To Invoice Email, choose Yes to add invoice PDF to invoice email. This config will show only when admin Enable Auto Invoice.

In Enable automatic shipment generation, choose Yes to enable the function then shipment will be generated automatically after orders are completed.

Remember that only when automatic invoice generation is enabled, can you enable automatic shipment generation.

In Attach PDF File To Shipment Email, choose yes to enable the function to add shipment PDF to email shipment. This config will show only when admin Enable Auto Shipment.

2.7.3. Invoice/Shipment confirmation email

If you enable both the automatic invoice and shipment generations, your customers will receive 3 emails after ordering completely: Order confirmation, Invoice confirmation, and Shipment confirmation.

Check email samples as follow: Invoice confirmation email

Shipment confirmation email

2.7.4. Select capture status for online payment methods

In the configuration panel, you can choose to the capture status up to 3 status:

• Capture Online
• Capture Offline
• Not Capture

2.7.5. Create order shipment independent with order invoice

You can create order shipment independent with the order invoice within the backend configuration. This comes in handy when you want more flexible with your work flow.

For example: You allow customers to pay after they receive their order.

2.8. Product Grid Inline Editor

2.8.1. General configs

Please go to Store ⇒ Configuration ⇒ BSSCommerce ⇒ Product Grid Inline Editor.

In Enabled: choose Yes to enable the module, or No to disable it.

In Allow Editing Content of Input Types: multi-select product attribute input types including Text Field, Text Area, Date, Yes/No, Multiple Select, Dropdown, and Price to allow editing in the grid.

***Note:

• If the Date input type is allowed editing, the default format in the grid for you to customize is mm/dd/yyyy.
• Quantity is considered as Text Field input type, so you can edit product quantity only when the Text Field is picked.

In Edit Multiple Rows: choose Yes to allow editing multiple rows (products) in the grid at once, or No to not allow.

In Edit Single Cell: choose Yes to only edit a cell is clicked at once, or No to take action on all editable fields in a row.

***Note: Edit Multiple Rows and Edit Single Cell function can’t work together. If you turn both configs to Yes, only Edit Single Cell function will be enabled. Although Edit Multiple Rows is Yes, you are not allowed to take action on multiple rows.

After selecting all configs, press Save Config button, and flush cache to start using this module.

2.8.2. Edit Attributes in the admin product grid

Please navigate to Catalog ⇒ Products, the admin product grid is displayed on this page. You can add columns (both default and custom columns) to product grid.

2.8.2.1 Edit a product in a row

To edit a product that is displayed on a particular row, please click on the row (except first tick-box and links).

The selected row is enabled and the editable information and attributes are included in boxes, which are available for you to change their values. After editing, you need to hit one of the following buttons to complete:

• Cancel: cancel all your recent adjustments on this row, and all values in the row won’t be changed.
• Save: save your changes.

***Note: You are not allowed to:

• Edit Quantity of these product types: configurable, grouped, and bundle product.
• Edit cells in Price attribute input type of these product types: configurable product, grouped product, and bundle product with dynamic price.
• Edit ID, Thumbnail, Type, Attribute Set, Websites, Action (link) of all product types.

2.8.2.2. Edit multiple rows

To edit multiple rows at once, please follow this instruction:

Step 1: Choose a row

Step 2: Select other rows to be edited together by checking box, an additional row including editable boxes that are correlative to the selected rows will be enabled.

Step 3: enter the custom values to the All in Column boxes

Step 4: Choose Apply button in the additional row to apply new attribute values to all chosen products.

Step 5: Choose Save Edits or Cancel button to complete.

***Note: You can edit multiple products in different types, but the new values can be applied to only allowed editing input types.

2.8.2.3. Edit a single cell only

When you set to allow editing single cell only, you need to click on the cell you want to edit and enter the new value, then press Save button.

***Note: With MSI:

• You can edit multiple source quantity and status via popup under Edit Single Cell type only.
• Can not work with Edit Multiple Rows type.
• All enabled Sources will be displayed in the popup (including unassigned Sources); when a Source's quantity is edited, that Source will automatically be assigned for the product.

2.9. Duplicate CMS Page/Block

After completed installing, “Duplicate Button” will appear immediately in Content, as below:

• In Grid View

In Grid View, you can duplicate with “duplicate button” in the right action-column.

Besides, you are able to duplicate mass Pages/Blocks in the grid view. Firstly, you choose Pages or Blocks which you want to duplicate. Then, you click on “Duplicate Button” in the left Action column.

• In Detailed Page/Block

In the detailed view, “Duplicate button” appears on the menu bar.

A successful message will be displayed after the duplicating process.

After being duplicated, the status of your new CMS Page and Block is Disabled, but you can change to “enable” at any time.

A new URL key and Identifier is automatically generated for your duplicated Page/Block. Additionally, you can freely change the URL key or Identifier for your purpose.

• URL Key in CMS Page

• Identifier in Block

2.10. Delete Order

2.10.1 Delete orders

Please go to Sales ⇒ Orders, a list of all orders will be shown as usual. Tick on the checkbox of unwanted order(s) and choose the action Delete Orders in Select Items box.

Then a pop-up will appear for action confirmation. Select OK to completely delete the order(s).

You can also delete orders from Order View Page by choosing Delete button in the Information tab of a particular order.

***Note:

• You can delete many delete orders at a time by ticking on their checkboxes.
• Once you delete an order, it would be removed permanently from the system and could not be restored. You’d better do it carefully.
• When an order is deleted, all of its related information like shipment, invoice, credit memo will be erased too.

2.10.2. Delete invoices

Go to Sales ⇒ Invoices and select Invoices you want to wipe out of the backend and then choose Delete Invoices in Select Items box. After that, a popup appears and you click OK to confirm removing these selected Invoices.

After Invoices are deleted, order status turns back to Pending (if shipments have not been created) or Processing (if shipments have already created). Credit memos are also removed. Invoices can be also recreated.

You can also delete invoice of a particular order in its Order View Page by going to tab Invoices, click on Delete button or choose Delete Invoices in Actions dropdown box.

2.10.3 Delete shipments

Similar to deleting orders and invoices, we can erase unneeded shipments by navigating to Sales ⇒ Shipments and select Shipments that you want to rub out. Then, you choose Delete Shipments in Select Items box and press OK in the confirmation popup to finish the process.

Similarly, you can delete shipment from Order View Page under Shipments tab by clicking on Delete button or choose Delete Invoices in Actions dropdown box.

When a shipment is removed, its order status is updated to Pending (if invoices have not been created) or Processing (if invoices have already been created). Admin can totally recreate shipments.

2.10.4. Delete credit memos

Like Invoices and Shipments, there are two ways to remove redundant Credit memos:

• Go to Sales ⇒ Credit memos, select unwanted Credit memo(s), choose Delete Credit memos in Select Items box, then click OK in the popup to completely exclude them from the backend.
• Under Credit Memos tab in Order View Page of a particular order, click on Delete or select Delete Credit Memos in Actions dropdown box.

Order Status is altered to Complete (if invoices and shipments have already been generated) or Processing (if only invoices have been created). Credit memos are easily recreated.

2.11. Reindex from the Backend

Please go to Stores ⇒ System ⇒ Index Management and start configuration.

Choose the Indexers which you want to reindex.

In Action box: Choose Reindex Data.

Choose Submit to complete.

2.12. Custom Product Attribute Export

Please go to Stores ⇒ Configuration ⇒ BSSCOMMERCE ⇒ Product Export Column and start configuration.

In Enable: Choose Yes to enable the module or choose No to disable it.

In Allowed Attribute: Choose the custom product attributes which you want to be in separate columns when exporting products.

After that, move over to System⇒ Data Transfer ⇒ Export.

In Entity Type, select Products.

After that, scroll all the way to the end of the page and click Continue to export your product with custom attributes seperated.

***Note: For Magento 2.3.2, the export is processed under the backend. You need to set up Cron and wait for the export process complete and then check exported file by navigating to System ⇒ Export.

2.13. Disable Compare

Please go to Stores ⇒ Configuration ⇒ BSSCommerce ⇒ DisableCompare.

In Disable, choose Yes to remove all functions related to Compare. This action will:

• Remove the Compare button on the Widget, Category Page, Search Result Page, and Product Page.
• Remove Compare at the bottom of Layered Navigation.
• Remove Compare next to the Search Box (if you previously added one or more products to Compare)
• Remove Compare in the Related, Upsell, Cross-sell Products.

When you select No, Compare functions will work normally.

1. Overview

Magento 2 Convert Images to WebP extension allows Magento store owners to change all images in the format: jpg., png., jpeg. to webp. This action aims to optimize the speed loading and image quality of your website.

2. How Does It Work? 

2.1. General Settings

Please go to Stores ⇒ Configuration ⇒ BSS COMMERCE ⇒ Convert Image Webp ⇒ General Configuration.

• In the Enabled section, choose:

- Yes: Enable Magento 2 Webp online converter module. It starts the automatic conversion of Webp image display in the frontend.
- No: Disable the module. You don't want the automatic conversion and display of Webp images in the frontend.

• Quality: The higher this value is, the higher the image quality will become. Our Webp quality default is 75.

* Note: This configuration can only be applied when uploading images or running commands, which means that the Webp image quality displayed on the frontend will not depend on this value.

• Image CDN: If you use image CDN, enter the CDN URL into this field to enable its compatibility with the module.
• Convert Images inserted via Page Builder: Choose Yes to enable converting images in Page Builder (banner, slider, image, product listing) to Webp format.

*Note:
- If you enable both this config and the Auto Generate on First Page Loading config, the module will convert Page Builder images on the first page load. From the second page load,
- The more images in the Page Builder, the slower the speed on the first page loading time.

• Skip Folders:  You can pick the image folders that you do not allow automatic conversion to Webp images in the frontend. Enter the relative path of an image in its original format (jpg, png..).

• Auto Generate on First Page Loading: Choose "Yes" to automatically convert images to webp format when loading pages that have images in jpg, jpeg, or png format. Choose "No" to keep images in jpg, jpeg, or png format. This config can be enabled to convert images from before installing this module without having to run cmd to convert.

• Clear All Webp Images: Delete all webp images that the module generated (used when updating new quality)

*Note: In case you want to update quality using command, you can run php bin/magento bss_c_i_w:convert [<path>] [<quality>], with [<path>] is the image location and [<quality>] is the new quality index. (e.g. php bin/magento bss_c_i_w:convert pub/media 80). With this cmd, you would not need to wait for the system to delete old webp images.

 

2.2. Choose the place on-site to convert to webp images

Magento 2 Convert images to webp enables you to choose the pages you want the webp image online converting. There are 4 main places: Product Page, Category Page, Home Page, CMS Page.

Product Page

• Switch Enabled to Yes to enable the process of converting images to webp automatically at the Product Pages.
• Ignore IDs Products: For Product IDs inputted here, in the frontend, images in those product pages will be shown in the original format.
• Ignore Images: Input the image name in the original format. It's possible to input many images, each of them is separated by commas. The inputted images will be shown in the original format. This configuration is used when admin wants to display images with full size and quality on the frontend, which does not require to convert images into .webp format.

* Note: In case you upload an existing image, Magento will auto-change the image name. So, please make sure to input the exact image name.

The same configurations are applied to the other page types.

Category page

Home Page

CMS Page

 

*Note: The module does support converting child items' images of configurable products on the product listing page when user click on it. However, if there are too many variants, it could affect badly on the user's loading speed on the first page loading time.

1. Overview

Store owners desire to classify products into multiple categories to make it convenient for customers and for admin to manage products more easily. With products that store owners want to sell more, allowing special attributes to appear on multiple positions on the product page is a great way to attract customers. 

Magento 2 Custom Attribute Position is an amazing extension that supports you to do that. This module allows showing product attributes on the optional positions on the product page. Furthermore, this feature can be customized following the store view.

2. How Does It Work?

This module is easy to use. You just take 1 minute to get this feature. Follow the below-detailed steps:

Please go to Stores ⇒ Configuration ⇒ BSSCOMMERCE ⇒ Custom Attribute Position and start the configuration.

In Enable, choose Yes to enable the module, otherwise choose No.

In Custom Attribute Position, you can set up the position of product attributes with 4 configs:

• 'Attribute Code' (required): Type the attribute code (You can check in Product section: Admin > Store > Attributes > Product)
• 'Custom Position' (required): Choose the frontend block class that you want the product attribute to display in the frontend.

How to get the frontend block class:

Step 1: Go to frontend product page, open devtool window (F12 or Right-clicked on the block to ‘Inspect’ it.)

Step 2: Ctrl + Shift + C (Or click on the mouse icon in the upper left corner of the Inspect table) -> click on the class you want to display

Step 3: Copy class name or id 

Step 4: Convert to JQuery selector.

Example: <div class="page content"> => 'div.page.content'

• Add roll

• Remove roll

In Apply product type, choose the product types that you want to apply this feature to.

In Attribute CSS, set up CSS for displayed attributes.

*Notes:

- Attribute still displays without config " Visible on Catalog Pages on Storefront: Yes". It will appear in both Default Magento and module CAP positions if displayed.

- 1 attribute can be displayed in multiple positions and vice versa. 

1. Overview

By limiting the order quantity per product, store owners can manage the inventory quickly and achieve business sale margin at all time.

Limit Order Quantity Per Product For Customer Group is a key to getting these benefits. This module allows the admin to specify minimum and maximum order quantity per product for specific customer groups.

2. How Does It Work?

You need to configure 2 sections in the backend.

Firstly, please go to Store > Configuration > BSS Commerce > Limit Order Qty Per Product For Customer Group > General Configuration.

In Enable, choose Yes to enable the module, otherwise choose No.

After enabling the module, let’s follow the following steps to complete the setting:

• Go to Catalog > Products > Edit (Create New)

(At this step, you select each product from the product grid table to configure it)

• On the editing product page, click on Advanced Inventory.

• In Minimum Qty Allowed in Shopping Cart Per Customer Group config:
  • Enter the minimum product quantity number you want the customer to have in the shopping cart in the Quantity column.
  • In Customer Group column, select one to apply the condition.
  • You can add more conditions by clicking the Add button.
  • Remove the condition by clicking the Delete button.

• In Minimum Qty Allowed in Shopping Cart Per Customer Group config:
  • Enter the maximum product quantity number you want the customer to have in the shopping cart in the Quantity column.
  • In Customer Group column, select one to apply the condition.
  • Add or Delete the conditions with the available buttons.

• Then Save the configuration and repeat this process for other products.

3. Import Min/Max Quantity

Please go to System > Data Transfer > Import.

In the Entity Type dropdown, choose BSS Limit Order Import.  Then click Download Sample File to download and edit the import file.

In the Import Behavior dropdown, choose the import behavior you want:

• Add/Update: If there isn't data before, the min/max quantity will be added. If there is, the min/max quantity will be updated. In case the old data. If the old data has more than one version for 1 customer group, it will be updated to only 1 version. If the new data has more than one version for 1 customer group, it will be changed to the new one.
• Replace: Delete all old data and save the new data.
• Delete: Save new data after removing old data from csdl.

Finally, scroll down to the File to Import section, in Select File to Import, click Choose File button and choose your import file.

4. Version

• Version 1.0.0: First Release
• Version 1.0.1: Update the import min/max quantity feature

*Note:

• The rules apply to simple products and child products of bundle/configurable/grouped products only.
• When you enable the min/max quantity of both the default and the module, the module's logic is applied.
• In Minimum qty configuration, if you set multiple quantities for one customer group, the condition applies the minimum value. The same rule applies for multiple max values.

1. Overview 

Magento 2 Convert Existing Account to Sub User (Addon) allows the store admin to switch a normal account to be a sub-user of a particular company account. 

This add-on works closely with Magento 2 Company Account extension to provide a complete solution for gathering access of all staff within an organization under a single account for easy management. 

SAVE Your Detailed List of B2B Account Management Features for Magento 2 Here! 

2. How Does It Work? 

2.1. In the Backend

The add-on works very simply. For any existing customer that you (as the store admin) want to turn into a sub-user of a company account, you just need to go to Customer Grid and go to the detail page of that customer. 

As long as this customer is not a company account, you will see a tab at the bottom of the Customer Information section called “Assign as Sub-user”.

In this tab, you will see a list of company accounts that you can assign this customer to be a sub-user of. Please choose the company first, then the equivalent roles will be automatically loaded for you to choose from. 

After this customer has been assigned, you will see them in the list of sub-users of this company account. 

2.2. In the Frontend

After the customer has been assigned as a sub-user, they will receive an email saying their account has been successfully transferred. All their former attribute information will be deleted but their orders will be kept.

Now when logging into their account, they will see the information of their company account and take some actions that their role allows them to. 

If you need help using this add-on, please feel free to reach us via sales@bsscommerce.com.

1. Overview

Magento 2 Maximum Order Quantity per Product extension lets you set restrictions on the maximum quantity of each product that your customers can buy within a calendar month. Hence, you can make better inventory planning and avoid sending order rejection emails to customers. 

2. How Does It Work? 

2.1. In the Backend

As this extension allows you to set restrictions on two levels on configuration, with product config having higher priority than global config, we will look at them respectively. 

First of all, please go to Stores → Configuration → BSS Commerce → Order Restriction and set Yes to Enable our module. 

2.1.1. Global Config

Please go to Stores → Configuration → Catalog → Inventory → Product Stock Options.

In the Limit Product Quantity per Month field, uncheck the Use System Value checkbox, and enter the global limit that you want to set as the maximum order quantity within a calendar month for all products. Do not forget to hit Save. 

*Note: If you leave this field blank, then there will be no global limit for all products. 

2.1.2. Product Config

If you want to set a special limit for any specific product, please go to that product detail page then expand the Advanced Inventory section. 

In the Limit Product Quantity per Month field, uncheck the Use Config Settings field, and enter the maximum order quantity per month for this product. 

*Note: If you leave this field blank, then there will be no limit for this product. 

2.2. In the Frontend

When customers order a product with a quantity greater than the limit (first time in the month) or the remaining limit (second time and forth), they will receive an error message. 

2.2.1. When placing an order with surpassed quantity on the product page

2.2.2. When updating quantity to more than the available limit in the shopping cart

In mini cart

In shopping cart

If you change the limit of any product within the month or prioritize the product config over general config, then the limit will be automatically adjusted. Also, if an order is canceled or refunded, like with the case of inventory being added back, the limit will be adjusted accordingly.

Overview

Magento 2 B2C package by BSSCommerce is the complete retail solution to help your site sell better, bigger, and easier. 

The package contains 5 quintessential modules:

• Magento 2 SEO extension
• Magento 2 Popup extension
• Magneto 2 One Step Checkout extension
• Magento 2 Guest to Customer
• Magento 2 Social Login extension

I. Magento 2 SEO Extension

Please go to Store ⇒ Configuration ⇒ BSSCOMMERCE and start configuration.

1.1. In SEO Core

In Enable Custom H1 Page: Choose Yes to enable or No to disable this function.

When you choose Yes, you go to the Search Engine Optimization of each category, CMS or product edit page to enter a customized Heading 1.

This feature is very useful for store owners in specific cases.

For example: you run a promotion for a product A and want to place an eye-catching Heading 1 without changing the product name (the H1 as the default setting), you can enter a custom H1 like “Hot Deal 50% OFF Strive Shoulder Pack | Today Only”. Customers now see the new heading on the product page replacing the original heading 1. However, the product name is unchanged anymore and is still displayed in the shopping cart and checkout page.

In Google Site Verification Code: If you are using Google Search Console, you need to enter the code provided by Google. This helps the module to show you impressions, clicks, CTR,... from Google Search Console.

For example:

• Meta tag provided by Google as below:

<meta name="google-site-verification" content="_rHp4oQoxOfKF8VN85ZiKWEZO_5ThgO8r7HaIKKJ0eI" />

• You enter this code to the field: _rHp4oQoxOfKF8VN85ZiKWEZO_5ThgO8r7HaIKKJ0eI

In Bing Verification Code: Bing also provides verification code as meta tag.

For example:

• Meta tag provided by Bing as below:

<meta name="msvalidate.01" content="9FD50240145DBB177642FF639FD4A222" />

• You enter this code to the field: 9FD50240145DBB177642FF639FD4A222

1.2. In Rich Snippets

In Enable: Choose Yes to enable the feature or choose No to disable it.

1.2.1. Site Structure

In Sitename in Search Result: Choose Yes to show the website name you assign in the search result, otherwise choose No. If you choose No, the Show Search Box in Search Result will be disabled.

In Website Name: Choose the name for your website to be displayed in the search result.

In Website Description: This description is applied to all pages as a default one (excepted for product and category pages).

In Website Image: Choose an image for your website to be displayed when sharing via Open Graph on Facebook and via Twitter Card on Twitter.

In Show Search Box in Search Result: Choose Yes to show a specific search box for your website, otherwise choose No.

In Twitter Username: Enter Twitter Username with @ to support Twitter card.

In Show breadcrumbs: Choose Yes to show breadcrumbs (show navigation path) of product pages instead of the regular URLs in the search result, otherwise choose No.

1.2.2. Local Business

In Enable Local Business: Choose Yes to show the following information of your website in the search result, otherwise choose No. If you choose No, all the following settings will be disabled.

In Business Type: Select your suitable business type from the drop-down list.

In Logo: Choose a logo of your business.

In Name of Business: Choose a name for your business to be displayed in the search result.

In Email: Enter your business email.

In Telephone: Enter your business phone.

In Price Range: Enter the price range of your business.

In Locality: Enter the locality of your business.

In Street Address: Enter your business street address.

In Country: Enter country of your business in two capital letters following ISO 3166-1 alpha-2 country code.

In Post Code: Enter your business post code.

In Social Profile Links: Enter your business social profile links. Please enter one link per line.

⇒ For more information about these store properties, explore HERE!

1.2.3. Product Options

In Show Name: Choose Yes to show the product name in the search result, otherwise choose No. If you choose No, all the following settings will be disabled.

In Show SKU: Choose Yes to show the product SKU in the search result, otherwise choose No.

In Show Image: Choose Yes to show the product image in the search result, otherwise choose No.

In Show Description: Choose Yes to show the product description in the search result, otherwise choose No.

In Show Review: Choose Yes to show the product review in the search result, otherwise choose No.

In Show Avg. Rating: Choose Yes to show the product average rating in the search result, otherwise choose No.

In Show Price: Choose Yes to show the product price in the search result, otherwise choose No.

In Show Availability: Choose Yes to show the product availability (in stock/out of stock) in the search result, otherwise choose No.

In Show Conditions: Choose Yes to show the New condition of products. We support the New attribute to appear in the search result.

In Add Category: If you choose Enable, the category path is added to the product URL displayed in SERPs.

In Add Brand: Select an attribute code of the brand to appear in the search result.

In Add Gtin: Select a GTIN to display in the search result.

In Custom Properties: Customize any Rich snippet and assign it to an attribute. You need to enter custom properties following the Rich snippet structure. Otherwise, you face issues when checking your website on Google Structured Data Testing Tool.

1.2.4. Category Options

In Show Name: Choose Yes to show the category name in the search result, otherwise choose No. If you choose No, all the following settings will be disabled.

In Show Description: Choose Yes to show the category description in the search result, otherwise choose No.

In Show Product Offers: Choose Yes to display offers of products in the search result, otherwise choose No.

In Show Image: Choose Yes to show the category image in the search result, otherwise choose No.

1.2.5. Open Graph

In Enable for Product Page: Choose Yes to enable Open Graph when sharing Product Pages via Facebook, otherwise choose No.

In Enable for Category Page: Choose Yes to enable Open Graph when sharing Category Pages via Facebook, otherwise choose No.

In Enable for Website: Choose Yes to enable Open Graph when sharing your homepage via Facebook, otherwise choose No.

1.2.6. Twitter Card

In Enable for Product Page: Choose Yes to enable Twitter Card when sharing Product Pages via Twitter, otherwise choose No.

In Enable for Category Page: Choose Yes to enable Twitter Card when sharing Category Pages via Twitter, otherwise choose No.

In Enable for Website: Choose Yes to enable Twitter Card when sharing your homepage via Twitter, otherwise choose No.

1.3. Google XML Sitemap

To configure XML sitemap for your Magento 2 store, please follow these 2 steps:

• Step 1: Configure the extension settings as your wishes at Stores ⇒ Configuration ⇒ BSSCOMMERCE ⇒ Google XML Sitemap.
• Step 2: Create a new XML sitemap at Marketing ⇒ Google XML.

First, we will show you how to configure the feature settings.

1.3.1. General Setting

In Enables: Choose Yes to generate an XML Sitemap.

In Frequency: Choose the frequency for the extension to update the sitemap. The options are Daily - Weekly – Monthly.

In Error Email Recipient: Choose the recipient to receive an error email once there is an error.

In Error Email Sender: Choose the name of the sender displayed in the error email.

In Error Email Template: Choose the template for error email.

In Root Path: Specify a root path for the XML sitemap.

In Sitemap Title: Enter a title for the sitemap.

In Sitemap Description: Enter a description for the sitemap.

1.3.2. Homepage Options

In Show Homepage: Choose Yes to show homepage in the XML sitemap, otherwise choose No to hide it.

In Frequency: Choose the frequency for the search engine crawlers to index Homepage. The options are: Always - Hourly - Daily - Weekly - Monthly - Yearly - Never.

In Priority: Choose the priority for the search engine crawlers to index Homepage. Valid values range from 0.0 to 1.0.

In Enable Modify: Choose Yes to show the time of the latest modify of the homepage in XML sitemap file, otherwise choose No to hide it.

1.3.3. Categories Options

In Frequency: Choose the frequency for the search engine crawlers to index category pages. The options are: Always - Hourly - Daily - Weekly - Monthly - Yearly - Never.

In Priority: Choose the priority for the search engine crawlers to index category pages. Valid values range from 0.0 to 1.0.

In Disable Category and All Products on Category: Fill in the ID of categories you want to hide from sitemap (separated by a comma). All products in selected categories will be hidden as well.

* Note: You can exclude categories from the XML sitemap by configuring it in each category edit page. Once you set Yes for this configuration, the category is listed in the Disable Category and All Products on Category config.

1.3.4. Product Options

In Enable Path: If you choose Yes, the Use Categories Path for Product URLs config is also enabled. This config is found by going to Stores ⇒ Configuration ⇒ Catalog ⇒ Catalog⇒ Search Engine Optimization ⇒ Use Categories Path for Product URLs.

In Frequency: Choose the frequency for the search engine crawlers to index product pages. The options are: Always - Hourly - Daily - Weekly - Monthly - Yearly - Never.

In Priority: Choose the priority for the search engine crawlers to index product pages. Valid values range from 0.0 to 1.0.

In Add Images to Sitemap: Choose how you want to add the images of products into your XML sitemap. There are 3 options:

• No: Do not add images to the sitemap.
• Base Only: Only add base images of products into the sitemap.
• All: Add all images of products into the sitemap.

In Disable Product Type: You can choose to hide all products belong to (a) product type(s) from the sitemap.

In Disable Product: Fill in the ID of products you want to hide from sitemap (separated by a comma).

* Note: You can exclude products from the XML sitemap by configuring it in each product edit page. Once you set Yes for this configuration, the product is also listed in the Disable Products config.

1.3.5. CMS Page Options

In Frequency: Choose the frequency for the search engine crawlers to index CMS pages. The options are: Always - Hourly - Daily - Weekly - Monthly - Yearly - Never.

In Priority: Choose the priority for the search engine crawlers to index product pages. Valid values range from 0.0 to 1.0.

In Disable CMS Link: Choose CMS links to be disabled from the XML Sitemap.

1.3.6. Additional Link List

In Frequency: Choose the frequency for the search engine crawlers to index additional links. The options are: Always - Hourly - Daily - Weekly - Monthly - Yearly - Never.

In Priority: Choose the priority for the search engine crawlers to index additional links. Valid values range from 0.0 to 1.0.

In List of Additional Links: Fill in the list of additional links to be shown in the sitemap.

1.3.7. Sitemap File Limit

In Divide Sitemap: There are 4 options for dividing sitemap:

• None: Do not divide sitemap.
• Date: Divide site map by the last modified date of the products.
• Category: Divide site map by the products in the same category.
• Manufacture: Divide site map by the products with the same manufacturer. The sitemaps are arranged based on the following sort order:

1: CMS Page Link + Category Link

2: Product Link

3: Additional Link

* Note: Dividing the sitemap still follows the maximum number of URLs per file and maximum file size settings.

In Maximum No of URLs per file: Maximum number of URLs in an XML sitemap file.

In Maximum File Size: Maximum file size in byte.

1.3.8. Search Engine Submission Settings

In Enable Submission to Robots.txt: Choose Yes to display XML Sitemap URL in Robots.txt file, otherwise choose No.

1.3.9. Generate Sitemap

After finishing setting up the extension, the admins will generate a sitemap that will be created following the above settings.

Please go to Marketing ⇒ Google XML Sitemap, select Add Sitemap to create a new sitemap.

In File Name: Choose a name for the sitemap. The format is nameofthesitemap.xml.

In case you are already using an XML sitemap, there would be 2 options at this point:

• Create a new sitemap with a different name from the old sitemap. You can submit both sitemaps on Google Search Console and the crawler will read both file.
• Delete the old sitemap then create a new one with the same name as the old. The new sitemap following the module setting will be overwritten on the search console and will not affect SEO.

In Path: The default path is “/”. If you want to use a different path, you have to create a new folder at the backend.

Choose Save.

After saving the sitemap, click Generate for the sitemap to be created following the module settings.

1.3.10. Edit and Delete Sitemap

Please go to Marketing ⇒ Google XML Sitemap, select the sitemap you want to edit or delete.

In the Name, Path and Store View section, you can change the name, path and store view of the XML Sitemap. Click Save and Generate to finish the change.

Click Delete to delete the sitemap.

To reset the sitemap, click Reset and then click Save. Back to the main section, and click Generate to finish.

1.4. In HTML Sitemap

1.4.1. General

In Enable: Choose Yes to enable the feature, otherwise, choose No.

In HTML Sitemap URL Key: Enter a URL key for the sitemap.

*Note:

• URLs of the sitemap are different per store:

For example, the URL key of the sitemap in store A is store-a and the URL key of the sitemap in store B is store-b. When customers access the sitemap of store A, then switch to store B, customers are redirected to the sitemap in store B under the right sitemap URL of store B.

• Enter special characters to URL key or any spaces:

After saving configs, these special characters or spaces are auto removed and replaced by the dash(-).

In Title of Site: Choose the title for the sitemap.

In Show Link at: Select Footer or Header where the sitemap link is displayed.

In Session Order: Fill in the order of sessions to be displayed. Please fill in all 4 items separated by a coma. The ID of sessions as below:

• 1: Product List
• 2: Store View List
• 3: Additional Link List
• 4: Category and CMS Page List

1.4.2. Search Engine Optimization

In Meta Title: Choose the meta title for your sitemap.

In Meta Keywords: Choose the meta keywords for your sitemap.

In Meta Description: Write meta description for your sitemap.

1.4.3. Product List

In Show Product Link: Choose Yes to show product links in the sitemap, otherwise, choose No.

In Title of “Product List”: Choose the title for the product list session in the sitemap.

In Sort Product by: Choose among DESC for descending or ASC for ascending.

In Arrange Product by: Choose Name/Date/Price to sort product links.

In Maximum Products Displayed on Sitemap: Choose the maximum for the number of product links to be shown. The limit number you can fill in is 50000.

* Note: You can exclude products from the HTML sitemap by configuring it in each product edit page.

1.4.4. Store List

In Show Store View Link: Choose Yes to show store view links in the sitemap, otherwise choose No.

In Title of “Store View List”: Choose the title for the store view list session in the sitemap.

1.4.5. Category List

In Show Category Link: Choose Yes to show category links in the sitemap, otherwise choose No.

In Title of “Category List”: Choose the title for the category list session in the sitemap.

In Disable Category: Fill in IDs of categories you want to hide in the sitemap (separated by a comma). For example: 1,2,5,9,23,45,77.

* Note: You can exclude categories from the HTML sitemap by configuring it in each category edit page. Once you set Yes for this configuration, the category is listed in the Disable Category config.

1.4.6. Additional Link List

In Title of “Additional Link List”: Choose the title for the additional link list session in the sitemap.

In List of Additional Links: Choose the links and the anchor you want to display for each link. Follow this example: [http://yourlink1.com][Anchor Text 1].

In Open Additional Link in a New Tab: Choose Yes to open additional links in a new tab, otherwise choose No.

1.4.7. CMS Link List

In Show CMS Link: Choose Yes to show CMS links in the sitemap, otherwise choose No.

In Title of “CMS List”: Choose the title for the CMS link list session in the sitemap.

In Disable CMS Link: Choose the CMS links you want to hide from the sitemap. Hold Ctrl when choosing multiple options.

1.5. Robots Meta Tag

In Enable: Choose Yes to enable the feature or choose No to disable it.

In Robots Meta Tag: Enter URL Pattern based on the following formats.

• With single Category Page or Product Page: enter the URL key. For example: your product page URL is http://yourdomain.com/teton-pullover-hoodie.html. Then URL key is teton-pullover-hoodie.
• With categories or a folder: Enter the path with "/" before and after the path

For example: You want to set NoIndex and Nofollow for all categories with the "tops-men" URL key. Please enter: /tops-men/

In Option: There are 3 options for you to choose, which is INDEX, NO FOLLOW – NOINDEX, FOLLOW and NOINDEX, NOFOLLOW.

In NOINDEX, FOLLOW Robots Meta Header: Choose pages to set up No Index, Follow Tag.

Edit custom instruction of robots.txt File: enter your custom instruction of robot.txt file (if any). You can learn how to write a robot.txt file here. If you leave this field blank, file Robots.txt will run with the default Magento setup.

1.6. Canonical Tag

In Enable: Choose Yes to enable the feature or choose No to disable it.

1.6.1. Canonical Tag for Homepage

In Use Another Url for Homepage: Leave it blank if you want to use the default Canonical Tag for Homepage. Fill in the URL path if you want the crawler to read that URL instead of the homepage.

This config is also included in the Search Engine Optimization section of the Homepage edit page.

1.6.2. Canonical Tag for Product

In Canonical for Product: There are 2 available options:

• Use Short Url Path: Set the Canonical Tag on the shortest product URL. Here is an example: http://yourdomain.com/product.html
• Use Long Url Path: Set the Canonical Tag on the longest product URL. If the product belongs to multiple categories at the same category level, the applied category will be the last category in the Categories section on Catalog management of the product. Take the below image as an example, the applied category will be Jackets.

In the Search Engine Optimization section of each product edit page, you can also specify another URL for the Canonical tag.

1.6.3. Canonical Tag for Category

In Use Next/Previous Tag in Category: Choose Yes to enable canonical for Next/Previous Tag in categories or choose No to disable it.

In Add Canonical Tag to Layered Navigation:

• Choose Yes: Canonical URL is the URL of the original category.
• Choose No: Canonical URL is the URL corresponding to parameters.

In the Search Engine Optimization section of each category edit page, you can also specify another URL for the Canonical tag.

1.7. Advanced Breadcrumbs SEO

In Enable: Choose Yes to enable the feature or choose No to disable it.

In Type of Breadcrumbs: There are 2 available options:

• Use Long Url Path: Set the breadcrumbs to be the FULL path of a product or a category
• Use Short Url Path: Set the breadcrumbs to be the SHORTENED path of a product or a category. Now, you need to configure Enable Category Priority to show the shortened path (Noted: Type of Breadcrumbs config has higher priority than Enable Category Priority config.)

The Breadcrumbs for Product A will be Home ⇒ Jacket ⇒ Product A. You can take a look at the image below.

If the product belongs to multiple categories with the same category level, the applied category will be the last category at the Categories section on Catalog management of the product.

In Enable Category Priority: Choose Yes to enable category priority or No to disable it.

To manage category priority, please go to Marketing ⇒ BSS Commerce SEO ⇒ Advanced Breadcrumbs.

• ID: show the ID of the category. In this section, all available categories of your site will be listed.
• Path: show the path of the category.
• Level: show the category level. Only categories whose the category level is greater or equal 2 can be applied breadcrumbs
• Priority: fill in the ID of the prior category (to prevent your breadcrumb from rendering wrongly, you shouldn't fill the Priority ID with 1 or 2 - any other number is fine.) Take a category with ID= 5 and the path of 1/2/3/5 as an example. If you fill in the priority as 3, Breadcrumbs of category 5 and all of its belonging products will be displayed with breadcrumbs of category 3 as the priority.
• The default table has no priority set up and the system will automatically show the full breadcrumb path accordingly. Once you edit the value of the priority config, you must enter a number or Cancel to get back to the original value. From here, you can't leave this field empty anymore.

1.8. Redirect 301 SEO

1.8.1. General

In Enable: Choose Yes to enable the feature or choose No to disable it.

1.8.2. Redirect 301 SEO

This setting only applies to deleted product pages.

Here are examples of deleted product links:

http://yourdomain.com/catalog/product/view/id/1401/category/23

http://yourdomain.com/product.html

http://yourdomain.com/category/product.html

In Default Redirect to: Set the default page for the 301 pages to be redirected to. These are the options for the destination of redirecting: Parent Category, Parent Category with Priority, Homepage, and Other CMS Pages.

• In case of choosing Parent Category, when a product is deleted, the links of that product will be redirected to the nearest parent category of the product.
• In case of choosing Parent Category with Priority, redirects work similarly to the option of Parent Category. However, if the destination category is set up for a priority in ID in Marketing ⇒ BSS Commerce SEO ⇒ Advanced Breadcrumbs, the links of that product will be redirected to this category priority.
• In case the product gets several categories at the same level, the category will be redirected is the last category in the Categories section on Catalog management of the product.

In Time Period (in days) to Keep Redirect on Website: choose the time period for redirecting to be applied.

1.9. HREFLANG Tag Support

In Enable: Choose Yes to enable the feature or choose No to disable it.

In Add HREFLANG for Store View: Assign language and country for each store view.

In Enable for Homepage: Choose Yes to enable Hreflang tag for Homepage or choose No to disable it.

In Enable for Category: Choose Yes to enable Hreflang tag for Category Pages or choose No to disable it.

In Enable for CMS Page: Choose Yes to enable Hreflang tag for CMS Pages or choose No to disable it.

In Enable for Product Page: Choose Yes to enable Hreflang tag for Product Pages or choose No to disable it.

1.10. Meta Tags Template

1.10.1. Feature Settings

In Enable, choose Yes to enable the feature or choose No to disable it.

In Product Setting:

• In Max Product Meta Title Length: Choose the maximum number of characters for product meta title (should be about 70-71 characters).
• In Max Product Meta Description Length: Choose the maximum number of characters for product meta description (should be about 160 characters).
• In Max Product Meta Keywords: Choose the maximum number of product meta keywords (should be about 30 words).
• In Max URL Key Length: Choose the maximum number of characters for product URL keys (should be about 70 words).

In Category Setting:

• In Max Category Meta Title Length: Choose the maximum number of characters for category meta title (should be about 70-71 characters).
• In Max Category Meta Description Length: Choose the maximum number of characters for category meta description (should be about 160 characters).
• In Max Category Meta Keywords: Choose the maximum number of category meta keywords (should be about 30 words).
• In Max URL Key Length: Choose the maximum number of characters for category URL keys (should be about 70 words).

1.10.2. Generate a Product Meta Template

Please go to Marketing ⇒ BSS Commerce SEO ⇒ Meta Template and start configuration.

Choose Add New to create a new meta template.

In General:

• In Enable: Choose Yes to enable the template or No to disable it.
• In Name: Choose a name for the template.
• In Meta Template Type: Choose Product.
• In Scope: Choose the scope (store view, website) to apply the template. You can choose multiple store views/websites by holding Ctrl and click.
• In Priority, choose priority for the template. In case the product is under multiple categories with different templates, the priority settings will be considered for the affected meta template to avoid conflict. The smaller number will be prioritized.

In Product Conditions:

You need to set up necessary conditions to determine which products to be applied by the meta tag template.

In Template Settings:

• In Meta Title: Write the meta title for products. You can click on Insert Template Variables to choose the variables we provide.
• In Meta Description: Write the meta description for products. You can click on Insert Template Variables to choose the variables we provide.
• In Meta Keyword: Write the meta keywords for products. You can click on Insert Template Variables to choose the variables we provide.
• In URL Key: Enter a URL key or click on Insert Template Variables to choose the variables we provide.
• In Short Description: Write a short description of the products. In the WYSIWYG editor, the Insert Template Variables will not be shown. Click on Show/Hide Editor to show the regular text area with variables.
• In Description: Write a short description of the products. In the WYSIWYG editor, the Insert Template Variables will not be shown. Click on Show/Hide Editor to show the regular text area with variables.

Finally, you click Save and Generate button and then are redirected to a new Generate Meta Template page. You continue to click Start Generating button and will track the process of generating the product template. You can let the process automatically run and continue to make other configurations in a new tab. Don’t configure on the same tab while the process is happening.

After this process is finished, you can check the results on the Search Engine Optimization of each product edit page.

*Note: In the Search Engine Optimization of each product edit page, you can exclude the product from Meta Templates Updates.

1.10.3. Generate a Category Meta Template

Please go to Marketing ⇒ BSS Commerce SEO ⇒ Meta Template.

Choose Add New to create a new meta template.

In General:

• In Enable: Choose Yes to enable the template or No to disable it.
• In Name: Choose a name for the template.
• In Meta Template Type: Choose Category
• In Scope: Choose the scope (store view, website) to apply the template. You can choose multiple store view/website by hold Ctrl and click.
• In Priority choose priority for the template. In case the category is under multiple categories with different templates, the priority settings will be considered for the affected meta template to avoid conflict. The smaller number will be prioritized.

In Category Choose:

• Choose the category to apply the template. You can choose multiple categories by holding Ctrl and click.

• In Apply for Sub-categories: Choose Yes to apply the template for sub-categories, otherwise choose No.

In Template Settings:

• In Meta Title: Write the meta title for categories. You can click on Insert Template Variables to choose the variables we provide.
• In Meta Description: Write the meta description for categories. You can click on Insert Template Variables to choose the variables we provide.

• In Meta Keyword: Write the meta keywords for categories. You can click on Insert Template Variables to choose the variables we provide.
• In URL Key: Enter a URL key or click on Insert Template Variables to choose the variables we provide.
• In Description: Write a short description for the categories. In the WYSIWYG editor, the Insert Template Variables will not be shown. Click on Show/Hide Editor to show the regular text area with variables.

Lastly, click Save and Generate and do similarly as you start generating the product meta template.

*Note: In the Search Engine Optimization of each category page, you can exclude the category from Meta Templates Updates.

1.11. SEO ALT Text

1.11.1. Configurations

In Enable: Choose Yes to enable the feature or choose No to disable it.

In Alt Tag Template: Write Alt text template for images. You can click on Insert Template Variables to choose the variables we provide.

In Image Name Template: Write the name template for images. You can click on Insert Template Variables to choose the variables we provide.

Then you click Generate button to be redirected to a new page, then start generating both templates. You can track the process in this page conveniently.

*Note: In the Search Engine Optimization of each product edit page, you can exclude the product from SEO Alt Text Template.

1.11.2. Manage images and edit ALT for each image

Please go to Marketing ⇒ BSS Commerce SEO ⇒ SEO ALt Text.

This grid shows all product images on your website and you can easily filter wanted images.

When you click an image, you are able to edit the image file name and alt text, then save config within the grid.

*Note: Enter the right format for image names without any special characters and under .jpg, .jpeg, .png, .gif, .bmp.

For product with many images, click on the product and every image is shown for you to edit.

1.12. SEO External Links

In Enable: Choose Yes to enable the feature or choose No to disable it.

In Excluded Domain: List domains you want to not apply this function.

1.13. SEO Toolbar

In Enable: Choose Yes to enable the feature or choose No to disable it.

Then you click Start Check button to see an SEO analysis for homepage on the frontend.

This toolbar tells you which SEO factors meet requirements, and which ones are not good enough and need to be checked again.

When you navigate to other pages, the toolbar appears to give an SEO analysis for these pages.

1.14. SEO Report

2.14.1. Configurations

In Enable: Choose Yes to enable the feature or choose No to disable it.

In Google Search Console Start Date: Enter a start date to check data on Google Search Console.

In Google Search Console End Date: Select an end date

• Current date: Data is checked from the start date to the current time you are checking.
• Custom date: You can select any date as you want.

In Google Authorization Code: Click the button to get the Google Authorization Code, then enter it into the field.

1.14.2. SEO report & SEO Audit in edit pages

After completing configurations, you navigate to a product, category or CMS edit page to check how SEO report and SEO Audit performs.

• SEO Report

In Meta Title and Meta Description: display a color bar to notify admins about how valid title and description are, according to the number of characters.

In Main Keyword: Enter the main keyword and it is used to for SEO Audit and Google Search Console.

• SEO Audit

In SEO Audit: The module gives you a list of messages to notify about:

+ The usage of main keyword in meta title, meta description, product description, and URL

+ Main keyword density

+ The current situation of description

+ Outbound links

In Google Search Console: You need to set up Google Authorization Code to connect Google Search Console, then complete settings in the SEO Report Config.

A grid is displayed to tell you such information as below:

The module checks 3 factors in this section: Main keyword, Meta keyword and Page URL. Through connecting Google Search Console, the admin will know the details of each key including Average position, Impressions, Clicks and CTR.

*Note: URLs of product, category or CMS pages are used to query on Google Search Console. These URLs meet configs on the Canonical Tag module.

1.14.3. SEO Report Dashboard

Please go to Marketing ⇒ BSS Commerce SEO ⇒ SEO Report.

This grid displays all important SEO information of page URLs on the website.

If you click Crawl All Site button, you are redirected to the Crawl SEO report page. The module carries out crawling data for websites which have just set up this module. This process only needs to be done once because new products are automatically updated.

You tap Crawl All site button to start the data crawling process. There are 2 Crawl status:

• Success: the URL can be accessed from the frontend (even 404).
• False: Lost of Internet connection can be a cause for False status. As a consequence, the crawling process is not finished.

*Note:

• Data of meta title, meta description, meta keyword and main keyword is updated according to the real time.
• Data of Headings, Images, Open Graph, Twitter Card is updated once a day when admins edit products/categories.
• During the crawling process, you can open a new tab to make other configurations.
• The process will stop when you click Back to SEO Report button.

Pop-up for Magento 2 extension helps you create the eye-catching pop-up that is highly flexible and customizable for many purposes, such as promotion, notification, guideline, or newsletter. You decide where to display the pop-up, set display animation, and apply for customer groups or store views.

II. Magneto 2 Popup

2.1 General Configuration

Please go to Stores ⇒ Configuration ⇒ BSSCommerce ⇒ Pop-up General Configuration.

In Enable, choose Yes to enable the extension, or No to disable it.

2.2 Manage Pop-up Grid

Go to Marketing ⇒ BSSCommerce ⇒ Pop-up ⇒ Manage Pop-up.

Manage Pop-up grid shows all pop-up you have created with full information, including Pop-up Name, Enable, Display Rule, Displayed Pages, Content, Store Views, Customer Groups, Start Date and End Date. The Manage Pop-up grid works just like standard grid in Magento 2 default with features such as mass action (delete, enable, disable), filter and column display.

2.3 How to Create New Pop-up

Please click on the Create New Pop-up button located on the top right of the grid. You will be redirected to the New Pop-up Page, which has 3 tabs:

• General
• Display Rule
• Content and Design

There are 4 buttons to support creating a new pop-up:

• Back
• Reset
• Save and Continue
• Save Pop-up

2.3.1 General

In Enable, choose Yes to enable the new pop-up.

In Name, enter the pop-up’s name.

In Store Views, select which store views to display the pop-up.

In Customer Groups, choose the customer groups to view pop-up.

In Start Date, select a date in the calendar view to begin showing the pop-up.

In End Date, select a date in the calendar view to stop displaying the pop-up.

In Priority, enter a number to decide the priority of the pop-up when multiple pop-ups are created on a page.

2.3.2 Display Rule

In Display Rule, choose one of the four following conditions to set conditions for displaying the pop-up:

• After customers spend X seconds on the page.
• After customers scroll page by X percent.
• After customers view X pages.
• Immediately when customers visit the page.

In X equals, enter a number to decide the value of X.

In Display Animation, choose one of the six following options to set display effects for the pop-up:

• Zoom
• Horizontal Move
• Move from Top
• 3D Unfold
• Zoom-out
• None

In Position, select the position to display the pop-up on the page.

• Top Left
• Top Center
• Top Right
• Middle Left
• Middle Center
• Middle Right

In Auto Close Pop-up After, enter the amount of time (seconds) for the pop-up to automatically close. Ex: 10. Enter “0” to disable auto close of Pop-up

In Display Frequency, determine the frequency of pop-up display by selecting one of the following options:

• When all conditions are satisfied: the pop-up appears if the above rules are executed.
• Only once: the pop-up only appears once.
• Only once per session: the pop-up appears once in a session. If you choose this option, you need to set Cookie Expires.

For example, if you choose Display Frequency as “Only once per session” and set the 2 minutes for the Cookie Expires, the pop-up is displayed when the conditions are satisfied, then it won’t be shown in the next 2 minutes (until the session ends or the cookie expires).

In Layout Updates:

In Display on, select pages to show the pop-up, including the following types of pages:

• Category Pages
• Product Pages
• Generic Pages

When you choose each type of page, you can select all pages or specific pages depending on your demand.

For example:

+ Category page:

+ Product page:

+ All pages:

(you can exclude specific pages from displaying a popup when you select the option as All pages)

Furthermore, it is easy to add more layout updates to show popup in more pages by clicking the button.

2.3.3. Content and Design

In Content, use the WYSIWYG editor to create content for the pop-up.

You can use this tool to insert widget, image or video for the pop-up’s content.

In Pop-up CSS, use CSS to change the design of the pop-up. If leaving blank, the default pop-up will be applied.

Or, you can use our default template to quickly render your pop up.

There are 5 templates to choose from:

• Contact Form
• Age Verification
• Newsletter
• Hot deals (product listing)
• Social sharing

After choosing your template, click on the Load Template button to make the template appear in the Content edit interface.

In the Content edit, you can make any modification if needed.

Note: After any change to the pop-up configuration, either  Save, Delete, Mass delete, Mass active, is made, a cache notification will appear.

You then must go to SYSTEM -> Tools -> Cache Management ->Flush Magento Cache for those changes to be applied to the front end.

III. Magento 2 One Step Checkout

Please go to Stores ⇒ Configuration ⇒ BSSCOMMERCE ⇒ One Step Checkout.

3.1 In General

In Enable:

• Choose Yes to enable Magento 2 One Step Checkout extension.
• Choose No to disable this module.

In Allow Creating Account On Checkout Page:

• Choose Yes to allow customers to create their accounts right on the checkout page.
• Choose No to disable this function.

In Title: Write your wanted title for the checkout page.

In Router Name: Choose an URL name for your checkout page.

3.2 In Fields Display

In Show Order Comment:

• Choose Yes to show a text box for customers to leave their comments for orders.
• Choose No to exclude this box from the checkout page

In Show Discount Code:

• Choose Yes to display a discount code box for entering coupon codes.
• Choose No to hide it.

3.3 In Newsletter

In Show Subscribe Newsletter:

• Choose Yes to allow customers to subscribe to the newsletter on the checkout page.
• Choose No to disable this function.

In Auto Check Newsletter Sign up Box: Choose Yes to automatically tick the Newsletter Sign up box or choose No to uncheck.

3.4 In Tracking Address by Google

In Enable Tracking  Address by Google:

• Choose Yes:  Auto-detect and pre-fill customers' country, state/province, city - Google Suggest to autocomplete shipping address while typing.

• Choose No: Customers have to find all street addresses and location information themselves.

In Google API Key: Fill in your API Key. In case you haven’t yet had an API Key, please click the link after this configuration to get it.

In Tracking  Address from Applicable Countries: This configuration determines which countries to apply auto-suggesting customer addresses. There are 2 options to select:

• If you choose All Allowed Countries: auto-suggesting address function is applied to every country.
• If you choose Specific Countries: there is a list of countries in Tracking Address from Specific Countries and the maximum number of countries you can select is 5. Moreover, when you choose this option, Google just auto-suggests city name and country, not street name. This is the default function of Google auto-suggest.

*Notes:

• Admin has to work with Google and pay for Google Maps to activate the address autocompleting feature.
• Your websites must be "https://" to run the auto-fill function.
• Your login customers can checkout with multiple addresses.

3.5 In Order Delivery Date

In Show Delivery Date:

• Choose Yes to display Order delivery date in the Shipping method section that allows customers to choose their own suitable dates and times to receive orders.
• Choose No to disable this function.

In Show Delivery Comment:

• Choose Yes to display a Delivery comment box in the Shipping Method section.
• Choose No to hide it.

*Install M2 Order Delivery Date to see more premium features of this function:

• In case M2 Order Delivery Date is installed: All features of M2 Order Delivery Date will be active. Customers can choose the delivery date and admin can give them certain delivery time slots:

• In case M2 Order Delivery Date is not installed: All features of One Step Checkout delivery date will be active. Customers can choose whatever delivery date and time they want:

3.6 In Gift Message

In Show Gift Message on Order Level: 

• Choose Yes to allow customers to send a gift message to other people.
• Choose No to disable this function.

* Gift Message config is applied only when the corresponding default config is enabled. To enable the default config, please go to Stores ⇒ Sales ⇒ Sales ⇒ Gift Options and choose Yes to the suitable gift message level:

3.7 In Gift Wrap

In Enable:

• Choose Yes to allow customers to request a gift wrap for their order.
• Choose No to disable this function.

In Type: This function currently supports gift wrap for each order only, so the value is Per Order by default.

In Gift Wrap Fee: Fill the price for gift wrap service. The entered value is a positive number and automatically rounded to two decimal places. If left empty or filled with a negative number, the value would turn to be 0.

3.8 Additional Add-on

M2 One Step Checkout is already compatible with multiple related modules: M2 Customer Attributes, M2 Checkout Custom Field, M2 Reward Points, M2 Pre-Select Shipping/Payment. Install the suitable modules to better optimize M2 One Step Checkout.

• M2 Customer Attributes: Carefully config the Customer Attributes function to give your customers the best shopping experience! Go to Customers ⇒ Customer Attributes. In each customer attribute, go to Display Configuration:
  • In Display on Checkout Page: Choose Yes to make customer attributes be shown on the checkout page, choose No to disable this function.
  • In Hide If Filled Before: Choose Yes so that if customers fill the customer attribute for the first time, it will not display after that. Choose No to always display the customer attribute whenever customers go to the checkout page.

• M2 Checkout Custom Field: Go to Sales ⇒ Bss Commerce ⇒ Manage Checkout Custom Field ⇒ Add New Field to create a custom field for the checkout page.

• M2 Pre-select Shipping/Payment: Go to Stores ⇒ Configuration ⇒ BSS COMMERCE ⇒ Pre-select Shipping/Payment to config the default shipping/payment method when customers enter the checkout page.

3.9 In Custom Style

In Checkout Step Number Color: you choose the color for the checkout number steps.

In Checkout Step Background Color: Choose a color for the background of checkout number steps.

In Custom Code: you can add more code to customize about background color for the checkout page, “Sign in” button or text color and so on.

3.10 Somes notes

• Notes about custom code

+ Change background of the checkout page, you need to add more code:

body { background-color: #333333;

}

(#33333 is the color code which is corresponding to Black).

+ Change text color of the checkout page, you need to add more code:

body { color: #ffffff;

}

(#fffff is the color code which is corresponding to White).

+ Change Sign in to a button, you add more code:

.authentication-wrapper button{

padding: 15px;

background: #6D268A;

color: #fff;

}

.authentication-wrapper button:hover{

text-decoration: unset;

background: #FF0000;

color: #fff;

}

• Note about configuring payment method

+ You need to configure all payment methods that default Magento supports.

+ Current support payment methods:

• Amazon Payment
• Paypal, Paypal Braintree, Paypal Express Checkout, Paypal Payflow Pro & PayPal Payment Flow CreditCard
• Pay by Credit Eway
• Splitit Card-Based Installment Payment Solutions
• NMI payment Direct Post
• NEW! Sagepay payment (Ebizmarts_SagePaySuite
• Zalopay
• Pay by Card (Stripe), Credit Card
• Online banking, etc.
• Stripe official
• Note about adding payment trust badge

Step 1: Go to Content ⇒ Blocks ⇒ Add New Block to create a new block for payment trust badge.

Step 2: Go to Content ⇒ Widgets ⇒ Add Widget to choose certain place to display the block of payment trust badge.

• Note about adding header/footer for the checkout page: Upload folder bss_onestepcheckout to app/design/frontend/theme_space/theme.

3.11 API Support

We provide you lists of Restful API and GraphQL  API that our Magento 2 One Step Checkout extension supports.

*Note: 

• Restful API support is included in the main module package (from One Step Checkout v2.1.9).
• GraphQL API support is included in the GraphQL package, acting as an add-on for anyone who needs to use GraphQL.

3.11.1 Restful API 

No	API	URL	Method
1	Update cart information in One Step checkout when customers change product quantity (for Not logged-in customers)	{{base_url}}/rest/V1/bss-osc/guest-carts/:cartId/update-item	POST
2	Update cart information in One step checkout when customers change product quantity (for logged-in customers)	{{base_url}}/rest/V1/bss-osc/carts/mine/update-item	POST
3	Apply Gift Wrap	{{base_url}}/rest/V1/bss-osc/giftwrap/apply/0	POST
4	Validate Gift Wrap	http://one-step-checkout.demom2.bsscommerce.com/rest/V1/bss-osc/giftwrap/validate/:fee/:use	POST
5	Add information about Order delivery date and delivery comment to orders when getting orders via /V1/orders/:id (default)	{{base_url}}/rest/V1/orders/:id	GET
6	Add information about Order delivery date and delivery comment to invoices when getting invoices via /V1/invoices/:id (default)	{{base_url}}/rest//V1/invoices/:id	GET
7	Add information about Order delivery date and delivery comment to credit memo when getting credit memo via /V1/creditmemos/:id (default)	{{base_url}}/rest/V1/creditmemos/:id	GET
8	Add information about Order delivery date and delivery comment to shipment  when getting shipment via /V1/shipment/:id (default)	{{base_url}}/rest/V1/shipment/:id	GET
9	Get Store config of the module	{{base_url}}/rest/V1/bsscommerce/osc/storeconfigs/:storeview	GET
10	Add information about Order delivery date and delivery comment to the payment extension corresponding to the customer's current cart	{{base_url}}/rest/V1/bsscommerce/osc/deliveryinfo	PUT
10.1	Add information about Order delivery date and delivery comment to the payment extension by GUEST	{{ api_base }}/V1/bsscommerce/osc/deliveryinfoguest	PUT
11	Get information about Order delivery date and delivery comment from Quote	{{base_url}}/rest/V1/bsscommerce/osc/deliveryinfo/cart/:id	GET

3.11.2. GraphQL API 

No	GraphQL API	URLs	Method
1	Add information about Order delivery date and delivery comment to orders when getting orders via customerOrders default	{{base_url}}/graphql	POST
2	Add information about Order delivery date and delivery comment to the payment extension	{{base_url}}/graphql	POST
3	Get information about Order delivery date and delivery comment from Quote	{{base_url}}/graphql	POST

IV. Magento 2 Guest To Customer

To configure the extension, please go to Store ⇒ Configuration ⇒ BSSCOMMERCE ⇒ Guest to Customer.

4.1 General configs

In Enabled: set Yes to enable or set No to the module.

In Assign Orders with The Same Checkout Email to Customer: Choose Yes to enable this function and choose No to disable it. The logic of this config is presented as follow:

Config status	Customer behaviors	Result
Yes	Create an account right after the purchase using this button on the checkout success page:	The order gets assigned to the customer profile both frontend and backend.
Yes	Create an account using after the purchase using the button on the header:	Due to complications regarding time delay between orders and the relation with the invoice, credit memo,... outside of a sheer order => Currently, in this case, the extension doesn't support assigning orders with the same email to the new account.
Yes	Checkout using the registered email but not login	The order gets assigned to the customer profile both frontend and backend

• Config: Yes. The customer creates an account right after their purchase using the button => The orders get assigned to the customer profile both frontend and backend.
• Config: Yes. 

In Sync address, choose Yes to synchronize customer's address when the billing address and shipping address are the same.

In Auto Convert to Customer: there are 2 options to select.

+ If you set Yes, guests are automatically converted to real customers after they finish their checkout.

In Customer Group: select customer group to assign converted customers.

+ If you set No, guest users after checkout will be included in a Guest Management grid table. Then, you can make mass actions to assign them to customer groups. This action also means that you manually convert them to real customers and create accounts for them.

For guests placing orders before you install this extension, you can still import them to the Guest Management grid, and convert them into customers automatically or manually.

Accordingly, pick a period time to import guest in From and To.

Then, click Import button to import guests.

4.2. Guest Management

You go to Customers ⇒ Guest ⇒ Guest Management to check this table:

If you want to convert any guest to a customer, you tick in the box and then choose Assign a Customer Group. Specific customer groups are displayed to select:

After choosing customer group and submit the request by click OK in the popup, guests are converted to customers.

4.2 Notification email

In Enable Notification Email to Customer: choose Yes to enable this function or choose No to disable it.

In Email Sender: select one store email to send notification emails to customers. These emails confirm customer account information to login into store website.

In Email Templates: select email template. This extension provides a default email template and you can easily customize in Marketing ⇒ Communications ⇒ Email Templates.

4.3 Required fields

In this section, you complete customer information which are displayed in the checkout if you set up as Required for this information in the Name and Address Options.

*Note: Reason why you need these configurations.

In Stores ⇒ Configuration ⇒ Customer ⇒ Customer Configuration ⇒ Name and Address Options:

In case you set Required for information such as Show Prefix, Show Suffix, Show Date of Birth, Show Tax/VAT Number, Show Gender, Show Telephone, Show Company and Show Fax, which means that customers can create accounts only when they complete all of this information. However, when a guest user checkouts, he/she doesn't complete them because this information is not included in the default checkout. Therefore, the module cannot create accounts for guests when converting them to customers

With Required Fields configuration of the module, customer information is completed here and in the above case, the module will take customer data from these configurations to create an account for converted customers.

V. Magento 2 Social Login

Please go to Store  ⇒ Configuration ⇒ BSS COMMERCE ⇒ Ajax Social Login.

5.1. General

In Enable, choose Yes to enable the extension or No to disable it.

In Use Popup Ajax, choose Yes to enable popup for login and register. Otherwise, choose No to disable it.

In Send Password, choose Yes to send customers an email that contains the password after they login using a social account. The customer then can use their email and password to log in to your site. Choose No to disable it.

In Display Customer Photo, choose Yes to display the customer’s profile photo from the social account they used for signup, or choose No to not display customer’s social photo.

In Redirect after Login, select the page on site or any particular URL you want to redirect after customer login successfully.

In Redirect after Register, select the page on site or any particular URL you want to redirect after customer completed register process.

5.2. Social Button Block

In Display buttons social login on popup, decide to display social buttons on Login tab or Register tab of popup, or place it on both tabs.

In Display buttons social follow class or id, enter class/id to place social button social login on.

In Display buttons social register follow class or id, enter class/id to place social button social register on.

In Number of button displayed, set the restriction of number of buttons to display on social login block.

In Social Button Sorting, decide the arrangement of buttons in social login block.

5.3. ReCaptcha

In Site Key and Secret Key, click “Create a site key” and register reCaptcha.

After registering, you will get the Site key and Secret key as below:

In Theme, choose the theme of reCaptcha between:

Light:

Dark:

In Type: Choose the type of robot checking between Image and Audio

In Size: Choose the size of reCaptcha widget between Normal and Compact.

In Popup Form: Choose the form(s) of popup on site to place the reCaptcha widget. A form of popup includes Login, Register and Forgot Password?

5.4. Configure specific social account

5.4.1. Facebook

Take Facebook account as the example:

In Enable, choose Yes to enable Facebook account for login and register on the site, or choose No to disable it.

In App ID and App Secret, click on “click here” below Enable dropdown box, you will be redirected to a page to set up new API like below.

After completing register step, you will see a page as below. Click on Get Started in Facebook Login.

Click on Dashboard, you will see your App ID and App Secret - copy them and paste correspondingly into App ID and App Secret box in the backend configuration.

In URI redirection valid OAuth– copy the Valid OAuth redirect URIs like below and paste into the box URI redirection valid Oauth.

In Small Icon, upload the file for the icon of this account displayed in the frontend.

In Login Button Text, customize the text in social login button.

In Registration Button Text, customize the text in social registration button.

Note: In case you run into the error “Blocked URL” use URI at the link to re-setup the configuration, as follow:

For other social accounts, follow similar steps like the setting for Facebook:

5.4.2.    Twitter

5.4.3. Google

5.4.4. LinkedIn

To get Client ID, Client Secret and Redirect URL, please click on "click here" link and follow steps as below:

+ Create new application:

+ Set up Authentication for application: You get Redirect URLs in this step:

+ Copy Client ID and Client Secret to the configuration:

5.4.5. Window-Live

To get Application ID, Application Secret and Redirect URL, please click on "click here" link and follow steps as below:

+ Click on "click here" link to be redirected to Microsoft App register page:

+ Copy & Paste Redirect URL(s) to the app detail page:

+ Copy & Paste Application Id and Secret to Social Login configuration:

5.4.6. Instagram

Note: You need to edit the email after the 1st login.

To get Application ID, Application Secret and Redirect URL, please click on "click here" link and follow steps as below:

+ Create New Client ID:

+ Fill in web information:

+ Get Client ID and Client Secret:

*Note:

- Client status must be Authorized, then you can get the real Instagram account. In case you use sandbox mode, sandbox account is only accepted.

- Sometimes, you might face up to the error like this.

The solution is to copy the Redirect URIs and paste it in the client info page:

5.4.7. Vkontakte

Finally, click Save Config and to complete setting process.