USER MANUAL Magento Australia Post eparcel Extension

Size: px
Start display at page:

Download "USER MANUAL Magento Australia Post eparcel Extension"

Transcription

1 USER MANUAL Magent Australia Pst eparcel Extensin Versin: TABLE OF CONTENTS 1. Intrductin Benefits f Magent Australia Pst eparcel Extensin Back end Cnfiguratin: Features Pints t Nte FAQ Cntact Us Cmpatibility: Magent Cmmunity Editin 1.4.*.* t 1.9.*.*

2 1. Intrductin Biztech Cnsultancy prvides effective slutin in the frm f Magent Australia Pst eparcel Extensin which helps stre wners t submit cnsignment manifests t eparcel and generate labels fr printing. Custmer will be able t chse admin prvided shipping methds and pt fr the best suitable methd. Admin will be able t set charge cdes fr the defined methds alng with setting up free shipping methds as well. Admin will have list f cnsignments and will be able t submit them t eparcel via creating Manifests. After creating the manifests admin will have detailed infrmatin abut the manifests and get labels fr printing. With Magent Australia Pst eparcel Extensin admin will be able t reprint the labels withut any extra charge. 2. Benefits f Magent Australia Pst eparcel Extensin Integratin with Australia Pst Shipping Custm articles fr cnsignments Shipment Tracking with eparcel Free Shipping Rules Management Address Verificatin and Suggestins fr Addresses Address Verificatin by Admin End Pssible Integratin with Delivery Chice API Submit cnsignments t manifests effrtlessly Manifest summary reprt Biztech Stre Page 1

3 3. Back end Cnfiguratin: Please fllw the belw steps t cnfigure Magent Australia Pst eparcel Extensin. G t System Cnfiguratin Sales Shipping Methds. Step 1: General Cnfiguratin Enable: Select Yes t enable the extensin. It is disabled by default. Title: Add title fr the shipping methds. Shw methd if nt applicable: Chse if methd will be displayed r nt if it is unavailable. Pssible ptins are: Yes N Displayed Errr Message: Set message which will be displayed when methd is nt applicable. Biztech Stre Page 2

4 Shipping Methd Cnfiguratin: Ggle Map API Key: Set Ggle Map API Key fr address aut-suggestins. Calculate Handling Fee: Set n what basis Handling Fee will be calculated. Pssible ptins are: Fixed Percent Handling Fee: Set handling fee fr the shipments. Insurance and Default Insurance Value: Set Insurance & Default Insurance Values fr the shipment. Biztech Stre Page 3

5 eparcel Authenticatin: Biztech Applicatin ID: Yu need a valid API Key fr this eparcel mdule t wrk. Add yur Biztech Applicatin ID which will be prvided by Biztech. eparcel Merchant Lcatin ID: Issued by Australia Pst. A unique three r five alphanumeric character identifier fr yur gegraphic merchant lcatin where eparcels are prepared and/r ldged. Add yur eparcel Merchant Lcatin ID which is prvided by Australia Pst eparcel. eparcel Pst Charge t Accunt: Issued by Australia Pst. Merchant accunt t which Australia Pst pst the charges against fr invicing purpses. Add yur eparcel Pst Charge t Accunt Number which is registered with eparcel. On basis f this accunt number all yur transactins with eparcel will wrk. Merchant ID: Issued by Australia Pst. Merchant ID with Australia Pst, fr inclusin n the Manifest Summary Reprt. Admin can find this ID n Manifest Summary reprts prduced using the eparcel Prtal. Add yur eparcel Merchant ID prvided by eparcel. Ldgment Facility: Issued by Australia Pst. The Ldgment Facility assciated with yur Merchant Lcatin ID, fr inclusin n the Manifest Summary Reprt. SFTP Username: Issued by Australia Pst. Yur username fr uplading manifests t Australia Pst SFTP service. SFTP Passwrd: Issued by Australia Pst. The passwrd assciated with yur username fr uplading manifests t Australia Pst SFTP service. Operatin Mde: Test mde enables admin t use and test all features f the Australia Pst eparcel fr Magent mdule withut actually submitting rders t Australia Pst. Live mde will uplad yur rders t Australia Pst eparcel system. This cnfiguratin is nly available fr label printing and shipment tracking. Pssible ptins are: Test Live Biztech Stre Page 4

6 Return Address Cnfiguratin: Add Yur Return Address details which will be used when any rder is returned. Article Cnfiguratin: Biztech Stre Page 5

