Top Banner
Magento 2 - Bpost Shipping Module Date document: 4/08/2016 Version: 1 Last changed date: 5 September 2016
28

Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

May 22, 2020

Download

Documents

dariahiddleston
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost

ShippingModule

Datedocument: 4/08/2016Version: 1Lastchangeddate: 5September2016

Page 2: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 1

1 TABLEOFCONTENT

1 TableofContent.............................................................................................................................................1

2 General...........................................................................................................................................................3

3 Languages&Compatibility.............................................................................................................................4

4 Installation......................................................................................................................................................5

5 Backend&Configuration................................................................................................................................6

5.1 Shippingsettings.......................................................................................................................................6

5.2 ShippingMethods.....................................................................................................................................8

5.2.1 bpostHomedelivery.......................................................................................................................8

5.2.2 bpostHomedeliveryinternational..................................................................................................9

5.2.3 bpostPick-uppoint........................................................................................................................10

5.2.4 bpostParcellocker........................................................................................................................11

5.2.5 bpostClick&Collect......................................................................................................................12

5.3 BackendOrderProcessing......................................................................................................................13

5.3.1 Weight...........................................................................................................................................14

5.3.2 Generatinglabels...........................................................................................................................14

5.3.3 Processingorderwithmultipleshipments....................................................................................15

5.3.4 Downloadinglabels.......................................................................................................................16

5.3.5 Downloadingasinglelabel............................................................................................................16

5.4 Returnlabels...........................................................................................................................................17

5.4.1 Automaticallyalongwitheachlabel.............................................................................................17

5.4.2 Manually........................................................................................................................................17

5.4.3 Downloadlabel..............................................................................................................................18

5.4.4 Emaillabelandinstructionstoclient............................................................................................18

5.5 Track&Trace..........................................................................................................................................19

6 Frontendimplementation............................................................................................................................20

6.1 Deliverydates.........................................................................................................................................20

6.1.1 Displaydeliverydate.....................................................................................................................20

6.1.2 Choosedeliverydate.....................................................................................................................21

Page 3: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 2

6.2 UseMagentotomanagelabels=“No”...................................................................................................22

6.3 Shippingmethods...................................................................................................................................22

6.3.1 bpostHomedelivery.....................................................................................................................22

6.3.2 bpostHomedeliveryinternational................................................................................................23

6.3.3 bpostParcellocker........................................................................................................................24

6.3.4 bpostPick-uppoint........................................................................................................................26

6.3.5 bpostClick&Collect......................................................................................................................26

Page 4: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 3

2 GENERAL

Important:beforeusingthemodule,youneedtocontactbposttoacquirethenecessarytestandproduction

credentialsandconfigurationsettings.

ThemoduleimpactsyourMagentoinstallationinthefollowingareas:

• Frontend:

o Duringcheckout5newshippingmethodswillbeavailable.

• Backend:

o Two extramenu items “Sales > bpost Orders > All bpost orders” and “Sales > bpost Orders >

Pendingbpostorders”tomanageyourorders,generatelabelsanddownloadthegeneratedlabels.

o Extra tab in “Stores > Configuration > Sales > Shipping Settings” to set general account

configurations.

o Extratabsin“Stores>Configuration>Sales>ShippingMethods”tosetspecificshippingmethod

configurations.

Page 5: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 4

3 LANGUAGES&COMPATIBILITY

Thefollowinglanguagepacksareincludedinthemodule:

• English

• Dutch

• French

Themoduleiscurrentlysupporttheversionsbelow:

• Magento2.0.7Community&Enterprise

• Magento2.0.8Community&Enterprise

• Magento2.0.9Community&Enterprise

Page 6: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 5

4 INSTALLATION

ToBeDeterminedwhenthepackageisuploadedinthemarketplace.

Page 7: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 6

5 BACKEND&CONFIGURATION

Important: It is important that you aware of the default behavior ofMagento, this document assumes you

alreadyknowhowthebasicsworkbydefault.

