Overview

introduction sparklayer ignite is a commerce framework that enables any platform to easily integrate with the power of sparklayer from delivering a world class frontend b2b self service ordering experience, to connecting to sparklayer's extensive b2b pricing engine use cases the most common use case is to use sparklayer ignite alongside a complimentary ecommerce platform or content management system (cms) for example, an ecommerce platform may have very limited b2b ecommerce functionality and it's not viable to build it natively by connecting the ecommerce platform to sparklayer ignite (e g via a custom application), b2b functionality can be rapidly enabled please note access to sparklayer ignite requires completing an application form https //share eu1 hsforms com/1zsi9nes5swgyrx9kvwia2wfkn6z that our team will review as part of the approval process, we will evaluate applications to ensure sparklayer is a good match for the relevant use case, both technically and strategically before starting our documentation covers all key principles and concepts required to build an integration via the sparklayer ignite framework this includes how to connect a platform (e g an ecommerce platform) and synchronise data, right through to connecting to specific endpoints to allow you to customise as you need to in order to familiarise yourself with how sparklayer works, we recommend reviewing the following guides area notes the sparklayer frontend https //docs sparklayer io/sparklayer frontend/overview of features the sparklayer frontend is a javascript overlay that replaces specific parts of an ecommerce website with wholesale ordering capabilities the sparklayer dashboard https //docs sparklayer io/sparklayer dashboard/the sparklayer dashboard the sparklayer dashboard is a web browser based tool that lets users keep track of all elements of their sparklayer integration key principles understanding the data flow understanding how data flows between sparklayer and a platform (e g an ecommerce platform) is central to building an integration at a very top level, our diagram below illustrates the key data flows platform connection platform connection is the term used for when a platform is connected to sparklayer (e g an ecommerce platform) there are two endpoints one to inform of new connection another to inform once it's removed learn more about platform connection https //docs sparklayer io/ignite/x 67 platform connection data sync overview sparklayer requires data from the platform in order to operate when an install initially happens, a full sync will be required to begin the process for further updates, webhooks should power these incremental changes with the option to run the sync again (in case of any issues) for visibility, data sync issues should also be logged within the sparklayer dashboard https //docs sparklayer io/sparklayer dashboard/the sparklayer dashboard/customers#customer import for easy review data should include area details product data sparklayer needs a basic level of product data to be synced across for the frontend widgets https //docs sparklayer io/sparklayer frontend/overview of features to operate customer data sparklayer needs a basic level of customer data to be synced across for the frontend widgets https //docs sparklayer io/sparklayer frontend/overview of features to operate order data sparklayer needs order data to be synced across for the frontend widgets https //docs sparklayer io/sparklayer frontend/overview of features to show order data within the account section store settings sparklayer needs to know the base currency of the store learn more about the data sync https //docs sparklayer io/ignite/data sync endpoints the below are required instantly on a customer request and these endpoints will outline the request body and response body area details create/update/delete of addresses via the frontend https //docs sparklayer io/sparklayer frontend/overview of features/my account interface , customers can create, update and delete their addresses; we require endpoints to action these fetching shipping and tax for an order via the frontend https //docs sparklayer io/sparklayer frontend/overview of features/quick order interface , as the customer proceeds through the checkout; we need to be able to show shipping rates and tax information for an order create/delete customers for sub accounts via the frontend, customers can create and delete the customers which are sub accounts; we require endpoints to action these create a checkout for upfront orders via the frontend https //docs sparklayer io/sparklayer frontend/overview of features/quick order interface#payment methods when a customer places an order which requires ‘upfront payment’ through the platform (e g via credit card), we need to be able to send the user to the checkout to complete payment this checkout can use the standard platform checkout and does not need to include discounts and giftcards create a order for orders with payment handled offline via the frontend https //docs sparklayer io/sparklayer frontend/overview of features/quick order interface#payment methods when a customer places an order which does not require payment, we need to be able to create an order in the platform learn more about the endpoints https //docs sparklayer io/ignite/endpoints overview please note the following currently, these areas are excluded from this documentation and will be covered in due course or elsewhere billing and any sparklayer dashboard logic sparklayer currently only supports a single storefront per sparklayer environment sparklayer currently only supports simple option products, i e complex bundles are unsupported