7 Signature Required: Default setting fr 'Signature Required' n cnsignments. This default can be verridden when creating cnsignments. Nte: if set t 'N', custmers will be prmpted t cnfirm that they authrize their delivery t be left if n ne is available t sign fr it, and then be required t enter special instructins. E.g. 'leave at side dr' - these instructins will shw n labels assciated with the cnsignment fr the rder. Pssible ptins are: Yes N Print Return Labels: Default setting fr printing return labels fr cnsignments. This default can be verridden when creating cnsignments. Pssible ptins are: Yes N Partial Delivery Allwed: Default setting fr specifying if partial delivery is allwed fr cnsignments. This default can be verridden when creating cnsignments. Pssible ptins are: Yes N Use Order Ttal Weight: If yur prducts in Magent have weights assciated with them, admin can use this ptin t use the ttal weight f the cmbined items n an rder as the weight fr the cnsignment. Pssible ptins are: Yes N Prduct Weight Unit: Select if admin have input prduct weight in KG r grams. AusPst eparcel requires that all weights are in KG, s if yur prduct weight is entered in Magent in grams, the cmbined rder weight will be cnverted t KG fr cnsignment and articles weights. Pssible ptins are: KG GM Packaging Allwance Type: Use this ptin if admin want t add additinal weight t yur rder ttal t allw fr packaging. Use 'Fixed' if admin want t add a set weight t each rder, r use Percentage t add an allwance based n a percentage f the ttal weight fr each rder. Pssible ptins are: Fixed Percent Biztech Stre Page 6

8 Packaging Allwance Value: Depending n the ptin admin chse fr 'Packaging Allwance Type', this value will determine what value t add t the ttal weight f the cmbined items n an rder. If admin select Fixed, then input the additinal weight admin want t add in KG. E.g..25 fr.25 kg/250 grams. If admin select percentage, then input the percentage admin want t add t an rder Eg. 5 fr 5%. Leave this field empty if admin dn't want t apply a packaging allwance t rders. Use Article Dimensins: If yur're n a dead-weight f cubic-weight cntract with Australia Pst, then admin may nt be required t enter dimensins fr each article admin ship with eparcel. If that's the case, then set this ptin t N. If admin are required t enter dimensins fr articles, then set this ptin t Yes. Pssible ptins are: Yes N Default Article Height: Set a default Article Height. This value is used as the default value when selecting 'Custm' article type, and can be verridden when creating articles. Leave blank if admin dn't want t set a default. Default Article Width: Set a default Article Width. This value is used as the default value when selecting 'Custm' article type, and can be verridden when creating articles. Leave blank if admin dn't want t set a default. Default Article Length: Set a default Article Length. This value is used as the default value when selecting 'Custm' article type, and can be verridden when creating articles. Leave blank if admin dn't want t set a default. Apply eparcel Shipping t All AU Orders: Select this ptin if admin want t apply eparcel shipping and management t all f yur existing Magent shipping rules and ptins, including rders via M2E Pr. If admin wuld like t apply different eparcel shipping types t the different shipping methds admin ffer, we recmmend admin use ur 'Assign Shipping Types' ptin instead. Default Charge Cde fr AU rders: Enter the eparcel Charge Cde admin want t assciate with all f yur existing Magent shipping rules and ptins. Biztech Stre Page 7

9 Label Cnfiguratin: Australia Pst Branding: Whether the Australia Pst branding shuld be included n the labels. If admin are using purchased statinary frm Australia Pst, then the generated labels shuld nt include the branding. Default is "False". Pssible ptins are: Yes N Label Left Margin: Use this field t adjust the left margin f the page. Default is "0". Label Tp Margin: Use this field t adjust the right margin f the page. Default is "0". Label Lg: Use this ptin if yu want t display yur wn lg n eparcel labels. The lg will nt be used if admin are printing labels t pre-printed eparcel labels. Label Frmat: Use this field t set label frmat. Pssible ptins are: 1pp 3pp 4pp Biztech Stre Page 8

10 Cnsignment Cnfiguratin: Display Order Status n Cnsignment View: Set this ptin t Yes if admin want the Magent rder status fr all rders t be displayed in the cnsignment view. Pssible ptins are: Yes N Chse the statuses t shw in the cnsignment view: By default, rders that have a status f 'Pending', 'Prcessing' r have an pen cnsignment against them are displayed in the Cnsignment View. If yu'd like t chse different rder statuses t display in the Cnsignment View then set this ptin t Yes. Pssible ptins are: Yes N Change Order Status n Dispatch f Manifest: Use this ptin t change the rder status when a manifest is dispatched. Pssible ptins are: Canceled Clsed Cmplete Suspected Fraud On Hld Payment Review PayPal Canceled Reversal PayPal Reversed Pending Pending Payment Prcessing Biztech Stre Page 9

