user guide · 2. for linux os: enter the following commands keeping their order: cd /app/code mkdir...
TRANSCRIPT
1
USER GUIDE
StarTrack Shipping (Magento 2)
Compatibility:
Community Edition: 2.0.x
2
Contents 1. Introduction ............................................................................................................................. 3
2. Prerequisite ............................................................................................................................. 3
3. Installation ............................................................................................................................... 3
3.1. Manual Installation (Installing Magento 2 extension by copying code) .......................... 3
3.2. Installation via Composer ................................................................................................. 5
4. Extension Activation ................................................................................................................. 8
5. Configuration ......................................................................................................................... 10
6. Quick Notes ........................................................................................................................... 14
7. Technical Support .................................................................................................................. 15
8. About Biztech Consultancy .................................................................................................... 16
Magento Expertise ........................................................................................................................ 16
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 email at
[email protected] or make a call to 1800 028 361.
3. 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.
3.1. 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”.
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.
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.
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.
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! Scroll down to activate the extension.
8
4. Extension Activation
Step 1:
Copy an activation key
Copy the activation key from the Order Confirmation Mail.
OR
Log into your account at http://store.biztechconsultancy.com using the email and password you have provided at checkout process.
Go to Downloadable Options and copy the activation key for the StarTrack Shipping extension.
Step 2:
Activate the extension
Log into Magento Admin Panel and go to Stores → Configuration → Biztech → StarTrack Shipping
and enter the activation key in the ''Activation Key'' field and then click the “Save Config” button.
Step 3:
Select Websites
When you enter and save the key it will be verified and you can select the websites where you need
to use the StarTrack Shipping extension. Click the ''Save Config'' button after making your
selections.
9
Now, StarTrack Shipping Extension got activated! You just have to set configurations.
10
5. Configuration
Please follow below mentioned steps to configure the “StarTrack” shipping method.
Go to Stores → Configuration.
Step 1: General Configuration
In the left column under Sales tab click on Shipping Methods tab. Here you can see Biztech
StarTrack Shipping sections.
In this tab, you can set basic configurations of StarTrack Shipping Extension. Here is the detailed description of the configuration.
Enabled: Select "Yes" to enable the StarTrack Shipping extension. The extension is disabled
by default. After enabled extension you can see new shipping method in checkout process.
Title: Define Title which you want to get displayed in shipping method section.
Method name: Specify method name for shipping method.
Username, Password, API Key and Account Number: Enter specified details of your
StarTrack account. You can generate StarTrack account from
https://www.startrack.com.au/user-admin/request-registration/
Origin City, State and Postcode: Define the warehouse city, state and postcode.
11
Step 2: Enable Shipping method and Handling charges
Allowed Methods: Enable one or more methods. (These methods will get enabled when
customer postal code is relevant to the warehouse postcode).
Include GST: Set “Yes” to include Goods and Services Tax in StarTrack shipping rates.
Risk Warranty: Choose “Yes” to include risk warranty charges.
Fuel Surcharge: Select “Yes” to include fuel surcharge.
Security Surcharge: Set “Yes” to include security surcharge.
Handling Applied: You can choose how the handling charges will be applied.
Calculate Handling Fee: Set how the handling fee will be calculated. It can be set to
“Percent” or “Fixed”.
Handling Fee: Enter the relevant value for handling fees based on the above selection.
12
Step 3: Attribute Configuration
Length, Height, Width: You need 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.
If you haven't created relevant attributes yet then please create it first. To create attributes, please follow below steps:
Go to Stores→ Attributes section →Product→ Add New Attribute and create 3 new attributes
(length, width and height).
Go to Stores → Attributes section→ Attribute Sets and assign these 3 attributes to
appropriate attribute sets.
Then go to Stores→ Configuration →Sales → Shipping Methods and open "Biztech StarTrack"
shipping method. Then manually bind the length, width, and height attributes.
Step 4: Advance Configuration
Display Delivery Estimate: Select “Yes” to show delivery estimation with shipping service.
Ship to Applicable Countries: Choose from “All Allowed Countries” or “Specific Countries”.
The StarTrack shipping method will be available to those countries.
Ship to Specific Countries: If you opt for “Specific Countries” in the above selection, then you
need to select the particular countries for which this shipping method is to be enabled.
Sort Order: Define at which position, you want to display the shipping method. (This order
works only when other shipping methods are given sort order).
Show Method if Not Applicable: If you select “Yes”, then the following error message will be
displayed. It is recommended to choose “Yes”, so that your customers can understand why
the shipping method is not available.
Displayed Error Message: Enter the error message to be displayed at front end when
shipping method is not available.
13
Step 5: Product Configuration
Go to Products → Catalog and open any product in edit view.
You will find four attributes in a row: Weight, width, height and length.
Enter appropriate values for all the attributes which will be used as dimension of product to
calculate rates.
All set! You are now ready to use the extension.
14
6. 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.
15
7. 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 email at [email protected].
Your IT Partner, With You Anytime, Anywhere!
You may also like
16
8. 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!
