Wholesale Price List Pro

Welcome

Thank you for purchasing Wholesale Price List Pro extension!

This document contains information for Wholesale Price List Pro extension. If you have any questions that are not found in this readme document, please look for contact information in the support section.

Extension info

Features

Overview

Wholesale Price List Pro provides the capabilities for your store to create multiple product price lists that can easily be viewed, printed, and saved as PDF for different customer groups.

Highlights

1. Display products as a list, useful for regular, wholesale, or any customer groups to add products to cart in batch.
2. Customers are able to filter the price list products by category.
3. Flexible control - Almost all price list features can be customized from the admin easily.
4. A total of 23 different columns and unlimited product attributes can be toggled on or off independently and arranged from the admin.
5. Price list can be sorted by 18 different columns & attributes.
6. 11 types of Barcode is supported.
7. Customers are able to print the price list with a single click in a print-ready format.
8. Customers are able to save the price list in PDF document format.
9. Price list can be restricted to certain customer groups or store. Useful if you want to allow your wholesale customers access to price list, but not to your normal retail customers.
10. Multi languages and multi stores are supported.

What's new in version 1.5?

1. Support for OCMOD installation option
2. Added Duplicate Pricelist
3. Added QR Code column
4. Added Search in Pricelist
5. Added Filter by Price range slider
6. Choose column alignment(left, center, right)
7. Customer Group restriction on column
8. Separate 'Special' price column
9. Affiliate members restriction

Installation

Prerequisite

1. OpenCart version must be a compatible version. Please refer to the 'OpenCart version compatibility' list stated above in the Extension Info.
2. PHP 5.3 and above.
3. Skip to Install only if vQmod is installed and working on your store.
4. Requires vQmod 2.4.1 minimum.(v2.6.1 for OpenCart v2.x) Get it from here: https://github.com/vqmod/vqmod/releases
5. Follow instruction in https://github.com/vqmod/vqmod/wiki/Installing-vQmod-on-OpenCart

Install (OCMOD)

1. Login to your store admin page, navigate to Extensions > Extension Installer > Upload the extension.ocmod.zip file(rename if necessary).
2. Navigate to Extensions > Modifications > Clear/Refresh.
3. Navigate to Extensions > Modules, and click on the Install button for 'Wholesale Price List Pro' module.
   

Install (vQmod)

1. Upload all contents from 'upload' folder into your OpenCart store root folder with an FTP software. No files will be replaced.
   
2. Login to your admin page, go to Extensions > Modules, and click on the Install button for 'Wholesale Price List Pro' module.
   

Setup

1. For Wholesale Price List Pro v1.4.5 - v1.5(OpenCart v2.2.0.x - v2.3.0.x), requires MPDF v6.1.1. Get it from here: https://github.com/mpdf/mpdf/archive/v6.1.1.zip
2. Unzip "mpdf-6.1.1.zip" and upload the "mpdf-6.1.1" to [your store root folder]/system/library/[rename to "MPDF611"]
3. Navigate to Extensions > Modules > Wholesale Price List Pro and click on the Edit button.
   
4. Please see Usage section for further instructions.

Upgrade

From v1.4.x to v1.5

1. Please note that all your previous Pricelist setup data will be retained. However, you are advised to BACKUP your store database before continuing with the upgrade process.
2. Copy all contents from 'upload' folder to your store root folder. Only extension files from previous version will be replaced.
3. Login to store admin and navigate to Extensions > Modules > Wholesale Price List Pro > click on the Edit button. At this point the upgrade process will run in the background. There's no need to Uninstall or re-install the extension.

From v1.3-beta to v1.4

1. v1.4 is only for OpenCart v2.x. Therefore only fresh install is available.
2. v1.3-beta & below is not supported in latest OpenCart v2.x

From v1.2 to v1.3-beta

1. Please note that all your previous Pricelist setup data will be DELETED. You are advised to backup your store database before continuing with the upgrade process.
2. Copy all contents from 'upload' folder to your store root folder. Only extension files from previous version will be replaced.
3. Uninstall & re-install the extension from the admin Extensions > Modules page.
4. Clear all vqcache files in /vqmod/vqcache/ folder and delete 'mods.cache' file from /vqmod/ folder.

From v1.0 to v1.1, v1.0 to v1.2, v1.1 to v1.2

1. Please note that all your previous Pricelist setup data will be retained. However, you are advised to backup your store database before continuing with the upgrade process.
2. Copy all contents from 'upload' folder to your store root folder. Only extension files from previous version will be replaced.
3. There's no need to Uninstall or re-install the extension from the admin Extensions > Modules page.
4. Clear all vqcache files in /vqmod/vqcache/ folder and delete 'mods.cache' file from /vqmod/ folder.

