--- title: Settings slug: dashboard-configurations description: Learn how to effectively configure and integrate SparkLayer into your systems with this comprehensive document. Discover step-by-step instructions for onboarding, setup, and manual testing. Generate API keys effortlessly to seamlessly integrate with the S docTags: createdAt: 2023-06-12T07:24:37.000Z --- ## Introduction The **Settings** 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 The Onboarding section guides you through the process of configuring SparkLayer. You can learn more about this [Getting Started](docId:-5djX1YCIgzAI6MRkq0u6). 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. ![](https://api.archbee.com/api/optimize/kxppJrvFK15E9wXbMKaTP/A6a0VgrI4bM1Gs_ICxW5l_image.png) *** ## API Keys :::hint{type="info" attributes="[object Object]"} **Please note** Access to the SparkLayer API is only available on the [Pro and Enterprise Plans](https://www.sparklayer.io/pricing/) ::: In order to interact with the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT), 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 ![](https://api.archbee.com/api/optimize/kxppJrvFK15E9wXbMKaTP/gOuOQsDgksBidkXO_-zr-_image.png) When you click 'Create API Key', you'll then see your unique **Client ID** and **Client Secret** that you'll need for the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT). ![](https://api.archbee.com/api/optimize/kxppJrvFK15E9wXbMKaTP/2nQSeAa1X25SKj2Dd5rKo_image.png) :::hint{type="warning" attributes="[object Object]"} **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 integration. If you require additional API keys to be created, simply follow the same process noted above. *** ## Configurations Configurations let you configure specific options for your customers when they're using the [Frontend](docId\:OgKfvQX13dHW2582D57kJ). :::hint{type="info"} **Learn more about configurations** To see all available configurations on SparkLayer, please refer to [our guide here](docId\:SBEaOaCq_A7FfbTatX8bD). ::: ::::Tabs :::Tab{title="🌐 General"} | Setting | Details | | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | `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. | | `Internal Purchase ID Prefix/Postfix` | When a purchase is internal to SparkLayer, we use an internal ID. This is the case for purchases that are not in Shopify, e.g. orders for approval, and quotes. You can customise this ID to have a prefix and/or postfix. By default, the prefix is `#P`. | ::: :::: ### Store Details :::hint{type="info"} **Please note** If you're using [company user email notifications](docId:_WwfeWVJY9xrSuNCQlFoZ), this feature allows you to customise the store name used in emails sent from SparkLayer. ::: By default, the store name displayed in your SparkLayer account is synchronised directly from your eCommerce platform. This ensures consistency across platforms, so any updates you make to the store name in your eCommerce platform will automatically appear in SparkLayer. To customise the name of your B2B store, you can overwrite the default settings by following these steps: 1. Log in to your SparkLayer Dashboard. 2. From the left-hand sidebar, select **Configurations**. 3. Under **Store Settings**, go to **Store Details** and click **Edit**. 4. In the side pop-up, update the **Store Name** field with your preferred name. 5. Save your changes by clicking **Update Settings**. ![](https://api.archbee.com/api/optimize/kxppJrvFK15E9wXbMKaTP/uEMyRGCc3YsfbU2EGNvXg_image.png "Modified Store Details") :::hint{type="info"} **Please note** Enabling the "Modify store data" setting will overwrite the default data synchronised from your Shopify store. ::: **Additional Details:** - Once you modify the store name in SparkLayer, these changes will not sync back to your eCommerce platform. - After enabling the modification setting, any future updates to the store name in your eCommerce platform will no longer reflect in SparkLayer. - If you disable the "Modify store data" setting, the store name will automatically revert to the default, synchronised name from your eCommerce platform. By following these steps, you can ensure your B2B store's details reflect your preferences while understanding how changes interact between SparkLayer and your eCommerce platform. *** ## Shipping To learn about how shipping works, please refer to our [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) guide. *** ## Templates :::hint{type="info" attributes="[object Object]"} **Please note** The Templates feature is only available on the SparkLayer *Pro* and *Enterprise* plan. You can [change your plan here](https://app.sparklayer.io/settings/plan) or [learn more](https://www.sparklayer.io/pricing/) about our how pricing works. Templates are also specific to your SparkLayer setup and have no impact on storefront "themes' that you may be using for your website design. ::: Templates allow you to customise the look, layout and data for emails and PDFs generated by SparkLayer. These currently include the following areas: | Template type | Details | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `Order review emails` | Used in parallel to [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) when an order needs to be reviewed by a company user member | | `Invoices` | Used to generate the [Invoices](docId\:NKh8H14Ffna5DD71SwwNd) PDF that customers can download. | | `Quotes` | Used in notifications sent when using the [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) as well as the Quote PDF that customers can download. | We've included a top-level overview of how Templates work below and you can also explore how they work in more detail in our [Tech Docs](https://docs.sparklayer.io/tech-docs/templates). :::ExpandableHeading **Creating a Template** In order to use a template, first you'll need to create a template in the Template Editor, and then publish it. By default, a template is empty and therefore falls back to the SparkLayer core templates and language files. ::: ::::ExpandableHeading **Adding files to your Templates** :::hint{type="info"} **Please note** You should only add templates when you intend to change them. This is because once a template is added, it can’t be automatically updated based on the core template. For instance, if a new feature rolls out and it adds a section to a template, this will not be applied to a merchants custom templates. You will need to either copy those changes to their template or create a new template. ::: When adding a new file to a template, you have a few options: | Type | Details | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Language` | A language file to be used by the templates. Even if you haven't created any templates, providing it matches your store's language, the SparkLayer core templates will use this language file, and fall-back to the SparkLayer language files if a key’s not found. Ultimately, SparkLayer falls back on the SparkLayer `en` language file as a last resort. | | `Sections` | Sections are currently only used in emails. This template allows a merchant to have a re-usable header and footer for their email templates. | | `Emails` | For managing emails sent via SparkLayer | | `PDF` | For managing PDFs sent via SparkLayer | :::: :::ExpandableHeading **Templating language** Please note the following: - All templates are [written in liquid](https://shopify.github.io/liquid/\)). They must have valid HTML markup and CSS should be written in the template. All CSS is in-lined when the template is rendered for the best compatibility, particularly with email clients. - For email templates, it’s advised to consider email client compatibility. Tools like Litmus allow developers to test emails in various email clients. SparkLayer only supports modern email clients from the last few years. - All language files are written in JSON and should be keyed appropriately for use in templates. See the technical docs for details on the language filter. ::: ::::ExpandableHeading **Using the editor and making revisions** Once a file has been added, it can be edited in the SparkLayer editor. The editor has a basic code editor ideal for making quick or small changes. Once done, click Save and this will then create a revision (previous revisions can be viewed from the Revisions drop down). If a revision is viewed and saved, this will become the current revision and therefore used when rendering a template. :::hint{type="info"} **Please note** Alternatively, from the Template selection, you can also download a ZIP file of your template to provide to a developer, and use proper development tools such as an IDE and versioning control. Once ready this can be zipped back up and uploaded to a template. Only the known templates will be processed, any additional files such as custom templates and assets like images **will not** be processed or added to the template. ::: ::::