11 Manifest and Other Cnfiguratin: Ntify Custmers n Dispatch f Manifest: Use this ptin t ntify custmers f tracking numbers when a manifest is dispatched. This default can be verridden when creating cnsignments. Pssible ptins are: Yes N Australia Pst Ntificatin: Default setting fr using Australia Pst's ntificatin service n cnsignments. This default can be verridden when creating cnsignments. Pssible ptins are: Yes N Frm Address: The 'frm' address t be used when ntifying custmers f tracking infrmatin when a manifest is dispatched. Custmer Template: Admin can use the [TrackingNumber], [OrderNumber], [CustmerFirstname] dynamic variables and can edit template frm Transactinal s Sectin. Pssible ptins are: Default Template frm Lcale Auspst eparcel Track Template Biztech Stre Page 10

12 Change rder shipping ptin: Select this ptin if yu want t change the rder's current shipping ptin t ther shipping ptins. Pssible ptins are: Yes N Step 2: Cnsignment Management G t Australia Pst eparcel Management Cnsignment Management In this tab admin will get a list f cnsignment with fllwing details: Order #: The rder Number f the Cnsignment Ship t Name: Custmer name wh has placed the rder Weight (Kgs): Weight f the shipment Is Valid Address?: Address set by custmer fr delivery is valid r nt Cnsignment #: If cnsignment fr the rder is already created then it s number Shipping Methd: The shipping methd with which rder was generated Is Labels Created?: Is label fr the cnsignment generated frm the eparcel r nt Is Labels Printed?: If label is generated then it is printed r nt Is Return Labels Printed?: If return rder request is placed then it s return label is printed r nt Is Under Current Manifest?: It willll display if the cnsignment is under current manifest r nt. N. f Articles: Number f articles under this cnsignment Created On: Date f Cnsignment creatin Mdified On: Mdificatin date f the cnsignment Biztech Stre Page 11

13 Step 2.1: Create a Cnsignment fr the Order G t Australia Pst eparcel Management Cnsignment Management Fr any rder, whse cnsignment is nt created admin will have ptin t create cnsignment fr it. Click n Create cnsignment and admin will be able t chse number f articles in the cnsignment alng with article type. Admin can chse article type frm articles types that admin have created r admin can als create a custm article type fr the cnsignment. Fr any specific cnsignment admin can als change default cnsignment settings by clicking n Change Default Cnsignment Settings. After setting article type admin can click n Create Cnsignment t create a cnsignment. After creating a csignment admin will be able t submit cnsignment t eparcel t get the labels frm Label printing Service. In respnse eparcel will return labels and tracking details. Admin will be able t print the labels and the labels will als be saved in ur gateway fr re-printing. Biztech Stre Page 12

14 With Dispatch admin ll be able t dispatch all the cnsignments f the current manifest in t eparcel System. In the respnse admin ll get Manifest Summary reprt frm eparcel. Step 3: Manifest Management G t Australia Pst eparcel Management Manifest Management Admin will be able t have a list f manifests that are assciated with the stre. Admin will be able t see Manifest Cde alng with Date f Manifest Dispatch, N. f Cnsignments in the manifest & N. f articles in it as well. Admin will als be able t generate Manifest Summary frm the list. By clicking n any manifest admin will be able t see Manifest Details. Frm manifest details admin will be able t add mre cnsignments t the manifest as well as pre-added cnsignment details alng with Label & Tracking details fr the cnsignments. Biztech Stre Page 13

15 Step 4: Free Shipping Rule Management G t Australia Pst eparcel Management Free Shipping Rule Management Admin will be able t set free shipping rules management based n which cnsignments will be shipped fr free. On this screen admin will be able t see Charge Cde, Cst Range, Shipping Cst and Rule Status. Admin can add new shipping rule by clicking n Add New Rule. While adding a new rule admin will be able t chse charge cde, Frm and T Cst fr which rule will be used, Shipping cst & Status f the rule. Biztech Stre Page 14

16 Step 4: Article Type Management G t Australia Pst eparcel Management Article Types Admin will have list f Article types that are created fr the cnsignments. Admin will be able t add new article type by clicking n Add New. Admin will be able t set Article Type name, Article Weight, Height, Width & Length alng with the status f the Article Type. Step 4: Adding Shipping Methds and Assigning Shipping Types t Charge Cdes G t Australia Pst eparcel Management Assign Shipping Types Admin will be able t assign the enabled shipping methds t eparcel Charge cdes frm here. Admin can select the Shipping methd & assign a charge cde t it. Biztech Stre Page 15

17 4. Features Live Rates Integratin with Australia Pst Shipping: Integrate with Australia Pst Shipping (Shipping Type Management with Charge Cde fr eparcel) t prvide stre custmers ptins fr varius shipping methds t chse frm. Charge Cdes fr Applicable Shipping Methds: Set Charge cdes fr all the shipping methds and submit the cnsignment thrugh that shipping methd Biztech Stre Page 16

18 Define Shipping Methds: Activate varius shipping methds that yu prvide fr yur custmers t chse frm Keep Australia Pst as default shipping methd: If custmer selects any shipping methd ther than Australia Pst, admin can still get the rder reassigned t Australia Pst eparcel. Applicable charges t be managed manually. Biztech Stre Page 17