ThebpostShippingManagermoduleisconfiguredinthedefaultMagentosystemconfiguration.

5.1 SHIPPINGSETTINGS

Setting Description Default

Accountid Your6digitsbpostaccountIDusedfortheShippingManager <Empty>

Passphrase ThepassphraseyouenteredinbpostShippingManagerback-

officeapplication.Thisisnotthepasswordusedtoaccessbpost

portal.

<Empty>

APIurl Donotmodifythissettingifyouarenot100%sureofwhatyou

aredoing.

https://api.bpost.be

Sender…fields Thesefieldsareusedinthewebservicecalls.Theywillbeput

onthelabelaswell.

<Empty>

UseMagento

tomanage

labels

Ifyouenablethisoption,labelsaregenerateddirectlywithin

Magento.ItisnotneededtousethebpostShippingManager

forthesetasks.Pop-upsmustbeenabledinyourbrowser,in

ordertoviewtheprintedlabels.

Ifyoudisablethisoption,anorderwillbestillbemadeinthe

bpostShippingManageratthetimeavisitorcompletesthe

checkoutprocess.Butyouwillneedtomanagethelabelsinthe

bpostShippingManager,thebpostorderoverviewswillnotbe

availableinMagento.

Yes

Labelformat ChoosebetweenA6orA4format,thisdetermineshowthe

resultingPDF’sarereturnedfromtheAPI.

A6

Automatic

retourlabels

Ifyouenablethisoption,aretourlabelisautomaticallyadded

andprintedwhengeneratinglabels,theyareautomatically

addedtothegeneratedPDFwhengeneratinglabels.Youare

abletomanuallycreatereturnlabelsontheMagentoorder

withthebutton“bpostReturnLabel”.

No

Display Displayscalculateddeliverydateinthefrontendtothevisitor Yes

Page 8: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 7

Setting Description Default

deliverydate

duringcheckout.

See“Deliverydates”formoreinformation.

Daysbetween

orderand

shipment

Daysbetweenorderandshipment.

Thisisusedtocalculatethedeliverydate.

See“Deliverydates”formoreinformation.

1

Choose

deliverydate

Allowcustomertochoosetheirdeliverydate,wherethe

calculateddeliverydateisthefirstpossibleoption.

No

Numberof

deliverydays

shown

If“Choosedeliverydate”,thenumberofdaystochoosefrom.

See“Deliverydates”formoreinformation.

5

Nextday

delivery

allowedtill

Iftheorderisplacedafterthiscut-offtime,thisimpactsthe

displayeddeliverydate(s).Orderplaced=endofcheckout.

00:00

Saturday

deliverycost

AdditionalfeewhenusingSaturdaydeliveryoption,e.g.:4.95.

6

Unitweight Tellsthemoduleinwhichunittheweightisfilledinon

Magentoproducts.

Usedtocalculatetheweightbeforesendingittobpost.

g

Google

browserAPI

key

bpostusesGoogleMapsAPItodisplaythemapinthefrontend.

Note:Thisisoptionalifyouwillnotmeettheusagelimits.Visit

Google’sonlinedocumentationformoreinformation.

<Empty>

Googleserver

APIkey

bpostusesGoogleGeocodingAPItocalculateGEOlocation

basedontheshippingaddress.

Note:Thisisoptionalifyouwillnotmeettheusagelimits.Visit

Google’sonlinedocumentationformoreinformation.

<Empty>

Note: These settings are configured at the “Global” (default)Magento scope by default, but can be set on

websitelevel/scopeifneeded.

If‘daysbetweenorderandshipment’ issetto“0”themoduleassumesthatyoushiptheorderonthesame

dayitisplaced.Howeveriftheorderiscreatedafterthetimesetin‘Nextdaydeliveryallowedtill’thenthe

moduleassumesthatyouwillshiptheorderthenextday.

Page 9: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 8

5.2 SHIPPINGMETHODSIf themodule is installedcorrectly,5newbpostShippingmethodscanbefound in“Stores>Configuration>

