Difference between revisions of "Free Gifts"

From Custom Scriptz
Jump to: navigation, search
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 ==
Line 38: Line 37:
  
 
== 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 ===
+
* Unzip the file that you downloaded from our [http://customscriptz.com/customers Customers Area] to a temp dir on your computer.
# Inside the Zip, you will notice two folders: extras and uploads and two files called "CHANGES.htm" and "README.txt"
+
* Inside that dir, you will notice one dir called "uploads".
# 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.
+
* If your "admin" directory has a different name, rename the dir "admin" dir that's inside the "uploads" dir to match yours.
# 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.
+
* Upload all contents of the dir "uploads" to the root of your shop (don't upload the dir "uploads", but what is inside of it). There are no overwrites.
# Go to your Admin Panel -> Tools -> Free Gifts and let it install itself.
+
* After uploading all files, go to the Admin Panel of your Store -> Tools -> Free Gifts.
# Now you can upload the '''shopping_cart.php''' file to the proper dir and you are done. Now go to the Tutorial below.
+
* Free Gifts will install itself and you should notice a ''success'' message.
 +
* Now go to [[#Replace_Files|Replace Files]]
  
=== Part 2 ===
+
== Upgrading Instructions ==
Now you need to make changes to two files:
+
* Unzip the file that you downloaded from our [http://customscriptz.com/customers Client Area] to a temp dir on your computer.
- 'includes/classes/shopping_cart.php'<br />
+
* Inside that dir, you will notice one dir called "uploads".
- 'includes/modules/order_total/ot_total.php'<br />
+
* If your "admin" dir is set to a different name, rename it to match yours.
 +
* If you changed any of the language files located at "/includes/languages/your-languages/extra_definitions", be sure to backup this dir before overwrite the files.
 +
* Upload all contents of the dir "uploads" to the root of your shop (don't upload the dir "uploads", but what is inside of it). Overwrite all files.
 +
* After uploading the files, go to the Admin Panel of your Store -> Tools -> Free Gifts. Free Gifts will update itself if necessary.
 +
* Now go to [[#Replace_Files|Replace Files]]
  
There is two ways to do those changes:<br />
+
== Replace Files ==
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.
+
* Go to "/includes/classes" and rename the file "shopping_cart.php" to "shopping_cart-backup-dd-mm-yy.php" (where dd-mm-yy means day-month-year).
 +
* Go to "/includes/classes" and rename the file "shopping_cart_freegifts.php" to "shopping_cart.php".
 +
* 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.
  
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].
+
* Go to "/includes/modules/order_total" and rename the file "ot_total.php" to "ot_total-backup-dd-mm-yy.php" (where dd-mm-yy means day-month-year).
 
+
* Go to "/includes/modules/order_total" and rename the file "ot_total_freegifts.php" to "ot_total.php".
== Upgrading Instructions ==
+
* If you changed the original file "ot_total.php", you will need a comparison tool like [http://winmerge.org WinMerge] to see what's different in both files.
* Upload the files that are inside 'uploads' to your shop-root dir.
+
* Compare both shopping_cart.php and ot_total.php to your current version to be sure that the files has not been modified.
+
  
 
== Settings ==
 
== Settings ==
Line 67: Line 71:
 
* '''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.
+
* '''Show "Already in Cart" Message:''' This setting is usefull to prevent your customer of inserting the product to the cart again when it's already in their cart. Setting this to True, will show a little message on the product page telling that the product is already in their cart.
 
+
  
 
== Tutorial ==
 
== Tutorial ==
Line 74: Line 77:
 
* After that, go to Tools -> Free Gifts.
 
* 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.
 
* Click the button 'New Product', wait the page load. Depending on the number of products, this might take some seconds.
 
  
 
'''Fields'''
 
'''Fields'''
Line 81: Line 83:
 
* '''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.
 
* '''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.
 
* 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.
+
* 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.
+
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.
 
+
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.
+
  
 
== 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 be removed from the cart and the customer will receive a notice.
  
* 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.
+
'''* 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.
  
  
For Bugs, Suggestions and Requests, go to http://customscriptz.com/support
+
'''Got Questions, Bugs or Requests?'''
 +
http://customscriptz.com/support

Revision as of 09:56, 18 February 2010

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.x.x or newer
MySQL 5

Features

  • Get one Product when you buy more them $x.xx.
  • Example:

If your customer buy $10.00 you, him/her get product X 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

  • Unzip the file that you downloaded from our Customers Area to a temp dir on your computer.
  • Inside that 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.
  • Upload all contents of the dir "uploads" to the root of your shop (don't upload the dir "uploads", but what is inside of it). There are no overwrites.
  • After uploading all files, go to the Admin Panel of your Store -> Tools -> Free Gifts.
  • Free Gifts will install itself and you should notice a success message.
  • Now go to Replace Files

Upgrading Instructions

  • Unzip the file that you downloaded from our Client Area to a temp dir on your computer.
  • Inside that dir, you will notice one dir called "uploads".
  • If your "admin" dir is set to a different name, rename it to match yours.
  • If you changed any of the language files located at "/includes/languages/your-languages/extra_definitions", be sure to backup this dir before overwrite the files.
  • Upload all contents of the dir "uploads" to the root of your shop (don't upload the dir "uploads", but what is inside of it). Overwrite all files.
  • After uploading the files, go to the Admin Panel of your Store -> Tools -> Free Gifts. Free Gifts will update itself if necessary.
  • Now go to Replace Files

Replace Files

  • Go to "/includes/classes" and rename the file "shopping_cart.php" to "shopping_cart-backup-dd-mm-yy.php" (where dd-mm-yy means day-month-year).
  • Go to "/includes/classes" and rename the file "shopping_cart_freegifts.php" to "shopping_cart.php".
  • 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 rename the file "ot_total.php" to "ot_total-backup-dd-mm-yy.php" (where dd-mm-yy means day-month-year).
  • Go to "/includes/modules/order_total" and rename the file "ot_total_freegifts.php" to "ot_total.php".
  • If you changed the original file "ot_total.php", you will need a comparison tool like WinMerge to see what's different in both files.

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.
  • Show "Already in Cart" Message: This setting is usefull to prevent your customer of inserting the product to the cart again when it's already in their cart. Setting this to True, will show a little message on the product page telling that the product is already in their cart.

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.
  • 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.

Fields

  • 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.
  • Free Gift Threshold: The ammount that the customer need to spend for this Free Gift to activate.
  • 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 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 be removed from the cart and the customer will receive a notice.


* 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