Difference between revisions of "Free Gifts"

From Custom Scriptz
Jump to: navigation, search
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Free Gifts''' is a module developed by [[Custom Scriptz]] for [http://www.zen-cart.com Zen Cart] where your Customers can get a free product by a certain ammount.
+
'''Free Gifts''' is a module developed by [[Custom Scriptz]] for [http://www.zen-cart.com Zen Cart] where your customers can get a free product by spending a certain amount.
 
+
  
 
=== This module is free? ===
 
=== This module is free? ===
* No, this module isn't free and it's for sale at our [http://customscriptz.com scripts store].
+
* No, this module is available at our [http://customscriptz.com scripts store].
  
 
=== This module is supported by Zen Cart Team? ===
 
=== This module is supported by Zen Cart Team? ===
Line 9: Line 8:
  
 
=== This module will overwrite any of my files? ===
 
=== This module will overwrite any of my files? ===
* Yes, this module does overwrite 2 (two) core files from Zen Cart.
+
* Actually, it does not overwrite, but take place of 2 core files from Zen Cart.
  
 
== System Requirements ==
 
== System Requirements ==
 
[http://www.zen-cart.com Zen Cart v1.3.8a or newer]<br />
 
[http://www.zen-cart.com Zen Cart v1.3.8a or newer]<br />
 
[http://ioncube.com ionCube Loaders]<br />
 
[http://ioncube.com ionCube Loaders]<br />
[http://php.net PHP 5.x.x or newer]<br />
+
[http://php.net PHP 5 or newer]<br />
 
[http://www.mysql.com MySQL 5]<br />
 
[http://www.mysql.com MySQL 5]<br />
  
 
== Features ==
 
== Features ==
* Get one Product when you buy more them $x.xx.
+
* Get a product when you buy more than $x.xx.
 +
* Get a product when you buy more than $x.xx from selected categories.
 +
* Get a product when you buy another product.
 +
* Get a product from one or more categories and get another product.
 
* '''Example:'''
 
* '''Example:'''
If your customer buy $10.00 you, him/her get product X for Free.
+
If the customer spend $10.00, he can get product X for Free.
 +
If the customer spend $10.00 in category A, he can get product Y for Free.
  
 
== Screenshots ==
 
== Screenshots ==
Line 38: Line 41:
  
 
== Before Installing / Upgrading ==
 
== Before Installing / Upgrading ==
'''Thought our modules are exhausted tested, we do not guarantee that everything goes smoothly, so please, backup your database and files before proceed'''
+
'''Thought our modules are exhausted tested, we do not guarantee that everything goes smoothly, so please, BACKUP YOUR DATABASE AND FILES before proceed.'''
  
 
== Installation Instructions ==
 
== Installation Instructions ==
=== Part 1 ===
+
* Download the license manager from http://customscriptz.com/downloads/license-manager.zip
# Inside the Zip, you will notice two folders: extras and uploads and two files called "CHANGES.htm" and "README.txt"
+
* Extract both license manager and the module file that you downloaded from our [http://customscriptz.com/customers Customers Area] to a temp dir on your computer.
# Open the folder uploads and you will notice a folder called "admin". If your admin directory has a different name other than "admin", change it.
+
* Cut the "uploads" dir from the license manager package and past over the extracted module dir, merge if asked.
# Upload all files that are inside the folder "uploads" to your shop-root directory by using your preferable ftp software. Don't upload the folder "uploads", upload what's inside of it.
+
* Inside the extracted dir, you will notice one dir called "uploads".
# Go to your Admin Panel -> Tools -> Free Gifts and let it install itself.
+
* If your "admin" directory has a different name, rename the dir "admin" dir that's inside the "uploads" dir to match yours.
# Now you can upload the '''shopping_cart.php''' file to the proper dir and you are done. Now go to the Tutorial below.
+
* Rename the dir "uploads/includes/templates/YOUR-TEMPLATE" to match your template.
 +
* '''PrivateArea owners''': If you are installing on PrivateArea, duplicate the admin dir and rename to privatearea.
 +
* Now, upload all the contents of the dir "uploads" to the root of your store. Don't upload the "uploads" dir, but what's inside of it. There are no overwrites.
  
=== Part 2 ===
+
* Wait for the upload of all files to complete.
Now you need to make changes to two files:
+
* If your Zen Cart version is equals to 1.3.x -> go to Admin -> Tools -> Free Gifts
- 'includes/classes/shopping_cart.php'<br />
+
* If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Free Gifts
- 'includes/modules/order_total/ot_total.php'<br />
+
  
There is two ways to do those changes:<br />
+
* You will then be redirected to the License Manager to enter your license.
1. If you did not modified the file shoppin_cart.php and ot_total.php shown above, you can open the dir '''extras''' that came with the zipped file you downloaded from our cliente area, then copy the dir '''includes''' that's inside the dir '''v1.3.8a Patch''' to your shop-root and replace both files. Be sure to keep a backup of those two files in case you need to rollback the changes.
+
* After you enter the license, the module will redirect you to it's main page and show you that the installation was succeed.
 
+
* Now go to [[#Replace_Files|Replace Files]]
2. If you changed the files and want to do the modifications by hand. Use a tool like [http://winmerge.org WinMerge] from both pair of files and make the proper patch to your files. If you want us to do it for you, contact us by going to [http://customscriptz.com/support http://customscriptz.com/support].
+
  
 
== Upgrading Instructions ==
 
== Upgrading Instructions ==
* Upload the files that are inside 'uploads' to your shop-root dir.
+
* Follow the installation instructions.
* Compare both shopping_cart.php and ot_total.php to your current version to be sure that the files has not been modified.
+
 
 +
== Replace Files ==
 +
* Go to "/includes/classes" and rename the file "shopping_cart.php" to "shopping_cart-backup.php" (without quotes)
 +
* Go to "/includes/classes" and rename the file "shopping_cart_freegifts_xxx.php" to "shopping_cart.php" (where xxx is the version of your cart).
 +
* If you changed the original file "shopping_cart.php", you will need a comparison tool like [http://winmerge.org WinMerge] to see what's different in both files.
 +
 
 +
* Go to "/includes/modules/order_total" and copy the file "ot_total.php" to your computer, then delete it.
 +
* Go to "/includes/modules/order_total", rename the file "ot_total_freegifts.php.freegifts" to "ot_total.php"
 +
 
 +
* All set. Now go for the Tutorial part below.
  
 
== Settings ==
 
== Settings ==
Line 67: Line 79:
 
* '''Sidebox Image Width:''' This control the image width for the Free Gifts sidebox.
 
* '''Sidebox Image Width:''' This control the image width for the Free Gifts sidebox.
 
* '''Sidebox Image Height:'''  This control the image height for the Free Gifts sidebox.
 
* '''Sidebox Image Height:'''  This control the image height for the Free Gifts sidebox.
* '''Auto Add Product:''' If you mostly run only 1 free gift at a time, this could be set to True, because when the customer reach the amount for the free gift, it will be automatically added to the cart, but if you run 2 or more free gifts at a time, you should leave this to False, as the customer could select which free gift to get. Also, there is no problem to leave this as False when running 1 free gift or to True when running 2 free gifts, it's just a matter of choice.
+
* '''Items to show on the sidebox:'''  This control how many products will show randomly in the sidebox.
 +
* '''Remove Free Gift if Coupon is Used:''' If you want to restrict a customer to use a coupon that makes the order total pass the minimum threshold to get the free gift, set this to True. Eg. Free Gift Threshold $10, customer buy $15 in total, use a coupon of 50%, so the order will be $7.50, not $10, so if this is set to True, the customer will be warned, and the free gift removed from the cart. If you don't want to care about this and let customer checkout even if the order total is less than the minimum amount, set this to False.
  
  
 
== Tutorial ==
 
== Tutorial ==
* Go to Tools -> Layout Boxes Controller. You will notice that a new box has been found: freegifts. Go ahead and activate it. I recommend you to place on the top, so your customers will notice the free gifts. The box is not displayed if there are not free gifts available.
+
* Go to Tools -> Layout Boxes Controller. You will notice that a new box has been found: freegifts. Go ahead and activate it. I recommend you to place on the top, so your customers will notice the free gifts. The box is not displayed if there are no free gifts available.
* After that, go to Tools -> Free Gifts.
+
* Click the button 'New Product', wait the page load. Depending on the number of products, this might take some seconds.
+
  
 +
* If your Zen Cart version is equals to 1.3.x -> go to Admin -> Tools -> Free Gifts
 +
* If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Free Gifts
  
'''Fields'''
+
* Click the button 'New Product', wait the page load.
* '''Free Gift Name:''' Choose the Product that you want to be a '''Free Gift'''. Only active and products that are not already a '''Free Gift''' will appear on that list. '''The product does not have to be a free product.'''
+
* That page contains tips and instructions about each field.
* '''Free Gift Threshold:''' The ammount that the customer need to spend for this '''Free Gift''' to activate.
+
* Fill in all the required fields and then click "Insert".
* '''Start Date and End Date:''' The timeframe that this '''Free Gift''' will be avaiable. Only '''Free Gifts''' with status active and the date is in the timeframe will be available.
+
* Click the Insert button.
+
* The '''Free Gift''' will be inserted, but the Status will be Inactive. To activate it, click the Red flag and vice-versa to deactivate.
+
  
Note: Don't leave any field Empty.
+
* The '''Free Gift''' will be inserted, but the Status will be Inactive. To activate it, click the Red flag and the inverse to deactivate.
  
Note 2: If you want to make the Free Gift available at 01/01/2010 only. Do as follow: Start Date -> 01/01/2010 - End Date -> 02/01/2010. Then the '''Free Gift''' will be available only at 01/01/2010.
+
Note: Don't leave any field Empty. If you want to make the Free Gift available at 01/01/2010 only. Do as follow: Start Date -> 01/01/2010 - End Date -> 02/01/2010. Then the '''Free Gift''' will be available only at 01/01/2010.
  
 
== FAQ ==
 
== FAQ ==
* What happens if the customer remove products from the cart so the threshold is less then the cart total?
+
'''* What happens if the customer remove products from the cart so the threshold is less then the cart total?'''
* The free gift will be removed from the cart and the customer will receive a notice.
+
* The free gift will act like a normal product.
 +
 
  
* Can I set more than one free gift at the same time for the same timeframe?
+
'''* Can I set more than one free gift at the same time for the same timeframe?'''
* Yes, just be sure to set the Configuration to not Auto Add the product to the Cart.
+
* Yes. The customer will be able to choose which one to pick.
  
  
For Bugs, Suggestions and Requests, go to http://customscriptz.com/support
+
'''Got Questions, Bugs or Requests?'''
 +
http://customscriptz.com/support

Latest revision as of 22:12, 16 January 2015

Free Gifts is a module developed by Custom Scriptz for Zen Cart where your customers can get a free product by spending a certain amount.

This module is free?

This module is supported by Zen Cart Team?

  • No, we support this module.

This module will overwrite any of my files?

  • Actually, it does not overwrite, but take place of 2 core files from Zen Cart.

System Requirements

Zen Cart v1.3.8a or newer
ionCube Loaders
PHP 5 or newer
MySQL 5

Features

  • Get a product when you buy more than $x.xx.
  • Get a product when you buy more than $x.xx from selected categories.
  • Get a product when you buy another product.
  • Get a product from one or more categories and get another product.
  • Example:

If the customer spend $10.00, he can get product X for Free. If the customer spend $10.00 in category A, he can get product Y for Free.

Screenshots

Screenshot #01

Freegifts01.jpg


Screenshot #02

Freegifts02.jpg


Screenshot #03

Freegifts03.jpg

Before Installing / Upgrading

Thought our modules are exhausted tested, we do not guarantee that everything goes smoothly, so please, BACKUP YOUR DATABASE AND FILES before proceed.

Installation Instructions

  • Download the license manager from http://customscriptz.com/downloads/license-manager.zip
  • Extract both license manager and the module file that you downloaded from our Customers Area to a temp dir on your computer.
  • Cut the "uploads" dir from the license manager package and past over the extracted module dir, merge if asked.
  • Inside the extracted dir, you will notice one dir called "uploads".
  • If your "admin" directory has a different name, rename the dir "admin" dir that's inside the "uploads" dir to match yours.
  • Rename the dir "uploads/includes/templates/YOUR-TEMPLATE" to match your template.
  • PrivateArea owners: If you are installing on PrivateArea, duplicate the admin dir and rename to privatearea.
  • Now, upload all the contents of the dir "uploads" to the root of your store. Don't upload the "uploads" dir, but what's inside of it. There are no overwrites.
  • Wait for the upload of all files to complete.
  • If your Zen Cart version is equals to 1.3.x -> go to Admin -> Tools -> Free Gifts
  • If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Free Gifts
  • You will then be redirected to the License Manager to enter your license.
  • After you enter the license, the module will redirect you to it's main page and show you that the installation was succeed.
  • Now go to Replace Files

Upgrading Instructions

  • Follow the installation instructions.

Replace Files

  • Go to "/includes/classes" and rename the file "shopping_cart.php" to "shopping_cart-backup.php" (without quotes)
  • Go to "/includes/classes" and rename the file "shopping_cart_freegifts_xxx.php" to "shopping_cart.php" (where xxx is the version of your cart).
  • If you changed the original file "shopping_cart.php", you will need a comparison tool like WinMerge to see what's different in both files.
  • Go to "/includes/modules/order_total" and copy the file "ot_total.php" to your computer, then delete it.
  • Go to "/includes/modules/order_total", rename the file "ot_total_freegifts.php.freegifts" to "ot_total.php"
  • All set. Now go for the Tutorial part below.

Settings

The settings below can be found at: Configuration -> Free Gifts

  • Sidebox Image Width: This control the image width for the Free Gifts sidebox.
  • Sidebox Image Height: This control the image height for the Free Gifts sidebox.
  • Items to show on the sidebox: This control how many products will show randomly in the sidebox.
  • Remove Free Gift if Coupon is Used: If you want to restrict a customer to use a coupon that makes the order total pass the minimum threshold to get the free gift, set this to True. Eg. Free Gift Threshold $10, customer buy $15 in total, use a coupon of 50%, so the order will be $7.50, not $10, so if this is set to True, the customer will be warned, and the free gift removed from the cart. If you don't want to care about this and let customer checkout even if the order total is less than the minimum amount, set this to False.


Tutorial

  • Go to Tools -> Layout Boxes Controller. You will notice that a new box has been found: freegifts. Go ahead and activate it. I recommend you to place on the top, so your customers will notice the free gifts. The box is not displayed if there are no free gifts available.
  • If your Zen Cart version is equals to 1.3.x -> go to Admin -> Tools -> Free Gifts
  • If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Free Gifts
  • Click the button 'New Product', wait the page load.
  • That page contains tips and instructions about each field.
  • Fill in all the required fields and then click "Insert".
  • The Free Gift will be inserted, but the Status will be Inactive. To activate it, click the Red flag and the inverse to deactivate.

Note: Don't leave any field Empty. If you want to make the Free Gift available at 01/01/2010 only. Do as follow: Start Date -> 01/01/2010 - End Date -> 02/01/2010. Then the Free Gift will be available only at 01/01/2010.

FAQ

* What happens if the customer remove products from the cart so the threshold is less then the cart total?

  • The free gift will act like a normal product.


* Can I set more than one free gift at the same time for the same timeframe?

  • Yes. The customer will be able to choose which one to pick.


Got Questions, Bugs or Requests? http://customscriptz.com/support