19 Address Verificatin & Suggestins Frntend Address Validatin & Suggested Cities: Validate address f the users while an rder is being placed. Suggested Cities: On the basis f state & pin-cde entered by the custmer fr rder, suggested cities will be listed fr them. Address Validatin fr Admin: Address validatin is dne even when cnsignment is generated by admin. While creating a shipment admin will have list f pssible cities fr wrng addresses. Biztech Stre Page 18

20 Free Shipping Rules Shipping Rules Management: Set shipping rules and shipping cst based n cst f the shipment Biztech Stre Page 19

21 Charge Cde & Extra Shipping Cst: Set charge cde and extra shipping cst fr the selected shipping rule Free Shipping Management: Admin can select shipping methds and charge cdes fr them fr free shipping Cnsignments Management Article Type Management: Define varius article types which can be chsen at the time f shipment generatin. The articles will have parameters like Weight (Kgs), Height (cm), Width (cm), Length (cm) Biztech Stre Page 20

22 Custm Articles fr Shipments: Admin will be able t create custm articles fr a single shipment as well. That article will nly be used fr single shipment nly. Cnsignment Creatin & Assignment t Manifest: Create cnsignments based n articles and start the prcess f sending them fr the Label Printing. Assign these cnsignments t current r new manifest. Yu can als create custm cnsignments Biztech Stre Page 21

23 Generate Return Labels: Admin will be able t generate return label fr the cnsignment by submitting return label request f the cnsignment. Biztech Stre Page 22

24 Manifest Management Label Printing: Get labels frm the eparcel fr printing and sticking them n the shipment based n the cnsignment details submitted Manifest Submissin & Summary Reprt: Submit cnsignments t the eparcel and send manifest generatin request. Once generated, get manifest summary reprt fr the manifests. Biztech Stre Page 23

25 Shipment Tracking: Track status f yur shipments with Australia Pst eparcel shipment tracking API service 5. Pints t Nte Cnfiguratin settings like address, SFTP details, LPS details must be valid as per eparcel Accunt Submit cnsignment t eparcel system after verifying all the cnsignments details One article weight must nt exceed weight limit (fr dmestic 22 kg and fr Internatinal 20 kg) T get cntract rates, required services must be enabled in Merchant s Australia Pst Business Accunt. Biztech Stre Page 24

26 6. FAQ 1. Will I be ntified when a custmer submits the qute? Ans. Yes, an will be received n the recipient address entered in the cnfiguratin. 2. Can I edit the fields f the qute request page? Ans. Currently it nly displays the fields cnfigured by us. There isn't any ptin t edit these fields as we have cvered every necessary field fr qute. 3. Is it pssible t allw qute submissin nly fr higher prduct quantities? Ans. Yes, the admin can set prduct quantity threshld s if the custmer enters quantity less than the threshld, then the qute wuld nt be submitted. 4. Can the custmer prvide their wn price in the qutatin? Ans. Yes, we have given prvisin in the qute request page t specify prpsed qutatin ttal. 5. Is it pssible t negtiate with the custmer befre finalizing the qute? Ans. Yes, there is an ptin prvided where admin can cmmunicate with yur custmer and finalize the qute. 6. Hw can the custmer view the status and detail f their qute? Ans. There is a prvisin in custmer's accunt where he/she can refer the qute details. The custmer needs t lgin n adminr stre. 7. Is it mandatry fr the custmer t be registered n ur website prir t submissin f the qute? Ans. Yes. If the custmer is nt registered/lgged in while qute submissin, then a pp up will pen t register/lgin. 8. The qute has apprval frm bth custmer and admin. What next? Ans. After apprval frm bth the sides, a cupn cde will be aut-generated and sent t respective client. The client can use the cupn cde while checkut and place rder. 9. What if custmer agrees fr the qute, but admin has nt yet apprved? Will the cupn cde still generate? Ans. N, the cupn cde will be generated nly after final apprval frm admin. Biztech Stre Page 25

27 7. Cntact Us We simplify yur business, ffer unique business slutin in digital web and IT landscapes. Live Chat Get instant supprt with ur Live Chat. Visit ur prduct page at and click n the Live Chat buttn fr instant supprt. Tickets Raise tickets fr yur specific questins! Send an t supprt@biztechcnsultancy.cm r admin can lgin t my accunt at and click n My Supprt Tickets n yur accunt dashbard, t get answers t yur specific questins. Our team will wrk t respnd t yur query prmptly. Custmizatin If admin wuld like t custmize r discuss abut additinal features fr Magent Australia Pst eparcel Extensin, please write t sales@biztechcs.cm Our cre expertise includes: (Add Plug-in Custmizatin) Biztech Stre Page 26