Sales>ShippingMethods”

5.2.1 bpostHomedelivery

Setting Description Default

Enabled Enablesordisabledthedeliverymethod. Yes

Freeshipping Allowfreeshippingforthisshippingmethod. Yes

…asof Freeshippingwillbeappliedasfromaminimumamount.Toamountis

basedonthetotalorderamountVATincluded.

<Empty>

Ratetype Select“flatrate”ifyourequireafixedrateforthisshippingmethod.

Select“tablerates”ifyouwanttheratestobebasedonatablerates

configuration.

FlatRate

Flatrateprice Onapplicableif“Ratetype”issetto“flatrates”. 0

Tablerates

condition

Onapplicableif“Ratetype”issetto“tablerates”.

Themoduleusestableratesconfigurationinthesamewaythedefault

Magentotablerateswork.

ForchoosingyourconditionandconfiguringthetableratesCSV,please

visit:http://www.magentocommerce.com/knowledge-

base/entry/how-do-i-set-up-table-rate-shipping

Weightvs.

Destination

2nd

presentation

Thisoptionsprovidesautomaticallyasecondpresentationatthe

receiver'saddressshouldhebeabsentuponfirstpresentation.

No

…asfrom Onlyappliedtoorderswiththisminimumamount.Toamountisbased

onthetotalorderamountVATincluded.

<Empty>

Insurance Insurancetoinsureyourgoodstoamaximumof500,00euro. Yes

…asfrom Onlyappliedtoorderswiththisminimumamount.Toamountisbased

onthetotalorderamountVATincluded.

100

Signature Thedeliveryhappensagainstsignaturebythereceiver. No

…asfrom Onlyappliedtoorderswiththisminimumamount.Toamountisbased

onthetotalorderamountVATincluded.

100

Saturday

delivery

TheparcelisdeliveredonSaturdayifitistimelydroppedinthebpost

network.

0

Page 10: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 9

Setting Description Default

…asfrom Onlyappliedtoorderswiththisminimumamount.Toamountisbased

onthetotalorderamountVATincluded.

0

5.2.2 bpostHomedeliveryinternational

Setting Description Default

Enabled Enablesordisabledthedeliverymethod. Yes

Freeshipping Allowfreeshippingforthisshippingmethod. No

…asof Freeshippingwillbeappliedasfromaminimumamount.Toamountis

basedonthetotalorderamountVATincluded.

<Empty>

Ratetype Onlyapplicableif“Ratetype”issetto“flatrate”.

Fixedamountasshipmentcoste.g.:4.95.

0

Flatrateprice Onapplicableif“Ratetype”issetto“flatrates”. 0

Tablerates

condition

Onapplicableif“Ratetype”issetto“tablerates”.

Themoduleusestableratesconfigurationinthesamewaythedefault

Magentotablerateswork.

ForchoosingyourconditionandconfiguringthetableratesCSV,please

visit:http://www.magentocommerce.com/knowledge-

base/entry/how-do-i-set-up-table-rate-shipping

Weightvs.

Destination

Exporttable

ratesfile

Onlyapplicableif“Ratetype”issetto“tablerates”.

YoucandownloadthecurrentCSVbyclickingthe“ExportCSV”button.

NA

Importtable

ratesfile

Onlyapplicableif“Ratetype”issetto“tablerates”.

YoucanuploadyourCSVhere.

Note:ThetableratesconfigurationfileisonlyavailableintheMagento

[Website]scope;itwillnotbevisibleinanotherconfigurationscope!

Tip:YoucanuseonlinetoolstogenerateaCSVfilelike

this:http://elgentos.nl/tablerates/

NA

Import

countries

Importyourbpostconfiguredcountrieshere.

Clickingthe“import”buttonconnecttoyourbpostShippingManager

accountandimportthecountriesyouconfiguredintothe“Allow

countries”field.

NA

Allowed

countries

Thepossiblecountriesarefilledbyclickingthe“Import”buttonunder

“Importcountries”.

