Prestashop Ship2MyId Module Configuration Process Ship2MyID Module Version : v1.0.2 Compatibility : PrestaShop v1.5.5.0 - v1.6.0.14 1 P a g e
Table of Contents 1. Module Download & Setup on Store... 4 1.1. If you are using PrestaShop version 1.6 or PrestaShop Cloud... 4 1.2. If you are using PrestaShop version 1.4 or 1.5... 4 1.2.1.Installing using the dedicated form... 4 1.2.2.Installing using a FTP client... 5 1.3. Important Manual Steps... 5 2. Module Installation & Configuration... 7 2.1. Module Installation... 7 2.2. Before Module Configuration.....8 2.3 Module Configuration......8 2.4 Module Changes to Point Ship2MyId Live/Production Server...10 3. How to Test Module... 12 2 P a g e
Assumptions: Ship2MyId Module is uploaded on PrestaShop Add-ons (The Official Marketplace for PrestaShop Modules). Limitation: Image 1.0 : Ship2MyId Module Page on PrestaShop Add-Ons Site. 1. Ship2MyId Module is compatible with PrestaShop versions PrestaShop v1.5.5.0 - v1.6.0.14. 2. Ship2MyId Module does not support PayPal Express Checkout Payment method. 3. Ship2MyId Module does not support Onestepcheckout Imp Note: On the module configuration page, the default URL s are pointing to mapmyid.com server. You need to manually update it to ship2myid.com. 3 P a g e
1. Module Download & Setup on Store Merchant can download the module zip file from PrestaShop add-ons page (Ref. Image 1.0). Below are the steps to download module to store. 1.1 If you are using PrestaShop version 1.6 or PrestaShop Cloud: In your store's Admin Panel, click on the tab to connect to PrestaShop Add-ons, in the upper right of the page. Enter your login information in the box. Now all of your purchases will appear directly in your list of Admin Panel modules! After connecting to add-ons from your store's Admin Panel, click on the "Modules" tab in the menu. Look for the name of the module you want, click "Install", then configure it. For Configuration, Please refer Point 2. 1.2 If you are using PrestaShop version 1.4 or 1.5: Once you have downloaded a module from the add-ons online shop to your computer, it has up to you it installed on your PrestaShop site. There are two ways to install a module: either using the dedicated form, or using your FTP client. 1.2.1. Installing using the dedicated form To install a new PrestaShop module automatically, click on the "Add new module" link at the top of the list of modules, in the "Modules" page. A new section will slide open. Image 1.1 : PrestaShop Add New Module Form. The form in this section enables you to upload the archive file of the module, as downloaded from Add-ons. You can either upload a zip file, or a tar.gz one (tarball). The form is straightforward: simply browse to the module's file that you downloaded, and 4 P a g e
click the "Upload this module" button. Do not point to the module's uncompressed folder or any of its unpacked files! In previous version of PrestaShop, you could upload the module's zip file on your FTP server and point the form to that file's URL. This feature has been taken out of PrestaShop 1.5 for security reasons. Once you have clicked the button, PrestaShop will upload the module from your computer to its server, unpack it, place the files in the correct location, and update the page, all this in a handful of seconds. PrestaShop will then display "Module downloaded successfully". Modules are not installed by default: you still have to click the module's "Install" button, and then possibly configure its settings. Once configuration is complete, be sure to test the module immediately to confirm that it works as planned. 1.2.2. Installing using a FTP client To install a new PrestaShop module manually: Unzip (decompress) the module archive file (.zip or tar.gz). This should result in a new folder with name shiptomyid. Using your FTP client, connect to PrestaShop web server, and place the unpacked module folder in PrestaShop's /modules folder. Pay attention NOT to upload that folder in another module's folder (which can happen when drag-and-dropping items). Upload both the folder and the files it contains, not just the files. Now make sure the uploaded folders have write permissions and apply these permissions recursively (to their subfolders). Go to your Admin Panel, in the "Modules" menu. Locate the new module in the modules list. You might have to scroll down; you can also use the list's search engine, which should give you a dynamically updated list of matching module names. In the row for the new module, click the "Install" button. Your module is now installed and should be activated too. If necessary, click on the module's "Configure" link. Also, pay attention to any warning message that might be displayed by PrestaShop. 5 P a g e
1.3 Important Manual Steps Once you finish Installation with above steps, you need to follow below steps to complete the Installation. 1. This is a manual process, you have to move/ copy one file from one location to another one by one, for that you need to connect with FTP or the CPanel File Manager. 2. Using your FTP Client / CPanel connects to the PrestaShop Web server and go to the <Root> folder of PrestaShop setup. Where you will see different folder s like cache, classes, config modules, override etc. 3. Go to the below Source path, copy file and paste it on destination. 1 st File Source Path : <ROOT>/modules/shiptomyid/override_files/classes/Customer.php 1 st File Destination Path : <ROOT>/override/controllers/ classes/customer.php 4. If in case you will same file name in the destination folder, then you need to compare and merge files. 5. After placing the file in the destination folder, you need to clear the cache. 6. To Clear Cache please go through below steps. a. Open Prestashop admin panel and go to Advanced Parameters > Performance b. Set Force compiles to Yes and save changes. c. Go to your front-office and refresh the store page. 6 P a g e
2. Module Installation & Configuration After module download and setup, you need to install the module on the store. 2.1 Module Installation i. Login to Prestashop Admin and go to menu Modules => modules.once you are on module page, from Categories list, click on Smart Shopping / Total.Please refer below screen shot. Image 1.2 : Prestashop module page with Ship2MyId module search. ii. iii. iv. In the search box, type ship2myid, on module list you will see Ship2MyId. On Module row, click on Install button. Ship2MyId Module gets installed on your store and you will be on configuration page. Note : By default the module is pointing to the Shi2MyId Hotfix Server (Test Environment) for testing purpose. 7 P a g e
2.2 Before Module Configuration First, you will need to register with Ship2MyId as Merchant. You will find the Merchant Registration link on Ship2MyId site or PrestaShop Add-ons page or on the module configuration page or click here. To make this module working, you should use the same Ship2MyId username and password that you used to register with ship2myid. Once you register with Ship2MyId as a Merchant, you will get a Welcome email from Ship2MyId. Note: These Credentials will only work in the Hotfix Environment (Test Server). By using these details you can test the module, once everything is working perfectly on Hotfix server, you can request Ship2MyId Support Team (merchantsupport@ship2myid.com) to send you the Production Details (Please Refer Point 2.4). 2.3 Module Configuration Login to PrestaShop Admin and go to menu Modules => modules. Once you are on modules page, from Categories list, click on Smart Shopping / Total. Please refer below screen shot. Configuration Page fields: Image 1.3: PrestaShop module page with Ship2MyId module search. Ship2MyId username: Ship2MyId Username used to login to ship2myid server with API. 8 P a g e
Ship2MyId password: Ship2MyId Password used to login to ship2myid server with API. Webservice URL: REST API webservice URL. Terms URL: Ship2MyId Terms and Condition URL. Privacy policy URL: Ship2MyId Privacy Policy URL. Ship2MyId video link: Ship2MyID informational YouTube video link. Default street address: Receiver s Default Shipping address used for calculating max shipment cost. Default street address (line 2): Receiver s Default Shipping address used for calculating max shipping cost. Default City: Receiver Default Shipping City. Default region/state: Receiver Default Shipping Region / State. Default zip/postal code: Receiver Default Shipping Zip / Post Code. Default Country: Receiver Default Shipping Country. Default phone number: Receiver Default Shipping Phone number. Ship2MyId label: Ship2MyId Label used in the Receiver Default Shipping address. Webservice popup URL: This is Popup URL for retrieving receivers details. Webservice popup width: Popup Width Webservice popup height: Popup Height Rejected order status: This is Ship2MyId Order Status in case the Order get Rejected by receiver. Check order CRON URL: This is CRON URL; you can run this manually or set it on your server. Configuration Field Default Values : Webservice URL : http://hotfix-app.mapmyid.com/ship2myid/rest/ Terms URL: http://www.mapmyid.com/terms-of-use Privacy policy URL: http://www.mapmyid.com/privacy Ship2MyId video link: http://www.youtube.com/watch?v=_4yvwduycis Default street address: The shipping address is protected by Ship2MyID. Default street address (line 2): X Default City: XX Default region/state: You have to set the State Country: Default Shop Country Default phone number: XXXX Ship2MyId label: Ship2MyId Webservice popup URL: http://hotfixapp.mapmyid.com/ship2myid/shopping_cart_popup/index.jsp?plateform=presta shop Webservice popup width: 634 Webservice popup height: 774 Rejected order status: Canceled Check order CRON URL: This is CRON URL, you can run this manually or set it on your server 9 P a g e
Please refer below image for configuration page. Image 1.4: Ship2MyId Module Configuration Page. 10 P a g e
Note: From above fields 1. Fields mark in Blue needs to be changed while moving to Production sever. 2. Fields mark in Red need to be updated/set while doing module configuration. 3. Fields mark in Green is the CRON URL, You have to set CRON on your server with time lapse. Our recommendation is Every 12 hours. 4. Please do not change default values. Imp. Note: 1. Fields (Webservice URL, Terms URL, Privacy policy URL, Webservice popup URL) are by default pointing to mapmyid.com. While configuring the module you need to change mapmyid.com to ship2myid.com. After change, URL s are as below. Webservice URL: Terms URL: Privacy policy URL: Webservice popup URL: http://hotfix-app.ship2myid.com/ship2myid/rest/ http://www.ship2myid.com/terms-of-use http://www.ship2myid.com/privacy http://hotfixapp.ship2myid.com/ship2myid/shopping_cart_popup/index.jsp?plateform=prest ashop 2.4 Module Changes to Point Ship2MyId Live/Production Server Once testing in Hotfix environment is complete, follow below steps to point this module to Production server. 1. Send a request mail to merchantsupport@ship2myid.com (Ship2MyId Support) to create Production Credentials with your Login ID (its unique identity). 2. The following details will be sent by Ship2myid Team for Production Environment configuration. a. Ship2MyId Username b. Ship2MyId Password c. Webservice URL d. Webservice Popup URL You need to update these details on the module configuration page. 11 P a g e
3. How to Test Module To test the module, please refer below steps. A. Scenario for Entering Receivers detail manually. Steps to Send the Gift 1. Open PrestaShop store in the browser 2. Add any product to the cart. 3. Login to store (User A s credentials) and select billing details and continue. 4. In Address Section you can see I want to use Ship2MyId for my Order button, next to Add a new Address button. Image 1.5 : PrestaShop Checkout Page with Ship2MyId Button. 5. Click on the button I want to use Ship2MyId for my Order, After click you will see the Ship2MyId Popup. Image 1.6 : Ship2MyId Popup on Checkout Page. 12 P a g e
6. Fill the popup form with receiver details (Receiver B ). 7. After entering all details, click on the PROCEED Button. 8. Go to the next steps Shipping select shipping method, go to Payment screen select Payment method as Credit Card or PayPal and place the order. 9. Your order gets placed successfully; you will see the order for Receiver B in PrestaShop Admin Panel. Image 1.7 : Prestashop Admin Order Page. 10. In Admin Panel -> Order page, you can see some additional fields like Ship2MyId Order, Receiver Name, Receiver Email, and Ship2MyId Status. Steps To Accept the Gift: 11. Check Receiver B s email for Ship2myid Gift Email. 14. Click on the link in the email. 15. This will open up the Ship2MyId App. Enter all details for Receiver B and click on Submit. 16. Click on close button from gift accepted successfully alert. 17. This will register Receiver B to Ship2MyId app. Getting Receivers address in Admin Panel: 18. Run the CRON manually. 19. Once the CRON job is completed, check ship2myid status for Receiver B s Order (should be accepted) and Receivers B s shipping address. B. Scenario for selecting Receivers detail from Ship2myid address book. Pre-requisite:-To test this scenario we need the sender to be registered to ship2myid. To Enter Contacts in User B s address book. 13 P a g e
1. Open URL:- http://hotfix-app.ship2myid.com/web. 2. Enter User B s credentials. This was the same receiver as in scenario A. 3. Click on Address Book link. 4. Click on Add contacts. 5. Enter one contact details (Receiver C ) and click on add. Steps to Send the Gift 1. Open PrestaShop store in the browser 2. Add any product to the cart. 3. Login to store and select billing details and continue. 4. In Address Section you can see I want to use Ship2MyId for my Order button, next to Add a new Address button. 5. Click on the button I want to use Ship2MyId for my Order, After click you will see the Ship2MyId Popup. 6. From Ship2myid Popup window, select Ship2myid Address book option. 7. Enter Ship2myid Credentials.(User B s credentials) 8. Select contact C, and click on Proceed. 9. Select Shipping method, payment method and place order. Steps to Accept the Gift 10. Check Receiver C s email for Ship2myid Gift Email. 11. Click on the link to Enter detail. 12. Enter all detail and click on Submit. 13. Click on close button from gift accepted successfully alert. 14. This will register Receiver C to Ship2MyId app. Getting Receivers address in Admin Panel: 14. Run the CRON manually. 15. Once the CRON job is completed, check ship2myid status for Receiver C s Order (should be Accepted) and Receivers C s Shipping address. C. Scenario for selecting Receivers detail from Facebook. Steps to Send the Gift 1. Open PrestaShop store in the browser 2. Add any product to the cart. 3. Login to store (User A s credentials) and select billing details and continue. 4. In Address Section you can see I want to use Ship2MyId for my Order button, next to Add a new Address button. 5. Click on the button I want to use Ship2MyId for my Order, After click you ll see the Ship2MyId Popup. 6. From Ship2myid Popup window, select Facebook option. 7. Enter Facebook Credentials. (User A s Facebook credentials). 14 P a g e
8. Select Any contact (Say User D ), and click on choose, Enter personalize message and click on Proceed 9. Select Shipping method, payment method and place order. Steps to Accept Gift:- 10. Check Receiver D Facebook account for Ship2myid Gift post. 11. Click on the post to Enter detail (Receiver is not registered to ship2myid). 12. Enter all detail and click on Submit. 13. Click on close button from gift accepted successfully alert. 14. This will register Receiver D to Ship2MyId app. Getting Receivers address in Admin Panel: 15. Run the CRON manually. 16. Once the CRON job is completed, check ship2myid status for Receiver D s Order (should be accepted) and Receivers D s Shipping address. D. Scenario for Auto-Acceptance of gift. 1. Open PrestaShop store in the browser 2. Add any product to the cart. 3. Login to store (User A s credentials) and select billing details and continue. 4. In Address Section you can see I want to use Ship2MyId for my Order button, next to Add a new Address button. 5. Click on the button I want to use Ship2MyId for my Order, After click you will see the Ship2MyId Popup. 6. Fill the popup form with receiver details (Receiver B ). 7. After entering all details,click on the PROCEED Button. 8. Go to the next steps Shipping select shipping method, go to Payment screen, select Payment method as Credit Card or PayPal and place the order. Steps To Accept the Gift: 9. Open URL:- hotfix-app.ship2myid.com/web. 10. Login with User B s credentials. 11. Click on Shipment Log link. 12. Check Incoming Shipment tab. 13. The Gift Sent from User A should be Auto- Accepted. Getting Receivers address in Admin Panel: 14. Run the CRON manually. 15. Once the CRON job is completed, check ship2myid status for Receiver B s Order (should be Accepted) and Receivers B s Shipping address. 15 P a g e
E. Check Shipping calculation:- 1. Log in to store with A's login details. 2. Select any product and checkout. 3. Enter delivery address as "225, Rector Place, NYC, New York, ZIPCODE-10280". 4. Check shipping cost (Shipping method /Cost). 5. Click on Previous button. 6. Click on "I want to use Ship2myid for my order" button. 7. Enter Receivers B s detail whose Address is set as "225, Rector Place, NYC, New York, ZIPCODE- 10280" in his ship2myid account. 8. Check Shipping cost (Shipping method /Cost). 9. Shipping cost in Step 4 and 8 should be same. Note: Check above process of shipping calculation for 1-2 address just to ensure, everything is working fine. 16 P a g e