Magento 2 Australia Post Shipping Extension

Document technical information

Format pdf
Size 782.9 kB
First found May 15, 2017

Document content analysis

Category Also themed
Language
English
Type
not defined
Concepts
no text concepts found

Persons

Organizations

Places

Transcript

USER MANUAL
TABLE OF CONTENTS
Introduction .................................................... 1
Benefits of Australia Post Shipping ................ 1
Pre-requisites ................................................. 1
Installation & Configuration ........................... 2
Installation Steps ........................................ 2
Manual Installation (Installing Magento 2
extension by copying code) ........................ 2
Installation via Composer ........................... 4
Extension Activation ....................................... 6
Configuration .................................................. 7
Australia Post Shipping
Version: 1.0.3
Compatibility:
Community Edition 2.*
Contact Us .................................................... 12
USER MANUAL – Australia Post Shipping
Introduction
“Australia Post Shipping” extension allows fetching live rates from Australian post for parcels and letters on Magento 2
store.
Benefits of Australia Post Shipping
•
•
•
Australia Post Shipping offers a smooth prospect for merchants to help customers with an enhanced buying
experience.
It provides feature rich extension helps add value to an online store and make shipping process smooth.
Australia Post Shipping extension offers shippers the ability to enjoy appropriate, high quality and reasonable
shipping solution.
Pre-requisites
•
The user should have an account at Australia Post, as the Australia Post API key is required to make the extension
work.
www.appjetty.com
1
USER MANUAL – Australia Post Shipping
Installation & Configuration
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.
Installation Steps
Manual Installation (Installing Magento 2 extension by copying code)
Step 1:
For Windows OS:
• Go to <your Magento install dir>/app/code. Under that, create the folders using following hierarchy:
o Biztech
o Auspost
For Linux OS:
• Enter the following commands keeping their order:
cd <your Magento install dir>/app/code
mkdir -p Biztech/Auspost
• After this, find the Download Zip and extract all files and folders in Biztech/ Auspost.
Step 2:
•
•
After the successful installation you have to run the command on Magento2 root directory-“php bin/magento
setup:upgrade”.
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.
www.appjetty.com
2
USER MANUAL – Australia Post Shipping
Step 4:
After successful installation, you can see the “Australia Post Shipping” under Biztech tab inside STORES →
CONFIGURATION.
www.appjetty.com
3
USER MANUAL – Australia Post Shipping
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 →Auspost, right click on composer.json and select use composer here.
www.appjetty.com
4
USER MANUAL – Australia Post Shipping
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.
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 “Australia Post Shipping” under Biztech tab inside STORES →
CONFIGURATION.
The installation is successful! Scroll down to activate the extension.
www.appjetty.com
5
USER MANUAL – Australia Post Shipping
Extension Activation
Step 1: Copy an activation key
•
•
•
Copy the activation key from the Order Confirmation Mail. OR
Log into your account at www.appjetty.com using the email and password you have provided at checkout
process.
Go to Downloadable Options and copy the activation key for the Australia Post Shipping extension.
Step 2: Activate the extension
•
Log into Magento Admin Panel and go to Stores → Configuration → Biztech → Australia Post Activation and
enter the activation key in the ''Activation Key'' field for the Australia Post extension 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 Australia Post extension. Click the ''Save Config'' button after making your selections.
Now, Australia Post Extension got activated! You just have to set
configurations.
www.appjetty.com
6
USER MANUAL – Australia Post Shipping
Configuration
Please follow below mentioned steps to configure the shipping method of Australia post.
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 Australia Post
sections.
In this tab, you can set basic configurations of Australia Post Extension. Here is the detailed description of the
configuration.
•
•
•
•
•
•
•
•
Enabled: Select "Yes" to enable the Australia Post 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.
API Key: Specify API Key provided by Australia Post (you can generate API key from
https://developers.auspost.com.au/apis/pacpcs-registration ).
Calculate Handling Fee: Admin can decide handling fee type either fixed or percentage wise.
Handling Applied: Admin can decide to apply handling fee per order or per package.
Warehouse Postcode: Admin can decide his warehouse/dispatched location postcodes from here.
Enable Prepaid Satchel’s Service: Select “Yes” to enable the Satchel services for shipping of your products.
You can enable it for products having weight as defined in the Satchel service guide lines.
www.appjetty.com
7
USER MANUAL – Australia Post Shipping
Step 2: Enable Shipping Services
•
•
•
•
Enable Domestic services for Parcel: Domestic service for parcel can be configured from here either
standard/express.
Enable International services for Parcel: International service for parcel can be configured from here.
Admin can decide which service he/she wants to enable.
Enable Domestic services for Letter: Domestic service for letter can be configured from here either
Regular/Express.
Enable International services for Letter: International service for letter can be configured from here. Admin
can decide which service he/she wants to enable.
www.appjetty.com
8
USER MANUAL – Australia Post Shipping
Step 3: Advance Configuration

•
•
•
•
•
•
•
•
Disable Signature on Delivery services: If you want to disable Signature on Delivery methods
from frontend then you can do it here.
Add Extra Cover Price for Domestic services: Select “Yes" to add extra cover (insurance) charge for Australia.
Add Extra Cover Price for International services: Select “Yes" to add extra cover charge for International
countries. (insurance)
Ship every Item separately: If set yes, and cart weight is greater than 22KG then every item will be
Shipped in different package.
Ship to specific countries: Shipping will be available for one or more specific country. It gets enabled
when shipping is enabled for specific country.
Show Method if Not Applicable: If selected “Yes” message will be displayed to user from “Displayed
Error Message” box. If selected “No” method will not be shown.
Displayed Error Message: Defined error message which get displayed in frontend when shipping
method is unavailable.
Sort Order: At which order wants to display Australia post shipping method.

www.appjetty.com
9
USER MANUAL – Australia Post Shipping
Step 4: Product Configuration
•
•
In this tab, admin can set default configurations for every product dimension and can also decide
product weight unit to be considered.
•
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.
•
Default weight Unit: you can set default weight unit from here like KG/Gram.
•
Allow default value for dimension: Australia post works on product dimension and entering
dimension is compulsory for every user, now if admin wants to set default dimensions for all
products it can be done from here.
•
Default Length (in C.M): Default length can be configured from here.
•
Default Height (in C.M): Default height can be configured from here.
•
Default Width (in C.M.): Default width can be configured from here.
If you haven't created relevant attributes yet then please create it first. For 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 Australia

Post" shipping method. Then manually bind the length, width, and height attributes.
Step 5: Select Package type
•
•
•
•
Go to Products → Catalog and open any product in edit view.
You will find a new attribute “Australia Post Package Type”. It will have two options:
o Parcel
o Letter
Select the most appropriate one, according to the weight of the product.
Be careful here, any wrong selection will not display rate at front end!
www.appjetty.com
10
USER MANUAL – Australia Post Shipping
www.appjetty.com
11
USER MANUAL – Australia Post Shipping
Contact Us
We simplify your business, offer unique business solution in digital web and IT landscapes.
Live Chat
Tickets
•
Get instant support with our Live Chat.
•
Raise tickets for your specific question!
•
Visit our product page at:
https://www.appjetty.com/magento2-australiapost-shipping.htm and click on the Live Chat button
for instant support.
•
Send an email to [email protected] or you
can login to my account www.appjetty.com
and click on My Support Tickets on your
account dashboard, to get answers to your
specific questions. Our team will work to
respond to your query prompt.
Customization:
•
If you would like to customize or discuss about additional feature for Australia Post Shipping, please write to
[email protected]
www.appjetty.com
12

Similar documents

×

Report this document