NA

Page 11: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 10

Setting Description Default

Theshippingmethodwillbeshownforshippingaddressinanyofthe

selectedcountries.

International

insurance

Insurancetoinsureyourgoodstoamaximumof500,00euro. No

…asfrom

Onlyappliedtoorderswiththisminimumamount.Toamountisbased

onthetotalorderamountVATincluded.

100

5.2.3 bpostPick-uppoint

Setting Description Default

Enabled Enablesordisabledthedeliverymethod. Yes

Free

shipping

Allowfreeshippingforthisshippingmethod. No

…asof Freeshippingwillbeappliedasfromaminimumamount.Toamountis

basedonthetotalorderamountVATincluded.

<Empty>

Ratetype Onlyapplicableif“Ratetype”issetto“flatrate”.

Fixedamountasshipmentcoste.g.:4.95.

0

Flatrate

price

Onapplicableif“Ratetype”issetto“flatrates”. 0

Tablerates

condition

Onapplicableif“Ratetype”issetto“tablerates”.

Themoduleusestableratesconfigurationinthesamewaythedefault

Magentotablerateswork.

ForchoosingyourconditionandconfiguringthetableratesCSV,please

visit:http://www.magentocommerce.com/knowledge-base/entry/how-

do-i-set-up-table-rate-shipping

Weightvs.

Destination

Export

tablerates

file

Onlyapplicableif“Ratetype”issetto“tablerates”.

YoucandownloadthecurrentCSVbyclickingthe“ExportCSV”button.

NA

Import

tablerates

file

Onlyapplicableif“Ratetype”issetto“tablerates”.

YoucanuploadyourCSVhere.

Note:ThetableratesconfigurationfileisonlyavailableintheMagento

[Website]scope;itwillnotbevisibleinanotherconfigurationscope!

Tip:YoucanuseonlinetoolstogenerateaCSVfilelike

NA

Page 12: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 11

Setting Description Default

this:http://elgentos.nl/tablerates/

Insurance Insurancetoinsureyourgoodstoamaximumof500,00euro. Yes

…asfrom Onlyappliedtoorderswiththisminimumamount.Toamountisbasedon

thetotalorderamountVATincluded.

100

Saturday

delivery

TheparcelisdeliveredonSaturdayifitistimelydroppedinthebpost

network.

0

…asfrom Onlyappliedtoorderswiththisminimumamount.Toamountisbasedon

thetotalorderamountVATincluded.

0

5.2.4 bpostParcellocker

Setting Description Default

Enabled Enablesordisabledthedeliverymethod. Yes

Free

shipping

Allowfreeshippingforthisshippingmethod. No

…asof Freeshippingwillbeappliedasfromaminimumamount.Toamountis

basedonthetotalorderamountVATincluded.

<Empty>

APIurl Select“flatrate”ifyourequireafixedrateforthisshippingmethod.

Select“tablerates”ifyouwanttheratestobebasedonatablerates

configuration.

0

Ratetype Onlyapplicableif“Ratetype”issetto“flatrate”.

Fixedamountasshipmentcoste.g.:4.95.

0

Flatrate

price

Onapplicableif“Ratetype”issetto“flatrates”. Weightvs.

Destination

Tablerates

condition

Onapplicableif“Ratetype”issetto“tablerates”.

Themoduleusestableratesconfigurationinthesamewaythedefault

Magentotablerateswork.

ForchoosingyourconditionandconfiguringthetableratesCSV,please

visit:http://www.magentocommerce.com/knowledge-base/entry/how-

do-i-set-up-table-rate-shipping

NA

Export

tablerates

Onlyapplicableif“Ratetype”issetto“tablerates”.

YoucandownloadthecurrentCSVbyclickingthe“ExportCSV”button.

NA

Page 13: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 12

Setting Description Default

file

Import

tablerates

file

Onlyapplicableif“Ratetype”issetto“tablerates”.

YoucanuploadyourCSVhere.

Note:ThetableratesconfigurationfileisonlyavailableintheMagento

