Difference between revisions of "Free Gifts"

From Custom Scriptz
Jump to: navigation, search
Line 9: Line 9:
  
 
=== This module will overwrite any of my files? ===
 
=== This module will overwrite any of my files? ===
* Yes, this module does overwrite 1 (one) core file from Zen Cart.
+
* Yes, this module does overwrite 2 (two) core files from Zen Cart.
  
 
== System Requirements ==
 
== System Requirements ==
Line 37: Line 37:
 
[[File:freegifts03.jpg]]
 
[[File:freegifts03.jpg]]
  
== Before Installing ==
+
== Before Installing / Upgrading ==
'''BACKUP YOUR FILES AND DATABASE 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'''
 
+
This modification needs to replace the file 'includes/classes/shopping_cart.php' or you need to make the proper changes for '''Free Gifts''' to work.<br />
+
 
+
There is two ways to install this modification:<br />
+
1. Open the dir '''extras''' that came with the Zipped file you downloaded from our cliente area, then '''v1.3.8a Patch\includes\classes''' (if your version is different from 1.3.8a contact us before installing this mod, as there is guarantee that it will work with older/newer versions) and you will find a file called '''shopping_cart.php''' there. If you have not changed the original file and your Zen Cart version is 1.3.8a, you can safely replace the file at eg. /home/yourshop/shop/includes/classes, but don't upload it yet.
+
 
+
2. If you changed that file and want to do the modifications by hand. Find the file "CHANGES.htm" within the Zip file and do the replacements by hand or use a software like [http://winmerge.org WinMerge] and compare both files.
+
  
 
== Installation Instructions ==
 
== Installation Instructions ==
 +
=== Part 1 ===
 
# Inside the Zip, you will notice two folders: extras and uploads and two files called "CHANGES.htm" and "README.txt"
 
# Inside the Zip, you will notice two folders: extras and uploads and two files called "CHANGES.htm" and "README.txt"
 
# 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.
 
# 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.
Line 53: Line 47:
 
# Go to your Admin Panel -> Tools -> Free Gifts and let it install itself.
 
# Go to your Admin Panel -> Tools -> Free Gifts and let it install itself.
 
# Now you can upload the '''shopping_cart.php''' file to the proper dir and you are done. Now go to the Tutorial below.
 
# Now you can upload the '''shopping_cart.php''' file to the proper dir and you are done. Now go to the Tutorial below.
 +
 +
=== Part 2 ===
 +
Now you need to make changes to two files:
 +
- 'includes/classes/shopping_cart.php'<br />
 +
- 'includes/modules/order_total/ot_total.php'<br />
 +
 +
There is two ways to do those changes:<br />
 +
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.
 +
 +
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 ==
* '''Make a backup of your database and files.'''
+
* Upload the files that are inside 'uploads' to your shop-root dir.
* Just upload the files that are inside 'uploads' to your shop-root dir and you are done.
+
* Compare both shopping_cart.php and ot_total.php to your current version to be sure that the files has not been modified.
  
== Settings Available ==
+
== Settings ==
There are two settings only and you should already set it.
+
'''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.
 +
* '''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.
  
The image size for the Free Gifts sidebox is controlled by the settings located at Configuration -> Images. They are 'Small Image Width' and 'Small Image Height'.
 
  
 
== Tutorial ==
 
== Tutorial ==
Line 81: Line 88:
  
 
== FAQ ==
 
== FAQ ==
* What happens if the customer insert two free gifts on the cart?
 
* Only one gift will be activated, but the customer will receive a notice about the other gift. [Future release will include a Configuration, so you can set how many free gifts you want to give away]
 
 
 
 
* 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 act as normal product, but the customer will receive a notice about how much they need to spend to get that free gift.
+
* The free gift will be removed from the cart and the customer will receive a notice.
 
+
  
* What happens if the customer insert one Free Gift of threshold eg. $10.00 and another of $15.00 in the Cart?
+
* Can I set more than one free gift at the same time for the same timeframe?
* If the customer insert $12.00 (plus the second Free Gift) the product of threshold $10.00 will be activated on the cart. If the customer pass the $15.00 the second gift will take the place of the first.
+
* Yes, just be sure to set the Configuration to not Auto Add the product to the Cart.
  
== Change Log ==
 
'''Version 1.0'''
 
<pre>
 
Initial release
 
</pre>
 
  
For Bugs, Suggestions and Requests, go to http://customscriptz.com
+
For Bugs, Suggestions and Requests, go to http://customscriptz.com/support

Revision as of 02:55, 23 January 2010

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


This module is free?

  • No, this module isn't free and it's for sale at our scripts store.

This module is supported by Zen Cart Team?

  • No, we support this module.

This module will overwrite any of my files?

  • Yes, this module does overwrite 2 (two) 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

Part 1

  1. Inside the Zip, you will notice two folders: extras and uploads and two files called "CHANGES.htm" and "README.txt"
  2. 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.
  3. 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.
  4. Go to your Admin Panel -> Tools -> Free Gifts and let it install itself.
  5. Now you can upload the shopping_cart.php file to the proper dir and you are done. Now go to the Tutorial below.

Part 2

Now you need to make changes to two files: - 'includes/classes/shopping_cart.php'
- 'includes/modules/order_total/ot_total.php'

There is two ways to do those changes:
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.

2. If you changed the files and want to do the modifications by hand. Use a tool like 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.

Upgrading Instructions

  • 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

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


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 vice-versa to deactivate.

Note: Don't leave any field Empty.

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

  • 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, just be sure to set the Configuration to not Auto Add the product to the Cart.


For Bugs, Suggestions and Requests, go to http://customscriptz.com/support