Usage

Pricelist

Click on the Pricelist tab to reveal Pricelist below.

Add New Pricelist

Click on the Add New Pricelist button to insert a new Pricelist.

Name

Set a name for the Pricelist.

Meta Tag Title

Set a Meta Tag Title for the Pricelist.

Meta Tag Description

Set a Meta Tag Description for the Pricelist.

Meta Tag Keywords

Set Meta Tag Keywords for the Pricelist.

Status

Set the status of this Pricelist.

Sort Order

Set the sort order of this Pricelist.

SEO Keyword

Set the SEO keyword for this Pricelist. Please do not use spaces. Instead, replace the spaces with '-' and make sure the keyword is globally unique.

Affiliate Login Required

Only logged in Affiliate account are able to view this pricelist.

Customer Login Required

Only enable this Pricelist when customer is logged in.

Customer Group

Only enable this Pricelist to selected Customer Groups if "Customer Login Required" above is set to Yes.

Customers

Assign specific customers for this Pricelist. Type in the name of the customer in the autocomplete text field and select the customer from the drop down list.

Stores

Only enable this Pricelist for selected Stores.

Products

Assign specific products for this Pricelist. Type in the name of the product in the autocomplete text field and select the product from the drop down list.

Categories

Assign multiple products easily for this Pricelist based on Categories. Select the desire categories by checking the checkboxes.

Manufacturers

Assign multiple products easily for this Pricelist based on manufacturers. Select the desire manufacturers by checking the checkboxes.

Description Length

Set the number of characters to show in Product Description.

Product per Page Selection

Set the numbers of products per page for customers to select from a drop-down menu.

Image Dimension (W x H)

Set the width and height values in pixels for the product images in Pricelist.

Barcode Dimension (W x H)

Set the width and height values in pixels for the barcodes in Pricelist.

Make sure the Width value is wide enough to cover the length of your chosen barcode and its data. Some barcode formats have variable length data while some have fix length. To test it out, use a large width value like 300 to see the maximum barcode length and gradually reduce the value so that it fits the barcode length.

Barcode Magnification

Set the magnification value for the barcode. Default value is 2. Only increase this value if the barcode dimension is large and the lines in it seems too tight & tiny to be scanned properly by your scanning device.

Barcode Font Size

Set the font size of the text below the barcode.

Show Out of Stock Products

If set to Yes, products with 0 quantity stock and Subtract Stock set to Yes will not be shown in the Pricelist.

Filter by Special

If set to Yes, only products with Special prices will be shown in the Pricelist.

Filter by Discounts

If set to Yes, only products with Discount prices will be shown in the Pricelist.

Enable Filter by Category

Set to Yes to allow customers to filter the products in the Pricelist by category drop-down.

Enable Filter by Manufacturer

Set to Yes to allow customers to filter the products in the Pricelist by manufaturer(brand) drop-down.

Enable Bulk Add to Cart

Set to Yes to allow products to be added to cart in batch. Requires 'Checkbox' column.

Enable Print Output

Set to Yes to allow customers to print Pricelist in a print-ready format.

Enable Paging in Print Output

If set to No, there will be no pagination and all products will be included in the Print Output on a single page.

Enable PDF Output

Set to Yes to allow customers to save Pricelist as a PDF document. 'Display Errors' must be set to No under System > Settings > Your Store > click on the Edit button > Server tab.

Note: This extension uses the free mPDF PHP class to convert the Pricelist HTML page into PDF document. More info on mPDF can be found here: https://mpdf.github.io/

Enable Paging in PDF Output

If set to No, there will be no pagination and all products will be included in the PDF Output on a single document.

PDF Output Orientation

Select the orientation for the Pricelist PDF output file. Recommend to set orientation to Landscape if there are many columns in the Pricelist.

Display Product Discount

Set to No to hide product discount prices.

Display Product Option

Set to No to hide product options. If product contains any required options but is hidden in Pricelist, customer will be redirected to product page when trying to add the product to cart.

Display "Add to Wishlist" Link

Set to Yes to display "Add to Wishlist" link in Action column.

Display "Add to Compare" Link

Set to Yes to display "Add to Compare" link in Action column.

Design

Select a Layout to override if required. Works just like the Layout Override under the 'Design' tab while editing a product or category.

Columns

Attention: You will need to first create some columns before able to add columns to this Pricelist. Save your pricelist & proceed to the next section below on how to add new Columns.

Click on the Add Column button to add a column to this Pricelist. To remove a column, click on the Remove button.

Default Sort Column