[Website]scope;itwillnotbevisibleinanotherconfigurationscope!

Tip:YoucanuseonlinetoolstogenerateaCSVfilelike

this:http://elgentos.nl/tablerates/

NA

Insurance Insurancetoinsureyourgoodstoamaximumof500,00euro. Yes

…asfrom

Onlyappliedtoorderswiththisminimumamount.Toamountisbasedon

thetotalorderamountVATincluded.

100

Saturday

delivery

TheparcelisdeliveredonSaturdayifitistimelydroppedinthebpost

network.

0

…asfrom

Onlyappliedtoorderswiththisminimumamount.Toamountisbasedon

thetotalorderamountVATincluded.

0

5.2.5 bpostClick&Collect

Setting Description Default

Enabled Enablesordisabledthedeliverymethod. Yes

Logo Uploadsacustommapmarker. bpostlogo

Free

shipping

Allowfreeshippingforthisshippingmethod. No

…asof Freeshippingwillbeappliedasfromaminimumamount.Toamountis

basedonthetotalorderamountVATincluded.

<Empty>

Ratetype Onlyapplicableif“Ratetype”issetto“flatrate”.

Fixedamountasshipmentcoste.g.:4.95.

0

Flatrate

price

Onapplicableif“Ratetype”issetto“flatrates”. 0

Tablerates

condition

Onapplicableif“Ratetype”issetto“tablerates”.

Themoduleusestableratesconfigurationinthesamewaythedefault

Magentotablerateswork.

ForchoosingyourconditionandconfiguringthetableratesCSV,please

Weightvs.

Destination

Page 14: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 13

Setting Description Default

visit:http://www.magentocommerce.com/knowledge-base/entry/how-

do-i-set-up-table-rate-shipping

Export

tablerates

file

Onlyapplicableif“Ratetype”issetto“tablerates”.

YoucandownloadthecurrentCSVbyclickingthe“ExportCSV”button.

NA

Import

tablerates

file

Onlyapplicableif“Ratetype”issetto“tablerates”.

YoucanuploadyourCSVhere.

Note:ThetableratesconfigurationfileisonlyavailableintheMagento

[Website]scope;itwillnotbevisibleinanotherconfigurationscope!

Tip:YoucanuseonlinetoolstogenerateaCSVfilelike

this:http://elgentos.nl/tablerates/

NA

Insurance Insurancetoinsureyourgoodstoamaximumof500,00euro. Yes

…asfrom Onlyappliedtoorderswiththisminimumamount.Toamountisbasedon

thetotalorderamountVATincluded.

100

Saturday

delivery

TheparcelisdeliveredonSaturdayifitistimelydroppedinthebpost

network.

0

…asfrom Onlyappliedtoorderswiththisminimumamount.Toamountisbasedon

thetotalorderamountVATincluded.

0

5.3 BACKENDORDERPROCESSINGOrdersthathavebeencreatedwithabpostshippingmethodappearinthebpostoverviews:

Page 15: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 14

Ordersshouldbeprocessed fromwithin the“Pendingbpostorders”overview.Thiscontainsallbpostorders

thatarenotintheMagentostatus“Completed”,“Closed”or“Cancelled”.

Theoverview“Allbpostorders”containsallbpostorders,regardlessofthestatus.

5.3.1 WeightThemodule calculates the total weight of the order based on theweight of the products in the order per

shipments.Allitemswithoutaparentitemaretakenintoaccounttocounterproblemswithconfigurableand

bundledproducts.

Alabelisgeneratedforeachshipmentandthetotalweightpershipmentissenttobpostwhengeneratinga

label.

Weight isoptional,youarenot requiredto fill in theweightofyourproducts.Domindthatyoumighthave

agreedotherwiseinyourcontractwithbpostandwillhavetomaketheconfigurationassuch.

Note:Thesetting“Unitweight”under“ShippingSettings”isusedtocalculatetheweightandtranslateittothe

