BBAMagento2Version1.0Extension

UserGuide

IntroductionMagentoisanecommerceplatformthatallowsyoutomanagethelook,contentandfunctionalityofyouronlinestore.AlthoughMagentooffersawiderangeoffeaturestomanageyourwebstorewisely,itonlyoffersthepossibilitytoshipitemsfromasinglestoragewarehouse.

TheBBAMagentoModuleallowsMagentoe-CommerceStoreOwnerstoprovidethemostaffordableshippingratestotheircustomers.

UserscanstreamlinetheirshippingoperationswiththeBBAdashboard.OrdersareautomaticallyprocessedintheirBBAequippedwarehouseswhichalsoprovidesareal-timestatusofwherethepackageisinthechain.Allofthesetranslatetomorerepeatbusinessandprofitsforthestoreowner.

BBAalsoallowsforalltypesofshippinganddeliverymethods,ensuringretailersdriveandimprovesalesconversionmetrics.

ThisdocumentprovidesadetailedguidetoconfiguringBBASingle-Warehouseextension.

GettingStartedInstallingtheExtensionManyextensionsandthemesareavailableonMagentoConnect,andtheinstallationprocessvariesforeach.Someextensionsrequireadditionalconfigurationaftertheinstallation.Forcompleteinstallationandconfigurationinstructions,seethedocumentationprovidedbytheextensiondeveloper.Thefollowinginstructionsoutlinethegeneralprocess.Beforeinstallinganyextension,alwaysbackupyourstore.

LogIntoMagentoConnectManager

Tobackupyourstore:

OntheAdminmenu,selectSystem>MagentoConnect>MagentoConnectManager.SelecttheCreateBackupcheckboxandselectthebackuptype.�Thebackupiscreatedautomatically,andlistedunderSystem>Tools>Backups.

Toinstalltheextension:ToInstallaFreeExtension:1.NavigatetotheExtensionProfile2.SelectthePlatform3.ClicktheInstallNowbutton4.SelectYourMagentoConnectChannel

NOTE:InstallingthewrongextensionkeyonMagentowillresultinanerror.DevelopershavetheabilitytochoosewhichversionsofMagentotheysupport.Supportedversionsarelistedontheextensionprofilepage.

5.Checktheboxtoagreetotheextensionlicenseagreement.6.Onceyouselectthechannelandagreetothelicensingagreement,clickGetExtensionKey.7.Theextensionkeyisrevealed.ClickSelectKeytocopythekey.8.LogintoyourMagentoStoreAdminPanel9.NavigatetoSystem>MagentoConnect>MagentoConnectManager10.PastetheextensionkeyinStep2fieldandclickInstall.MagentoConnectManagerverifiestheextensionkeyandgivesyouoptionstoCancelInstallationorProceed.11.ClickProceed.TheConsoleBoxdisplaystheresultsofyourinstall.Ifthereareanyissues,itwillbedisplayedinthisbox.12.ClickRefreshtoseethisextensionaddedtoyourExtensionsList.

Toinstalltheextensionmanually:

1. GototheMagentorootdirectory.2. Pasteallcontentsoftheextensionzipfileprovided.3. Onthecommandlinenavigatetoyoursite’srootdirectoryandtypeinthis

command:“phpbin/magentosetup:upgrade”4. Oncesuccessfulusethefollowingcommandtorecompile:“phpbin/magento

setup:di:compile”

Note:ifupgradeisunsuccessfulpleasedeletethevar/generation,var/cacheand/var/page_cachefoldersthenretry.Alsocheckifthesecommandsneedelevatedpermissions.

BasicConfigurationAdminLoginAllofthebasicconfigurationtasksareperformedfromtheMagentoAdminPanel,whichisreferredtointhisguideasyourstoreAdmin.TheinitialAdminlogincredentialsweresetup

duringtheMagentoinstallation.Foradditionalsecurity,theAdminlogincanalsobeconfiguredtorequireaCAPTCHA.

Ifyouforgetyourusernameorpassword,atemporarypasswordcanbesenttotheemailaddressthatisassociatedwiththeaccount.

AdminLogin

BBAAPIConfiguration

TheBBAAPIConfigurationsectionallowstheusertosettheAPIcredentialsrequiredtoconnecttotheBBASystem.ThiswillallowthemagentoinstallationtointegrateandreceivedataseamlesslyfromBBA.

ToconnecttoBBA:

1. Logintotheadminpanel.2. GotoStore→Configuration

ConfigurationMenu

3. ClickSales→Shippingmethods

4. NowyouwillfindBBALogisticsconfigurationlikebelow:

ShippingMethodMenu

BBALogisticsConfigurationform

Field Description

Enabled SetthisconfigurationtoYestoenableBBAshippingmethods.

Title EnteraTitleforthisshippingmethod.ItwillbedisplayedduringcheckoutontheMagentofrontend.

ShowShippingCalculatorinProductPage

SetvaluetoYestoturnthisfeatureon.

UnitofMeasure SelectCentimeter,Inch

UnitofWeight SelectKilogram,Pounds,OunceorGrams

DefaultPackageHeight SpecifytheDefaultPackageHeight.Defaultvalueis1.DuringanAPIcall,itwillbesenttoBBAifBBAoptionsbyproductareempty.

