Installing SparkLayer on Magento

introduction sparklayer enables b2b functionality on your existing magento store, allowing your b2b customers to login, place orders, manage their account, and much more to familiarise yourself with sparklayer, we also recommend reviewing the following guides docid 2g8hwcxnn7ofy4o199y1 the fundamentals of what sparklayer does docid\ ogkfvqx13dhw2582d57kj the special "interfaces" sparklayer enables docid\ sszdkxunmleidooithqcu the available features and functions ⚠️ requirements important! before installing sparklayer on your magento store, please ensure the following item details magento you must be using one of the following magento versions magento open source version 2 4 2 or later adobe commerce version 2 4 2 or later the multi stock inventory module should be enabled (this should be the case on most magento installs by default) product skus in order for sparklayer to save b2b prices for your products, all products must have skus customers for your b2b customers to see the sparklayer docid\ ccz1vnh0o6d 722w35xpa , they must be assigned an appropriate b2b "role" within wordpress > users payment processor if you’re installing sparklayer on a test store, please ensure you have an example payment method enabled you can manage this within magento > sales > payment services shipping in order to place an order via the docid\ efevur a3ycjxuhvrr7t , please ensure you have shipping rules set up you can manage this within magento under stores >configuration > delivery methods or via sparklayer's own docid\ cfz zpgw2umovao73lc5m solution theme you have a technical magento partner or developer to integrate the sparklayer magento module with your theme luma and luma based themes are automatically supported by the sparklayer module other themes will need manual integration work to ensure sparklayer web components are output instead of normal magento pdp/plp cards, the sparklayer script is loaded for b2b customers, and customer authentication is connected to the sparklayer script areas of magento you'll be using as part of setting up sparklayer, you'll primarily be using the following areas area details catalog this will be used to setup which products you want to make available to b2b customers see "setting up your b2b pricing" below customers this will be used to setup your b2b customers see "setting up your b2b customers" below sales this will be used to review and process and orders that are placed by your b2b customers see "placing a b2b order" below in magento, go to orders in magento, go to orders 🔗 connecting your magento store please note setting up sparklayer will require generating api keys within your magento store if you're unsure how to do this, our team is happy to assist to get in touch, please docid\ nnuw1g9z7eaj4m78vk7t9 to get started with sparklayer on your magento store, there are a number of steps to follow once you've completed this step, you can then begin the process of configuring sparklayer such as pricing and customer rules install the sparklayer magento module and create an integration first, you'll need to install the sparklayer for magento module on your store please get in touch with your sparklayer account manager for access to the module once installed, open the sparklayer b2b module tab in the magento admin, and create an integration for the correct magento store by clicking the "create and activate integration" button then go to stores > configuration > sparklayer > b2b and ensure the "enabled" option is set to "yes" for your store access the integration api credentials next, you'll need to access the sparklayer integration api credentials within magento from your magento admin dashboard, you can find this within system > integrations > sparklayer b2b for "your store name" > edit > integration details you will need these credentials to in the following steps to connect and authorise your sparklayer account to connect to the magento store register with sparklayer next, you'll need to create a sparklayer account by http //app sparklayer io/register connect your magento store once registered, go to https //app sparklayer io/integrations/platform and select magento you'll then be prompted to enter your store url (this should be the url of the website you are installing sparklayer on, e g www mystore com ) enter the api credentials in sparklayer from with the sparklayer dashboard https //app sparklayer io/integrations/platform paste the provided credentials from the earlier step press save and wait a few seconds whilst sparklayer connects to the magento store and performs the sparklayer plugin initialisation store connected this completes the process of connecting your magento store to sparklayer! 🚢 the onboarding process important when setting up sparklayer, some activities take place via the https //app sparklayer io/ alongside magento you'll use the sparklayer dashboard primarily for setting up your b2b pricing and b2b customer rules when you create an account on sparklayer, you'll get access to the https //app sparklayer io/ the dashboard has a customised onboarding process that gently guides you through all the necessary steps before you're ready to start inviting your b2b customers and taking orders on your website 📓 setting up your b2b price lists you'll then set up the b2b price lists that you want your customers to see when they login these can be automated or you can manually upload specific pricing ➡️ https //app sparklayer io/pricing 👪 setting up your b2b customers you'll then set the ordering rules for your customers such as minimum order values, available payment methods and price lists they are assigned to ➡️ https //app sparklayer io/customers/groups 🛠️ installing the frontend widgets you'll need to check the special code snippets ("widgets") are installed on your magento store in order to show the special sparklayer b2b interfaces ➡️ https //app sparklayer io/integrations/widgets/core ✅ testing & launching you'll then need to run through some final checks (such as placing a test order) once you're happy, you can then launch sparklayer and start taking orders! ➡️ https //app sparklayer io/configuration/onboarding 📓 setting up your b2b pricing please note setting up your b2b pricing happens within the https //app sparklayer io/ , not via your magento admin within the https //app sparklayer io/pricing area of the sparklayer dashboard, you can create and manage your b2b pricing rules sparklayer allows you to set the following pricing types type details manual you can manually upload a csv file with specific prices and even enable quantity pricing automatic you can use your magento prices and apply a discount you can choose from your main magento price or the rrp price for any products that you want your b2b customers to be able to buy, these products must have unique skus assigned in magento, you can check this by going to catalog and editing a product next, go to https //app sparklayer io/pricing/lists within sparklayer and click "create price list" to create your first b2b price list you can choose between an automatic or manual price list and configure how this works ready to set your pricing? to learn more about pricing, please see our docid\ s8xcbzgxqpgdeigwtxset 👪 setting up your b2b customers please note setting up your b2b customer rules happens within the https //app sparklayer io/ , not via your magento admin https //app sparklayer io/customers/groups let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out much like with price lists, you can fully manage this via the https //app sparklayer io/customers/groups within sparklayer, create a customer group you can follow our guide, https //app sparklayer io/customers/groups sparklayer will sync any customer groups you create into magento as a "group" which can then be assigned to individual customers with magento groups synced from sparklayer will be automatically prefixed with "b2b" once your customers have been set up in magento (i e those with a b2b group assigned ), and you've assigned the customer group to at least one customer, you can then manage specific rules within the https //app sparklayer io/customers/groups you'll see a default base customer group that you can use for your b2b customers if you want to set up additional rules, you can simply click create customer group and configure accordingly for any additional customer groups you create, you'll need to update the role on the customer record in wordpress/magento to match to simulate logging in as a b2b customer, please see ✅ testing & launching below you can also check if your customer record is syncing by using the https //app sparklayer io/data sync/customers area of sparklayer within magento, navigate to the customers section, search for a customer, and note the id with this unique id, you can then paste this into the https //app sparklayer io/data sync/customers area of sparklayer if the search results show the customer details, this confirms the customer is synchronising correctly ready to configure your customer groups? to learn more about customer groups, please see our docid 5 lwmnohhjbjjppg9e6vh 🛠️ installing the frontend widgets sparklayer comes with ready made b2b optimised "widgets" that we collectively call the sparklayer docid\ ogkfvqx13dhw2582d57kj the widgets simply overlay sections of your existing magento store and enable our powerful b2b features once set up, your approved b2b customers (see above "setting up your b2b customers") will then see your b2b pricing and can begin placing orders you can learn more about how this works in docid\ ccz1vnh0o6d 722w35xpa installing sparklayer widgets please note due to the nature of high level of customisation of many magento stores and themes, you will need a magento developer to install and integrate the sparklayer frontend core scripts and widgets the sparklayer magento module provides out of the box setup for the magento luma theme (which should work for any luma based themes) your developers can use this implementation as a reference of how to set this up to enable the frontend integration on your store for luma based themes go to stores > configuration > sparklayer > b2b in the magento admin dashboard, and enable the frontend widgets option which will automatically add the required frontend integration setup steps required to integrate the sparklayer frontend widgets install the https //app sparklayer io/configuration/frontend/core within your main website header you'll need to add the sparklayer core script that activates the sparklayer functionality when a customer tagged with a sparklayer b2b group is logged in install the https //app sparklayer io/configuration/frontend/pdp you'll need to update your storefront's product detail page with the sparklayer product purchasing interface when a customer logs in and sparklayer recognises them as being a b2b customer, this will load a special interface with their specific prices and a way to purchase 🛠️ view instructions \<spark pdp parent id="{{id}}">\</spark pdp> to get started, add the code snippet above to your product detail pages the exact location of the files may vary based on your magento theme once this is added, the interface will display for all logged in b2b customers and they can begin placing orders important! if you're using sparklayer on your existing website, you will need to hide elements that you don't want your b2b customers to see to do this, you can hide elements by adding data spark="b2c only" to any element in the code you will need to do this for any code that renders a price, quantity selection, product options, buy now buttons, and anything else you want to hide from your b2b customers please see our docid\ qwxsym9x5 pviogutekcp for more details install the https //app sparklayer io/configuration/frontend/pdp when you install sparklayer, the product card interface should automatically be added if for any reason it isn't, you'll need to update your product collection pages to show the product card interface this allows your customers to see their unique pricing and add items to their order from anywhere on your website 🛠️ view instructions \<spark product card parent id="{{id}}">\</spark product card> to get started, add the code snippet above to the file that renders products on your collection pages once this is added, the interface will display for all logged in b2b customers and they can begin placing orders important! if you're using sparklayer on your existing website, you will need to hide elements that you don't want your b2b customers to see to do this, you can hide elements by adding data spark="b2c only" to any element in the code you will need to do this for any code that renders a price, quantity selection, product options, buy now buttons, and anything else you want to hide from your b2b customers please see our docid\ qwxsym9x5 pviogutekcp for more details add the https //app sparklayer io/configuration/frontend/css you can customise the look and feel of sparklayer by editing special css controls that overwrite the sparklayer defaults for example, you can change button colours, font sizes, spacing, even typefaces 🛠️ view instructions to get started, within your magento theme, add the https //app sparklayer io/integrations/widgets/css once added, these then overwrite the "default" styling for sparklayer to match your website's look and feel docid\ qwxsym9x5 pviogutekcp finished adding the code widgets? please review our docid\ qwxsym9x5 pviogutekcp you can also explore all the configurations and customisations we have available that you may want to activate on your shopify store! docid\ sbeaoacq a7ffbtatx8bd 🛒 placing a b2b order once you've logged into your magento store as a b2b customer, you can then place an order by going to any product page and adding items to your order when you add items, they will then appear in the docid\ efevur a3ycjxuhvrr7t and you can then proceed to checkout to complete the order how payment methods work when customers reach the payment step, they'll see a variety of available payment methods and can select their preference payment method description payment on account 👪 for the b2b customer this will allow the customer to checkout without needing to enter any payment details payment by invoice 👪 for the b2b customer this will allow the customer to checkout without having to enter in payment details pay online by card 👪 for the b2b customer the customer will be directed to your standard checkout process and will be required to make payment right away (e g by card or via another payment processor) how orders arrive into magento depending on which docid\ ibikczvhm085bkejiffyv you've selected, orders will arrive into magento in the following ways payment method flow pay by invoice the order will be created within magento > sales with a payment status of "pending" you can then manually mark the order as paid once you have received payment (e g via offline means) pay on account the order will be created within magento > sales with a payment status of "pending" you can then manually mark the order as paid once you have received payment (e g via offline means) pay online by card the order will be created within magento > sales with a payment status of "processing" providing you have this already configured within magento you can then proceed to fulfil the order note this is termed "upfront payment" within the docid 5 lwmnohhjbjjppg9e6vh area of the sparklayer dashboard "unpaid" orders and "paid" orders by default all payment methods other than upfront payment will be generated as "pending" orders you will need to capture payment either via your magento admin or via offline methods (e g bank transfer) magento checkout payment methods if a customer selects "pay online by card" (i e "upfront payment"), they'll be directed to the magento checkout by default, they will see all magento payment methods you have set up (e g card payment, paypal, etc) additional order details when an order is placed via sparklayer, it will also include additional data within an order under sparklayer order information ✅ testing & launching the final step is to run some tests and checks to ensure sparklayer is fully configured within the sparklayer dashboard, you'll see a number of https //app sparklayer io/?expand=launch to perform, from logging in as a b2b customer, through to placing an order we recommend following the below steps set up a customer record within your magento admin, you'll need to ensure you have an example customer record set up (either a new one or an existing) most importantly, a customer must be associated with an appropriate role please see "setting up your b2b customers" above for more details on how this works place a test order once you've logged in as a b2b customer, proceed to add items to your cart and complete the checkout please see "placing a b2b order" above for more details on how this works invite your customers you could also think about sending a marketing newsletter to your customers to notify them of your new b2b store and to sign in we also have some example messaging you can use when inviting your customers and you can explore more in docid\ yufghegoxe h7ujfcshna ⚙️ advanced configurations in addition to the above setup, there are a number of other configurations that are possible at this time displaying stock (inventory) levels you can configure sparklayer to show docid\ gj ao gq6oa jx0d27hys in a variety of ways if you want to show inventory numbers (e g 100), you'll need to make sure this is turned on within magento within magento, go to stores> configuration > inventory and turn on manage stock adjusting tax settings sparklayer supports tax calculations and simply 'inherits' the rules you've set up in your magento settings enabling sparklayer javascript modifications (e g checkout customer fields, language updates) sparklayer supports a range of advanced configurations that rely on updating javascript via "spark options" within our docid\ sbeaoacq a7ffbtatx8bd , you can apply any of the modifications by updating the code within your magento theme store within the "core script options" you can add the below code { termsandconditionslink "/policies/terms of service", checkoutcustomelements \[ { name 'shipping date', translations { en { title 'preferred shipping date', detail 'shipping unavailable on weekends ', }, }, attributes { required true, type 'date', }, }, ], } enabling a url redirect when signing in sparklayer supports a range of advanced configurations that rely on updating javascript via "spark options" within our docid\ sbeaoacq a7ffbtatx8bd , you can apply any of the modifications by updating the code within your wix store under "core script options" you can add the below code { accountredirect { urlregex /\\/account/g, goto "/index", // page to redirect logged in users to }, } enabling "dark mode" for high contract websites if your magento store is set up with a darker theme, it's possible to enable a special "dark mode" for sparklayer, ensuring colours and fonts are easily readable under "core script options" you can add the below code { display { darktheme true, }, } enabling sparklayer shipping methods sparklayer has a built in docid\ cfz zpgw2umovao73lc5m system that lets you customise how shipping works for your b2b customers by default, your existing shipping methods in your magento store will be used, however it's possible to update this to use sparklayer via the https //app sparklayer io/configuration/shipping enabling pre order (or "back orders") sparklayer has built in support for pre orders (someimtes referred to as "back orders") once enabled, this will then show a message to the b2b customer on the product page and allow purchasing 📁 troubleshooting to troubleshoot the most common issues (such as issues with pricing), please see docid\ blcekkx3i30nkucglsfw7 you can also docid\ nnuw1g9z7eaj4m78vk7t9 and we'll be happy to assist ℹ️ frequently asked questions plans and pricing which sparklayer plans do you offer for magento? our "enterprise" plan is required to use the sparklayer magento integration https //www sparklayer io/pricing/ about our plans and pricing how does billing work? when you sign up to sparklayer, billing is managed via the sparklayer dashboard under acccount > plan magento setup where do i find the sparklayer magento module? please get in touch with our support team to get access to the sparklayer magento module what magento plan do i need to be on to use sparklayer? sparklayer supports the following magento plans magento open source (version 2 4 2+) adobe commerce (cloud, version 2 4 2+) can i have dtc and b2b on the same store? yes, it's possible to install sparklayer onto your existing magento dtc store (i e retail), meaning you can run both dtc and b2b on the same store we call this a 'hybrid setup'; when your b2b customers sign in, they simply see the special sparklayer docid\ ogkfvqx13dhw2582d57kj interface that allow them to see their prices and place orders if you want to see this in action, you can try our https //demo woocommerce sparklayer io/ store setup how does sparklayer affect my current magento theme? the sparklayer b2b widgets, including b2b pricing, cart and my account area, are only loaded once a customer who has been added to a b2b customer group successfully signs in to your store for all other users, your store will remain completely unaffected this allows you to have full control over which customers are able to see your b2b pricing and place b2b orders what if i'm already using a wholesale b2b app on my website? if you already have a b2b / wholesale app installed on your store, sparklayer can work alongside this it's a great way to test out sparklayer and, once you're happy, you can simply uninstall any previous b2b apps you were using if your previous b2b app has made code changes to your magento store, you may want to ask the app developer to remove these although this is optional payments can i use my existing payment methods on the checkout? if your customers choose "pay online by card" during the sparklayer checkout process, they will be taken to our magento payment methods checkout from there, any payment methods you have set up in magento (e g paypal, affirm pay) will show up, allowing the customers to pay by this method in short, if magento support specific payment methods, your b2b customers could select it during the checkout providing they choose "pay online by card" products how do i hide products or set up b2b only products? there are a few things we recommend to make the experience better you could create a b2b only collection and redirect customers to this once they login you could also configure your magento theme to hide and show products based on tag via custom coding can i use my magento prices for my b2b pricing? yes! sparklayer allows you to automatically synchronise your magento prices (e g your main magento retail price), making it really easy to set up b2b pricing for your customers for example, you could set your b2b prices to be 20% off your magento prices and we can even make provisions for your tax set up in magento (e g exclusive or inclusive of tax) do i need to use product skus? in terms of product skus, sparklayer relies on these being added to your products within magento so that we can display the correct b2b pricing when your customers log in without a unique sku, there's no way for sparklayer to do this if you don't already have skus in magento, it's relatively quick to do you can either edit individual products and add them manually, or you can use magento 'import' or 'edit products' feature to do this in bulk how do i show inventory (stock) levels? it's possible to show inventory levels and a stock status when your b2b customers log in you can learn more about how to enable this in docid 5 lwmnohhjbjjppg9e6vh how do i restrict b2b customers from dtc inventory (and vice versa) if you're installing sparklayer on a single website and you are looking to run both dtc and b2b at the same time, it will be necessary to use the same stock pool behind the scenes from an inventory point of view, this essentially means that both dtc and b2b customers will be ordering from the same stock source which can pose challenges important it is not possible to block dtc customers from ordering from your inventory and there is no mechanism in magento to do this if you are wanting to implement this, you will need to consider creating b2b specific products on your store creating a separate store just for your b2b customers, effectively separating out your inventory completely user experience how do i set up a b2b registration form? if you're looking to enable a wholesale/b2b registration form there are a few good options for this and in summary, these are the options we recommend you could use your current login/registration page and enhance the registration page with some additional fields you could create a brand new registration page and direct prospective b2b customers to this it's also worth noting that you can manually add customers via the admin by going to magento > customers and from there you could moderate your wholesale applications how do i invite a b2b customer to my website? when you're ready to invite your b2b customers to begin using your store, there are a variety of ways you can do this you could think about sending a marketing newsletter to your customers to notify them of your new b2b store and to sign in we also have some example messaging you can use when inviting your customers and you can explore more in docid\ yufghegoxe h7ujfcshna will sparklayer slow down my magento website? no for performance, the sparklayer frontend only loads when a valid b2b customer successfully logs into a website; for your standard (dtc) customers, no code is loaded at all when a b2b customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though sparklayer is a hosted third party solution the result is the end customer will have a rapid experience browsing products and placing orders how do i setup b2b specific content on my magento website? this is possible but would require custom coding we recommend consulting with a magento expert developer before making changes to your website orders how do i edit orders? it is possible to edit orders within magento when an order is placed via sparklayer providing payment hasn't already been processed from magento > sales, navigate to an order you'll then see the option to edit order allowing you to make changes how do i send an invoice? in terms of invoicing, sparklayer doesn't send invoices directly when sending an invoice, this is managed outside of sparklayer and it will require you to collect payment by your preferred means once you've received payment, you can then mark the order as paid within wix and then fulfil it as normal how do i set a minimum order quantity? within sparklayer, we support the ability to set minimum/maximum order level spends for your b2b customers you can configure these by going to the https //app sparklayer io/customers/groups area of the sparklayer dashboard