unitbpostisexpecting,makesureitissetcorrectly.

5.3.2 GeneratinglabelsInthebpostoverviews,youcanfiltertheordersyouwouldliketoprocessusingthestandardMagentocolumn

filtersthatareavailableintheoverview:

Filter theoverviewand select all theorders youwould like to process. Then, perform the action “Generate

shippinglabel”thatisavailableinthe“Actions”dropdowntopleftoftheoverviewbyselectingit.

5.3.2.1 Magentoshipmentwillbecreated.

Performingthen“Generateshippinglabel”actionwillcontactbpostthroughawebservice,whichwillprovidea

trackingcodeandabpostlabelasPDF.

Page 16: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 15

Iftheorderdoesnotyethaveashipment,aMagentoshipmentwillbecreatedandthetrackingnumberwillbe

addedtothatshipment:

Youcanalsoverifyifalabelispresentbycheckingthe“Labeldownload”columnintheoverview.Ifanorder

alreadyhasashipment,anewshipmentwillnotbecreated,alabelandtrackingnumberwillbegeneratedfor

eachexistingbpostshipment.See“Processingorderwithmultipleshipments”formoreinformation.

5.3.2.2 Thestatusoftheorderchanges.

Ifyourorderhadthestatus“Processing”beforeperformingthe“Generateshippinglabel”,itwillautomatically

besetto“Complete”.

ThestatusoftheorderischangedbasedonthestandardMagentostatusworkflow.Asaresult, ifnoinvoice

has been created before the action “Generate shipping label” the status would go from “Pending” to

“Processing”.

5.3.3 ProcessingorderwithmultipleshipmentsWhen an order requiresmultiple shipments, you have to create asmany shipments as neededmanually in

Magentobeforeperformingthe“Generateshippinglabel”action.

YoucancreatetheshipmentlikeanyotherMagentoshipment,butifabpostlabelneedstobegeneratedfor

thatshipment,youneedtoselectbpostascarrierandfillinadummytrackingnumber(use“x”forexample):

Page 17: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 16

Note:Thedummytrackingnumberwillbereplacedwiththebposttrackingnumberassoonas

theaction“Generateshippinglabel”hasbeenperformed.Youcanjustput‘x’

Whenthe“Generateshippinglabel”processestheorder,itwillgeneratealabelandtrackingnumberforeach

bpostshipmentintheorder.Youcanalsoaddother(non-bpost)shipmentsintheorderifneeded;theywillbe

ignoredbythe“Generateshippinglabel”action.

Afterthe“Generateshippinglabel”hasbeenperformedonanorder,thevalueinthe“bpostlabel”columnwill

changetoa"download"andyouwillnotbeabletore-processtheorder.

5.3.4 DownloadinglabelsThemodule assumes youwill only download the label once, and youdonotwant to download a label you

already downloaded and therefore a flag “Label Downloaded” is set on an order when a label has been

downloaded.

Todownloadthelabelsthathavebeengeneratedwiththeaction“Generateshippinglabel”,selecttheorder

forwhichyouwanttodownloadthelabelsandperformthe“Download”action.

5.3.5 DownloadingasinglelabelYoucanalsodownloada single labelwithout reading the“downloaded” flagbyclickingon the“download”-

buttonintheoverview:

Page 18: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 17

You can also always download the bpost label, regardless of the fact you downloaded it before (= “Label

Downloaded”flagissetto“Yes”).

5.4 RETURNLABELS

5.4.1 AutomaticallyalongwitheachlabelYoucanhavereturnlabelstobeautomaticallyincludedintheinitiallabel.Youcanenableordisablethisoption

inthe“Shippingsettings”,field“Automaticretourlabels”.

Youwillprobablyonlyneedtousethisfunctionalityifyouwanttosendreturnlabelsalongwitheachpackage

toyourcustomers.Thisrendersthefunctionalitydescribedinthesection“Manually”obsolete.

5.4.2 ManuallyThe module allows Magento webshop administrators to generate return labels for a bpost order. Where

