Difference between revisions of "Email Orders"

From Custom Scriptz
Jump to: navigation, search
(Created page with ''''Email Orders developed by Diego Vieira'''<br /> '''Cannot be resold or freely distributed. This is not a free product.'''<br /><br /> '''To get your license key, go to <a href...')
 
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Email Orders developed by Diego Vieira'''<br />
+
'''Email Orders''' is a module developed by [[Custom Scriptz]] for [http://www.zen-cart.com Zen Cart] where Manufacturers (often called Designers by Scrapbooking Stores) can receive email reports with their sold products for each order.
'''Cannot be resold or freely distributed. This is not a free product.'''<br /><br />
+
'''To get your license key, go to <a href="http://customscriptz.com" target="_blank">http://customscriptz.com</a>'''<br /><br />
+
'''This modification need ionCube loaders installed on your system. If you try to use the files for first time and you receive this kind of message, you will need to ask your hosting company/administrator to install ionCube loaders.'''
+
  
 +
=== This module is free? ===
 +
* No, this module is available at our [http://customscriptz.com scripts store].
  
What this does do?<br />
+
=== This module is supported by Zen Cart Team? ===
Send email messages separately by manufacturer that have their products bought in the same order.<br /><br />
+
* No, we support this module.
<strong>Example:</strong><br />
+
Customer buy 10 products from 3 different Manufacturers (often called Designers by Scrapbooking Store Owners). When you use Email Orders, 3 email messages will be sent out with the following contents:<br /><br />
+
<i>ManufacturerA</i> receive an email message with 3 products and his totals (with discount if any)<br />
+
<i>ManufacturerB</i> receive an email message with 2 products and his totals (with discount if any)<br />
+
<i>ManufacturerC</i> receive an email message with 5 products and his totals (with discount if any)<br />
+
<i>Store Owner</i> receive an email message containing an report with the orders totals sent to this manufacturers.<br /><br />
+
  
If any coupon is used, the discount will be restricted only to the products/categories that have restriction to it. If a coupon is used and no restriction is applied, the discount is applied to all products for all emails with his own discount.<br /><br />
+
=== This module will overwrite any of my files? ===
This module is aimed to be used at Stores that have their default currency set to USD. In the future it will be added support for different currencies.<br /><br />
+
* No, this module does not overwrite any core file from Zen Cart.
  
'''Example:'''<br />
+
== System Requirements ==
<strong>EMAIL ORDER #1083</strong><br /><br />
+
[http://www.zen-cart.com Zen Cart v1.3.8a or newer]<br />
 +
[http://ioncube.com ionCube Loaders]<br />
 +
[http://php.net PHP 5 or newer]<br />
 +
[http://www.mysql.com MySQL 5]<br />
  
Order Number: #7335<br />
+
== Features ==
Date: 2009-05-13 23:53:17<br /><br />
+
* Send email messages separately by manufacturer that have their products purchased in the same order.
 +
* '''Example:'''
 +
Customer buy 10 products from 3 different Manufacturers. When you use Email Orders, 3 email messages will be sent out with the following contents:
  
PRODUCTS ORDERED<br />
+
* '''ManufacturerA:''' receive an email message with 3 products and his totals (with discount if any)
---------------------------------<br />
+
* '''ManufacturerB:''' receive an email message with 2 products and his totals (with discount if any)
Product name: Templates<br />
+
* '''ManufacturerC:''' receive an email message with 5 products and his totals (with discount if any)
Product model: Templates_01<br />
+
* '''Store Owner:''' receive an email message containing an report with the orders totals sent to manufacturers.
Product price: $3.50<br />
+
Product quantity: 1<br />
+
File 01 of 01<br /><br />
+
  
---------------------------------<br />
+
* If '''any''' coupon is used, the discount will be restricted only to the products/categories that have restriction to it. If a coupon is used and no restriction is applied, the discount is applied to all products for all emails with his own discount.<br /><br />
Order Total: $3.50
+
This module is aimed to be used at Stores that have their default currency set to USD. In the future versions will support different currencies.
  
<br /><br />
+
== Demo Message ==
<strong>Note: Same Order, but to another Manufacturer!</strong><br /><br />
+
'''Email sent to ManufacturerA'''
<strong>EMAIL ORDER #1083</strong><br /><br />
+
<pre>EMAIL ORDER #328
  
Order Number: #7335<br />
+
Order Number #6255
Date: 2009-05-13 23:53:17<br /><br />
+
Date: 2009-05-30 23:23:39
  
PRODUCTS ORDERED<br />
+
PRODUCTS ORDERED
---------------------------------<br />
+
---------------------------------
Product name: Template_02<br />
+
Product name: Example1
Product model: <br />
+
Product price: $2.50 (Coupon Applied)
Product price: $5.00 (Coupon Applied)<br />
+
Product quantity: 1
Product quantity: 1<br />
+
Download 01 of 01
File 01 of 01<br />
+
File 02 of 02<br />
+
File 03 of 03<br />
+
File 04 of 04<br />
+
File 05 of 05<br /><br />
+
  
---------------------------------<br />
+
Product name: Example2
Order Total: $4.50 (Coupon Code: xxxxxx - Coupon Amount: 10.00%)<br /><br />
+
Product price: $2.50 (Coupon Applied)
 +
Product quantity: 1
 +
Download 01 of 01
  
Before Installing<br />
+
Product name: Example3
This modification needs to replace the file shop-root/admin/manufacturers.php with a modified one, if you have modded this file, do the replacements by hand in the bottom of this file.<br />The moded file is compatible with <a href="http://www.zen-cart.com" target="_blank">Zen-Cart</a> v1.3.8a and it's located at the directory 'extras' within this zip. If you have not changed the original file and your Zen-Cart version is 1.3.8a, you can safely replace the file 'admin/manufacturers.php' with the modified one. Just upload the 'admin' directory that is inside your 'extras' directory to your shop-root dir. ex. /home/username/public_html/shop or you can merge the 'admin' directory that is inside the 'extras' directory with the 'upload' directory.<br /><br />
+
Product price: $4.00
 +
Product quantity: 1
 +
Download 01 of 01
  
Installing Instructions<br />
+
---------------------------------
Upload all files that are inside the folder "upload" to your shop-root directory by using your preferable ftp software.<br /><br />
+
Sub-Total: $9.00
Go to Customers -> Email Orders (if you have Admin Profiles mod, when you try to access this page you will get a 'Denied' page, so you must go to Tools -> Admin Settings and allow access to this file and try to access it again). Now you will be asked for the license key, go to <a href="http://customsriptz.com" target="_blank">http://customsriptz.com</a> then login into the client area, click on 'View Your Licenses' then 'View & Download' on the right, then you will see a box called 'Your License Key' that should look like this: 'EmailOrders-4a5s84d6asq8q'. Carefull when copying your license key, because if you miss typing the code inside the right box, you will need to reupload the file 'email_orders_license_key.php' or do the manual editing of this file. Now that you have copied the license key, past it into the text field and hit the button Save. If everything is ok, you should see the email orders page asking you to Install it. If not, insert your key manually by doing the steps below or try to reupload the file 'email_orders_license_key.php' overwriting the old one.<br /><br />
+
Coupon Discount: $5.00 (Coupon Code: coupon_test_code)
<strong>Manyally editing license key file if the step above failed:</strong><br />
+
Total: $4.00
Open the file 'upload/admin/email_orders_license_key.php' with notepad and past your license key around the quotes <strong>$license="Past here your license...";</strong> -> ex. <strong>$license="EmailOrders-4a5s84d6asq8q";</strong> (don't remove the quotes or the ;) save and upload this file to your admin folder and replace the older one. Try to access the email orders page now and hit the Install button and follow the instructions.<br /><br />
+
</pre>
and.. nothing else, just configure what you want and you are ready to go. Easy isn't?! :D<br /><br />
+
  
 +
'''Email sent to ManufacturerB'''
 +
<pre>EMAIL ORDER #329
  
After Installing<br />
+
Order Number #6255
Go to Catalog -> Manufacturers and edit each Manufacturer Email Address. If you don't type the email address for a particular Manufacturer, when you try to send a email order for him/her, you will get a error and the email will not be sent until you type his email address.<br /><br />
+
Date: 2009-05-30 23:23:39
    By default the software is set to work in Debug Mode, after you are done testing, you may want to change it to live mode, to do this go to Configuration -> Email Orders -> Debug Mode and set this to False. While debug mode is On, you will see a report at your screen like how the email message would be sent, but no emails will be send until you set debug mode to False.<br /><br />
+
  
 +
PRODUCTS ORDERED
 +
---------------------------------
 +
Product name: Example4
 +
Product model: Model_Test4
 +
Product price: $3.50
 +
Product quantity: 1
 +
Download 01 of 01
  
Upgrading Instructions<br />
+
---------------------------------
<strong>Do a full backup of your database and files before continue. We are not responsible for any loss of data.</strong><br /><br />
+
Sub-Total: $3.50
   
+
Coupon Discount: $0.00
Upload all the files that are inside the folder "upload" to your shop-root directory by using your preferable ftp software, overwriting the old files.<br />
+
Total: $3.50
Go to Customers -> Email Orders -> press the button 'Update'.<br /><br />
+
</pre>
  
Settings Available<br /><br />
+
'''Email sent to ManufacturerC'''
 +
<pre>EMAIL ORDER #330
  
All the setings below can be found at: Configuration -> Email Orders<br />
+
Order Number #6255
    <strong>Cron Admin ID</strong> - For the first time you install Email Orders, this will be set to the admin ID that installed the software, but if you delete that admin, you must change this ID for your current admin ID. You can see your admin ID going to Tools -> Admin Settings and click the green (E) and look at the right panel, you will see a number before your login name, this is your admin ID. (this is not necessary until AutoSend feature is ready)<br /><br />
+
Date: 2009-05-30 23:23:39
    <strong>Debug Mode</strong> - If this is set to True, you will see the email that would be sent out, but not sent any email until this is change to True.<br /><br />
+
    <strong>Include Gift Certificate</strong> - Changing this to false, will cause the software to not include GIFT certificates. Default = True (True meaning include gift certificates).<br /><br />
+
    <strong>Maximum Emails per Batch</strong> - When you use AutoSend feature, this will determine how many emails you can sent per batch, so if you set your cron job to run every hour it will send this amount of emails or if you set your cron job to run each 30 minutes, this value will be 2x per hour, so carefull when changing this value. Default = 25.<br /><br />
+
    <strong>Send $0 Email Orders</strong> - Changing this to false, will cause the software to not send email out if the Order Total is $0. (ex. after a coupon of 100% is applied towards the entire order, the order total will be $0). Default = True.<br /><br />
+
    <strong>Show Customer Details</strong> - This is to show the customer details within email messages, but I highly recommend leave this setting Off because of Privacy Policy. I'm not responsible for the bad use of this feature. Default = False.<br /><br />
+
    <strong>Show $0 Products</strong> - This will show the products with price of $0.00 (normally Free products) to be displayed at the send form and used with AutoSend feature. Default = False.<br /><br />
+
  
<strong>Email Orders Page - Send Old feature</strong> - You can resend products that have been sent already, when you access the Email Orders page, you will see a 'Send Old' button at the top of the page (allright, I'll move that button to the statistics panel :p). So you click the Send Old and do a search for the period that you want and send the products again as you do normally. Note: Products that have been sent will not disappear for this list, instead the column 'Sent Times' will increase by 1 each time you send the order. If you want to send new emails, just click the Send New button.<br /><br />
+
PRODUCTS ORDERED
   
+
---------------------------------
<strong><span style="color: orange;">Additional Settings</span></strong><br />
+
Product name: Example5
Catalog -> Manufacturer -> Manufacturer New/Edit Page<br /><br />
+
Product model: Model_Test5
<strong>Manufacturers Email</strong> - This is necessary if you want to send email to this manufacturer.<br /><br />
+
Product price: $3.50
<strong>Receive Email Orders</strong> - Check this if you want this manufacturer to receive email orders, otherwise his/her products will not be available for you to send to him/her until you check this.<br /><br />
+
Product quantity: 1
 +
Download 01 of 01
  
How to Use<br />
+
Product name: Example6
When you are ready, go to Customers -> Email Orders.<br /><br />
+
Product model: Model_Test6
In this page you will see a list of Products with their respective Manufacturers. Check the products (99% of the time you will leave the products checked - but you can un/check all the boxes at the top of the column with the boxes) that you want your manufacturers to receive the email for it and press the button "Send". If everything nothing goes wrong, your manufacturers should receive a email right way with his bought products. Now you are done sending and the next batch/page (if there are remaining products) will be displayed and you press the button "Send" to start again. If failed to send the email out (manufacturer with no email address for example) the products will be displayed again until you you correct the email address at the Manufacturers page. Next version you will be able to configure a scheduled task to do the job for you.<br /><br />
+
Product price: $3.00
 +
Product quantity: 1
 +
Download 01 of 01
  
AutoSend<br />
+
---------------------------------
In Development<br /><br />
+
Sub-Total: $6.50
 +
Coupon Discount: $0.00
 +
Total: $6.50
  
Note<br />
+
</pre>
- This tool send a email for each order for each manufacturer that has products in the order. Ex. Order #1234 -> 3 Manufacturers envolved, 3 email messages will be sent out, Order #1235 -> The same 3 Manufacturers, 3 email will sent out for that and this particular order, total = 6 messages. Before complaining that the tool is not working, check your email settings at My Store -> E-Mail Options or ask your host to increase the limit of email messages that you can send per hour. Maybe you have reach this limit.<br /><br />
+
''' And finally, this is the email that the Store Owner receive at each batch sent:'''
 +
<pre>Email Orders Sent Report
 +
05/30/2009 23:23:39
  
Troubleshooting<br />
+
Email Messages Sent: 3
<strong>Q:</strong> One product does not appear on the list for me to send, why?<br />
+
---------------------------------
<strong>A:</strong> Check if this a product have a manufacturer set up on the Products Page. This is a free product and your configuration is set to 'False' to not send products with price of $0.<br /><br />
+
ManufacturerA
 +
---------------------------------
 +
Email Order #328 - Order #6255 - Sub-Total: $9.00 - Coupon Discount: $5.00 (Coupon Code: coupon_test_code)
  
Manually Editing<br />
+
ManufacturerB
    <strong>File:</strong> shop-root/admin/manufacturers.php<br />
+
---------------------------------
    <strong>FIND:</strong><br />
+
Email Order #329 - Order #6255 - Sub-Total: $3.50
    <cite>$manufacturers_name = zen_db_prepare_input($_POST['manufacturers_name']);</cite><br /><br />
+
   
+
    <strong>AFTER THAT LINE ADD:</strong><br />
+
    <cite>$manufacturers_email = zen_db_prepare_input($_POST['manufacturers_email']);<br />$manufacturers_receive_orders = zen_db_prepare_input($_POST['manufacturers_receive_orders']);</cite><br /><br />
+
   
+
    <strong>FIND:</strong><br />
+
    <cite>$sql_data_array = array('manufacturers_name' => $manufacturers_name);</cite><br /><br />
+
   
+
    <strong>REPLACE WITH:</strong><br />
+
    <cite>$sql_data_array = array('manufacturers_name' => $manufacturers_name, 'manufacturers_email' => $manufacturers_email, 'manufacturers_receive_orders' => $manufacturers_receive_orders);</cite><br /><br />
+
   
+
    <strong>FIND:</strong><br />
+
    <cite>$manufacturers_query_raw = "select manufacturers_id, manufacturers_name, manufacturers_image, date_added, last_modified from " . TABLE_MANUFACTURERS . " order by manufacturers_name";</cite><br /><br />
+
   
+
    <strong>REPLACE WITH:</strong><br />
+
    <cite>$manufacturers_query_raw = "select manufacturers_id, manufacturers_name, manufacturers_email, manufacturers_receive_orders, manufacturers_image, date_added, last_modified from " . TABLE_MANUFACTURERS . " order by manufacturers_name";</cite><br /><br />
+
   
+
    <strong>FIND:</strong><br />
+
    <cite>$contents[] = array('text' => '&lt;br&gt;' . TEXT_MANUFACTURERS_NAME . '&lt;br&gt;' . zen_draw_input_field('manufacturers_name', '', zen_set_field_length(TABLE_MANUFACTURERS, 'manufacturers_name')));</cite><br /><br />
+
   
+
    <strong>AFTER THAT LINE ADD:</strong><br />
+
    <cite>$contents[] = array('text' => '&lt;br&gt;' . TEXT_MANUFACTURERS_EMAIL . '&lt;br&gt;' . zen_draw_input_field('manufacturers_email', '', 100));<br />$contents[] = array('text' => '&lt;br&gt;' . TEXT_MANUFACTURERS_RECEIVE_ORDERS . '&lt;br&gt;' . zen_draw_checkbox_field('manufacturers_receive_orders', '1', 'checked'));</cite><br /><br />
+
   
+
    <strong>FIND:</strong><br />
+
    <cite>case 'edit':</cite><br /><br />
+
   
+
    <strong>AFTER THAT LINE ADD:</strong><br />
+
    <cite>$check = '';<br />if($mInfo->manufacturers_receive_orders) $check = 'checked';</cite><br /><br />
+
   
+
    <strong>FIND:</strong><br />
+
    <cite>$contents[] = array('text' => '&lt;br /&gt;' . TEXT_MANUFACTURERS_NAME . '&lt;br&gt;' . zen_draw_input_field('manufacturers_name', $mInfo->manufacturers_name, zen_set_field_length(TABLE_MANUFACTURERS, 'manufacturers_name')));</cite><br /><br />
+
   
+
    <strong>AFTER THAT LINE ADD:</strong><br />
+
    <cite>$contents[] = array('text' => '&lt;br /&gt;' . TEXT_MANUFACTURERS_EMAIL . '&lt;br&gt;' . zen_draw_input_field('manufacturers_email', $mInfo->manufacturers_email, 100));<br />$contents[] = array('text' => '&lt;br /&gt;' . TEXT_MANUFACTURERS_RECEIVE_ORDERS . '&lt;br&gt;' . zen_draw_checkbox_field('manufacturers_receive_orders', '1', $check));</cite><br /><br />   
+
  
    <strong>FIND:</strong><br />
+
ManufacturerC
    <cite>$contents[] = array('text' => '&lt;br&gt;' . zen_info_image($mInfo->manufacturers_image, $mInfo->manufacturers_name));</cite><br /><br />
+
---------------------------------
   
+
Email Order #330 - Order #6255 - Sub-Total: $6.50
    <strong>AFTER THAT LINE ADD:</strong><br />
+
    <cite>$contents[] = array('text' => '&lt;br&gt;' . $mInfo->manufacturers_email);</cite><br /><br />
+
   
+
    <strong>SAVE, CLOSE AND UPLOAD TO YOUR shop-root/admin DIR</strong><br /><br />
+
  
 +
Sub-Total: $19.00
 +
Discounts Total: $5.00
 +
Orders Total: $14.00</pre>
  
   
+
== 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.'''
  
'''Change Log'''
+
== 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 [http://customscriptz.com/customers 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.
 +
* 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.
 +
* 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.
  
<strong>v1.0</strong><br />
+
* Wait for the upload of all files to complete.
1. Initial Release<br /><br />
+
* If your Zen Cart version is equals to 1.3.x -> go to Admin -> Customers -> Email Orders
 +
* If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Email Orders
  
<strong>v2.0</strong><br />
+
* You will then be redirected to the License Manager to enter your license.
1. A lot of improvimentst to the SQL queries<br />
+
* After you enter the license, the module will redirect you to it's main page and show you that the installation was succeed.
2. Deleted file email_orders_edit_designers.php and move the field Email to Manufacturers Page<br />
+
3. Patched manufacturers.php file to include Email field. Zen-Cart v1.3.8a.<br />
+
4. Created README file with Upgrade/Installation Instructions, Settings and How to Use. Included manually edits for file manufacturers.php.<br />
+
5. Added Spam disclaimer and copyright notice to the bottom of the emails sent. (in the next version, members will be able to buy the version withow the copyright notice)<br />
+
x. Many, many improvements to the performance and minor bug fixes.<br /><br />
+
  
<strong>v3.0</strong><br />
+
== Upgrading Instructions ==
1. AutoSend under test (not fully working)<br />
+
* Download the license manager from http://customscriptz.com/downloads/license-manager.zip
2. Added setting 'Cron Admin ID' for future AutoSend feature<br />
+
* 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.
3. Added setting 'Maximum Emails per Batch' for future AutoSend feature<br />
+
* Cut the "uploads" dir from the license manager package and past over the extracted module dir.
4. Added setting 'Show $0 Products'<br />
+
* 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. Overwrite everything.
5. Reports are now sent to the Store Owner with the send result for both Manual Send and AutoSend.<br />
+
6. Install/Update feature withow manually doing SQL updates.<br />
+
7. Set if a manufacturer can receive email or not for his/her products.<br />
+
8. Resend products that are previosly sent.<br />
+
x. Fixed minor bugs<br /><br />
+
  
<strong>v3.1</strong><br />
+
* Wait for the upload of all files to complete.
1. Manufacturers can now be set to receive or not email orders.<br />
+
* If your Zen Cart version is equals to 1.3.x -> go to Admin -> Customers -> Email Orders
3. Moved all Email Orders Settings to it's own configuration Group to Configuration -> Email Orders<br />
+
* If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Email Orders
4. Added setting 'Include Gift Certificate'<br />
+
5. Added setting 'Send $0 Email Orders'<br />
+
6. Added setting 'Send $0 orders'<br />
+
7. Emails are now sent using HTML and Plain TEXT<br />
+
x. Minor improvements<br /><br />
+
  
'''Next Version'''<br />
+
* Email Orders will update itself if necessary.
  
- Set a scheduled task (cron job) to send the emails out (AutoSend feature)<br />
+
== Settings ==
- Allow selection of what to show at the email message such as, Customer name, Order number, etc<br />
+
'''Settings can be found at the Admin Panel of your Store -> Configuration -> Email Orders'''
- Statistics panel with: How many email orders has been sent, Manufacturers total, grand total.. (suggestions are welcome)<br />
+
* Mostly settings are self-explanatory and has a description when you click on it. Just click the setting and look at the right panel to know what is it for.
- Begin test with other currencies<br />
+
 
 +
The setting below can be found at the Admin Panel of your Store -> Customers -> Email Orders
 +
* '''Send Old:''' You can resend products that have been sent already, when you access the Email Orders page, you will see a 'Send Old' button at the top of the page (allright, I'll move that button to the statistics panel :p). So you click the Send Old and do a search for the period that you want and send the products again as you do normally. Note: Products that have been sent will not disappear for this list, instead the column 'Sent Times' will increase by 1 each time you send the order. If you want to send new emails, just click the Send New button.<br /><br />
 +
 
 +
''Note: If you have PrivateArea installed, you may edit the Manfanufacturer (a.k.a Designers) at Tools -> Providers''
 +
The setting below can be found at the Admin Panel of your Store -> Customers -> Email Orders - Edit Email
 +
* '''Manufacturers Email:''' Set the email for the manufacturers.<br /><br />
 +
 
 +
== Tutorial ==
 +
''Note: If you have PrivateArea installed, you may skip the step below.''
 +
 
 +
* If your Zen Cart version is equals to 1.3.x -> go to Admin -> Customers -> Email Orders - Edit Email
 +
* If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Email Orders - Edit Email
 +
 
 +
* Edit each Manufacturer Email Address. If you don't enter the email address for a particular Manufacturer, when you try to send a email order for him/her, you will get a error and the email will not be sent until you enter his/her email address.
 +
 
 +
* By default the software is set to work in Debug Mode, after you are done testing, you may want to change it to live mode, to do this go to the Admin Panel of your Store -> Configuration -> Email Orders -> Debug Mode and set this to False. While debug mode is On, you will see a report at your screen like how the email message would be sent, but no emails will be send until you set debug mode to False.
 +
 
 +
* Go to the Admin Panel of your Store -> Customers -> Email Orders.
 +
* In this page you will see a list of Products with their respective Manufacturers. Check the products (99% of the time you will leave all products checked - but you can un/check all the boxes at once - just click the link on the top of the checkboxes column) that you want your manufacturers to receive the email from it and press the button "Send". If everything nothing goes wrong, your manufacturers should receive a email right way with his purchased products. Now you are done sending and the next batch/page (if there are remaining products) will be displayed and you press the button "Send" to start again. If failed to send the email out (manufacturer with no email address for example) the products will be displayed again until you you correct the email address at the Manufacturers page. After you are confortable using email orders, if you haven't done so, activate AutoSend and it will do it for you.
 +
 
 +
=== Emails Note ===
 +
This module send a email for each order for each manufacturer that has products in the order. Ex. Order #1234 -> 3 Manufacturers envolved, 3 email messages will be sent out, Order #1235 -> The same 3 Manufacturers, 3 email will sent out for that and this particular order, total = 6 messages. Before complaining that the tool is not working, check your email settings at My Store -> E-Mail Options or ask your host to increase the limit of email messages that you can send per hour. Maybe you have reach this limit.
 +
 
 +
== FAQ ==
 +
'''* One product does not appear on the list for me to send, why?'''
 +
* Check if this a product have a manufacturer set up on the Products Page. This is a free product and your configuration is set to 'False' to include free products.
 +
 
 +
 
 +
'''* How to reset the old products to not being sent to my manufacturers?'''
 +
* Just click the link 'Reset Old Products' on the right. Then, it will just disappear and only new orders will be available to be sent.
 +
 
 +
 
 +
'''Got Questions, Bugs or Requests?
 +
http://customscriptz.com/support'''

Latest revision as of 23:34, 27 April 2012

Email Orders is a module developed by Custom Scriptz for Zen Cart where Manufacturers (often called Designers by Scrapbooking Stores) can receive email reports with their sold products for each order.

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?

  • No, this module does not overwrite any core file from Zen Cart.

System Requirements

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

Features

  • Send email messages separately by manufacturer that have their products purchased in the same order.
  • Example:

Customer buy 10 products from 3 different Manufacturers. When you use Email Orders, 3 email messages will be sent out with the following contents:

  • ManufacturerA: receive an email message with 3 products and his totals (with discount if any)
  • ManufacturerB: receive an email message with 2 products and his totals (with discount if any)
  • ManufacturerC: receive an email message with 5 products and his totals (with discount if any)
  • Store Owner: receive an email message containing an report with the orders totals sent to manufacturers.
  • If any coupon is used, the discount will be restricted only to the products/categories that have restriction to it. If a coupon is used and no restriction is applied, the discount is applied to all products for all emails with his own discount.

This module is aimed to be used at Stores that have their default currency set to USD. In the future versions will support different currencies.

Demo Message

Email sent to ManufacturerA

EMAIL ORDER #328

Order Number #6255
Date: 2009-05-30 23:23:39

PRODUCTS ORDERED
---------------------------------
Product name: Example1
Product price: $2.50 (Coupon Applied)
Product quantity: 1
Download 01 of 01

Product name: Example2
Product price: $2.50 (Coupon Applied)
Product quantity: 1
Download 01 of 01

Product name: Example3
Product price: $4.00
Product quantity: 1
Download 01 of 01

---------------------------------
Sub-Total: $9.00
Coupon Discount: $5.00 (Coupon Code: coupon_test_code)
Total: $4.00

Email sent to ManufacturerB

EMAIL ORDER #329

Order Number #6255
Date: 2009-05-30 23:23:39

PRODUCTS ORDERED
---------------------------------
Product name: Example4
Product model: Model_Test4
Product price: $3.50
Product quantity: 1
Download 01 of 01

---------------------------------
Sub-Total: $3.50
Coupon Discount: $0.00
Total: $3.50

Email sent to ManufacturerC

EMAIL ORDER #330

Order Number #6255
Date: 2009-05-30 23:23:39

PRODUCTS ORDERED
---------------------------------
Product name: Example5
Product model: Model_Test5
Product price: $3.50
Product quantity: 1
Download 01 of 01

Product name: Example6
Product model: Model_Test6
Product price: $3.00
Product quantity: 1
Download 01 of 01

---------------------------------
Sub-Total: $6.50
Coupon Discount: $0.00
Total: $6.50

And finally, this is the email that the Store Owner receive at each batch sent:

Email Orders Sent Report
05/30/2009 23:23:39

Email Messages Sent: 3
---------------------------------
ManufacturerA
---------------------------------
Email Order #328 - Order #6255 - Sub-Total: $9.00 - Coupon Discount: $5.00 (Coupon Code: coupon_test_code)

ManufacturerB
---------------------------------
Email Order #329 - Order #6255 - Sub-Total: $3.50

ManufacturerC
---------------------------------
Email Order #330 - Order #6255 - Sub-Total: $6.50

Sub-Total: $19.00
Discounts Total: $5.00
Orders Total: $14.00

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.
  • 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.
  • 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 -> Customers -> Email Orders
  • If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Email Orders
  • 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.

Upgrading 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.
  • 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. Overwrite everything.
  • Wait for the upload of all files to complete.
  • If your Zen Cart version is equals to 1.3.x -> go to Admin -> Customers -> Email Orders
  • If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Email Orders
  • Email Orders will update itself if necessary.

Settings

Settings can be found at the Admin Panel of your Store -> Configuration -> Email Orders

  • Mostly settings are self-explanatory and has a description when you click on it. Just click the setting and look at the right panel to know what is it for.

The setting below can be found at the Admin Panel of your Store -> Customers -> Email Orders

  • Send Old: You can resend products that have been sent already, when you access the Email Orders page, you will see a 'Send Old' button at the top of the page (allright, I'll move that button to the statistics panel :p). So you click the Send Old and do a search for the period that you want and send the products again as you do normally. Note: Products that have been sent will not disappear for this list, instead the column 'Sent Times' will increase by 1 each time you send the order. If you want to send new emails, just click the Send New button.

Note: If you have PrivateArea installed, you may edit the Manfanufacturer (a.k.a Designers) at Tools -> Providers The setting below can be found at the Admin Panel of your Store -> Customers -> Email Orders - Edit Email

  • Manufacturers Email: Set the email for the manufacturers.

Tutorial

Note: If you have PrivateArea installed, you may skip the step below.

  • If your Zen Cart version is equals to 1.3.x -> go to Admin -> Customers -> Email Orders - Edit Email
  • If your Zen Cart version is equals or above 1.5.x -> go to Admin -> Custom Scriptz -> Email Orders - Edit Email
  • Edit each Manufacturer Email Address. If you don't enter the email address for a particular Manufacturer, when you try to send a email order for him/her, you will get a error and the email will not be sent until you enter his/her email address.
  • By default the software is set to work in Debug Mode, after you are done testing, you may want to change it to live mode, to do this go to the Admin Panel of your Store -> Configuration -> Email Orders -> Debug Mode and set this to False. While debug mode is On, you will see a report at your screen like how the email message would be sent, but no emails will be send until you set debug mode to False.
  • Go to the Admin Panel of your Store -> Customers -> Email Orders.
  • In this page you will see a list of Products with their respective Manufacturers. Check the products (99% of the time you will leave all products checked - but you can un/check all the boxes at once - just click the link on the top of the checkboxes column) that you want your manufacturers to receive the email from it and press the button "Send". If everything nothing goes wrong, your manufacturers should receive a email right way with his purchased products. Now you are done sending and the next batch/page (if there are remaining products) will be displayed and you press the button "Send" to start again. If failed to send the email out (manufacturer with no email address for example) the products will be displayed again until you you correct the email address at the Manufacturers page. After you are confortable using email orders, if you haven't done so, activate AutoSend and it will do it for you.

Emails Note

This module send a email for each order for each manufacturer that has products in the order. Ex. Order #1234 -> 3 Manufacturers envolved, 3 email messages will be sent out, Order #1235 -> The same 3 Manufacturers, 3 email will sent out for that and this particular order, total = 6 messages. Before complaining that the tool is not working, check your email settings at My Store -> E-Mail Options or ask your host to increase the limit of email messages that you can send per hour. Maybe you have reach this limit.

FAQ

* One product does not appear on the list for me to send, why?

  • Check if this a product have a manufacturer set up on the Products Page. This is a free product and your configuration is set to 'False' to include free products.


* How to reset the old products to not being sent to my manufacturers?

  • Just click the link 'Reset Old Products' on the right. Then, it will just disappear and only new orders will be available to be sent.


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