Settings

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 setup the setup 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 api keys please note access to the sparklayer api is only available on the pro and enterprise plans 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 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 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 integrations need help setting things up? our team is here to help! head over to our support docid\ nnuw1g9z7eaj4m78vk7t9 page to get in touch the integrations 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 131 false true left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type setting up a test environment with sparklayer test mode docid\ y74dzm4nk61rsuzwj3vcn , you can configure a live and test environment order actions you can additionally configure specific order actions for your store 343 false true left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type not applicable configure metafields within the sparklayer dashboard , you can speed up the creation of metafields using our built in tool to automatically configure them to get started, go to integrations and click configure within the configure metafields section you'll then see all available metafields that can be configured for product and customer data when a metafield is enabled, this will automatically be added to the custom data section of your shopify admin and will be 'pinned' for easy access when configuring metafields for products or customers any metafields automatically created by sparklayer in this way will be prefixed with b2b \[name] for example b2b pack size should you need to modify or remove metafields, you can manage this via the custom data section within your shopify store widgets the widgets section guides you through installing the frontend interfaces docid\ ccz1vnh0o6d 722w35xpa on your website there are the following key steps installing the core script installing the product page scripts customising the design by using css you can read our full guide on how this works in our frontend integration guide docid\ qwxsym9x5 pviogutekcp configurations configurations let you configure specific options for your customers when they're using the frontend docid\ ogkfvqx13dhw2582d57kj learn more about configurations to see all available configurations on sparklayer, please refer to configurations docid\ sbeaoacq a7ffbtatx8bd 243 false true left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type store details please note if you're using company users 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 log in to your sparklayer dashboard from the left hand sidebar, select configurations under store settings , go to store details and click edit in the side pop up, update the store name field with your preferred name save your changes by clicking update settings 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 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 true false 201false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type 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 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 adding files to your templates 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 true falsefalse unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type templating language please note the following all templates are written in 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 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 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