regular labelsaregeneratedandmaintainedatashipment level,thereturn labelsarenot linkedtoacertain

shipmentinMagento,andcanbemanagedfromwiththeorder:

Page 19: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 18

Togenerateareturnlabelforanorder,clickonthe“bpostReturnLabel”buttontoprightofanorder:

Afterclickingonthisbutton,abpostreturnlabelwillbegeneratedandisavailableunder“bpostReturnLabels”.

5.4.3 DownloadlabelTodownloadthereturn label,youcanclickonthe“Download” linkof therowcorrespondingtothedesired

returnlabel.

5.4.4 EmaillabelandinstructionstoclientYoudonothavetodownloadthelabeltosendittotheclient,youcanemailthereturnlabelwiththeaction

“Emailtoclient”inthe“Email”column:

Page 20: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 19

Anemailwillbesenttotheemailaddressofthecustomerthatisavailableintheorder.Adefaulttemplateis

included(andused)inthemoduleforthisandiscalled“bpost–returnlabelEmail”.

5.5 TRACK&TRACEWhenalabelisgenerated,bpostwillreturnatrackingcodeforyourorder(notpershipment).

ThelinkwillbeaddedtothestandardMagento“Trackyourorder”window:

Page 21: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 20

6 FRONTENDIMPLEMENTATION

Thebpostshippingmethodsbasicallydisplaysthesameasothershippingmethodbutwithsomeextrafeatures:

1.Thecostisbasedonyourconfiguration,beit“flatrate”or“tablerates”.

2.Thelinkopensthemapbasedontheshippingaddress.

6.1 DELIVERYDATES

6.1.1 DisplaydeliverydateTheoption“Displaydeliverydate”in“Stores>Configuration>ShippingSettings”defineswhetherthedelivery

dateisdisplayedduringcheckout.Thisisageneralsettingforallshippingmethods.

Ifyes,thedeliverydateiscalculatedlikethis:

• Tostart,1dayisaddedtotheorderdate,asanorderisnotdeliveredthesameday.

• Then,anextraday isadded iftheorder isplacedafterthecut-offtime(=valuefrom“Nextdaydelivery

allowedtill”intheShippingSettings)

Whendaysare“added”,itischeckedifthenextdayisvalid,avaliddateis:

• notaholiday

Page 22: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 21

• notaSunday

• notaSaturdaywhen…

o Saturdaydeliveryisnotallowedfortheselectedshippingmethod;

o The total amount is lower than the “As from…” value for Saturday delivery for the selected

shippingmethod).

Ifenabled,thecalculateddeliverydateisdisplayedlikethis:

6.1.2 ChoosedeliverydateIftheoption“Choosedeliverydate”isenabledunder“Stores>Configuration>ShippingSettings”avisitorcan

choosethedeliverydateforhisorder.Thisisageneralsettingforallshippingmethods.

The number of days he can choose from is based on the setting “Number of delivery days shown” under

“Stores>Configuration>ShippingSettings”.

Ifenabled,thepossibiledaysareshownasradiobuttonwherethevisitorcanmakehischoice:

Page 23: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 22

Ifadeliverydateaweekintothefutureischosenbythecustomer,themerchantissupposedto

holdontothepackageforaweekbeforehandingitofftobpost.

6.2 USEMAGENTOTOMANAGELABELS=“NO”Theeasiestoptionforthesetting“UseMagentotomanage labels”formostshopkeepers is“Yes”.But ifyou

choose to not manage your labels in Magento, an extra webservice call is placed at the end of the order

creatinginthefrontend.

Because labels will not be managed in the Magento backend, an order is created in the bpost Shipping

ManagerwhenaMagentoorderiscreated,whenthecheckoutiscompleted.

Ifthiswebservicecallfails,thecheckoutprocesswillcontinue,thevisitorwillnotseeadifference.Theerroris

loggedinbpost.logandanemailissenttotheemailaddressthatisconfiguredinthedefaultMagentosetting

