Configuration

Introduction

The Configuration section is the centralised location where you manage all elements of the SparkLayer integration on your website. To begin with, it is used as part of the Onboarding Process, and once you're up and running, it can then be used as a ongoing systems health-check.

Onboarding & Setup

The Onboarding & Setup section guides you through the 6-step process of configuring SparkLayer. You can learn more about this here. Once all steps are completed, your integration is ready to go!

If you're installing Shopify on SparkLayer, see our Shopify Installation guide

Each step can be clicked either to take you to the appropriate area of the Dashboard to be configured, or expanded to show you information right there. For the last two steps, manual testing is required and you'll be asked to check a variety of boxes before marking the step as complete.

API Keys

In order to interact with the SparkLayer API, you'll first need to generate a unique API key that you'll use as part of your integration.

To get started, from within the API Key section, click the 'Create new API Key' button

When you click 'Create API Key', you'll then see your unique Client ID and Client Secret that you'll need for the API integration.

Important! You will only see the Client Secret code once when you create your API Key so make sure to make a note of it.

Once you've created an API Key, you'll then see this listed on the page and you can begin your SparkLayer API integration. If you require additional API keys to be created, simply follow the same process noted above.

Platform Configuration

The Platform Configuration section lets you specify which eCommerce platform you'll be installing SparkLayer on. For listed third-party platforms, this has the added benefit of automatically connecting your website to SparkLayer via the SparkLayer Connector.

Platform

Details

Shopify

If choosing Shopify, you'll be prompted to enter your Shopify merchant ID. When you click "Save", you'll be taken off to Shopify to install the SparkLayer app. This will connect your Shopify store to SparkLayer and products and customer data will automatically be sent through

Magento

Coming soon!

Custom

If choosing Custom, you'll need to manually send SparkLayer all necessary data. You can learn more here.

Setting up a test environment With SparkLayer Test mode, you can configure a live and test environment. Learn more

Frontend Integration

The Frontend Integration section guides you through installing the SparkLayer Frontend on your website. There are the following key steps:

  • Installing the Core script

  • Installing the product page script

  • Customising the CSS

  • Installing the checkout script (Shopify only)

You can read our full guide on how this works here.

Settings

Settings let you configure specific rules for your customers; from defining their minimum order values, through to what payment methods they're allowed to use when checking out.

Customer groups

It's common for B2B customers to have terms agreed when they place orders with you. For example, brand new customers may only be allowed to pay via credit/debit card, whereas long-term customers may have more favourable payment terms. The Customer Groups section lets you define specific rules for specific customer groups, giving you flexibility in how your B2B customers order online.

By default, SparkLayer will automatically add a Default customer group with a handle of base which will be applied to all your customers. If you have very simple rules, you can simply edit the set up of this to suit your requirements. It's possible to configure the following rules

Rule type

Description

Minimum order

This is the minimum order value the customer must reach before being able to checkout on the SparkLayer Frontend

Payment methods

The payment methods that the customer will see when they checkout

Price lists

The price lists that are assigned to that customer group. For example, you may have different price lists per customer group

Minimum order

To configure a minimum order per customer group, click the Edit icon in the Minimum Order column. If the customer group doesn't already have a minimum order set, click Add new, select a currency and then enter minimum order value. Note: All order values are in net pricing.

Once you've set this, when you access the Quick Order on the frontend, you'll then see corresponding messaging.

How minimum order totals show on the SparkLayer Frontend

Payment methods

You can specify what payment methods are shown for each customer group by clicking the Edit icon in the Payment Methods column. You'll then see the following options

Payment method

Description

Payment by invoice

This will allow the customer to checkout without having to enter in payment details and apply a Zero-value order

Payment on Account

Similar to above, the customer can checkout without needing to enter any payment details

Upfront Payment

The customer will be required to enter credit/debit card details and pay as normal during the checkout process

When the customer activates the Quick Order, they'll see whichever payment methods are allowed and can then select as appropriate.

How payment methods show on the SparkLayer Frontend

Price lists

Depending on which price lists you have set up in the Price Lists section, you can assign specific price lists to customer groups. Click the Edit icon in the Price Lists column and then choose the available Price List from those shown.

Synchronising customer groups

When you create or edit a customer group, SparkLayer needs a way to 'match' the customer group to those stored in your eCommerce platform. By matching the customer group in this way, SparkLayer can then ensure the customer sees the correct rules when they start placing orders on your website.

It does this by using the Handle which is an identifier that corresponds to what you specify in the equivalent way in your eCommerce platform. When you create a new customer group, you'll see the following screen where you can enter a Display Name and a Handle.

If you're using Shopify, for the two systems to match, the handle you enter in Shopify has to be prefixed with b2b-. For example, if you enter the Handle of default-customers in SparkLayer,, Shopify should include the handle b2b-default-customers.

In Shopify, you can do this in one of two ways

  1. By using Customer Tags - in the Customers Admin of Shopify, enter in the handle for the tag in SparkLayer prefixed with b2b-, e.g. b2b-default-customers

  2. By using Customer metafields - metafields can be assigned to customers (just as with product data) and can be added directly via an API or manually if a metafields Shopify app is installed.

Other eCommerce platforms will have similar concepts to those noted above for Shopify.

Setting a customer tag in Shopify

You can verify this works by logging in as a B2B customer on your website and then proceeding to checkout via the SparkLayer Quick Order. You should see then the rules you've set (e.g. minimum order value, payment types).

Shipping Rates

Please refer to our full guide on shipping