Difference between revisions of "Free Gifts"

From Custom Scriptz
Jump to: navigation, search
(Features)
 
(23 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/products 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? ===
* No, we support this module as soon as you have a valid license.
+
* No, we support this module.
  
 
=== 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.
+
* 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://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 ==
 +
'''Screenshot #01'''
 +
 
 
[[File:freegifts01.jpg]]
 
[[File:freegifts01.jpg]]
 +
 +
 +
'''Screenshot #02'''
 +
 
[[File:freegifts02.jpg]]
 
[[File:freegifts02.jpg]]
[[File:freegifts03.jpg]]
 
  
== Before Installing ==
 
'''BACKUP YOUR FILES AND DATABASE 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 />
+
'''Screenshot #03'''
  
There is two ways to install this modification:<br />
+
[[File:freegifts03.jpg]]
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.
+
== 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 ==
 
== Installation Instructions ==
# Inside the Zip, you will notice two folders: extras and uploads and two files called "CHANGES.htm" and "README.txt"
+
* Download the license manager from http://customscriptz.com/downloads/license-manager.zip
# 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.
+
* 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.
# 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.
+
* Cut the "uploads" dir from the license manager package and past over the extracted module dir, merge if asked.
# Go to your Admin Panel -> Tools -> Free Gifts and let it install itself.
+
* Inside the extracted dir, you will notice one dir called "uploads".
# Now you can upload the '''shopping_cart.php''' file to the proper dir and you are done. Now go to the Tutorial below.
+
* 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|Replace Files]]
  
 
== Upgrading Instructions ==
 
== Upgrading Instructions ==
* '''Make a backup of your database and files.'''
+
* Follow the installation instructions.
* Just upload the files that are inside 'uploads' to your shop-root dir and you are done.
+
  
== Settings Available ==
+
== Replace Files ==
There are two settings only and you should already set it.
+
* 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.
  
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'.
+
* 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"
  
== Tutorial ==
+
* All set. Now go for the Tutorial part below.
* 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.
+
  
 +
== Settings ==
 +
'''The settings below can be found at: Configuration -> Free Gifts'''
  
'''Fields'''
+
* '''Sidebox Image Width:''' This control the image width for the Free Gifts sidebox.
* '''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.'''
+
* '''Sidebox Image Height:''' This control the image height for the Free Gifts sidebox.
* '''Free Gift Threshold:''' The ammount that the customer need to spend for this '''Free Gift''' to activate.
+
* '''Items to show on the sidebox:''' This control how many products will show randomly in the sidebox.
* '''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.
+
* '''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.
* 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 activate.
+
  
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: Star Date -> 01/01/2010 - End Date -> 02/01/2010. Then the '''Free Gift''' will be available only at 01/01/2010.
+
== 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.
  
== FAQ ==
+
* If your Zen Cart version is equals to 1.3.x -> go to Admin -> Tools -> Free Gifts
* What happens if the customer insert two free gifts on the cart?
+
* If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Free Gifts
* Only one gift will be activated, but the customer will receive a notice about the other gift.
+
  
 +
* 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".
  
* What happens if the customer remove products from the cart so the threshold is less then the cart total?
+
* The '''Free Gift''' will be inserted, but the Status will be Inactive. To activate it, click the Red flag and the inverse to deactivate.
* 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.
+
 
 +
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.
  
  
* 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. The customer will be able to choose which one to pick.
  
== Change Log ==
 
'''Version 1.0'''
 
<pre>
 
Initial release
 
</pre>
 
  
For Bugs, Suggestions and Requests, go to http://customscriptz.com
+
'''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