“Stores>Configuration>General>StoreEmailAddresses>GeneralContact”.

6.3 SHIPPINGMETHODS

6.3.1 bpostHomedeliveryThehomedeliverymethodacts likeastandardMagentoshippingmethod.Themodulehasnoreal frontend

impactonthisshippingmethodbesides.

TheshippingmethodisonlyshownifthedeliveryaddressisinBelgium.Ifthepostalcodeisnotformattedas

“9999”,anerrormessageisshown:

Page 24: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 23

6.3.2 bpostHomedeliveryinternationalThehomedelivery internationalmethodacts likea standardMagento shippingmethod.Themodulehasno

realfrontendimpactonthisshippingmethodbesides.

The shipping method is only shown if the delivery address is in any of the selected countries in “Allowed

countries”intheshippingmethodconfiguration.

Tomake sure that postal codes thatwill be sentwith the API are valid, the postal code during checkout is

validated. This is a table that gives you an overview of the validation being applied per country:

http://bpost.freshdesk.com/support/solutions/articles/4000040467-current-international-zip-code-masks

Ifthepostalcodedoesnotmatch,anerrormessageisshown:

Setting up countries for bpost Home delivery international requires configuration in the bpost shipping

managerandontheshippingmethodconfigurationpage.

Page 25: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 24

In the shippingmethod configuration screen you’ll be able to indicatewhat countries youwant to ship to.

Checkoutswithdestinationaddresseswithacountrythatisnotselectedinthislistwillnotbeshownthebpost

Homedeliveryinternationaloption.

Inordertogetcountrieslistedheretheyneedtoimportedfromthebpostshippingmanager:

1. You’llhavetologintoyouraccountinthebpostshippingmanagerandconfigureinternationaldelivery.

2. Revisit the bpost home delivery international shippingmethod configuration page and click the import

buttonunderoptions.

6.3.3 bpostParcellockerWhenthebpostParcellockershippingmethodisselected,alinktoshowtheGooglemapappears:

Whenclicking the link theGoogleMapopensand shows the spots thatwhere foundbasedon the shipping

address.TheshippingaddressistranslatedtopointonthemapusingtheGoogleGEOAPI. Ifthegeolocation

failsornoparcellockerswerefound,thefollowingmessageisshown:

Page 26: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 25

Ifthegeolocationworks,andparcellockerswerefound,themapisshownwithupto10parcellockersnearest

totheshippingaddress:

Toselectabpostparcellocker,thecustomercanselectamarkeronthemapandclick“Select”,orusethelist

ontheleft.

Whenthescreenisverynarrow(e.g.onmobiledevices)onlythemaplistisshown,themapwillbehidden:

Afterchoosingaparcellocker,theselectedparcellockerispresentedonthecheckoutpage:

Page 27: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 26

Byclicking the link“Clickhere tochangeyourbpostparcel locker” themapappearsagainandanewparcel

lockercanbechosen.

Acustomercanalsochooseoptionalservices.

Thereducedmobilityzonereferstolockersthatareeasytoaccessforpeoplewithdisabilities,thisoftenmeans

thattheyareeasytoaccessfromawheelchair.

6.3.4 bpostPick-uppointThepick-uppointshippingmethodandtheparcellockershippingmethodworksinasimilarway.

Therearetwodifferences:

1:Apick-uppointalsohasopeninghoursthatareshownonthemaporbyclickingthequestionmarknextto

thenameonceselected:

2:Theoptionalservicesaredifferent:

6.3.5 bpostClick&CollectTheClick&CollectshippingmethodandthePick-uppointshippingmethodworkinasimilarway.

Thereareonlytwodifferences:

1. Click&CollectpointsaredefinedinthebpostShippingManagertool.

Page 28: Magento 2 - Bpost · Magento 2 - Bpost 6 5 BACKEND & CONFIGURATION Important: It is important that you aware of the default behavior of Magento, this document assumes you already

Magento2-Bpost 27

2. Youcanusecustommarkersforthedisplayofthepoints.