USER GUIDE StarTrack Shipping (Magento 2) Compatibility:

Transcription

1 USER GUIDE StarTrack Shipping (Magento 2) Compatibility: Community Edition: 2.0.x 1

2 Contents 1. Introduction Prerequisite Installation Manual Installation (Installing Magento 2 extension by copying code) Installation via Composer Quick Notes Technical Support About Biztech Consultancy Magento Expertise

3 1. Introduction The StarTrack Shipping extension when installed on your store fetches live rates from StarTrack as per the dimension of products added in the cart. 2. Prerequisite The user should register at StarTrack to obtain the API key. To register, please at or make a call to Installation Mandatory Instruction: Kindly ensure that Magento 2 is set up correctly. Enter developer mode before initiating the installation. You can achieve the mode by running the following command: bin/magento deploy:mode:set developer -s It will enable the developer mode and skip compilation. You can enter default mode after successful installation of the extension Manual Installation (Installing Magento 2 extension by copying code) Step 1: 1. For Windows OS: Go to <your Magento install dir>/app/code. Under that, create the folders using following hierarchy: -Biztech - StarTrack 2. For Linux OS: Enter the following commands keeping their order: cd <your Magento install dir>/app/code mkdir -p Biztech/StarTrack After this, find the Download Zip and extract all files and folders in Biztech/StarTrack. Step 2: After the successful installation you have to run the command on Magento2 root directory- php bin/magento setup:upgrade. 3

4 If you see blank page or permission error, go to Terminal (Linux)/ Command Prompt (Windows). cd [magento root directory][var] run the following command $ chmod R 777 * Step 3: After running the command, log into the admin panel and clear the Cache. Go to SYSTEM Tools (section) CACHE MANAGEMENT to clear the cache. Step 4: After successful installation, you can see the StarTrack Shipping under BIZTECH tab inside STORES CONFIGURATION. 4

5 3.2. Installation via Composer Step 1: Install composer from this link. If you already installed composer, skip this step. Step 2: Go to app code Biztech StarTrack, right click on composer.json and select use composer here. 5

6 Step 3: After that you can see command prompt where you have to run the following command: - composer update Step 4: Now go to [magento root directory] and right click on use Composer here. 6

7 Step 5: You can see the cmd window and run the following command here: - php bin/magento setup:upgrade Step 6: After running the command, log into the admin panel and clear the Cache. Go to SYSTEM Tools (section) CACHE MANAGEMENT to clear the cache. Step 7: After successful installation, you can see the StarTrack Shipping under BIZTECH tab inside STORES CONFIGURATION. The installation is successful! 7

8 4. Quick Notes StarTrack Shipping method currently works only for country Australia. Username, Password, API Key, Account Number is must to define for automatic reflection of changes that takes place in StarTrack API. Merchant has to manually bind the three major attributes (properties) length, width, and height used in this extension with the relevant length, width and height that the admin has given to different products for their identification. Units of measurement to use in our extension are below: o Weight: kg o Length: cm o Height: cm o Width: cm The admin needs to fill the value of weight, apart from height, width and length of the attribute, individually for each product while filling out the details of product. In addition, the admin has to enter the relevant warehouse postcode to get the shipping rates for various destination locations, where the parcels have to be delivered. Go to catalog > Manage Products and fill the value of weight, apart from height, width and length of the attribute, individually for each product. 8

9 5. Technical Support We welcome all forms of customized Magento e-commerce queries and deliver tailor-made Magento e-store solution, given your distinct business needs! We provide all technical support! Get in touch filling in our online message form to contact our support team or shoot us an at Your IT Partner, With You Anytime, Anywhere! You may also like 9

10 6. About Biztech Consultancy We simplify your business by offering unique business solutions in digital web and IT landscapes. Our core expertise includes Magento Expertise We are Magento e-commerce specialist! Be it, Store Development Customization Integration Maintenance Upgradation You can trust our expertise! 10

11 11