DefaultPackageLength SpecifytheDefaultPackageLength.Defaultvalueis1.DuringanAPIcall,itwillbesenttoBBAifBBAoptionsbyproductareempty.

DefaultPackageWidth SpecifytheDefaultPackageLength.Defaultvalueis1.DuringanAPIcall,itwillbesenttoBBAifBBAoptionsbyproductareempty.

DefaultPackageWeight SpecifytheDefaultPackageWeight.Defaultvalueis1.DuringanAPIcall,itwillbesenttoBBAifBBAoptionsbyproductareempty.

EnableOrderExporttoBBA SetthisconfigurationtoYestoturnOrderExporttoBBAon.

ShiptoApplicableCountries Ithave2choice:AllallowedCountriesandSpecificCountries

ShiptoSpecificCountries Ifyouset“ShiptoApplicableCountries”with“SpecificCountries”youcanchooseandsetthisvalues.

SortOrder

Allowstheusertosortavailableshippingmethods

BBALogisticsAPICredentialform

Field Description

EnableAPI Setenable/disableAPI

Username EnteryourBBAaccountusername.

Password EnteryourBBAaccountpassword.

ApplicationID EntertheApplicationIDprovidedbyBBA.

ApplicationSecretKey EntertheApplicationSecretKeyprovidedbyBBA.

AuthorizationCode EntertheAuthorizationCodeprovidedbyBBA.

AfteryousetallBBALogisticsconfigurationvalues,click“SaveConfig”button.

Note:AdditionalsettingsneedtobeconfiguredontheBBAinterfacetobeabletoimportdatatotheBBAsystem. OrderHandlingAssoonasanorderhasbeenplaceditgetsimportedintotheBBASystemandaddedtothePendingShipmentsListreadytobeprocessed.Inmagento,theconfirmedorderisfoundonorderssectionandcontainstheshippinginformationandthetrackingdetailsassoonastheShipmenthasbeenbookedontheBBAside.Tofindanorder:

1. Gototheadminpanel.2. FromthenavigationbaratthetopofthepageselectSales>Orders3. SelectthedesiredorderandClickon“View”toshowtheorderdetails.4. UnderShippingandHandlingInformationyoushouldseetheshippingmethodusedand

trackingdetailsiftheorderhasalreadybeenbooked.

StoreFront

LocationWidget&ShippingCalculatorThe Location widget is a feature that validates a buyer’s address and searches it within the BBA Logistics’ database. To get a list of state, postcode, or city, the widget sends a request to the BBA System to check if the location provided is serviceable. If it is, the Shipping calculator logic gets all relevant shipping rates and includes all additional costs then outputs them as shipping methods.

Orderhandling

ProductPageInthemagentoproductpage,thelocationwidgetandshippingcalculatorprovidesawaytodeterminethebestmethodandratetoshipthespecificproducttakingintoconsiderationtheitem’slocation,destination,price,weightandothervariables.Togetavailableshippingmethods:

1. GototheStoreFront.2. Selecttheproductwewanttoinspectbyclickingonit.3. SelectaCountryfromthelocationwidget.4. SelectaPostcodefromthelocationwidget.5. Clickon“Estimate”linkandwillshowformlikebelow:

EstimateShipping

6. ToshowcompleteShippingmethodavailableclick“ViewMore”button.

7. ToaddtheproducttoCart,clickon“ADDTOCART”button.

ShoppingCartInthemagentoshoppingcart,thelocationwidgetandshippingcalculatorprovidesawaytodeterminethebestmethodandratetoshipthealltheproductsinthecarttakingintoconsiderationtheitems’location,destination,totalprice,totalweightandothervariables.

Togetavailableshippingmethods:

1. GototheStoreFront.2. Selecttheproductstoaddtocart.3. Clickonthe“Cart”linkonthetoplefthadcornerthenclickon“ViewandeditCart”.

completeshippingmethod

4. Click“estimateShippingandTax”linkandfillCountry,Zip/Postalcodeandcitytogetshippingmethodavailable.

EstimateShippingandtaxform

viewandeditcartlink

Checkout

Inthecheckoutpage,thelocationwidgetandshippingcalculatorprovidesawaytodeterminethebestmethodandratetoshipthealltheproductsinthecarttakingintoconsiderationtheitems’location,destination,totalprice,totalweightandothervariables.AllBBAshippingmethodsareretrievedfromtheBBASysteminrealtime.Togetavailableshippingmethodsduringcheckout:

1. AfterClickingonthe“ProceedtoCheckout”buttonontheShoppingCartpage,itwillredirectyoutocheckout.

2. Filloutallrequiredinformationincludingthecountryandpostcodefields.Alternatively,youcanloginwithyouraccountanditwillauto-populateallthefields.

3. Under“ShippingMethods”magentowillshowtheavailableshippingmethodsaccordingtotheinformationyouenteredpreviously.

OrderDetailsTechnicallyadefaultfeatureofmagento,theOrderDetailspagedisplaystheshipmentinformationandaswellasthetrackingspecificsfromtheBBAsystemwhentheorderhassuccessfullybeenbooked.Toviewtheorderdetails:

1. LogintoyouraccountontheStoreFront.2. Clickonthe“MyOrders”linkontheleftsideofthepage.

3. Selectanordertoviewandthenclick“VIEWORDER”

ViewOrderLink

OrderDetail