Configuration
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.
The Onboarding & Setup section guides you through the process of configuring SparkLayer. You can learn more about this here. Once all steps are completed, your integration is ready to go!
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.
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.
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
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 Design by using CSS
- Installing the checkout script (Shopify only)
Important - to enable settings, you'll need to make sure your Shopify store is using the latest SparkLayer Core Script. From the SparkLayer Dashboard, go to Configuration and click Frontend (or you can use this link)
Setting | Details |
|---|---|
Allow address editing in My Account | If activated, your customers will be able to edit and add addresses via the SparkLayer My Account.
Important! If you've set up SparkLayer to automatically synchronise addresses from another system (e.g. an ERP), these may override updates your customers make. Please contact us if you're unsure. |
Stock level display limit | If you're displaying stock levels on a product page, you can choose the maximum stock number customers see. For example, if you enter 51, on the frontend this will display as 50+ to the customer if you have more than 50 in stock. Learn more |
Use Shopify Checkout for all orders | If you've set up additional payment methods such as Payment by Invoice, by default orders will be created as Draft orders without needing to go through the Shopify checkout (note: upfront payments always go through the Shopify checkout and sales agents will never use the checkout)
If you'd prefer for all customers (apart from sales agents) to go through the Shopify checkout regardless of their chosen payment method, you can activate this setting. Note: we only recommend this for Shopify Plus merchants.
You will need to ensure that you have manual payments enabled during the checkout to allow customers to place orders without making payment. Learn more about how payments work. |
Automatically complete Shopify draft orders | If you're using manual payments (such as Payment by Invoice) these will be default enter the Shopify admin as Draft orders. This setting allows you to automatically mark these as completed and the orders will instead show in the Shopify Orders admin as soon as they are placed |
Automatically mark Shopify draft orders as paid | For new draft orders, the payment method will be set as payment pending. It's possible to automatically mark these orders as paid allowing you to process the orders faster. To enable this, first tick the 'Automatically complete Shopify draft orders' toggle, then choose from the following settings;
|
Apply tiered pricing across variants | If a product has variants (e.g. sizes), tiered pricing will by default be applied across all variants. You can adjust this to apply only so specific variants instead. Learn more |
Last modified 3mo ago