bba magento v1 modulev rev5...magento is a highly customizable e -commerce platform and content...
TRANSCRIPT
![Page 1: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/1.jpg)
BBAMagento v1Module
BBAModuleDesignDocument
Version1.0
![Page 2: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/2.jpg)
PluginOverview
ProjectContext
![Page 3: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/3.jpg)
WhatisMagento?
What is Magento?Magento is a highly customizable e-commerce platform and content management system that you can use to build online storefronts or web sites for selling merchandise. Magento provides common e-commerce features, such as shopping carts and inventory management, and encourages extensive customization to meet your organization’s specific goals.
OOP architecture and programming principlesObject-Oriented Programming (OOP) design allows for maximum flexibility and extensibility of software components, permitting you to design and implement highly customized web sites. The advantages of OOP principles include incorporation of industry-standard programming design patterns and the strict separation of business logic from presentation. Object inheritance is important, too: In keeping with classic object-oriented programming methodology, the Magento platform provides core components with base functionality that can be inherited by custom components for a specific web site or application.
3
![Page 4: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/4.jpg)
BBAMagentoModule/Extension
• TheBBAMagentoModuleallowsMagentoe-CommerceStoreOwnerstoprovidethemostaffordableshippingratestotheircustomers.
• UserscanstreamlinetheirshippingoperationswiththeBBAdashboard.
• OrdersareautomaticallyprocessedintheirBBAequippedwarehouseswhichalsoprovidesareal-timestatusofwherethepackageisinthechain.
• Allofthesetranslatetomorerepeatbusinessandprofitsforthestoreowner.
4
![Page 5: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/5.jpg)
Module MainComponents
StoreFront AdminSection API
TheBBAMagentoModuleplacessomeinterface
elementsliketheShippingCalculatorandLocationWidget
intheStorefronttoallowonlinecustomerstochoosethebestandmostaffordableshippingmethodavailablein
theirarea.
TheModulealsoaddsafewcustomizationstotheAdminSectionthatallowstheStoreOwnertoConfigurehowBBAinteractswiththeirMagentositeallowingformaximumcustomizabilityandcontrol.
+ +Apartfromthebuilt-inCoreAPI,theBBAModulehasadditionalAPIfunctionality
whichcommunicateswiththeBBACoreSystems.Thisallowsforaseamlessandsecureconnection toendless
possibilities.
5
![Page 6: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/6.jpg)
StoreFrontFeatures
ScopeofStoreFrontFeatures
![Page 7: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/7.jpg)
ProjectScope|StoreFront
7
No. Features
1 Shipping CalculatoronProductpage
2 Shipping CalculatoronCartpage
3 Shipping CalculatoronCheckoutpage
4 “Saveyourlocationfeature”inShop (Cookies)
5 LocationWidgetAuto-Complete onProductpage
6 LocationWidgetAuto-Complete onCart
7 LocationWidgetAuto-Complete onCheckout
8 TrackingNumber/URLDisplay(OrderCompletion)
9 TrackingNumber/URLDisplay(Orders Page)
![Page 8: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/8.jpg)
Store FrontModuleInterface|Product Page
8
• LocationWidget
• ShippingMethods(Calculator)
![Page 9: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/9.jpg)
Store FrontModuleInterface|CartPage
9
• LocationWidget
• ShippingMethods(Calculator)
![Page 10: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/10.jpg)
Store FrontModuleInterface|CheckoutPage
10
• LocationWidget
• ShippingMethods(Calculator)
![Page 11: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/11.jpg)
Store FrontModuleInterface|MyOrdersPage
11
• ShippingMethods(Calculator)
![Page 12: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/12.jpg)
Store FrontModuleInterface|LocationWidget
12
CodeSamples:
http://13.54.5.60/dev/location-widget/examples/basic.html
http://13.54.49.93/dev/location-widget/examples/checkout.html
Confluence site:https://bbalogistics.atlassian.net/wiki/display/BWRC/Location+widget
![Page 13: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/13.jpg)
AdminSectionFeatures
ScopeofAdminSectionFeatures
![Page 14: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/14.jpg)
ProjectScope |Admin Section|ShippingMethods– 1/2
14
No. Features
1 Enabled/DisableModule
2 SetStoreFrontModule Title
3 ShowShipping CalculatorinProductPage
4 Enable/Disable Contingency valuesforAPI
5 SetFlatRateValue
6 SetDefaultDimensions
7 SetDefaultWeight
8 SetDefaultUnitofMeasure
9 SetDefaultPick-upAddress
10 SetAPIUsername
11 SetAPIApplication ID
12 SetAPIApplication SecretKey
13 SetAPIAuthorizationCode
![Page 15: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/15.jpg)
ProjectScope |Admin Section|BBA ShippingMethods– 2/2
15
No. Features
14 SetAPIKey
15 CheckAPIStatus
16 SetDefaultCountry ofOrigin
17 SetDefaultRegion/StateOrigin
18 SetDefaultZIP/PostalCode
19 SetDefaultCity
20 SetDefault StreetAddress
21 SetDefaultStreetAddressLine2
22 AllowShipping toMultipleAddresses
24 MaximumQty.AllowedforShipping toMultipleAddresses
![Page 16: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/16.jpg)
ProjectScope |Admin Section|Orders
16
No. Features
1 ShowShipping &Handling Information (OrderShippingMethodsSelected)2 ShowTrackinginformation in“DisplayShipping &Handling Information”section3 ShowListofItemsOrderedforeachorder.4 Show Trackinginformation foreachitemin“ListItemsOrdered”section5 ShowStatus foreachitemin“ListItemsOrdered”section6 ShowReturnShipping &Handling Information (ReturnShippingMethodsSelected)7 ShowReturnTrackinginformation in“DisplayShipping &Handling Information”section8 ShowListofReturnedItems9 Show Trackinginformation foreachreturned itemin“ListItemsOrdered”section10 ShowStatus foreachreturned itemin“ListItemsReturned”section
![Page 17: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/17.jpg)
ProjectScope |Admin Section|BBAProductSettings
17
No. Features
1 Setindividual productlength2 Setindividual productwidth3 Setindividual productheight4 Toggle toenable/disablemultipledimensions5 SetDimensions ofamulti-packaged Product
![Page 18: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/18.jpg)
AdminModuleInterface|ShippingMethods
18
• Enabled/DisableModule• SetStoreFrontModuleTitle• ShowShipping CalculatorinProductPage• Enable/Disable Contingency valuesforAPI• SetFlatRateValue• SetDefaultHeight• SetDefaultLength• SetDefaultWidth• SetAPIUsername• SetAPIApplication ID• SetAPIApplication SecretKey• SetAPIAuthorizationCode• SetAPIKey• CheckAPIStatus
![Page 19: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/19.jpg)
AdminModuleInterface|Orders
19
• ShowShipping &HandlingInformationSetStoreFront
• ShowListofItemsOrderedforeachorder.
![Page 20: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/20.jpg)
BBAMagentoModuleAPI
BBAAPIModuleComponents
![Page 21: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/21.jpg)
ProjectScope |BBAMagentoAPI
21
No. Features
1 EventWeb-hook – Send signaltoBBASystemtoextractOrderDatafromtheMagentoModule
2 OrderDataExporttoBBASystem– BBASystemSends arequesttoModule toprovidearesponse containingOrderandItemInformation
3 TrackingURL/Number– Module sends requesttotheBBApendingshipmentsmodule toreturntheappropriatePackageTrackinginfo.
4 Shipping Status- Module sends requesttotheBBApendingshipmentsmodule toreturntheappropriatePackageShipping Status.
![Page 22: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/22.jpg)
ProjectScope |BBAMagentoAPIEndpoints(Soap)
22
MAGENTOAPIRESOURCEThisgroupofresources managetheconnection betweenmarketplaceandBBASystem
Note:ThismethodsneedstobeenabledonMagentoDasboardinsideSOAPUserRoleLevel Method Resource Pagination Description ACLMagento ParamsListofitemsoforder GET bbalogisticsProductList No Listall itemsinsideorder BBAlogistics->Products-List NoNeedGetallproducts instore GET bbalogisticsProductGet No Getallproducts instore BBAlogistics->Products->Get NoNeed
Getshimpmentinfofromorder GET salesOrderShipmentInfo NoGetshimpmentinformation fromorder SHIMPMENT shipmentIncrementId
Getcredit MEMO GET salesOrderCreditmemoList No Getcredit memoinfo CREDITMEMO NoNeedGetinvoicelist GET salesOrderInvoiceList No Getallinvoicesinformation INVOICES NoNeed
![Page 23: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/23.jpg)
APICommunicationArchitecture
BBACoreSystem
Magento BBASystemInternet
23
BBAModule
EventTriggeredWebHook
BBACoreSendsORDEREXPORTrequest
Module ExportsOrderandItemData
BBACoreSends TrackingandStatusInfo
![Page 24: BBA Magento v1 Modulev rev5...Magento is a highly customizable e -commerce platform and content management system that you can use to build online storefronts or web sites for selling](https://reader033.vdocuments.net/reader033/viewer/2022060417/5f14f1b173038f3fdb065d5b/html5/thumbnails/24.jpg)
APIModuleOrderExport
24
APITestScript:
http://13.54.5.60/dev/magento-community-v1/multiple/soap.php
Additional APIDocumentation:
https://bbalogistics.atlassian.net/wiki/display/BL/Shipment+and+Order+API