Shipping Surcharges. Shipping Surcharges Module for Magento

Transcription

1 Shipping Surcharges Module for Magento

2 TABLE OF CONTENTS Table of Contents Table Of Contents INTRODUCTION Overview Requirements Features Installation Shipping Surcharges Manual Installation Configuration Enable Shipping Surharges Extension Add surcharges for shipping methods Technical Information Un-installation Unsupported Features & Known Issues Troubleshooting...9

3 1. INTRODUCTION This document is intended as a technical resource for the installation, setup and use of the Shipping Surcharges Module for Magento. This extension is plug& Play and is compatible with Magento Community version 1.6, 1.7 & 1.8. This extension allows admin user to define surcharges for different methods of Fedex, UPS & USPS. 2. Overview Magento is an open source e-commerce CMS that uses a LAMP (Linux, Apache, MySQL, PHP) architecture. As an open source platform, the modifications one could make to their website are limitless. With this in mind the integration was developed to incorporate as close to core Magento API functionality as possible. By installing Shipping Surcharges in your website admin user will be able to define surcharges for different methods of Fedex, UPS & USPS easily from admin. This surcharge will get add with default handling fee of particular shipping method (i.e. of Fedex, UPS & USPS). 3. Requirements 1. Magento Community Edition v1.6+ & above 2. Shipping Surcharges Extension Module from 3. Magento Administrative Privileges 4. Features This is a Third Party Module to integrate with Magento. It has features to allow admin user to define surcharges for different methods of Fedex, UPS & USPS. (One method will have only one surcharge defined.) Also if user has set surcharge for a method & then user changed settings from shipping methods, & deselect that method from Allowed Method, in that case that method will no longer will be visible. But it s value will remain in database, until user don t save the configuration for Shipping Surcharges. Means if user again enable that method (without saving configuration for Shipping Surcharges ), it s old value will get display again.

4 5. Installation 5.1 Shipping Surcharges Manual Installation Below are the steps to install Shipping Surcharges extension : 1. Obtain a copy of the Shipping Surcharges module 2. Unzip the Module files into a local directory. 3. Move all files into their respective directories in your Magento installation directory on the FTP server as they appear after unzipping the package. 4. Clear cache from Magento admin panel under System > Cache Management. 5. Log Out of your Magento Admin and then log back in. (This refreshes the Magento ACL date which effects your administrative permissions. You will not see expected module behavior until you do this. You may also need to refresh your cache.) 6. You should now have a General and Manage Surcharges section in your Admin Panel under System>Configurations>Perficient extensions>shipping Surcharges 7. Enable Shipping Surcharges Extension from General section. 8. Shipping Surcharges is now enabled. 9. You can set surcharges configure frontend visibility from Manage Surcharges Section 6. Configuration All configurations can be managed from the Magento Admin Panel system configuration settings PERFICIENT EXTENSIONS-> Shipping Surcharges. 6.1 Enable Shipping Surcharges Extension Go to System>Configuration>Perficient Extension>Shipping Surcharges>General and set this to yes to enable the extension Figure 6.1-1

5 Go to System>Configuration>Perficient Extension>Shipping Surcharges>Manage Surcharges. Figure Add Surcharges for Shipping Methods Below are the Steps to add surcharges: Click Add surcharges to add new surcharge for particular method. Select a method from drop down. Select Apply type. If Fixed is selected then, surcharges will added as it is in total shipping amount fetched from UPS/USPS/Fedex. If Percent is selected then, that much percent of total shipping amount fetched from UPS/USPS/Fedex will get added. Define surcharge, if no value is define, surcharge will set to 0. Note: If default Handling Fee is define in shipping method then it will also get added to total shipping amount with surcharge. Note: User can set only surcharge for a method. If user will try to define multiple surcharges for a method, an error message will be shown & only first one will get added & rest will be removed. Figure 6.2-1

6 Figure Note: If Percent is selected then, percent of shipping charge will get calculated (excluding handling fee). Note: In Shipping Method dropdown only those methods will get displayed, which are set as Allowed Methods from UPS/USPS/Fedex. Figure 6.2-3

7 Figure Technical Information Following are the files required for the extension: The Shipping Surcharges module has the following components: Controllers: The Shipping Surcharges Module don t use any controller. Model: Contains all Model files providing data, service related to data and business logic. Block: Contains all block files which defines how to present data. Sql : The Shipping Surcharges Module doesn t create any database table. Frontend: The Shipping Surcharges Module doesn t use any layout or template for frontned. 8. Un-installation Below are the steps to un-install the application Remove Module Activation file: o Remove Perficient_Surcharges.xml from \app\etc\modules\ folder Remove Module from Code : o Remove files form app\code\local\perficient\surcharges\ of Shipping Surcharges. Remove Database Entries of modules :

8 o Run below query in database DELETE FROM `core_config_data` WHERE core_config_data.path LIKE '%perficient_surcharges%' 9. Unsupported Features & Known Issues The Shipping Surcharges module only supports methods of UPS, USPS & Fedex. Incompatible with "Address Validation : There is an extension UPS address validation and deliver date to add by Perficient Solution, Which is not fully compatible with "Shipping Surcharge". As the same class has been overridden by both the extensions. So only one class will be working at one time. If you are using both the extension at the same time, only one functionality will work. To resolve the issue you need to merge the classes of these two extensions into one. Below are the steps:- 1. Add all the functions & variable of class "Perficient_Perficientups_Model_Shipping_Carrier_Ups" to "Perficient_Surcharges_Model_Shipping_Carrier_Ups" 2. Remove below code <rewrite> <shipping_carrier_ups>perficient_surcharges_model_shipping_car rier_ups</shipping_carrier_ups> </rewrite> from Perficient/Surcharges/etc/config.xml Or 1. Add all the functions & variable of class Perficient_Surcharges_Model_Shipping_Carrier_Ups to Perficient_Perficientups_Model_Shipping_Carrier_Ups 2. Remove <rewrite> <shipping_carrier_ups>perficient_perficientups_model_shipping_c arrier_ups</shipping_carrier_ups> </rewrite> from Perficient/Perficientups/etc/config.xml

9 10. Troubleshooting If Module is not working on front end, then check is enable the extension from System>Configurations>Perficient extensions> Shipping Surcharges section.