Set a default sorting order of the products in Pricelist based on the column type data.

Save

Click on the Save or Save & Exit button to save this Pricelist.

Pricelist Columns

Click on the Column tab to reveal Column list below.

Add Column

Click on the Add Column button to add a new column to the Pricelist.

Name

Set a name for the Column.

Column Type

Select a column type.

• Checkbox - Works with 'Enable Bulk Add to Cart' setting above. Enables items in Pricelist to be selectable and added to cart in batch.
• Number - Number sequence starting with 1.
• Action - Contains product options, quantity field & Add to Cart button, and Add to Wishlist & Add to Compare links. Product Options can be disabled in 'Display Product Option' setting above. Add to Wishlist & Add to Compare links can be disabled in 'Display "Add to Wishlist" Link' & 'Display "Add to Compare" Link' settings above respectively.
• Blank - Empty column. Useful for Print and PDF output as a scribble space.
• Product
  • Image - Product Image.
  • Product Name - Product Name. Links to product page when clicked upon.
  • Description - Product Description. Number of characters can be set in 'Description Length' setting above.
  • Model - Product Model.
  • SKU - Product SKU.
  • UPC - Product UPC.
  • EAN - Product EAN.
  • JAN - Product JAN.
  • ISBN - Product ISBN.
  • MPN - Product MPN.
  • Category - Product Category.
  • Manufacturer - Product Manufacturer(Brand).
  • Price - Product price, special price, and discount prices. Discount prices can be disabled in 'Display Product Discount' setting above.
  • Points - Product points. Number of points needed to buy this product.
  • Reward - Product reward points. Number of points rewarded to customer if they buy this product.
  • Quantity (Stock) - Product stock quantity.
  • Stock Status - Product stock status.
  • Minimum Order Qty - Product minimum order quantity.
  • Ratings - Product ratings.
  • Dimensions - Dimensions (Length x Width x Height) of product.
  • Weight - Weight of product.
  • Date Added - Date of product being added.
  • Date Modified - Date of product being modified(updated).
  • Viewed - Number of views for this product.
• Attributes - It will show a list of all attributes from your store that you can use as a column. Products that will appear on this Pricelist will need to have its attribute setup for the attribute value to show in the selected attribute column.

Sortable

Set Yes to enable sorting for this column. Most column types & attributes are sortable EXCEPT:

• Checkbox
• Number
• Action
• Blank
• Product Image
• Product Category

Barcode

Select a Barcode format if you want to display this column data in barcode. Only the following column types will support barcode:

• Product Name
• Model
• SKU
• UPC
• EAN
• JAN
• ISBN
• MPN
• Manufacturer
• Attributes

Please note that most of the barcode formats only support numerical values while some support limited alphabets. You will need to verify your column data to make sure they are compatible with the chosen Barcode format.

More info for each supported barcode format can be found here:

• Codabar
• Code 11
• Code 39
• Code 93
• Code 128
• EAN-8
• EAN-13
• Standard 2 of 5
• Interleaved 2 of 5
• MSI
• Data Matrix

For Pricelist

Set Yes to enable this column in this Pricelist.

For Print

Set Yes to enable this column in Print-ready format.

For PDF

Set Yes to enable this column in PDF document format.

Save

Click on the Save or Save & Exit button to save this Column.

Layout Module

You need to add Layout modules that allow your customers to access the selected Pricelists on your store. For example:

Click on the Layout tab to reveal Pricelist Layout settings below.

Add Module

Click on the Add Module button to add new module row.

Name

Set a name for this module. This name is just a placeholder for module placement in the admin and will not be shown on the store front.

Pricelist

Select the Pricelists that you want to show in the list of this module.

Status

Enable or disable the module.

Remove

Click on the Remove button to remove this module.

Save

Click on the Save or Save & Exit button to save the Pricelist Module entries.

Applying the Module to Layout

After creating the modules, they need to be added to the Layout.

Navigate to System > Design > Layouts and Edit any Layout page that you would like to have the Pricelist module to appear on.

Add a new layout, select the appropriate Wholesale Price List Pro module, and set the Position and Sort Order accordingly.

Delete Pricelist

Select the Pricelist to delete by checking the checkbox & click on the Delete Pricelist button to remove selected Pricelist.

Delete Column

Select the Column to delete by checking the checkbox & click on the Delete Column button to remove selected Column.

Pricelist Layout

You can also add other modules to the Pricelist page. A Price List Layout selection has been added automatically during the installation of Wholesale Pricelist Pro extension, where you can use it in any other modules layout settings.

While editing other modules layout, select Price List as the Layout to add the module to the Pricelist page.

Customization

Custom Language

Wholesale Price List Pro extension readily supports multi languages.

Just enter the relevant Pricelist name or Column name text for each custom language installed on your store, and it will be displayed on the store front end according to the selected language.

To customize other module text such as control names and button text, please perform the following steps (assuming 'spanish' is custom language folder name):

1. Make a copy of the following file:
   • /admin/language/english/module/myoc_pricelist.php
2. Paste it into your custom language folder:
   • /admin/language/spanish/module/myoc_pricelist.php
3. Open and edit the newly copied file /admin/language/spanish/module/myoc_pricelist.php
4. Edit the text in the file to your custom language accordingly.
5. Make a copy of the following file:
   • /catalog/language/english/myoc/pricelist.php
6. Paste it into your custom language folder:
   • /catalog/language/spanish/myoc/pricelist.php
7. Open and edit the newly copied file /catalog/language/spanish/myoc/pricelist.php
8. Edit the text in the file to your custom language accordingly.

Custom Template

Please follow the basic guideline below to customize Wholesale Price List Pro for non default custom template.

1. Make a copy of the following files:
   • /catalog/view/theme/default/stylesheet/myoc/pricelist.css
   • /catalog/view/theme/default/template/module/myoc_pricelist.tpl
   • /catalog/view/theme/default/template/myoc/pricelist.tpl
2. Paste them into your custom theme folder accordingly:
   • /catalog/view/theme/[custom_theme_folder]/stylesheet/myoc/pricelist.css
   • /catalog/view/theme/[custom_theme_folder]/template/module/myoc_pricelist.tpl
   • /catalog/view/theme/[custom_theme_folder]/template/myoc/pricelist.tpl
3. Open the files and edit the HTML and CSS to match with your custom theme styles.
4. Please contact support if you need any further assistant in customization.

Troubleshoot / FAQ

Q: Extension is not working after installation.

A: Please make sure the following:

• vQmod is installed and working correctly on your store.
• Your store hosting is running PHP 5.3 and above.
• If you are using a custom template, you might require to customize the extension. Please see Customization > Custom Template.
• The Pricelist Module is setup and the list of Pricelists are selected.
• Pricelist Status is Enabled in the settings.
• Customer Groups and Stores are set correctly in the Pricelist settings.

Please see Usage section for detailed settings instruction.

Q: Failed to save PDF file, gives errors instead.

A: Please set Display Errors: to No in your store Admin under System > Settings > Your Store > Edit > Server tab.

Q: Barcode not showing or is blank.

A: Please make sure there is data in the column for that product and the data format matches with the barcode data format requirements.

Uninstall

Please follow the steps below to uninstall Wholesale Price List Pro from your store.

1. Login to your store admin and navigate to Extensions > Modules.
2. Click on the Uninstall button for 'Wholesale Price List Pro' module. WARNING: All Wholesale Price List Pro data will be erased.
3. Remove the following files from your store.
   1. /admin/controller/module/myoc_pricelist.php
   2. /admin/language/english/module/myoc_pricelist.php
   3. /admin/view/template/myoc/pricelist.tpl
   4. /catalog/controller/module/myoc_pricelist.php
   5. /catalog/controller/myoc/pricelist.php
   6. /catalog/language/english/myoc/pricelist.php
   7. /catalog/model/myoc/pricelist.php
   8. /catalog/view/theme/default/image/sort.png
   9. /catalog/view/theme/default/stylesheet/myoc/pricelist.css
   10. /catalog/view/theme/default/stylesheet/myoc/pricelist_print.css
   11. /catalog/view/theme/default/template/module/myoc_pricelist.tpl
   12. /catalog/view/theme/default/template/myoc/pricelist.tpl
   13. /catalog/view/theme/default/template/myoc/pricelist_print.tpl
   14. /system/font/arial.ttf
   15. /system/library/myoc/barcode.php
   16. /vqmod/xml/myoc_wplpro.xml
4. Remove the following directory from your store (optional).
   1. /system/library/MPDF56/

Changelog

Version 1.5

Version 1.4.6

Version 1.4.5

Version 1.4.4

Version 1.4.3

Version 1.4.2

Version 1.4.1

Version 1.4

Version 1.3-beta

Version 1.2

Version 1.1

Version 1.0

Support

Questions

If you have any questions regarding this extension, please email to [email protected]

Professional Service

We provide a variety of professional services for your OpenCart store.

• Extension Customization
• Extension Integration
• Custom Template Integration

Please email your request to [email protected] and see how we can help you.

Comments and Feedbacks

You can always post your comments, feedback, or suggestion on the extension page here: www.opencart.com/index.php?route=extension/extension/info&extension_id=11466