{{ product.price }}
```
### Displaying the SparkLayer interfaces
Once you've completed the step above, you can then proceed to add the special SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa).
| Interface | Details |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Product Detail` | This is shown on your product detail pages and allow customers to rapidly add products to an order.
[Learn more](docId\:JkCjbYUAnjzp75I8ul7MT) about how to add the code snippets |
| `Product Card` | This is shown anywhere a "product card" is shown such as on a product collection page.
[Learn more](docId\:Mrp_Z0QIZQ2QksseuJylv) about how to add the code snippets |
| `Product Price` | This allows you to display a product's B2B price anywhere on your website. You can use this instead of or alongside the "Product Card"
[Learn more](docId\:ngbcwK-OO4NJmCp8s8gYb) about how to add the code snippets |
***
## Design customisations (CSS)
SparkLayer by default has a relatively neutral user interface but it's possible to update nearly all aspects of the look and feel using special CSS variables.
- Colours
- Typography (e.g. typefaces and font sizing)
- Spacing (e.g. padding and margin)
- Button styling
- Form styling
As with the SparkLayer Core Script, the CSS code can be added to your existing CSS stylesheets or placed within the main header of your website's source code. If you're placing the CSS in your main header, remember to wrap it within the `
* **manually uploading** specific prices (via a CSV file), allowing you to set specific prices * **automated rules** by taking the prices from your eCommerce store (e.g. 50% off retail prices) | | `Product setup` | - Price lists are set up at a product variant level and rely on SKUs being available | | `Customer-rules` | * Price lists can be assigned to customers via [customer groups](docId:5_lWMNohhjBJJppg9E6Vh) * Multiple price lists can be assigned at a customer group level or specific customer level * Percentage discounts can be assigned at a customer-level via settings. [Learn more](docId\:v8dVUcJ7Ju0fH7BvINrEw) | | `Currencies` | - Price lists can be set up in different currencies. | | `Quantity pricing` | * You can set quantity pricing (volume-based discounts), e.g. Buy 1 at $10, Buy 10 at $8. * You can set up quantity pricing at a variant level but for quantity calculations to work at parent level | | `Discounts & promotions` | - In addition to price lists, you can also configure discounts and promotions for customers. [Learn more](docId\:WrejPw9URyjQwiQeKs_Cg) | | `Advanced settings` | * You can configure rules such as minimum and maximum order quantities, pack sizes and more at a per customer group level. See more within [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD) | [title] Managing Pricing [path] Dashboard/Price Lists/ ## Introduction Generally speaking, SparkLayer works by creating price lists that are then assigned to customers (via [Customers](docId:5_lWMNohhjBJJppg9E6Vh)). Once the customer then logs into your website, they then see the pricing rules you've set for them. When setting up your pricing, SparkLayer supports the following methods: | **Type** | **Details** | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Manually uploaded` | You can upload pricing into SparkLayer via our built-in CSV file import tool. It works by assigning prices to your product SKUs, allowing you to set **specific prices** as required. This option is great if you need very precise pricing rules. | | `Automatic ` | Automatic pricing works by letting you select a "pricing source" which you can then apply **discounting rules**, e.g. a percentage increase or decrease. For example, if you're using Shopify, you can automatically use your Shopify pricing and apply a discount (e.g. 50% off Shopify prices). This option is great if you have a relatively simple B2B pricing structure that is based on percentage discounts. | | `Integration` | If you're connecting a backend system to SparkLayer (e.g. an ERP, PIM, or CRM) you can automatically send pricing data through to SparkLayer | :::hint{type="info"} **Key concepts** - **Pricing types can be combined. **For example, you can have an automatic price list (50% off retail prices) and then manually upload pricing for a specific range of products - **Pricing is always shown as "net pricing" on your store. **Depending on how you have tax set up, tax is then added during the checkout process ::: *** ## Creating a new price list When you first sign up to SparkLayer, you'll be asked to create a price list. You can even choose from 'ready-made' price lists that will automatically setup pre-defined rules for you. When you click "Create Price List" you'll then be presented with the following screen:  You'll then be prompted to complete the following information: | **Item** | **Details** | | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `Price List Name` | The price list name as displayed in SparkLayer. You'll use this name to assign it to a customer group. | | `Price List Handle` | The unique handle (i.e. ID) of the price list. This is used for internal purposes and relevant if you're connecting your backend system to SparkLayer | | `Price List Currency` | The default currency, e.g. GBP | | `Automatic pricing` | Enabling this will allow you to select another pricing source in which to apply your pricing rules (e.g. 50% off Shopify prices) | | `Manual pricing` | At any point, you can additionally upload a manual price list, even if you've set the price list to be automated | Finally, when you click the **Create price list **button, the newly created price list will then show in the list of available price lists and you can then perform actions against it.  Please note, if you're connecting your backend system to SparkLayer, price lists should only be manually added if they aren't automatically imported via your backend system. *** ## Automatic price lists Automatic price lists are a great way to set up pricing rules that are **automatically** applied to your B2B customers. This differs from manual price lists (see below) that let you set the exact prices your customer see. ### How automatic price lists work Automatic price lists work by selecting where you want the pricing to come from (called a "pricing source") and then applying rules against it, such as a percentage variation. Pricing sources are grouped by the pricing type (e.g. manual, automatic, or integration). ### Configuring an automatic price list To get started, tick the "Enable automatic pricing" checkbox. From the **Pricing Source **menu, you can then select which pricing source you want to use.  ::::Tabs :::Tab{title="🛍️ Using Shopify"} If you're using Shopify, SparkLayer will automatically synchronise pricing from your Shopify store. Each time you update your pricing in your Shopify admin, this will reflect in the pricing rules you've set up in SparkLayer.  From SparkLayer, you can select from the following pricing sources when creating a price list: | **Shopify Price** | **Details** | | ------------------------ | --------------------------------------------------------------------------------------------- | | Shopify Price | This is the price your regular customers see on your store | | Shopify Compare-at Price | This is the 'Compare-at price' you set against products, sometimes referred to as RRP or MSRP | Within your Shopify admin, these correspond to the pricing fields you see when editing a product.  ::: :::Tab{title="🌐 Other platforms"} No configurations applicable or necessary ::: :::: ### Applying a percentage variation Once you've selected your pricing source, you can then choose how you want to apply discounts using a feature called "Percentage Variation".  Based on the pricing source chosen, you can then enter a percentage variation that either **decreases** or **increases** the pricing. For example, if you want to apply a 50% discount against a pricing source (e.g. your default B2B pricing), simply enter "50". ### Setting a currency conversion If you're setting up a new price in a **different currency** to your pricing source, you can optionally choose to set a manual exchange rate. For example, if your pricing source is set in GBP (£) and you want your new price list to be in EUR (Euros), you can set a fixed curency conversion rate.  :::hint{type="warning"} **Please note** If the currency of the new price list is the same as the pricing source, you won't be able to set a currency conversion. ::: ### Accounting for tax One of the important things to note about SparkLayer pricing is that pricing will always be shown to customers **exclusive of tax** (i.e. net pricing). If you have tax configured on your store, tax will subsequently be added during the checkout as a separate calculation. If you're using automatic price lists and you're looking to apply a percentage variation (e.g. 20% off your prices), the pricing the customer sees **may not necessarily correspond to this** when they see pricing on the product page. This is because pricing is being adjusted off a price that may already include tax. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} If you're using Shopify, you can review [how tax is set up here](https://admin.shopify.com/settings/taxes). Providing "**Include tax in prices**" is enabled in Shopify and you've configured sales tax for applicable countries, you'll then be able to use the tax adjustment feature below.  When configuring an automatic price list, you can account for tax variation by using the built in tax adjustment feature.  When this is clicked, it will adjust your original percentage (e.g. 20%) to factor in the necessary tax calculation. The end result is your customers can place orders and will be charged at the exact percentage intended. :::hint{type="info"} **Please note** If you're Shopify store is setup to use "line item tax" where you're charging specific tax rates on a SKU level, automatic price lists will not factor this into the B2B price calculations ::: :::: :::Tab{title="🌐 Other platforms"} No configurations applicable or necessary ::: ::::: *** ## Manual price lists Manual price lists differ to automatic ones in that you can upload the** exact pricing** you want for a price list. Perhaps you require very specific pricing for a customer group and you need to have control over the **exact** pricing they see. :::hint{type="success"} **Combining pricing types** It's possible to combine manual price lists and automatic price lists! This is a great way to automate your pricing and give you the flexibility to manually specify pricing for specific products. ::: To get started, click "**Upload CSV" **on the Price list you want to add prices to.  You'll then be prompted with the following screen and asked to upload a CSV file.  ### How CSV files work A CSV file (or comma-separated values file) is a common format that is used to quickly import structured data. All software systems used for creating spreadsheets will allow you to save a file as a CSV and typically you can do this from the "File" menu. In our example below, we've illustrated how this works in [Google Sheets](https://www.google.co.uk/sheets/about/)  ### Use our template CSV file You can save time and use our ready-made template CSV file and then adapt for your specific pricing structure: ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Download a CSV template ](https://cdn.shopify.com/s/files/1/0565/7500/0728/files/Example_CSVs_-_Simple_Example.csv?v=1634317574)Use our example CSV file as a starting point. ::: :::LinkArrayItem [Google Sheets Example ](https://docs.google.com/spreadsheets/d/13gi0W7yZcZ-CtWXYw1nUJN_art-gSbzRjqN8GSLNaig/edit?usp=sharing)Use our example Google sheet as a starting point. ::: :::: In order for the CSV file to import successfully, you simply need to set up the following columns: | **Column** | **Details** | **Required** | | ---------- | ----------------------------------------------------------------------------------------------------------- | ------------ | | `sku` | The product SKU as set up in your eCommerce platform or backend system | `Yes` | | `price` | The unit price for the SKU (e.g. 14.99).
Note: this must **not** include a currency symbol (e.g. $, £) | `Yes` | You can see how this looks in the example below.  :::hint{type="success"} **Time-saving tip** if you only need to upload prices for certain products, you can do this with 'partial CSV uploads'. Simply create a CSV file with the product SKU and price (as noted above) and this will update any existing pricing SparkLayer holds. You can also use [The Price Editor](docId\:fWW4Oh09nSO1-G9TXUTOP) tool to edit prices rapidly. ::: ### Upload quantity pricing If you're looking to apply quantity pricing (e.g. Buy 1 for $10.00, Buy 5 for $8.00), please see [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) ### Updating multiple price lists It's also possible to update multiple price lists in one go via the CSV upload. To access this, first go the [Price Lists overview](https://app.sparklayer.io/pricing/lists), and click "Bulk Upload" at the top of the page.  To get started with your CSV file, you'll first need to locate the price list "**Handle"** and you can find this on the main price list overview below the price list name. In the example below, the handles would be `base-uk` and `base-us`.  In your CSV file, simply add a new column at the end, `price_list_slug`. Within this column, you can then enter the price list handle and add as many entries as required. When you upload the CSV file, all associated price lists will then be updated.  :::hint{type="info"} **Having issues? ** Please see our [troubleshooting guide](docId\:BlCEkkx3I30nkUcglsfw7) for ways to solve common issues. ::: ### Validating the CSV file When you upload the CSV file, you'll then be shown validation messages based on the content of the file. If the CSV file successfully passes validation, you'll be notified and shown a sample of what has been imported.  Clicking **Save Price List **will then import the file into SparkLayer and customers will then see these prices when logged in. ### Validation notices & warnings If the file cannot be imported, e.g. missing prices or an incorrectly formatted file, you'll be notified with relevant details.  It's important to note that a file can be successfully imported but include missing data, e.g. perhaps a product SKU has been listed multiple times in your price list. You'll be notified of affected SKUs and notes on how to remedy the issue.  *** ## Synchronising price lists via the API If you're looking to import your price lists into SparkLayer automatically from your backend system (e.g. ERP), you'll need to send price list data via the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT) *** ## Assigning price lists to customers Once you've created and uploaded prices for your Price list(s), you can then assign these to different [Customers](docId:5_lWMNohhjBJJppg9E6Vh). This means you can control which customers see which prices when they sign into your website. Learn more in our [Customers](docId:5_lWMNohhjBJJppg9E6Vh) guide. *** ## Customer-specific discounts & price lists Once you've created a price list and assigned it to a customer group, it's also possible to set up customer-specific discounts **on top** of the price list giving you even more flexibility in the prices your customers see. If you're looking for a more advanced setup (e.g. via your ERP system), you can also configure customer-specific price lists using **metafield data.** Learn more in [Customer Pricing](docId\:v8dVUcJ7Ju0fH7BvINrEw) *** ## Price lists and tax Please refer to [our guide here](docId\:ZSsXG6FjRLCod_GxoluTN). *** ## Discounts & promotions SparkLayer supports the ability to have discounts and promotions applied during the checkout and these can either be redeemed via discount codes, or applied "automatically" to the customer's order. :::Iframe{iframeHeight="0" code=""} ::: The SparkLayer Discount Engine unlocks a range of discount rules including: - **Order-level discounts:** eg, spend $1,000 and get 10% off, spend $2,000 and get 15% off - **Percentage and fixed discounts: **eg, 20% off an order total, $100 off an order total - **Coupon codes:** eg, enter code NEWCUSTOMER and get 5% off - **Scheduled discounts:** eg, start discount today and end it on a specific date and time - **Customer-specific discounts:** eg, only allow customer group ‘b2b-vip’ to qualify for the discount - And more :::hint{type="info"} **Learn more about discounts** You can see a full overview of what’s possible with discounts in [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg). ::: *** ## Frequently Asked Questions ### Automatic Price Lists :::ExpandableHeading **How do I set up automatic price lists (based off my DTC pricing with a discount)?** Please refer to [our guide here](docId\:NX9Q00eWV_kbjxc3tg1ut). ::: :::ExpandableHeading **How can I override pricing for some products if I'm using an automatic price list?** It's possible to combine manual price lists and automatic price lists! This is a great way to automate your pricing and give you the flexibility to manually specify pricing for specific products. - Once you've created your price list using "automatic" rules, simply click "Options" and then "Upload CSV" - You can manually upload any additional prices you want to assign to the price list. You can then easily check these via the [Price Editor](https://app.sparklayer.io/products/price-editor). ::: :::ExpandableHeading **If I change a product's price in my admin, how long will it take to automatically update in SparkLayer?** If you're using automatic pricng, this will update instantaneously from your platform into SparkLayer ::: ### Manual Price Lists :::ExpandableHeading **How do I remove a price for a product for manually uploaded price lists?** There are a variety of ways to remove pricing from a product: - From the [Price Editor](https://app.sparklayer.io/products/price-editor), search for a SKU and then remove any entries you see - From [Price Lists,](https://app.sparklayer.io/products/price-lists) under "Options" next to a price list, click the "Clear" button. This will remove all pricing for all products - From [Price Lists](https://app.sparklayer.io/products/price-lists), upload a CSV file with just the SKU(s) you want to remove. In the "**price**" column, leave this blank ::: :::ExpandableHeading **How do I clear (empty) a price list for manually uploaded price lists?** From [Price Lists,](https://app.sparklayer.io/products/price-lists) under "Options" next to a price list, click the "Clear" button. This will remove all pricing for all products ::: :::ExpandableHeading **How do I see prices I’ve already uploaded?** When you upload pricing via the [SparkLayer Dashboard](https://app.sparklayer.io/products/price-lists), there are a variety of ways you can see the pricing you've uploaded: - You can download the contents of your price list as a CSV file. Simply click "Options" then "Download CSV" - You can log into your website and view the product page you need to check. You'll need to follow [this guide](docId:5_lWMNohhjBJJppg9E6Vh) to ensure you are logged in correctly as a B2B customer. - Use the [Price Editor](https://app.sparklayer.io/products/price-editor) within the SparkLayer Dashboard to quickly search by SKU. Learn more about the [Price Editor](docId\:zi2EaFxu8l_7PIFJxlS35) ::: ### Quantity pricing :::ExpandableHeading **How do I set up quantity (tiered) pricing?** Please refer to [our guide here](docId\:t2cEaOsmeOHmgZStjCnhe) ::: :::ExpandableHeading **Do I need to specify a price for a single unit if using quantity pricing?** Yes. When importing a price list that includes tiered pricing, please ensure that you include a tier for the price for a single unit, as demonstrated in the example below.  ::: ### Price configuration :::ExpandableHeading **Do I need product SKUs when uploading pricing?** In terms of product SKUs, SparkLayer relies on these being added to your products within Shopify so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. ::: :::ExpandableHeading **Why isn't my B2B pricing showing on my website?** If you're not able to see the B2B pricing, this could be due to one of the following: - Check that you've imported a [price list](https://app.sparklayer.io/products/price-lists) and assigned to a [customer group](https://app.sparklayer.io/customers/groups) - Check that all your products have **unique SKUs** assigned - Check that the product in your website admin has been set to Product Status "**Active**". Currently SparkLayer will only import prices for products that are active (versus in "Draft" status) - Check the** SKU exists** within your product catalogue ::: :::ExpandableHeading **How do I show the gross price?** In the context of SparkLayer, SparkLayer will **always **output the prices in the Net amounts, regardless of the tax status you set on your website. In effect, when you upload your B2B pricing via SparkLayer, the customer will see the **exactly the same prices** on your website. If there are circumstances where you do want to show Gross pricing to your B2B customers, there is a potential way around this. - It's possible to set a customer within your eCommerce platform (e.g. Shopify) to be 'Tax exempt'. This would mean their order would be zero tax rated. - In the price lists you upload to SparkLayer, set the prices to be the "gross" amounts (even though they don't technically include tax). - As to reporting, you would need to report on the tax amounts after the fact (e.g. via your accounting system) ::: :::ExpandableHeading **How do I show RRP (MSRP) pricing?** Please refer to [our guide here](docId\:S_VTlJBorGmnwjjfSMom9). ::: :::ExpandableHeading **How do I setup and manage multiple currencies?** SparkLayer supports multiple currencies by default and you can easily configure different currencies for your customer. To learn more about how to set this up, please refer to our platform-specific guides: - [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD) ::: :::ExpandableHeading **Can I set B2B pricing to be higher than my DTC prices** Yes! In this scenario, you may be looking to set up B2B pricing that is higher than the pricing you have set up for your regular (DTC) customers. With SparkLayer, you can set prices to be higher than the "retail" prices in your eCommerce platform should you require. ::: :::ExpandableHeading **Can I set up different automatic pricing rules based on product collections?** SparkLayer has no built in way to automatically selection which collections (or categories) to apply B2B pricing to, however we do have a suggested workaround if this is a requirement: - Create a [separate price list](https://app.sparklayer.io/products/price-lists) for each collection you require (Collection A, Collection B, etc) - In your [customer groups](https://app.sparklayer.io/customers/groups), assign each price list you want to show for your specific customer groups and you can even assign **multiple** price lists to a customer group ::: ### Discounts :::ExpandableHeading **How do I set up discount promotional codes at checkout?** It's possible to set up discount codes that customers can use during the checkout process. For example, you could set up a discount coupon that gives them 10% off their order. To learn how discounts work, please see [our guide here.](docId\:WrejPw9URyjQwiQeKs_Cg) ::: :::ExpandableHeading **How do I set up discounts to apply across a product range? ** Within the SparkLayer [Discounts](docId\:WrejPw9URyjQwiQeKs_Cg), using the "Advanced requirements and rewards", you can setup discounts to apply to products with specific tags setup within your store (e.g. in Shopify). For example, you could set the discount to only apply if products within the cart have a tag of `dog-toy` applied, or match a broad term of `dog`. This allows you to setup discounts to apply to collections and product ranges easily. There are also other workarounds without using discounts: - You could create a brand new product in your website catalogue and set up a range of variants within it (e.g. all the products you want to offer within the discount) - We have a special setting called *minimum product quantity* ([See our guide here](docId\:CmxfrPgjQxfz9vJzTVv0D)) which forces the customer to order at least X of the product (e.g. 3) - Using the [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe), you can then set up your discounted rates (e.g. buy 3 and the price is 10% cheaper) - Within Shopify, you could make these products 'hidden' from standard B2C customers simply by not associating them to a collection ::: :::ExpandableHeading **How do I set up discounts based on an order total?** It's possible to set up discounts that apply based on a certain threshold, e.g. the order total or the number of items in a cart. To learn more about discounts, see [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg) ::: ### Customer configuration :::ExpandableHeading **Can I assign multiple price lists to one customer group and/or customer?** **** From the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups), you can assign multiple price lists to a customer group if you want to set up more sophisticated pricing. From the "Update Price Lists" screen, simply click "Add new" to select a price list. In terms of pricing, if a product SKU exists in multiple price lists, SparkLayer will search through all available price lists and use the first one it finds.  ::: :::ExpandableHeading **How do I assign a price list to a specific customer?** Please refer to [our guide here](docId\:v8dVUcJ7Ju0fH7BvINrEw). ::: [title] Launching SparkLayer [path] Introduction/ :::hint{type="success"} **Book a FREE Onboarding Call** Remember, our expert team is here to help you go live. If you need assistance along the way, please [book your free call here](https://book.sparklayer.io/). ::: ## ℹ️ Introduction The [SparkLayer Dashboard](https://app.sparklayer.io/) guides you through the steps to setup SparkLayer such as adding the special frontend widgets, and setting up your B2B pricing and customer rules. You can learn more about this in [our guide here](docId:-5djX1YCIgzAI6MRkq0u6). Once you've completed the above, you're then ready to begin the process of launching! | Step | Details | | ---------------------- | ------------------------------------------------------------------- | | **✅ Testing ** | Perform your own tests such as logging in and placing a test order. | | **💌 Inviting ** | Begin inviting a range of customers to use your new B2B store | | 🚀 **Launching** | Going live with your new B2B store and onboarding more customers | *** ## ✅ Testing :::hint{type="info"} **Before you start testing, please make sure:** ✅ You've added the [SparkLayer frontend](https://app.sparklayer.io/configuration/frontend/core) (or our team has done this for you) ✅ You've added a [B2B price list](https://app.sparklayer.io/pricing/lists) (even if it's just a test one) ✅ You've added a [B2B customer group](https://app.sparklayer.io/customers/groups) (even if it's just a test one) ::: You've setup the basics of SparkLayer (see above), you're now ready to start testing it! We recommend going through a testing process to ensure you're familiar with how everything works. ::::::::ExpandableHeading **🔍 1. Test as a customer and log in ** The first step is to test your website as if you were a B2B customer. We recommend creating an example customer using the guide below. :::::::Tabs ::::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Before you start!** For any customers that you want to place B2B orders, they must have a tag of `b2b` assigned to them in [Shopify](https://admin.shopify.com/customers). Without this tag, SparkLayer will **not** load.  ::: :::::WorkflowBlock :::WorkflowBlockItem **Ensure customer accounts are enabled** You’ll need to make sure that customer accounts are **enabled** on your storefront so that customers can sign in. Within your Shopify admin, go to [Customer Accounts](https://admin.shopify.com/settings/customer_accounts) and select either "**Customer Accounts**" or "**Legacy Accounts**" (both are compatible with SparkLayer). ::: :::WorkflowBlockItem **Edit or create a customer record** Within your [Shopify Customers admin](https://admin.shopify.com/customers), find an **existing** customer record or add a **new one**.  Fill in all the form fields, **including the address**. It's important that an address is specified otherwise SparkLayer won't find the customer record. ::: ::::WorkflowBlockItem **Tag the customer** Next, tag the customer with `b2b` From within the customer record in Shopify, go to the **Tags** section and type `b2b` into the field. You can either choose from an existing tag, or add it as a new tag :::Iframe{iframeHeight="0" code=""} ::: :::: :::WorkflowBlockItem **Invite the customer** If you're using Shopify "**Customer Accounts**", you can simply direct your customers to the login page and they can then enter their email to receive a 6-digit access code. You can access this by going to `www.yourstore.com/account`. If you're using "**Legacy accounts**" and you're creating a brand new customer record, you'll need to click "**Send account invite"** and then confirm the account once you've received the activation email ([learn more here](https://help.shopify.com/en/manual/customers/customer-accounts#invite-customers-to-create-accounts)).  The customer will then receive an email asking them to confirm your account by setting a password. Should you require, you can also edit the contents [of this email here](https://admin.shopify.com/email_templates/customer_account_activate/preview).  ::: ::::WorkflowBlockItem **Login as a customer** Finally, return to your website and visit the login page (e.g. `www.yourstore.com/account`) and enter your details. If you're using Shopify "Customer Accounts", you'll be prompted to enter a 6-digit code that will be sent to your email. You'll then see SparkLayer load and you can browse your store as a B2B customer! :::hint{type="info"} **Please note** If you can't access this page, make sure you have [customer accounts enabled](https://admin.shopify.com/settings/customer_accounts). ::: :::: :::WorkflowBlockItem **Inviting customers** See our guide further down this page on how to invite your customers. ::: ::::: :::::: ::::::Tab{title="🔵 Using Wix"} To get started, please following the below steps: :::::WorkflowBlock ::::WorkflowBlockItem Within Wix, go to **Customers & Leads** and click **Contacts. **You can either create a new customer or edit an existing one. :::hint{type="warning"} **Please note** Please ensure that a valid address is added and all address fields are populated. Make a note of the email address you’ve added as you will need to access this to login. :::  :::: ::::WorkflowBlockItem To synchronise to SparkLayer, the customer must have a label of `b2b` assigned to them and be a **Site Member**. :::Iframe{iframeHeight="0" code=""} ::: You can set this up by clicking the **Add Label** button when editing a customer.   :::hint{type="warning"} **Please note the following on customer groups** - SparkLayer will only synchronise customers that have a label of `b2b` assigned - If you have created additional [customer groups](https://app.sparklayer.io/customers/groups) within SparkLayer, please ensure that the labels are added to the contact record in Wix exactly as shown. e.g. `b2b` `b2b-additional-group` - Customers must be set up as **Site Members** to be able to sign in to your online store. - When adding a new label in Wix, please ensure that it is not subsequently edited. ::: :::: :::WorkflowBlockItem Once your customers have been set up in Wix (i.e. those with a label of `b2b`), and you've assigned the customer group to **at least** one customer, you can then manage specific rules within the [Customer groups area.](https://app.sparklayer.io/customers/groups)  ::: :::WorkflowBlockItem You'll see a default **Base** customer group that you can use for your B2B customers. If you want to set up additional rules, you can simply click **Create Customer Group** and configure accordingly. For any additional customer groups you create, you'll need to update the labels on the customer record in Wix to match (e.g. `b2b` and `b2b-account`) ::: :::WorkflowBlockItem To simulate logging in as a B2B customer, please see **✅ Testing & launching** below. ::: :::WorkflowBlockItem You can also check if your customer record is syncing by using the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. Within Wix, navigate to a Contact record that has a label of b2b. Within the URL, you'll see a unique ID at the end of the URL. In the example below, the unique ID is `66b4c99a-3431-47d6-995d-309e4e8c5908`  With this unique ID, you can then paste this into the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. If the search results show the customer details, this confirms the customer is synchronosing correctly.  ::: ::::: :::::: :::Tab{title="🌐 Other platforms"} Please refer to your platform for details. ::: ::::::: :::hint{type="success"} **Checking a B2B customer** You can also check that a B2B customer has successfully synchronised to SparkLayer in the [Customer Sync](https://app.sparklayer.io/data-sync/customers) tool within the SparkLayer Dashboard. ::: :::::::: :::::::ExpandableHeading **🆔 2. Check you have product SKUs** :::hint{type="info"} **Please note** For SparkLayer to work, all products that you want B2B customers to see pricing for **must** have unique SKUs. Without SKUs, SparkLayer has no way to show B2B pricing or our special frontend "widgets" ::: ::::::Tabs :::Tab{title="🛍️ Using Shopify"} **How to check for SKUs in Shopify** Within your [Shopify Products admin](https://admin.shopify.com/products?selectedView=all), if you navigate to any product, you should see a SKU display within the product details. In our example below, the product has a SKU of `MUG-CAT` which is the unique identifier for the product.  **How to add SKUs** If you don't already have SKUs, it's relatively quick to do. You can either edit individual products and add them manually, or you can use the Shopify admin's **Import** or feature to do this in bulk. You may also want to consider an app such as [Matrixify](https://apps.shopify.com/excel-export-import) if you have a lot of SKUs to add. **Ensuring you have unique SKUs** For SparkLayer to work, any SKUs added must also be unique (e.g. MUG-CAT, MUG-DOG). If SKUs are "shared" between products, these will need to be adjusted to ensure SKUs are individually set. ::: :::::Tab{title="🔵 Using Wix"} To get started, please following the below steps: ::::WorkflowBlock :::WorkflowBlockItem For any products that you want your B2B customers to be able to buy, these products **must** have unique SKUs assigned. You can check this by going to **Catalogue > Store Products > Products** and editing a product. For regular products, you'll see the option to add a SKU within the **Inventory and shipping** section.  For products that have variants (e.g. colour, size), you'll need to edit a variant and add this within the **Product variants** section and ensure the setting **"Manage pricing and inventory for each product variant"** is turned on.  ::: :::WorkflowBlockItem Next, go to [Price Lists](https://app.sparklayer.io/pricing/lists) within SparkLayer and click "Create Price List" to create your first B2B Price list. You can choose between an automatic or manual price list and configure how this works. ::: :::: ::::: :::Tab{title="🌐 Other platforms"} No customisations applicable. ::: :::::: ::::::: :::::ExpandableHeading **✅ 3. Check your products are 'enabled'** ::::Tabs :::Tab{title="🛍️ Using Shopify"} For SparkLayer to show B2B pricing, products must be assigned to the **SparkLayer B2B & Wholesale** and **Online Store** sales channels for each product. If the product is not assigned, SparkLayer will not show any pricing. If you don't want the product to be purchaseable by your B2B customers, leaving **SparkLayer B2B & Wholesale** channel *unticked* can be a good way to make specific products "Unavailable" to your B2B customers.  ::: :::Tab{title="🌐 Other platforms"} No customisations applicable. ::: :::: ::::: ::::ExpandableHeading **💰 4. Set up your B2B pricing** :::hint{type="info"} **Please note** SparkLayer will not show any B2B pricing until this step is done. ::: Now you've got your customer account setup, you'll want to test how your B2B pricing works. You can add all your B2B prices in the [Price List section](https://app.sparklayer.io/pricing/lists) of SparkLayer and set either **automatic** price lists (a percentage off your retail prices) or **manually** uploaded prices. With manually uploaded prices, you can upload prices via CSV if you want to set exact B2B pricing (you can also download [a sample price list here](docId\:NX9Q00eWV_kbjxc3tg1ut)). :::: ::::ExpandableHeading **📦 5. Set up your B2B shipping** :::hint{type="info"} **Please note** If you're wanting to customise shipping for your B2B customers, please follow this step. ::: SparkLayer will by **default** use the shipping rules set up within your eCommerce platform (e.g. Shopify). You can also configure SparkLayer to use special "B2B-specific" shipping rules that only show for your B2B customers and you can [get started here](https://app.sparklayer.io/configuration/shipping). If you'd rather use your eCommerce platform for shipping rules, you can learn more in [our full guide here](docId\:CfZ_ZpGw2umOVAo73Lc5m) . :::: ::::::ExpandableHeading **🛒 6. Set up your B2B payment methods and place an order** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} Providing you have SKUs set up for your products, you can place an order by **going to any product page** and adding items to your order. When you add items, they will then appear in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) and you can then proceed to checkout to complete the order. **How payment methods work** When customers reach the payment step, they'll see available methods and can select their preference. | Payment method | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment on Account` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** needing to enter any payment details.
**🏦 For merchants:**
It's essentially an 'offline' payment method and you can even set credit limit rules and net payment terms such as `Net 30, Net 60, etc`[Learn more](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details.
**🏦 For merchants:**
Like "Payment on Account", this is essentially an 'offline' payment method. You can then process the order and take payment via offline channels (e.g. by bank transfer) | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). This is sometimes referred to as "Pro-forma payment".
**🏦 For merchants:**
This will come through as a paid (or "completed") order and no further action should be required to collect payment. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | | `Request for quote` | **👪 For the B2B customer:**
The customer can submit their order **without** choosing a payment method.
**🏦 For merchants:**
The order will be marked as a 'Draft' order and can subsequently be edited (e.g. changing the shipping cost, adding additional discounts, adding or removing products from an order). | The diagram below helps to illustrate how payments working with SparkLayer and Shopify, based on the payment method the B2B customer selects.  **How orders arrive into Shopify** Depending on which [payment method](docId\:ibIKczvHM085BkeJIfFYv) you've selected, orders will arrive into Shopify in the following ways by default | Payment Method | Flow | Status | | -------------------- | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | `Pay by Invoice` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | | `Pay on Account` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | | `Pay Online by Card` | The order is submitted as a **completed order** within Shopify and the customer will **receive an order notification** | Order is "Paid" status and can be fulfilled (shipped) | | `Request for Quote` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | **Draft orders and "Completed" orders** If you're using Shopify, by default **all payment methods** other than Upfront Payment will be generated as [Draft orders](https://help.shopify.com/en/manual/orders/create-orders). If you'd prefer to automatically convert Draft orders into *Completed* orders, you can enable this via the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general). **Shopify checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the Shopify checkout. By default, they will see all Shopify payment methods you have set up (e.g. card payment, Paypal, etc). It's possible to set rules on which payment methods show for your B2B customers and we recommend [exploring available apps here](https://apps.shopify.com/payfy-conditional-payments). Please note that if a customer uses "Pay Online by Card" and doesn't complete their order, this will still show in your Shopify Draft Orders admin for review. :::hint{type="success"} **Please note** You can automatically convert "Draft" orders into "Completed" orders by turning on the "Auto-complete Shopify Draft orders" in the [Sparklayer Dashboard here](https://app.sparklayer.io/configuration/settings/general). ::: **Additional order details** When an order is placed via SparkLayer, it will also include the following additional data: | Attribute | Notes | | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tag` | A tag of `b2b` is added to any order placed via SparkLayer. This is particularly useful for filtering and segmenting orders, or even adding more advanced automations | | `note` | Order Note: `sparkCartId`
This is added as an **order note.**
This is primarily for internal use for debugging | | `note` | Order Note: `sparkPaymentType`
This is added as an **order note.**
This contains the name of the payment option used:
* upfrontPayment * paymentOnAccount * paymentByInvoice * quote |  :::hint{type="success"} **Viewing B2B orders in Shopify** You can quickly view B2B orders by logging into your Shopify admin and adding this to the URL `orders?tag=b2b` or [by going here](https://admin.shopify.com/store/orders?tag=b2b) ::: :::: :::Tab{title="🔵 Using Wix"} When customers reach the payment step, they'll see a variety of available payment methods and can select their preference. | Payment method | Description | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment on Account` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** needing to enter any payment details. | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details. | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). This is sometimes referred to as "Pro-forma payment". | | `Request for quote` | **👪 For the B2B customer:**
The customer can submit their order **without** choosing a payment method. | **How orders arrive into Wix** Depending on which [payment method](docId\:ibIKczvHM085BkeJIfFYv) you've selected, orders will arrive into Wix in the following ways: | Payment Method | Flow | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Pay by Invoice` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay on Account` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay Online by Card` | The order will be created within **Sales > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | | `Request for Quote` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | **"Unpaid" orders and "Paid" orders** By default **all payment methods** other than Upfront Payment will be generated as "Unpaid" orders. **Wix checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the Wix checkout. By default, they will see all Wix payment methods you have set up (e.g. card payment, Paypal, etc). ::: :::Tab{title="🌐 Other platforms"} No customisations applicable. ::: ::::: :::::: ::::ExpandableHeading **🎨 7. Check your design customisations (CSS)** :::hint{type="info"} **Please note** If you've requested our team to install SparkLayer for you, this step will already be completed. ::: We typically recommend adding some basic CSS customisations to your website to match your styling. If you'd like to customise these further, please see [Customising the Design](docId\:qCt2Zk8wjhYIV2ZbVBJYy) :::: :::::ExpandableHeading **📝 8. Set up a B2B login and registration process ** :::hint{type="info"} **Please note** It's worth noting that you may not require a registration form at all if you are manually inviting your B2B customers. You can learn more in our "Inviting your customers" guide lower down on this page. ::: ::::Tabs :::Tab{title="🛍️ Using Shopify"} There are three recommended ways to set up a B2B registration process. 1. **Use our "B2B login and register" page: **We've a ready-made template that also includes a registration form. You can see this in action on our [demo store](docId:87ILO_vHmG3XUXKecOLXv). Learn more in [Shopify B2B Registration & Login](docId\:Gfc0UW7mJnMNpnNO6EdRl) 2. **SparkLayer Forms (recommended)** - Our built-in, no-code form builder lets you create and manage B2B registration forms directly within the [SparkLayer Dashboard](https://app.sparklayer.io/forms/) - no third-party apps needed. Get started with the ready-made Customer Registration Form template which includes approval workflows, automatic customer tagging, and email notifications. [Learn more about SparkLayer Forms](docId\:nn5qnfmfGkXlyUmAMpSnq) ::: :::Tab{title="🌐 Other platforms"} No customisations applicable. ::: :::: ::::: ::::ExpandableHeading **🚀 9. Enable additional B2B features (hiding products, approval form, shipping)** :::hint{type="info"} **Please note** This step is optional and you can continue testing without applying customisations if you do not require them. ::: We've got a variety of additional features you can add such as showing a live stock level, pack sizes, B2B-only products, retail prices (RRP), and much more. You can explore all available SparkLayer features in our [our interactive demo](https://www.figma.com/proto/5FPCY5hSGl7mlwjsjMZI2t/SparkLayer-Interfaces?page-id=0%3A1\&type=design\&node-id=86-36708\&viewport=554%2C-398%2C0.33\&t=34VlPwbCqpvQOTsh-8\&scaling=min-zoom\&starting-point-node-id=35%3A7920\&hide-ui=1). :::hint{type="success"} **Customer experience** ✅ [Set up a B2B login page](docId\:Gfc0UW7mJnMNpnNO6EdRl) ✅ [Set up a B2B registration page](docId\:Gfc0UW7mJnMNpnNO6EdRl) ✅ [Hiding B2B products from regular DTC customers](docId:30hMTg4Cqqv69EhqNvpnf) ✅ [Show B2B-only content](docId:30hMTg4Cqqv69EhqNvpnf) ✅ [Create a B2B-only navigation menu](docId:30hMTg4Cqqv69EhqNvpnf) ✅ [Modify your B2B email notifications](docId\:FAW11UwvEk1KN06woxik0) **** **Checkout process** ✅ [Configure B2B-only shipping](docId\:ZSsXG6FjRLCod_GxoluTN) ✅ [Customise your B2B payment methods](docId\:ibIKczvHM085BkeJIfFYv) ✅ [Configure custom checkout data fields](docId\:o3nDhZBCxisWH6M6satDt) **Product configurations** ✅ [Setup product pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D) ✅ [Setup minimum and maximum quantities](docId\:CmxfrPgjQxfz9vJzTVv0D) ✅ [Show live inventory levels](docId\:Gj_Ao_gQ6oA-jx0D27Hys) ✅ [Setup pre-orders and backorders](docId\:Gj_Ao_gQ6oA-jx0D27Hys) ✅ [Set "reserve inventory" for your DTC customers](docId\:Gj_Ao_gQ6oA-jx0D27Hys) **Automations** ✅ [Shopify Flow (Ready-made automations)](docId\:uvXV1kUg_VsZEPr5Dlb2z) ::: To see what else is possible, check [our full guide here](docId\:SSzdKXuNMlEIDOOITHQcU). :::: :::hint{type="info"} **Need help troubleshooting?** Please see our [Troubleshooting](docId\:BlCEkkx3I30nkUcglsfw7) guide for how to solve the most common queries. ::: *** ## 💌 Inviting You've tested SparkLayer and you're happy it works. Next, let's invite some customers to use it! We've some recommend tips you can use as part of your onboarding process. ::::::::ExpandableHeading **👤 Inviting your customers ** :::hint{type="warning"} **Before you invite your customers** We strongly recommend you perform a full end-to-end test of the steps within "*Test & Launch SparkLayer"*. Once you're done, you may want to invite a subset of customers to guage any feedback before inviting all your customers! ::: :::::::Tabs ::::::Tab{title="🛍️ Using Shopify"} When you're ready to begin inviting your B2B customers to your Shopify store, you can easily manage this via the Shopify admin by following the process below. :::hint{type="info"} **Before you start** You'll need to make sure you have accounts enabled in your Shopify store. Within your [Shopify admin here](https://admin.shopify.com/settings/customer_accounts), go to Customer Accounts and select either "Customer Accounts" or "Legacy Accounts" (both are compatible with SparkLayer). ::: To begin inviting customers, you can follow the steps below: :::::WorkflowBlock :::WorkflowBlockItem **Edit or create a customer record** First, within your Shopify Customers admin, find an existing customer record or add a new one.  Fill in all the form fields, **including the address.** It's important that an address is specified otherwise SparkLayer won't find the customer record. ::: ::::WorkflowBlockItem **Tag the customer** Next, tag the customer with `b2b` From within the customer record in Shopify, go to the **Tags** section and type `b2b` into the field. You can either choose from an existing tag, or add it as a new tag :::Iframe{iframeHeight="0" code=""} ::: :::: :::WorkflowBlockItem **Invite the customer** If you're using Shopify "**Customer Accounts"**, you can simply direct your customers to your login page (e.g. `www.yourstore.com/account`). They will be prompted to enter their email address and this will email them a 6-digit access code to sign in. If you're using **"Legacy accounts"** and you're creating a brand new customer record, you'll need to click **'Send account invite' **within the customer record in your Shopify admin.  The customer will then receive an email asking them to confirm your account by setting a password. You can edit the contents [of this email here](https://admin.shopify.com/email_templates/customer_account_activate/preview).  ::: ::::WorkflowBlockItem **Login as a customer** Finally, the customer can return to your website and visit the login page (e.g. `www.yourstore.com/account`). If you're using Shopify "Customer Accounts", the customer will be prompted to enter their email and then their 6-digit code. If you're using "Legacy Accounts", the customer can sign in with their email address and password.. They'll then see SparkLayer load and they can browse your store as a B2B customer! :::hint{type="info"} **Please note** If they can't access this page, make sure you have [customer accounts enabled](https://admin.shopify.com/settings/customer_accounts). ::: :::: ::::: :::::: :::::Tab{title="🔵 Using Wix"} ::::WorkflowBlock :::WorkflowBlockItem **Set up a customer record** Within your Wix admin, you'll need to ensure you have an example customer record set up (either a new one or an existing). Most importantly, a customer must be associated with a label of `b2b` and be a Site Member. Any customer that has a label of `b2b` will automatically synchronise with SparkLayer.   ::: :::WorkflowBlockItem **Invite your customers** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. One of the easiest ways is to use the built-in Wix messaging system to simply notify your customer to sign in and begin placing orders. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You'll see a tab called **Inbox** that allows you to send direct messages.  You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You can then search and filter your customers and click **Send Email Campaign** to send an email.  We also have some example messaging you can use when inviting your customers and you can explore more below in **"Using our example "Welcome" email"** ::: :::: ::::: :::Tab{title="🌐 Other platforms"} Please refer to your platform for details. ::: ::::::: :::::::: :::::ExpandableHeading **👥 Inviting your customers in bulk** ::::Tabs :::Tab{title="🛍️ Using Shopify"} - If you're looking to invite a set of B2B customers in one go, you can use third-party Shopify apps to streamline this for you. A popular option is [Matrixify](https://apps.shopify.com/excel-export-import?st_source=autocomplete) which has built-in tools to quickly create customer records and invite them. - If you're looking to bulk invite customers but want to skip sending them emails, you can also try [BAIS Bulk Account Invite](https://apps.shopify.com/bulk-account-invite-sender?) ::: :::Tab{title="🌐 Other platforms"} Please refer to your platform for details. ::: :::: ::::: :::::ExpandableHeading **🤖 Automating the approval process** ::::Tabs :::Tab{title="🛍️ Using Shopify"} **Automating the approval process** To further automate the process, it's possible to allow customers to "apply for access" on your store that you can then moderate before granting them the ability to place B2B orders. We've detailed some great options in [our guide here](docId\:Gfc0UW7mJnMNpnNO6EdRl). ::: :::Tab{title="🌐 Other platforms"} Please refer to your platform for details. ::: :::: ::::: *** ## 🚀 Launching You've invited a range of customers and things are working well. What's next? We now recommend **fully launching** your new B2B store and inviting more customers to use it! We've a variety of handy resources you can use to speed up and optimise this process. :::::::ExpandableHeading **⭐ Create an onboarding landing page to promote the benefits** A great way to encourage your customers to use your new B2B store is to **explain the benefits**. To help you get started, you can use our ready-made "onboarding landing page" that gives a great overview of the features to your customers.  ::::::Tabs :::::Tab{title="🛍️ Using Shopify"} To install the onboarding landing page, please follow these steps: ::::WorkflowBlock :::WorkflowBlockItem In Shopify, go to **Online Store** and click **Pages** (or [go here](https://admin.shopify.com/pages)) ::: :::WorkflowBlockItem Click the "Show HTML" button and then paste in the [code from here](https://gist.github.com/cm-sl/47d750425f90d527e1210efe3735dc7f)  ::: :::WorkflowBlockItem You can then customise the page title, URL, and any of the content as required. We recommend give the page a URL of `b2b-onboarding`  Finally, set the page to "**Visible**" to publish it on your store and you can then click "**View**" to see the page.  ::: :::WorkflowBlockItem To make customers aware of your new page, you could add this to your website navigation (such as your website header or footer). If you're using our ready-made [Shopify B2B Registration & Login](docId\:Gfc0UW7mJnMNpnNO6EdRl) you can also link to the page from there. ::: :::: ::::: :::Tab{title="🌐 Other platforms"} Please refer to your platform on how to set up custom landing pages. ::: :::::: ::::::: :::ExpandableHeading **✨ Create a dedicated B2B customer landing page** Alongside the "onboarding landing page" detailed above, you could also create a **dedicated** landing page that you direct B2B customers to as soon as they sign in - whether it's to highlight specific products, show important information, or act as a central hub for your B2B store. You can learn more in [our full guide here](docId\:iirMl1jUUXvRotG9fdhTp)  ::: :::ExpandableHeading **💌 Use our example "Welcome" email ** To help with the process of inviting your customers, we've put together an example email you could send to them! Perhaps this could be sent in a newsletter or as a personal email from your B2B sales team. *** Dear [Valued Partner], We’re excited to announce our new online B2B store and we’re excited to have you join! To ensure a smooth start, we’ve put together a guide to help you activate your account and start placing orders. **Account Activation: The First Step to Joining** - **Look Out for Our Email:** Keep an eye on your inbox for an email from [My Store] with the subject "Activate Your [My Store] Partner Account." - **Activate with a Click:** Within that email, you'll find the ‘Activate My Account’ button. Click it to move forward with your activation. - **Secure Your Login:** Follow the link to create your own secure password. After this, your account is all set and ready to go. **B2B Portal: Streamlining Your Business** - **Fast Track with Quick Order:** Speed is essential in business. That's why our ‘Quick Order’ feature offers a simple layout to place your orders quickly and efficiently - perfect for when you know exactly what you need. - **Explore Products in Detail:** Curious about a product? Visit the ‘Products’ page for an in-depth look at the benefits, and quickly add to your order **Effortless Account Management** - **Your Orders, Simplified**: By clicking on the ‘Account’ or ‘Cart’ icons, you can view your Order Summary, adjust account settings, and monitor your orders in real-time. - **Get a Shipping Quote:** Ready to finalize your order? Get live shipping costs right before you place your order - **Approval Before Payment:** If you need administrative approval, select 'Pay on Account' to submit your order and we'll take care of the rest. **Account Extras:** Within ‘My Account,’ you’ll also discover tools to: - Review your order history. - Save personalized shopping lists for quick reordering. - Update your shipping addresses whenever necessary. **We're Here for You** Should you have any questions or need assistance, our dedicated team is ready to help at [Your Support Email]. Thank you for choosing [My Store] as your partner, we’re excited to have you on board! Warm regards, [Your Name] [Your Position] [My Store] [Contact Information] ::: :::::ExpandableHeading **🎨 Updates to your website** ::::Tabs :::Tab{title="🛍️ Using Shopify"} Alongside the above recommendations, there are also a variety of "on site" updates you could think about to encourage your B2B customers to access your B2B store: 1. **Navigation:** Add a clear link to your navigation, e.g. in the header or footer. You can typically do this from your Shopify Admin, under "Online Store" and clicking "Navigation" 2. **Landing page:** Set up a landing page to entice new (and existing) customers. This could include graphics, some selling points of your B2B store, testimonials, featured products, and more 3. **Emails: **think about how you can update any email marketing you have to promote your new B2B store! ::: :::Tab{title="🌐 Other platforms"} Please refer to your platform for details. ::: :::: ::::: *** ## 📚 Additional resources Alongside the practical steps detailed above, we also regularly create publications to help you grow your B2B and wholesale business. ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-helIWHvtf5gvZ7mOSkWYz-20250627-135246.jpg"} [Micropaper - Unlocking customer Adoption](https://www.sparklayer.io/adoption/) Devise and deliver a winning B2B customer adoption strategy. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-TnWtoGpkMeIYctdZ4-vTb-20250627-135257.jpg"} [Micropaper - Reimagining B2B Operations](https://www.sparklayer.io/reimagine/) Discover the cutting-edge wholesale tactics brands are using to stay ahead. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-edfo-azM9DuQlZt868Yis-20250627-135311.jpg"} [Micropaper - Simplifying B2B Success](https://www.sparklayer.io/simplify/) Discover the cutting-edge wholesale tactics brands are using to stay ahead. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-ztzQDK6a1ggPCI7-svihw-20250627-135601.jpg"} [Video Series - Acquire, Onboard, Retain & Adopt.](https://www.sparklayer.io/b2b-journey/) A free video series for brands, wholesalers, and distributors on mastering the B2B customer journey and driving sales. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-TXnCggSTbCcXVyjyuoIms-20250806-094722.jpg"} [Love B2B eCommerce - by SparkLayer](https://www.sparklayer.io/love-b2b-ecommerce/) A free tooklit - discover how to grow your B2B eCommerce business with expert videos, strategy guides, case studies, and 1:1 consultations. ::: :::: [title] Tax & Shipping [path] Features/Configurations/ ## Introduction In the context of B2B, it's really important to understand the two types of pricing available to customers: | Price type | Tax setup | | ---------- | ------------------------------------------------------------------------------------------------------------------- | | `Gross` | The pricing will **include** tax. For example, if the price is $20.00, this price will include any tax calculations | | `Net` | The pricing will **exclude** tax. For example, if the price is $20.00, this price will exclude any tax calculations | B2B customers typically make payments in one of these ways: - either with tax **included** (Gross Pricing) - or tax **excluded** (Net pricing) *** ## How SparkLayer calculates tax Before diving into the details, here's a quick visual overview of how tax is calculated when your B2B customers place an order. :::Iframe{iframeHeight="0" code="
How tax works
How your B2B customers see tax in SparkLayer, and how it flows through to your Shopify orders.
Start
Your B2B customer browses your store
All prices shown by SparkLayer are excluding tax - your customers always see the net price, no matter how your Shopify tax settings are configured.
SparkLayer
The B2B price comes from your price list
The price your customer sees is the one you've set up in your SparkLayer price list. This is your wholesale price and it's what appears on the product page.
Checkout
Customer goes to checkout
Your customer adds products to their cart and starts the checkout. At this point, SparkLayer works with Shopify to figure out how much tax to add.
Does this apply to you?
Do you sell products with different tax rates?
Some stores sell products taxed at different rates (e.g. food vs non-food). We have a special setting for this - contact our team to enable it.
We create the order early for accurate tax
When your customer selects their shipping address, SparkLayer creates a preliminary order in Shopify behind the scenes. This gets the exact tax rate per product before showing the final total. You may see draft orders tagged b2b-pending.
Tax is calculated at the end
Tax is worked out as a single rate across the whole order. The order is only created in Shopify when the customer completes checkout.
Shopify checks
Is this customer tax-exempt?
Mark customers as tax-exempt in Customers › [Customer] › Manage tax exemptions
✓ Exempt
No tax charged. The order total won't include any tax.
✗ Tax applies
Shopify checks if Charge tax on this product is on per product.
Shopify
Tax rate based on shipping country
Shopify applies the correct tax rate based on where the order ships to. Manage this in Settings › Taxes and duties.
SparkLayer
Your wholesale price is sent to Shopify
SparkLayer replaces the standard retail price with your B2B wholesale price. The customer always pays the price from your SparkLayer price list.
Your Shopify settings
Do your Shopify prices include tax?
Check if Include sales tax in product price is on in Settings › Taxes and duties. Common for UK/EU stores.
Price list may need adjustment
Manual price lists: no action needed - enter net wholesale prices as normal.
Automatic price lists: tick adjust percentage to account for tax when setting up the price list.
No special setup needed
Your Shopify prices already exclude tax. Just set your wholesale prices in SparkLayer and you're good to go.
SparkLayer
Prices shown as net + tax
Your customer always sees the net price with tax shown separately as a line item. This is the case regardless of your Shopify tax settings.
SparkLayer
Customer completes their order
The customer confirms their order. If different tax rates was enabled, the preliminary draft order is updated. Otherwise, a new order is created.
Done
Order appears in your Shopify admin
Your order is now in Shopify. If "include tax in price" is on, Shopify shows prices as tax-inclusive with a tax summary - this looks different from checkout but the totals match. If it's off, prices show the same way as SparkLayer.
:::BlockQuote \[ \{ "location\_id": "123", "min\_stock\_level": -99999999, }, \{ "location\_id": "789", "min\_stock\_level": -150, } ] ::: | :::: ::::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | -------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `min_stock_level` | | `Value` | This must be set as **a negative integer**, e.g. `-6, -12, -20, etc` | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: :::::: ### Setting a custom "restock" date "Custom dates" allow you to set an exact date when the product is expected to be available. It’s a great way to give the end customer better visibility of when to expect receipt of the products on order, and helps deliver an overall better customer experience.  Use-cases could include: - Setting a "due in" date of when you're expecting the product to be in stock - Setting an "estimated shipping" date of when you're expecting the product to ship To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. ::::::Tabs :::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `date` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `restock_date` | | `Value` | This must be set in the appropriate date format, e.g. `17/11/2022` (for the UK) | If you're using [stock locations](docId:5_lWMNohhjBJJppg9E6Vh), you can also set restock dates on a per-location basis. In this case, the restock date must be in the format: `YYYY-MM-DD`. ::::ExpandableHeading **View example metafield configuration ** | Item | Details | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `json` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `stock_location_data` | | `Value` | This must be set per location with the location\_id taken from your eCommerce platform.
:::BlockQuote \[ \{ "location\_id": "123", "restock\_date": "2023-12-12" }, \{ "location\_id": "789", "restock\_date": "2024-12-12" } ] ::: | :::: ::::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | ------------------------------------------------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `date` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `restock_date` | | `Value` | This must be set in the appropriate date format, e.g. `17/11/2022` (for the UK) | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: :::::: :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.messaging.back-order-due": "Due {restockDate}", } }, /* End of code */ ``` ### Managing "pre-order" / "back-order" products If you're running a store that combines both retail (DTC) and B2B, you may want to offer your B2B customers the option to purchase special "pre-order" / "back-order" products that regular retail customers cannot purchase. Perhaps you need your B2B customers to order "pre-season" or you have a special range of products that aren't available to regular customers. ::::::Tabs :::::Tab{title="🛍️ Using Shopify"} **Setting up pre-order / back-order products ** Out of the box, Shopify doesn't allow you to specify products to hide or show based on a specific customer type. One of the most effective ways to "restrict" products is to use the following approach: - Create a brand new product (or range of products) and set this up as normal (e.g. with images, description, etc). - Using a third-party app (such as [Locksmith](https://apps.shopify.com/locksmith)), you can then configure the product to **only** show on your website on certain conditions (e.g. the customer logged in has the tag `b2b` set against them) - Via SparkLayer, you can then configure your B2B pricing and any settings required (e.g. [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D)) allowing your B2B customers to then purchase them When a regular customer (i.e. **not** a B2B customer) visits your store, they won't see any of the special products you've set up via the method above nor will they be able to purchase them. Whilst this approach does require duplicating data, it can be an effective way to manage "pre-order" / "back-order" products that you only want your B2B customers to see. **Managing orders with pre-order / back-order products** Alongside setting up pre-order / back-order products (as detailed above), it's also possible to add automations to streamline the **management of orders **that have these products within them.  One way is to use built-in Shopify automations to do this using the [Shopify Flow app](https://apps.shopify.com/flow) and the process broadly works as follows: 1. Tag products that are on pre-order / back-order with a special tag 2. When an order is placed with a product that has this tag, add a tag to the order itself 3. Within Shopify, add a filter to segment any orders that have this tag To get started, you can follow these steps: ::::WorkflowBlock :::WorkflowBlockItem First, within your Shopify catalogue, add a tag of `b2b-pre-order` to any product(s) that you want to make pre-orders / back-orders.  ::: :::WorkflowBlockItem Next, download the [Shopify Flow app](https://apps.shopify.com/flow) and upload the below sample files. When run, orders and draft orders that have pre-order / back-order products within them with have a special tag added `b2b-pre-order` ::File{src="https://archbee-doc-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/JRCsUHQE0Xlgs47IDhU6v_draft-order-tag-an-order-if-products-have-b2b-pre-order-tag-assigned.flow" label="[DRAFT ORDER] Tag an order if products have b2b-pre-order tag assigned.flow"} ::File{src="https://archbee-doc-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/9d0cqyfqYTovmVa_WtS1u_order-tag-an-order-if-products-have-b2b-pre-order-tag-assigned.flow" label="[Order] Tag an order if products have b2b-pre-order tag assigned.flow"} ::: :::WorkflowBlockItem Finally, within the Shopify Orders admin, you can set up a basic filter to segment all orders that have the tag `b2b-pre-order.` You can then use this to manage your internal workflows (e.g. how you fulfil items)  ::: :::: ::::: :::Tab{title="🌐 Other platforms"} For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: :::::: ### Hiding pre-order and back-order messaging SparkLayer will by default show products as pre-order if they match the criteria set within your store. There are two ways you can disable pre-order showing on your website. **Hiding via the SparkLayer Dashboard** Within the SparkLayer Dashb**oard, go to the Customers section and edit a customer group. Within Stock Display Settings** simply tick 'Hide pre-order' and this will hide this from showing in the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa)  **Hiding via your eCommerce platform** ::::Tabs :::Tab{title="🛍️ Using Shopify"} SparkLayer will show the pre-order stock message based on the following criteria: - On a product (or variant) level, "Track quantity" is enabled - The product (or variant) is set to "Continue selling when out of stock" - The inventory (Quantity) is 0 or less  To disable the message showing in SparkLayer, you can apply the following: - Turn off "Track Quantity" - Turn off "Continue selling when out of stock" ::: :::Tab{title="🌐 Other platforms"} For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: :::: *** ## Stock locations ("inventory locations") Stock locations allow you to specify which stock (or "inventory") locations you want specific customer groups to see stock display settings from. If your B2B store is set up with multiple stock locations (e.g. by geography), it's a great way to ensure your B2B customers are viewing stock disaply settings from the relevant location.  :::hint{type="info"} **Looking to enable stock locations?** You can learn more about how this works in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: *** ## Reserving stock If you're installing SparkLayer on a single website and you are looking to run both DTC **and** B2B at the same time, it will be necessary to use the same stock pool behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the **same stock source** which can pose challenges. For example, your B2B customers could place large orders which inhibit DTC customers from being able to order. SparkLayer has a way to solve this using a special setting called "Reserve stock quantity". It works as follows: - A product is set up within your store with a Reserve Stock Quantity, e.g. `50` - Both DTC and B2B customers can order this product via your store - When the total stock level reaches `50`, B2B customers will be **prevented** from adding the item to their order - DTC customers can continue to order the item, thus reserving stock for them To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `reserve_stock_quantity` | | `Value` | This must be set as an integer, e.g. `50` | :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | -------------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `reserve_stock_quantity` | | `Value` | This must be set as an integer, e.g. `50` | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: *** ## Stock status messaging Within the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa), SparkLayer will display the "stock status" of a product (and its variants), allowing customers to easily see the inventory availability. Providing you have the "Show stock levels (inventory)" configuration enabled, you can then adjust the messaging that is shown by overwriting the default language settings. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.messaging.back-order": "Pre-order", "pdp.messaging.back-order-due": "Due {restockDate}", "pdp.messaging.out-of-stock": "Out of stock", "pdp.messaging.low-stock": "Low stock", "pdp.messaging.last-stock": "Last stock", "pdp.messaging.in-stock": "In stock", "pdp.messaging.un-sellable": "Unavailable", } }, /* End of code */ ``` [title] Data Sync [path] Dashboard/ ## Introduction The **Data Sync** section is the heartbeat of your SparkLayer integration and gives you visibility of the product and customer data being synchronised from your online store. It's largely used as a way to diagnose any issues and is also useful to review the data being sent from your online store to SparkLayer. There are a number of reasons why data is synchronised: ::::WorkflowBlock :::WorkflowBlockItem **Product Sync** By synchronising product data, SparkLayer knows what product pricing to display when a B2B customer is signed in and visits a product page on your store. Learn more ::: :::WorkflowBlockItem **Customer Sync** By synchronising customer records, SparkLayer can recognise when a B2B customer signs into your store (and subsequently display the correct B2B information to them). ::: :::: *** ## Products Sync Once you've connected your platform via the **Integrations** section of the SparkLayer Dashboard, you'll see your product feed appear in the 'Products Sync' tab.  At the top, the status box will notify you of the following states: | Status | Description | | ---------- | ----------------------------------------------------------------- | | `🟢 Green` | Products are successfully syncing and data being received | | `🟠 Amber` | Products are successfully syncing, **but** errors have been found | | `🔴 Red` | No product data being received and configuration is required. | From within the interface, clicking the product feed status box will show further details, such as: - Products synchronised - Last import time - Errors with the feed :::hint{type="info" attributes="[object Object]"} **Please note** By default, SparkLayer will synchronise all products from your online store. Please note, products won't be purchasable until you've set up [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) for your products. SparkLayer will by default perform feed refreshes every 10 minutes, however, if you want to manually trigger a refresh, you can do so by clicking the **Refresh** button. This is useful if you've updated data on your eCommerce platform and want to ensure SparkLayer is synchronised more rapidly. ::: :::hint{type="warning"} **⚠️ Having technical issues?** If you're having issues with setting this up or are experiencing error messages, please refer to our [Troubleshooting](docId\:BlCEkkx3I30nkUcglsfw7) guide or contact our [Support](docId\:NNUw1G9z7eaJ4M78vk7t9) ::: ### Product Data Lookup The product data lookup is a handy tool that lets you inspect and diagnose the product data you're sending to SparkLayer. The search results will display all relevant data, allowing you to drill into more detail.  To use the Product data lookup tool, you can search by either of the following: ::::Tabs :::Tab{title="🌐 General"} | Type | Details | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Variant SKU` | Within your product catalogue you will likely have SKUs (Stock Keeping Units) assigned to your products and variants. For example, a product may come in 3 variants with SKUs:
* ABC-1 * ABC-2 * ABC-3 | | `Product ID` | You can search by an external product ID. For details on how to find this, click your platform type above | | `Product name` | You can search by the product name (or part of the full product name) | | `Description` | You can search by the product description as set within your eCommerce platfom | | `Barcode` | You can search by barcode (if specified) | | `Variant options` | You can search by variant option, e.g. "Red", "Green" etc | ::: :::Tab{title="🛍️ Shopify-specific"} | Type | Details | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product ID` | For third-party platforms such as Shopify, you can find this ID in the URL when navigating a product within the admin.
For example, the URL in your browser may look something like this:
`https://your-shopify-store-url.com/admin/products/7356521840875 `
In this example, the external Product ID would be `7356521840875` | ::: :::: **Stock** Under the product data lookup, you can view the stock data for the selected variant. This can be in 3 states: | State | Description | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Stock data found` | You have stock information configured for this product. A table of stock information for each location will be shown here | | `Stock data not found` | There is no data about stock in our system. Variants without stock data **cannot** be purchased | | `Stock not being tracked` | Stock/inventory tracking has been disabled on this variant within your e-commerce platform. We therefore have no stock information. This variant **can** still be purchased | *** ## Customers Sync SparkLayer automatically syncs your B2B customer data from your connected platform. This ensures that when a tagged B2B customer signs into your store, SparkLayer recognises them and displays the correct B2B information. At the top of the Customers page, the customer feed status box will notify you of the current sync state:  The feed status box will notify you of the following states: | Status | Description | | ---------- | ------------------------------------------------------------------ | | `🟢 Green` | Customers are successfully syncing and data being received | | `🟠 Amber` | Customers are successfully syncing, **but** errors have been found | | `🔴 Red` | No customer data is being received and configuration is required. | From within the interface, clicking the customer feed status box will show further details, such as: - Customers synchronised - Last import time - Errors with the feed :::hint{type="info"} **Customer data ** It's important to note that SparkLayer will **only** import customer data that has been specially tagged as a `b2b` customer or sent through with metafields with the namespace of 'sparklayer'. This is to ensure that you have control over the types of customers that get imported. **Customer data from Shopify** For third-party platforms, such as **Shopify**, this is set up within the platform itself and you can [Data Mapping and Metafields](docId\:LJ6VIeqqBgVAVMGiKhX_7) on how this works. ::: :::hint{type="warning"} **⚠️ Having technical issues?** If you're having issues with setting this up or are experiencing error messages, please refer to our [Troubleshooting](docId\:BlCEkkx3I30nkUcglsfw7) guide or contact our [Support](docId\:NNUw1G9z7eaJ4M78vk7t9) ::: ### Viewing customer data To check the data SparkLayer is syncing for a specific customer, go to Customers in the SparkLayer dashboard and click **View** on the customer you want to inspect. Their detail page shows all synced information, including basic details, customer group, financial settings, role, and addresses. This is the easiest way to confirm a customer is syncing correctly and to review the data being received from your platform. ::::Tabs :::Tab{title="⚫ Using Wix"} You can also if your customer record is syncing by using the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. Within Wix, navigate to a Contact record that has a label of b2b. Within the URL, you'll see a unique ID at the end of the URL. In the example below, the unique ID is `66b4c99a-3431-47d6-995d-309e4e8c5908`  With this unique ID, you can then paste this into the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. If the search results show the customer details, this confirms the customer is synchronosing correctly.  ::: :::Tab{title="🌐 Other platforms"} Please refer to your platform for how to find the customer ID ::: :::: [title] Test Mode [path] Dashboard/ ## Introduction The SparkLayer **Test mode** is a handy way to test SparkLayer without affecting your live website. It allows you to effectively have a test and a live environment under a single account and easily switch between the two as necessary. Common use-cases include: - You want to enable a test account on your live store to test pricing and customer data - You want to enable SparkLayer on a development (or sandbox) store before going live :::hint{type="info" attributes="[object Object]"} **Please note:** Test mode is only available on the Pro and Enterprise plans. ::: *** ## How it works  Test mode works by simply **switching the data** you see in the SparkLayer Dashboard between two environments that you specify: one environment being your live store (**production**), and one environment being your test store (sometimes referred to as **staging**). Once enabled, every section is re-loaded with the corresponding data and you can perform actions independent of one another. *** ## Configuring your environments When you create a SparkLayer account for the first time, you'll be asked to go through the [Configuration](docId\:ISj3O3OS27G_4KjuCsX72). Your environments are specified within the [Configuration](docId\:ISj3O3OS27G_4KjuCsX72) section and from here you can specify your two environments (i.e. live and test). **Live environment:** Ensure Test mode is set to **OFF** in the left hand menu and then enter your live store address  **Test environment:** Ensure Test mode is set to **ON** in the left hand menu and then enter your test store address if it isn't already pre-populated.  In each instance, you'll be redirected to Shopify and asked to authorise the SparkLayer Shopify app. :::hint{type="info" attributes="[object Object]"} If you're setting your Shopify store up in test mode, you'll be able to skip the billing step ::: Once the Platform has been configured, you can then proceed with the remaining onboarding steps for your test environment. *** ## When to add Test mode When installing SparkLayer for the first time, our recommendation is to configure the store initially for your live environment and then to add your test site **afterwards**. It's important to note that setting up Test mode is optional and can be added or edited at any point. :::hint{type="info" attributes="[object Object]"} **Transferring accounts** If you've already installed SparkLayer on a store and want to benefit from Test mode, we recommend the following steps: - Log into the Shopify store that has SparkLayer installed - In your Shopify admin. go to **Settings > Apps & Sales Channels** and remove SparkLayer - Log into your [SparkLayer account](https://app.sparklayer.io/) - Go to the [Integrations area](https://app.sparklayer.io/configuration/integrations/platform) in SparkLayer and connect to your live Shopify store and re-select the **Pro** plan. Once completed, this will re-link your SparkLayer account to your live store - To add your Test store, simply click '**Test mode'** on the left and then go to the [Integrations area](https://app.sparklayer.io/configuration/integrations/platform) and enter the Shopify store URL of your test store. ::: [title] Pricing [path] Dashboard/ ## Introduction The Pricing tool within the SparkLayer Dashboard lets you manage your B2B price lists and gives you a powerful way to set pricing the way you want for your B2B customers. From activating automatic B2B pricing (e.g. 50% off retail prices) or uploading exact B2B prices via our CSV file import tool, you can configure your pricing rules in a variety of ways!  In this guide, you'll learn how to get started with Price Lists. ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Supported Pricing Rules](docId\:FHHF5tHnVS2jg4lCUVAS2) Pricing types and rules support by SparkLayer ::: :::LinkArrayItem [Managing Pricing](docId\:NX9Q00eWV_kbjxc3tg1ut) How to set up automated and manual price lists ::: :::LinkArrayItem [The Price Editor](docId\:fWW4Oh09nSO1-G9TXUTOP) Using the Price Editor to make ad-hoc changes ::: :::LinkArrayItem [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) Setting up quantity discounts and "unit of measure" pricing ::: :::LinkArrayItem [Diagnosing Issues](docId\:zUNntq7Ptmr5HLQvIfwMZ) Investigating and solving common pricing issues ::: :::LinkArrayItem [Pricing FAQs](docId\:smlS3A5lRCGShNu_XLuNN) See our most commonly asked questions about managing B2B pricing ::: :::: [title] Pricing FAQs [path] Dashboard/Price Lists/ ## Frequently Asked Questions ### Automatic Price Lists :::ExpandableHeading **How do I set up automatic price lists (based off my DTC pricing with a discount)?** Please refer to [our guide here](docId\:NX9Q00eWV_kbjxc3tg1ut). ::: :::ExpandableHeading **How can I override pricing for some products if I'm using an automatic price list?** It's possible to combine manual price lists and automatic price lists! This is a great way to automate your pricing and give you the flexibility to manually specify pricing for specific products. - Once you've created your price list using "automatic" rules, simply click "Options" and then "Upload CSV" - You can manually upload any additional prices you want to assign to the price list. You can then easily check these via the [Price Editor](https://app.sparklayer.io/products/price-editor). ::: :::ExpandableHeading **If I change a product's price in my admin, how long will it take to automatically update in SparkLayer?** If you're using automatic pricng, this will update instantaneously from your platform into SparkLayer ::: ### Manual Price Lists :::ExpandableHeading **How do I remove a price for a product for manually uploaded price lists?** There are a variety of ways to remove pricing from a product: - From the [Price Editor](https://app.sparklayer.io/products/price-editor), search for a SKU and then remove any entries you see - From [Price Lists,](https://app.sparklayer.io/products/price-lists) under "Options" next to a price list, click the "Clear" button. This will remove all pricing for all products - From [Price Lists](https://app.sparklayer.io/products/price-lists), upload a CSV file with just the SKU(s) you want to remove. In the "**price**" column, leave this blank ::: :::ExpandableHeading **How do I clear (empty) a price list for manually uploaded price lists?** From [Price Lists,](https://app.sparklayer.io/products/price-lists) under "Options" next to a price list, click the "Clear" button. This will remove all pricing for all products ::: :::ExpandableHeading **How do I see prices I’ve already uploaded?** When you upload pricing via the [SparkLayer Dashboard](https://app.sparklayer.io/products/price-lists), there are a variety of ways you can see the pricing you've uploaded: - You can download the contents of your price list as a CSV file. Simply click "Options" then "Download CSV" - You can log into your website and view the product page you need to check. You'll need to follow [this guide](docId:5_lWMNohhjBJJppg9E6Vh) to ensure you are logged in correctly as a B2B customer. - Use the [Price Editor](https://app.sparklayer.io/products/price-editor) within the SparkLayer Dashboard to quickly search by SKU. Learn more about the [Price Editor](docId\:zi2EaFxu8l_7PIFJxlS35) ::: ### Quantity pricing :::ExpandableHeading **How do I set up quantity (tiered) pricing?** Please refer to [our guide here](docId\:t2cEaOsmeOHmgZStjCnhe) ::: :::ExpandableHeading **Do I need to specify a price for a single unit if using quantity pricing?** Yes. When importing a price list that includes tiered pricing, please ensure that you include a tier for the price for a single unit, as demonstrated in the example below.  ::: ### Price configuration :::ExpandableHeading **Do I need product SKUs when uploading pricing?** In terms of product SKUs, SparkLayer relies on these being added to your products within Shopify so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. ::: :::ExpandableHeading **Why isn't my B2B pricing showing on my website?** If you're not able to see the B2B pricing, this could be due to one of the following: - Check that you've imported a [price list](https://app.sparklayer.io/products/price-lists) and assigned to a [customer group](https://app.sparklayer.io/customers/groups) - Check that all your products have **unique SKUs** assigned - Check that the product in your website admin has been set to Product Status "**Active**". Currently SparkLayer will only import prices for products that are active (versus in "Draft" status) - Check the** SKU exists** within your product catalogue ::: :::ExpandableHeading **How do I show the gross price?** In the context of SparkLayer, SparkLayer will **always **output the prices in the Net amounts, regardless of the tax status you set on your website. In effect, when you upload your B2B pricing via SparkLayer, the customer will see the **exactly the same prices** on your website. If there are circumstances where you do want to show Gross pricing to your B2B customers, there is a potential way around this. - It's possible to set a customer within your eCommerce platform (e.g. Shopify) to be 'Tax exempt'. This would mean their order would be zero tax rated. - In the price lists you upload to SparkLayer, set the prices to be the "gross" amounts (even though they don't technically include tax). - As to reporting, you would need to report on the tax amounts after the fact (e.g. via your accounting system) ::: :::ExpandableHeading **How do I show RRP (MSRP) pricing?** Please refer to [our guide here](docId\:S_VTlJBorGmnwjjfSMom9). ::: :::ExpandableHeading **How do I setup and manage multiple currencies?** SparkLayer supports multiple currencies by default and you can easily configure different currencies for your customer. To learn more about how to set this up, please refer to our platform-specific guides: - [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD) ::: :::ExpandableHeading **Can I set B2B pricing to be higher than my DTC prices** Yes! In this scenario, you may be looking to set up B2B pricing that is higher than the pricing you have set up for your regular (DTC) customers. With SparkLayer, you can set prices to be higher than the "retail" prices in your eCommerce platform should you require. ::: :::ExpandableHeading **Can I set up different automatic pricing rules based on product collections?** SparkLayer has no built in way to automatically selection which collections (or categories) to apply B2B pricing to, however we do have a suggested workaround if this is a requirement: - Create a [separate price list](https://app.sparklayer.io/products/price-lists) for each collection you require (Collection A, Collection B, etc) - In your [customer groups](https://app.sparklayer.io/customers/groups), assign each price list you want to show for your specific customer groups and you can even assign **multiple** price lists to a customer group ::: ### Discounts :::ExpandableHeading **How do I set up discount promotional codes at checkout?** It's possible to set up discount codes that customers can use during the checkout process. For example, you could set up a discount coupon that gives them 10% off their order. To learn how discounts work, please see [our guide here.](docId\:WrejPw9URyjQwiQeKs_Cg) ::: :::ExpandableHeading **How do I set up discounts to apply across a product range? ** Within the SparkLayer [Discounts](docId\:WrejPw9URyjQwiQeKs_Cg), using the "Advanced requirements and rewards", you can setup discounts to apply to products with specific tags setup within your store (e.g. in Shopify). For example, you could set the discount to only apply if products within the cart have a tag of `dog-toy` applied, or match a broad term of `dog`. This allows you to setup discounts to apply to collections and product ranges easily. There are also other workarounds without using discounts: - You could create a brand new product in your website catalogue and set up a range of variants within it (e.g. all the products you want to offer within the discount) - We have a special setting called *minimum product quantity* ([See our guide here](docId\:CmxfrPgjQxfz9vJzTVv0D)) which forces the customer to order at least X of the product (e.g. 3) - Using the [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe), you can then set up your discounted rates (e.g. buy 3 and the price is 10% cheaper) - Within Shopify, you could make these products 'hidden' from standard B2C customers simply by not associating them to a collection ::: :::ExpandableHeading **How do I set up discounts based on an order total?** It's possible to set up discounts that apply based on a certain threshold, e.g. the order total or the number of items in a cart. To learn more about discounts, see [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg) ::: ### Customer configuration :::ExpandableHeading **Can I assign multiple price lists to one customer group and/or customer?** **** From the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups), you can assign multiple price lists to a customer group if you want to set up more sophisticated pricing. From the "Update Price Lists" screen, simply click "Add new" to select a price list. In terms of pricing, if a product SKU exists in multiple price lists, SparkLayer will search through all available price lists and use the first one it finds.  ::: :::ExpandableHeading **How do I assign a price list to a specific customer?** Please refer to [our guide here](docId\:v8dVUcJ7Ju0fH7BvINrEw). ::: [title] Discounts [path] Dashboard/ # Introduction Are you looking to setup discounts and promotions for your B2B customers? The SparkLayer Discount Engine gives you a powerful way to customise promotions that also work alongside any [B2B price list](docId\:s8XcbZGxQpgdeIGWtXseT) rules you have set up. It's a great way to offer incentives and rewards that can play an important part in helping increase sales and customer retention for your B2B business!  :::hint{type="success" attributes="[object Object]"} **Want to try out discounts?** Head over to our [B2B Demo store](https://demo.sparklayer.io/pages/b2b-login-register) and give it a go! Once signed in, add some products to your cart and use coupon code `SAVE10` Looking to try SparkLayer for the first time? [Speak to our team](https://www.sparklayer.io/?demo#contact) ::: :::Iframe{iframeHeight="0" code=""} ::: *** # Types of discounts available SparkLayer currently supports the following range of discount configurations. | Item | Details | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Discount Example` | - **Order total: **Applying a discount (percentage or fixed) based on the order total *e.g. 10% off when the order exceeds $500+* - **Order items: **Applying a discount (percentage or fixed) based on the number of items in an order *e.g. 10% off if 100+ line items are added* - **Shipping: **Applying a discount (percentage or fixed) based on the shipping method used *e.g. free shipping over $500* | | `How they are applied` | * **Automatic:** being able to *automatically* apply a discount * **Manual**: being able to apply a discount *manually* via entry of a coupon code | | `Specific requirements` | - **Minimum requirements: **Setting minimum requirements the customer must meet before qualifying *e.g. the customer must spend $500* - **Maximum requirements: **Setting minimum requirements the customer must meet before qualifying *e.g. the customer must not spend more than $5,000* - **Advanced requirements: **specifying the SKUs or tags of products that must be in the cart to qualify *e.g. the customer must have items from the "coffee" collection* | | `Eligibility` | * **Customer groups:** being able to apply discounts to specific customer groups *e.g. only apply a discount to VIP B2B customers* | | `Scheduling & timing` | - **Scheduling:** being able to specific when a discount starts and ends *e.g. expire the discount on X date* | | `Advanced Settings` | * **Customer usage limits**: how many times a discount can be used by a customer *e.g. customer can only use the discount one time* | | `Combinations` | - **Combination rules:** optionally being able to "combine" the discount with other discounts *e.g. the discount cannot be used with another discount* | *** # Getting started To get started with using discounts, please go to **Pricing** and click the [Discounts](https://app.sparklayer.io/discounts) section of the SparkLayer Dashboard. If you're viewing this for the first time, you can simply click **"Create Discount"** to start setting up a discount. Once you begin adding discounts, you'll see an overview of all your discounts in one central location.  You can also quickly see any discount requirements you've set by mousing over the icons within the **"Discount Requirements"** column.  ## Active versus Inactive The Discount section will categorise your discounts by "Active" and "Inactive" allowing you to easily see which discounts can be used by your customers. | Type | Details | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Active` | These are discounts that:
* Are set as "Enabled" * If they have scheduling configured, **have not yet expired** | | `Inactive` | These are discounts that:
* Are set as "Disabled" *and/or* * If they have scheduling configured, **have expired** | ## How discounts are applied Discounts can be applied in one of two ways: | Method | Details | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Automatic` | The discount is **automatically applied** to the customer's order based on the configurations you've set (e.g. spend over $200 and get $50 off) | | `Manual` | The discount is applied when the customer enters a **coupon code** during the [checkout process](docId\:efevur-A3yCJXUHvrR7t-). If the discount is applicable, the rewards will be applied to the order (e.g. $10 off) | :::hint{type="info"} **Learn more about coupon codes** You can learn more about how coupon codes work and what can be customised in our guide, [Cart & Checkout](docId\:o3nDhZBCxisWH6M6satDt) ::: ## Discount applications At this time, it is only possible to **apply one discount at a time** to a customer's order. If you have multiple discounts setup that are applicable to a customer, the first one shown within the [discounts section](https://app.sparklayer.io/discounts) will be applied. ## Sub-totals and tax It's important to note that when a discount is set up that applies an **"amount off an order", **this will apply against the **sub-total** of the customer's B2B order.  In our example above, the sub-total is $200.00 and the discount is applied against this total (e.g. $100 off, 20% off). This total is **"net" of tax** and any applicable tax calculations will be applied during the final step of the checkout. :::hint{type="info"} **Please note** Discounts will be applied to a customer's order regardless of which payment method is selected ::: *** # Configuring discounts If you're creating a new discount or editing an existing, you'll be presented with a range of options to customise how your discount works. ## Summary The **Summary** section allows you to set up the basic information for your discount.  | Item | Details | | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `Status` | You can set a discount as enabled or disabled. If disabled, the discount cannot be applied to the customer's order | | `Discount internal name` | This is the name used for your internal purposes and only ever shown in the SparkLayer Dashboard | | `Discount public name` | This is the name shown to customers when the discount is applied to their order and shows in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-). | You can optionally add a **discount description** that shows to your customers when a discount is successfully applied to their order.  It works by adding a special language string to your website that you can customise as required. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* [discount-id] should be replaced with the string shown in the discount summary. */ translations: { en: { "discount.[discount-id].message": "Include a description here", } }, /* End of code * ``` ## Discount Type The **Discount Type** section allows you to specify how you want your discount to work. Based on the options you select, this will then allow you to set rewards and configurations as required. You can select from the following discount types: | Type | Details | | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Give an amount off an order` | This will apply a discount that reduces the "sub-total" of the customer's B2B order, either by a percentage discount or a fixed amount discount | | `Give a free product` | This will apply a discount that adds a specific product to an order at 0.00 cost (free). | | `Give a percentage off products` | This will apply a discount that reduces the cost of chosen products, either by a percentage, or fixed amount | | `Give a shipping reward` | This will apply a discount that reduces the shipping cost by a percentage, fixed amount off, or by setting it to a fixed charge | | `Advanced requirements and rewards` | This will apply a discount based on the customer meeting more advanced requirements such as SKUs within the cart and more granular and multiple rewards can be selected | | `Advanced free products` | This will apply discounts based on specific product(s) being within the order (e.g. based on SKU or tag), and discounts can be set in a recursive fashion. | ## Discount Reward Based on the discount type selected (see above), you can then specify the "Reward Type" you would like to apply to the customer's order. ### Give an amount off an order If you've selected "Give an amount off an order", you can then choose what type of reward to give the customer, with a choice between a **percentage** or **fixed amount discount**.  :::hint{type="info"} **Please note the following on "Give an amount off an order"** - The discount reward will be applied against the sub-total of the order, exclusive of tax and shipping. ::: ### Give a free product If you've selected "Give a free product", you can specify which product SKU you want to be added to the customer's order. Once added, this will then show at 0.00 cost (i.e. free) within their order.  :::hint{type="info"} **Please note the following on "Give a free product"** - A valid SKU must be specified for it to apply to the customer's order - When the customer is redeeming the free product, it must be a different product to what is already within the customer's order ::: ### Give a percentage off products The "Give a percentage off products" reward type lets you specific specific SKUs you want to discount when the discount is applied. Simply enter the SKU and the percentage off and this will then reflect in the customer's order when they checkout.  :::hint{type="info"} **Please note the following on "Give a percentage off products"** - You can have a maximum of 25 SKUs ::: ### Give a shipping reward If you've selected "Give a shipping reward", you can then choose what type of reward to give the customer, with a choice between a percentage, fixed amount off discount, or setting the charge to a fixed amount. | Type | Details | | ---------------------------------- | ----------------------------------------------- | | `Percentage discount` | A percentage of the shipping amount to take off | | `Fixed amount discount` | A fixed amount to take off the shipping amount | | `Set the charge to a fixed amount` | Change the shipping amount to this price |  :::hint{type="info"} **Please note the following on "Give a shipping reward"** - This reward type can only be used if you're using [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) rules managed by SparkLayer (i.e. not your eCommerce platform). - The discount reward will be applied against the net shipping price, exclusive of tax. ::: ### Advanced requirements and rewards If you've selected "Advanced requirements and rewards", you can set up your discount to activate based on more comprehensive configurations. For example, it's a great way to set discounts to trigger based on a product with a specific tag being within the customer's cart, and more than one reward can also be set up. When selecting this option, you'll be prompted to configure the following: | Type | Details | | ----------------------- | ----------------------------------------------------------------------------------------- | | `Advanced Requirements` | This is where you set what criteria the customer must meet before the discount is applied | | `Advanced Rewards` | This is where you set what reward(s) are then applied | When setting "Advanced Requirements", you can choose from the following requirements and how you want to match against them using "Operators" ("must equal", "must contain", etc). You can also set multiple requirements within the same discount. These requirements can be configured in a number of different ways. **Requirements can be configured to contain multiple conditions:** In the below example, either condition can be matched in order for the discount to apply its rewards. For example, a user can add COFFEE-01 OR COFFEE-02 to their cart, and the discount will trigger.  **You can add multiple requirements to enforce multiple conditions being met.** In the below example, both COFFEE-01 and COFFEE-01 must be in the basket for the discount to be rewarded.  ::::Tabs :::Tab{title="🛍️ Using Shopify"} | Requirement | Details | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `SKU` | Which SKUs must be in the customer's cart, e.g. ABC-1, ABC-2 | | `Shopify Vendor` | Which Shopify Vendor is applicable to products within the customer's cart, e.g. products that have a vendor of "Dog Brand 1" set. | | `Shopify Tags` | Which Shopify Tags is applicable to products within the customer's cart, e.g. products that have a tag of "dog-treat" set. | ::: :::Tab{title="🌐 Other platforms"} Not applicable ::: :::: Using operators, you can broaden your requirements easily. For example, if you want to apply the discount to all products that have a tag that contains "dog", you can use the "Contains" operator.  "Advanced Rewards" let you specify the rewards a customer gets when their cart matches the "Advanced Requirements" set above. You can choose from the following: | Type | Details | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Sub-total` | A percentage or a fixed amount off the cart sub-total | | `Shipping` | A percentage or fixed amount to take off the shipping amount, or setting an explicit shipping cost | | `Requirements` | A percentage or fixed amount off of the requirements specified in "Advanced requirements". For example, if a discount requires a product with SKU of COFFEE-01, then all products with SKU of COFFEE-01 will be discounted with the specified percentage or fixed amount. | | `Cart Lines` | A percentage or fixed amount off the cart lines based a range of criteria: SKU, tags (or labels), vendor. | It's also possible to apply multiple "Advanced Rewards" within a discount. When doing so, you can also choose whether to apply all the rewards, or only the highest or lowest value awards (with a specific number being applicable). ### Advanced free products "Advanced free products" allows you to give more comprehensive free product rewards based on specific configurations being met. For example, you may want to give away free product(s) based on the customer having a range of products that have a specific tag, or you may want to provide a “Buy One Get One Free” style discount that rewards additional free product(s) when a user adds the product to the basket. :::hint{type="info"} **Please note** Unlike the Type "Give a free product", with "Advanced free products" you can also set **multiple** products to be added to the customer's cart. ::: When selecting this option, you'll be prompted to configure the following: | Type | Details | | ------------------------------------ | ----------------------------------------------------------------------------------------- | | `Advanced Free Product Requirements` | This is where you set what criteria the customer must meet before the discount is applied | | `Advanced Free Product Rewards` | This is where you set which free products are added and how you want this to behave. | When setting "Advanced Free Product Requirements", you can choose from the following requirements and how you want to match against them using "Operators" ("must equal", "must contain", etc). You can also set multiple requirements within the same discount. ::::Tabs :::Tab{title="🛍️ Using Shopify"} | Requirement | Details | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `SKU` | Which SKUs must be in the customer's cart, e.g. ABC-1, ABC-2 | | `Shopify Vendor` | Which Shopify Vendor is applicable to products within the customer's cart, e.g. products that have a vendor of "Dog Brand 1" set. | | `Shopify Tags` | Which Shopify Tags is applicable to products within the customer's cart, e.g. products that have a tag of "dog-treat" set. | ::: :::Tab{title="🌐 Other platforms"} Not applicable ::: :::: Using operators, you can broaden your requirements easily. For example, if you want to apply the discount to all products that have a tag of "dog", you can use the "Equals" operator. "Advanced Fee Product Rewards" let you specify the rewards a customer gets when their cart matches the requirements set above.  Once you’ve specified the products to be rewarded, you can then choose how you want to apply them. | Type | Details | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Once only` | The free product(s) will be added only one time to the customer's cart when the required product and quantity are added. | | `Recursively` | The free product(s) will be added each time the customer adds the required products and quantity to the cart with no limit to how many rewarded products can be added. . | | `Limited` | Similar to the above, this lets you specify a limit to how many times the rewarded product will be added to the cart. . | :::hint{type="info"} **Please note the following on "Advanced free products"** - When this is enabled, this replaces the "Rules" (or "Order rules") configuration ::: ## Order rules :::hint{type="success"} **Advanced order rules** It's also possible to setup more advanced order rules for your discounts, e.g. triggering them based off the "tags" of products. See "Advanced requirements and rewards" above to learn more. ::: Order rules let you set specific requirements that the customer must meet before the discount is applied. Currently, SparkLayer supports the ability to set "Product Rules" that allow you to apply discounts based on the customer having specific product(s) within their order. To get started, click the "New Product Rule" button and then add the SKUs you'd like the discount to apply against.  Once you've specified the SKUs, you can then set the total quantity the customer must have before the discount applies. This quantity can apply to any combination of the SKUs you've entered. For example, you may have entered: - SKU: `abc` - SKU: `xyz` - Required quantity of `2` The customer could meet the discount requirements with any of the following combinations: - 2 x `abc` - 2 x `xyz` - 1 x `abc` and 1 x `xyz` :::hint{type="info"} **Please note the following on "Order Rules"** - Valid SKUs must be specified for the discount to apply to the customer's order - You can have a maximum of 10 order rules - You can have a maximum of 10 SKUs per order rule ::: ## Customer Groups By default, discounts will be applied to **all** **customers** however it's possible to restrict your discount to specific [Customers](docId:5_lWMNohhjBJJppg9E6Vh).  The Customer groups section lets you select which customer groups are applicable to your discount and will have the discount reward applied. You can also select **multiple customer groups i**f you'd like the discount to be used by more than one customer group.  ## Scheduling If you want to set up a time-based discount, you can set a "Schedule" for the discount.  There are two dates that can be selected, both of which are optional: | Item | Details | | ------------------------- | -------------------------------------------------------------- | | `Start date of discount` | This is the date and time the discount will be applicable from | | `Expire date of discount` | This is the date and time the discount will expire | :::hint{type="info"} **Please note the following on time configurations** - The scheduling will use the timezone of your specific computer. For example, if you are based in Germany but you're setting up a discount for Canada, please be aware that you will need to change the date and time accordingly. - Selecting a time of `00:00` will start the discount at the beginning of the date selected - Selecting a time of `23:59` will start the discount at the end of the date selected ::: ## Coupon codes Coupon codes allow you to specify a unique code that the customer must enter in order to qualify for the discount reward. This is termed a "manual discount" in that the customer won't have the discount automatically applied by default, unless they manually add the coupon code. To add a coupon code, you can simply type in your coupon code reference into the field below.  Once you've added a coupon code, this will then be required to apply the discount. When the customer then goes through the checkout, they can simply apply the coupon to their order. When the order comes through to your website, you'll then see the coupon codes used within the order's "Additional notes".  :::hint{type="info"} **Please note the following on coupon codes** - Coupon codes will automatically be saved in uppercase. For example, if you type in `Code-Abc`, this will be saved as `CODE-ABC` - You can save **multiple coupon codes** against a discount. For example, you may have the same discount promoted in different locations but you want to set up different codes. For example, you could add `CODE-ABC` and` CODE-123` - On your website, the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) will only allow the customer to apply a **maximum of 3 coupon codes** against an order. For example, if a customer has 3 coupons applied to their order and they add a 4th, the most recently added coupon will not be applied. ::: ## Order sub-total limits It's possible to set "order sub-total limits" that allow you to specify the** sub-total rules** the customer must meet before being able to qualify for the discount. For example, you may want the customer to reach a certain amount before they can qualify for a discount (e.g. spending over $400 and getting 5% off). Once enabled, you'll see the option to enter a minimum and maximum sub-total.  :::hint{type="info"} **Please note the following on order sub-total limits** - When setting this up, please bear in mind the discount is calculated based on the sub-total of the customer's order. The is the total **without** tax and shipping costs being added to the order. ::: ## Order item limits Order item limits allow you to set requirements on how many items the customer must have in their order to qualify for the discount. There are two ways to define the order item limits: | Type | Details | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Quantity across all line items` | This is the **total quantity of items** within the customer's order across all products. For example, the customer may have:
`1 x Red Shoe`
`5 x Blue Shoe`
`4 x Green Shoe`
SparkLayer would calculate this as a quantity of `10` | | `Number of line items` | This is the **total unique items** within the customer's order across all products. For example, the customer may have:
`1 x Red Shoe`
`5 x Blue Shoe`
`4 x Green Shoe`
SparkLayer would calculate the number of line items as `3` | For each option selected, you can then define the minimum and maximum number that the customer must have within their order to qualify.  ## Usage limits The usage limits configuration lets you define how often a customer can qualify for the discount. For example, you may want to restrict the discount to only be used once by a customer, or a specific number of times.  :::hint{type="info"} **Please note the following on usage limits** - The limit will apply to the specific customer placing the order and is applied against their specific customer record. ::: ## Exclude customers You can exclude specific customers from a discount by entering customer email addresses or accounting IDs, separated by commas. The discount won’t apply to any customers included in this list.  ## Currency If you've set your discount to "Get an amount off an order" with a "Fixed amount discount", you can also specific the currency that the discount should be applicable to.  :::hint{type="info"} **Please note the following on currency** - By default, this configuration will automatically set the currency as the "default" currency of your store (e.g. USD, GBP, EUR) - If you have multiple currencies setup for your [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) which are then assigned to a customer, the currency must match the currency the customer is placing orders in. ::: *** ## Compatible discounts When you create a discount it will be able to be used in conjunction with all other discounts by default. If you would prefer to restrict which discounts can be used alongside others, you can enable this within the "Compatible discounts" section of the discount edit screen.  Once enabled, you can then select the discounts that you wish to be compatible by selecting them from the menu. :::hint{type="info"} **Please note the following on compatible discounts** - You can set the priority in which they apply against a customer's order by using the "Discount priorities" feature (see below). - There are some limitations to this. ::: *** ## Discount priorities By default, customers can apply a maximum of **one discount** to their order. If you have multiple discounts setup that are applicable to your customers, you may want to specify the order in which they get applied. This is particularly useful if you have multiple "competing" discounts and you need to ensure your customers have the right one applied. When you have more than one discount setup, you'll see a **Manage Priorities** button within the Discounts section . To get started, click this button and you'll then see all discounts listed.  You can then simply drag the discounts up and down in the priority you'd like them to apply. When a customer then qualifies for a discount, it'll use the highest one in the list. If you have discounts that aren't active (see above "Active versus Inactive"), you can also manage the priority of these within the list. **Priority Limitations:** What priority *does* - It decides which discount gets first pick of the items in the basket. - It settles clashes where discounts are not compatible (the higher-priority discount wins, lower ones are ignored). - It determines who consumes any per-order limits first (e.g. “can only apply once per order”). What priority *does not* do - It does **not** change the way savings are calculated. All discounts that share the same “calculation phase” (see below) are worked out from the *same* pre-discount totals; their savings are simply added together. - It does **not** make the second discount work on the already-discounted price of the first. To create true “discount-on-discount” behaviour the second discount must be placed in a later calculation phase. :::hint{type="info"} **Please note** You can also manage which discounts are compatible by editing a discount and going to "Compatible discounts" (see below). ::: *** # Updating the default text If you'd like to update the text shown to customers in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), you can update the default language strings on your store.  :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.coupons.apply": "Apply", "cart.checkout.coupons.input-placeholder": "Enter discount code here and click 'Apply'", "cart.checkout.coupons.not-found": "Discount code ''{couponCode}'' not found", "cart.checkout.coupons.already-applied": "Discount code ''{couponCode}'' already applied", "cart.checkout.coupons.successful-apply": "You've successfully added discount code ''{couponCode}''!", "cart.checkout.coupons.max-reached": "You can only add a maximum of 3 discount codes", "cart.checkout.discount.cta": "Enter a discount here or view discounts", "cart.checkout.discount.success-message": "Discounts have successfully been applied to your order", "cart.checkout.discount.totals-row-text": "Discounts Applied", "cart.checkout.discount.no-of-discounts-applied": "{numberOf} {numberOf, plural, =1 {discount applied} other {discounts applied}}" } }, /* End of code */ ``` *** # Duplicate Discounts You can now create **duplicate discounts** in SparkLayer - these are discounts that share the same structure, rules, and logic of a existing one. This is useful when you want to run the same discount for different customer groups, sales campaigns, or pricing scenarios without rebuilding each one from scratch. To duplicate a discount, simply click the '⋯' next to the discount you want to copy, then select 'Duplicate'. A new discount will be created with the same setup. By default: - The **Discount Public Name** will remain the same unless edited - The **Discount Internal Name** will have “\_copy” added to the end You can then edit any details as needed before saving. Each duplicate discount is treated as a separate entry in your system which means you can assign different coupon codes to each duplicate.  *** # Data & backend When a customer uses a discount, this will store a range of data against the order that will give you further details about the discount that has been applied. This data includes: - The coupon codes applied - The IDs/Handles of the discounts applied (discount slugs) - The cost of the order pre discount - The amount taken off by the discount :::hint{type="info"} **Please note:** All monetary values are in the currency the customer used to place the order. ::: ::::Tabs :::Tab{title="🛍️ Using Shopify"} The discount data is stored in the **"Additional Details"** section of the Shopify Order. From the Shopify API this is called `note_attributes` and you'll see the following: - `B2B Discount Coupon Codes` - a comma separated list of the coupon codes used. This is separate so you can easily view it at a glance - `sparkDiscountData` - the rest of the discount data, stored in a JSON string including SKUs order, net pricing, and the internal "ID" of the discount. If you need to access this data through code, you can use the Shopify API to access the order data ([learn more](https://shopify.dev/docs/api/admin-rest/latest/resources/order)).  ::: :::Tab{title="Using BigCommerce"} The data is stored in the **"Staff Notes**" section of the BigCommerce Order. We add two lines to these notes for each order with a discount: - `B2B Discount Coupon Codes` - a comma separated list of the coupon codes used. This is separate so you can easily view it at a glance - `B2B Discount Data` - the rest of the discount data, stored in a JSON string You can access this by clicking the 3 dots under "Action" in your orders table, then click "View notes" If you need to access this data through code, you can use the BigCommerce API to access the order data ([learn more](https://developer.bigcommerce.com/docs/rest-management/orders))  ::: :::Tab{title="Other platforms"} Please refer to out Technical Docs for further information. ::: :::: *** # Reporting on discounts Currently, there isn't built-in reporting with SparkLayer to analyse your discounts usage however, we have some recommended approaches that we have included below. ::::::Tabs :::::Tab{title="🛍️ Using Shopify"} Shopify has a built in automation tool called [Shopify Flow](https://apps.shopify.com/flow). Using Shopify Flow, it's possible to perform actions based on discounts being used by your B2B customers. Our [example Shopify flow](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Tag_B2B_order_with_discount_if_used.flow?v=1723118334) works as follows: ::::WorkflowBlock :::WorkflowBlockItem An order is created by the customer (e.g. draft order) ::: :::WorkflowBlockItem The Flow detects if a discount has been applied by searching the "B2B Discount Data" field applied to an order. You'll see this when viewing an order in Shopify under "Additional details".  ::: :::WorkflowBlockItem If the "B2B Discount Data" field includes a specific discount ID (within the `discountSlugs` data), it will then automatically add a tag to the order. In our example above, the `discountSlugs` is set to `free-product-test` and this subsequently adds a tag of `b2b-free-product-test` to the order.  You can find the ID of a discount within SparkLayer by editing a discount and viewing "Discount Handle (or ID)".  ::: :::WorkflowBlockItem Once a tag has been added to a B2B order, within Shopify you can then easily segment order data by this. Either by going to the [Analytics section ](https://admin.shopify.com/store/dashboards)or by filtering within the [Orders section](https://admin.shopify.com/store/orders?tag=b2b-discount-id) in Shopify ::: :::: ::::: :::Tab{title="Other platforms"} Not applicable ::: :::::: :::hint{type="success"} **Get started with Shopify Flow** You can download and edit our [sample discount-specific Shopify flow here](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Tag_B2B_order_with_discount_if_used.flow?v=1723118334). ::: *** # Troubleshooting :::ExpandableHeading **I don't see the discount coupon box on the checkout** The coupon code box will only show for your customers if there is a "Active" discount code that is "Enabled". If you don't see the discount coupon box, check your discounts in the [SparkLayer Dashboard](https://app.sparklayer.io/discounts).  ::: :::ExpandableHeading **How do I see discount details within an order in my store** When a customer places an order and uses a discount, you'll see special data show against the order when you view it within your store (e.g. Shopify or BigCommerce). To learn more, see "Data & backend" above. ::: :::ExpandableHeading **How should I inform my customers about discounts?** There are a variety of ways you could inform your customers about discount codes: | Method | Details | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | `Email Notifications` | Send personalised emails to your B2B customers highlighting the discount codes, their benefits, and usage instructions. | | `Website Banner` | Display a banner on your website’s homepage or relevant pages to announce the availability of discount codes. | | `Order Confirmation` | Add a note in order confirmation emails or invoices, reminding customers of any applicable discount codes for future purchases. | | `Sales Reps` | Ensure your sales team informs B2B customers about discount codes during interactions or negotiations. | | `Printed Materials` | Include discount codes in printed B2B marketing materials. | Implementing these methods will effectively communicate discount opportunities to your B2B customers, encouraging increased engagement and sales. ::: *** # Limitations The SparkLayer discount system will be subject to many ongoing improvements, however please be aware of the following limitations currently. | Item | Description | | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Discount usage` | At this time, it is only possible to **apply a maximum of 4 discounts at a time** to a customer's order. If you have multiple discounts setup that are applicable to a customer, you can use the "Discount Priority" feature to set the order. | | `Payment-specific discounts` | It is not possible to set discounts based on the payment methods the customer uses. For example, $10 if the customer pays by "Pay Online by Card" | | `Applying a discount via a URL` | It is not possible to apply a discount via the customer entering a URL. For example, $100 if visiting mystore.com/?discount=ABC | *** # Available on the Growth plan and above By default, [all plans](https://www.sparklayer.io/pricing/) benefit from our Discount functionality and there are some additional features that are available on our **Growth** plan and above. These include: - Give a free product - Give a percentage off products - Order rules - Usage limits - Compatible discounts - Advanced requirements and rewards (e.g. tag based discounts) - Pro plan - Advanced free products (multiple free products, tag based, and more) - Pro plan ** [title] Shopify Customisations [path] Integrations/Shopify/ ## Introduction  Once SparkLayer is installed, you can immediately allow your B2B customers to login and start placing orders. Beyond the initial SparkLayer installation, you may also want to apply some further modifications to really customise the B2B experience. In our guide below, we've detailed a range of suggested customisations that will supercharge your Shopify B2B store! ::::LinkArray :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-xrelmh2HotG2vOK1xg-YL-20250228-125249.png"} [Shopify B2B Registration & Login](docId\:Gfc0UW7mJnMNpnNO6EdRl) How to setup up a B2B registration form and customise your login page for B2B. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-EymfhHCxjNkVanKt2ndju-20250228-125256.png"} [Shopify B2B-only Content](docId:30hMTg4Cqqv69EhqNvpnf) How to hide products, hide prices, display B2B-only content (e.g. a navigation), and more. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-cDU6DcNV7ecwgFqOfLuzD-20250228-125429.png"} [Shopify Flow for B2B](docId\:uvXV1kUg_VsZEPr5Dlb2z) How to automate B2B-specific actions within your Shopify store such as email notifications. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-AWdkYVg6OVwjcGN1jzyUB-20250228-125639.png"} [Shopify B2B Store Setup](docId\:zNk5YTvGU44GeS3ZQhZ4q) How to configure your Shopify store for "hybrid" DTC and B2B, or setup a standalone store just for B2B. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-AfSoBljbjt52ZmSD9LZLO-20250228-125501.png"} [Shopify Payment Methods](docId:1URFSnTr0MDOfFUxel3Wc) How to customise the Shopify checkout payments for B2B customers. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-vbTkJf0FPGzWRN5YZOowA-20250228-125602.png"} [Shopify Email Notifications](docId\:FAW11UwvEk1KN06woxik0) How to customise your Shopify emails (notifications) for B2B customers (e.g. hiding content) ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-CR4nviykSl5QEIwzZVW5P-20250228-125621.png"} [Shopify Reporting & Filtering](docId\:BVgBU-uvqQVyoLoGmlG6B) How to report on B2B sales in your Shopify store. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-_tr8bOs_-DsD_D6x_IX_6-20250806-074101.png"} [Shopify B2B Landing Page](docId\:iirMl1jUUXvRotG9fdhTp) Create a landing page to give B2B customers a tailored experience. ::: :::: [title] Integrations [path] / ## Introduction SparkLayer works with a growing number of technology partners: from eCommerce platforms, ERP and operations systems, payment solutions, right through to tools that streamline the B2B customer experience. You can deliver a world-class B2B solution with our ready-made partner integrations! :::hint{type="info"} **Custom integrations** Looking to build your own integration with SparkLayer? Learn more in [our guide here](docId\:CmZj_EmE3vX8bU3J-xt3L). ::: *** ## eCommerce Platforms ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/PIEXshl0tG1QL9mwDUrSZ_shopify.png"} [Shopify](docId:7TmhkOEHbgEGGFdd6EMr1) ⚙️ Integrates Directly eCommerce Platform ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/MfTGR03MBhkc_usK1Rlo3_bigcommerce.png"} [BigCommerce](docId:6zLPH9x8-qEUITCHs2obE) ⚙️ Integrates Directly eCommerce Platform ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-AHbuSveltgWw9xRDwxWOk-20250210-144900.png"} [Wix](docId\:vEqgPapEA8X0X60U6ZWZe) ⚙️ Integrates Directly eCommerce Platform ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/xefZOKa2547cO9TNCWDyS-20251006-133942.png"} [WooCommerce](docId:2afrfuiZMXgapD6ToK-5L) ⚙️ Integrates Directly eCommerce Platform ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/tOSCISThJB_W31lHQ4F9p-20260224-055123.png"} [Magento](docId\:oGbycENjv56tYL5qa6Hu5) ⚙️ Integrates Directly eCommerce Platform ::: :::: *** ## ERPs & Operations ::::LinkArray :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/Vk2mT_ntWt6lPDP5BAjqb_brighpearl.png"} [Brightpearl](docId\:UdCRf8baae6izSgXo5uPB) ⚙️ Integrates Directly Multi-channel eCommerce ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/7mm9NPLs7kyK4R8IiJWXL_cin7a.png"} [Cin7 Core](docId\:L2xOOZGjB4uqMK5L2EDp3) ⚙️ Integrates Directly ERP Software ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/xfNiGBSgEn4kQgHpgIuNy_linnworks.png"} [Linnworks](docId\:ZvLT9mGlh1mVn8xHM4JIQ) ⚙️ Integrates Directly Multi-channel eCommerce ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/sXyIVQX8jqcgyBLnlwuR2_unleashed.png"} [Unleashed](docId:83JVcRRNGWsKjpUzf-WYm) ⚙️ Integrates Directly Inventory Management ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/ceApPKUYZPfAcAeLjXgt8_katana.png"} [Katana](docId\:goIlaInwUK3DbAJ0snj6t) ⚙️ Integrates Directly Inventory Management ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/C8m2i3Hp3fLgqCGIVek-i_patchworks.png"} [Patchworks ](https://www.sparklayer.io/partners-patchworks/)↗ ✅ Trusted Partner iPaaS solution ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/YTgjfLnAuv9ufeGE5bRvi_zynk.png"} [Zynk ](https://www.sparklayer.io/partners-zynk/)↗ ✅ Trusted Partner iPaaS solution ::: :::: *** ## Payments ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/XK7wbxwqgb_6TSQUcXmna_balance.png"} [Balance ](https://www.sparklayer.io/partners-balance/)↗ ✅ Trusted Partner Buy Now, Pay Later for B2B ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/DrzxLSJwqPwu_ZvrAGrM4_billiet.png"} [Billie ](https://www.sparklayer.io/partners-billie/)↗ ✅ Trusted Partner Buy Now, Pay Later for B2B ::: :::: *** ## Accountancy ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/SgPkgyz2M87ioKZl5xGrS-20251202-152201.jpg"} [Xero](docId\:WGhH4d8L-ys8zjOQmEoVx) ⚙️ Integrates Directly Create invoices and import payments ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/wBbAtWJv_p1-if-cpch7e-20260203-050948.png"} [QuickBooks Online](docId\:fDAlz0ggia651N47ICR2z) ⚙️ Integrates Directly Create invoices and import payments ::: :::: *** ## Customer Experience ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/F5usKmg_-6xRtRJXj0TU__sufio.png"} [Sufio Invoicing](docId\:qlBasATpzOCOF5eXC99O3) ⚙️ Integrates Directly Professional invoices ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-Sv5L43Yj_sdqbBSwRWZw--20241121-141344.png"} [Locksmith](https://docs.sparklayer.io/locksmith) ✅ Trusted Partner Restrict content ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-tqfB4hdlhBIZadLAKFqRu-20250214-094403.png"} [Intuitive Shipping](docId\:ZkesmMUAWX2SQQ7j6as07) ⚙️ Integrates Directly Advanced shipping ::: :::: [title] Invoices [path] Features/ ## Introduction Are you looking to create invoices for your B2B customers? SparkLayer offers a variety of ways to allow invoices to be sent, streamlining your B2B operations: | Method | Details | Use-case | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SparkLayer Invoices` | Customers can view & download invoices directly via SparkLayer. | Your invoicing requirements are relatively simple and you don't want to use additional third-party apps. *Learn more in the guide below.* | | `Metafield and attaching invoices` | Add custom invoice details within your store using special metafields that can be associated with an order (manually or automatically). | You have an existing system that is already generating invoices for your store and you can access these as files (e.g. a PDF). [Learn more](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Third-party app` | Tools such as Sufio allow you to automatically integrate their solution into SparkLayer. | You require invoicing beyond B2B (e.g. for your regular customers also) and need more design customisation. [Learn more](docId\:qlBasATpzOCOF5eXC99O3) | *Please note: this guide focuses on SparkLayer's own invoicing solution. * *** ## Sending invoices via SparkLayer :::hint{type="info" attributes="[object Object]"} **Please note** SparkLayer Invoices is only available on the SparkLayer *Growth,* *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. ::: The SparkLayer Invoice feature allows you to automatically generate professional invoices that your customers can easily download, directly from their My Account.  SparkLayer's invoicing feature removes the need for third-party invoicing tools or apps and offers a seamless way to manage and share invoices with your B2B customers. Want to see how invoices look before reading on? Click our *Example Invoice* below: ::File{src="https://archbee-doc-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-Gm77zkemwdDqLh0pEbl_C-20250215-112744.pdf" label="Example Invoice (via SparkLayer).pdf"} *** ## Getting started To get started with Invoices, you'll need to enable the feature. Within the SparkLayer Dashboard, go to the [Settings area](https://app.sparklayer.io/configuration/settings/general) and switch on "Enable Invoices".  Once enabled, you'll then see an option to edit **Invoice Settings **(such as the content that shows when viewing an invoice). Please see [Customising invoices](docId\:NKh8H14Ffna5DD71SwwNd) below for full details on how this works. *** ## How invoices work Once you've enabled invoices via the setting detailed above, the process for viewing and downloading invoices is simple for your customers. Watch our short video below to see: ::embed[]{url="https://www.youtube.com/embed/-LeGyR2E3F0"} The process works as follows: ::::WorkflowBlock :::WorkflowBlockItem Your B2B customer (or sales agent) **places an order** via your online store. ::: :::WorkflowBlockItem After an order is placed and in a "Processing" status, an invoice is **automatically generated** and prefilled with your company details, items within the order, and any other additional information you've included (see "Customising invoices" below). ::: :::WorkflowBlockItem Your B2B customer (or sales agent) can then login at any time and, when viewing a specific order, they'll see a button to **"View & Download Invoice"**. When clicking this button, the invoice will load and they can then download as a PDF if they require. ::: :::: *** ## Important items to note When using SparkLayer invoices, please note the following: | Item | Details | | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Order status` | - Invoices are available when an **order** is created (e.g. an order with a status of "Processing") - If you're using Draft orders or an order needs to be approved via [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ), the invoice will **not** be created until the order is completed. - Invoices are not available for orders that have a **refund** or **cancellation** applied - Invoices are not compatible with orders that have "split shipments" (e.g. part of the order was fulfilled before being completely fulfilled). The invoice will just display all products from the order. | | `Order edits` | * **❌ Editing a completed order** If you're making edits to a completed order (i.e. an order that is "Processing" but not yet fulfilled), these changes will **not** reflect on the invoice generated. * **✅ Editing a "draft" order** If you're making an edit to an order that is in draft status, these changes will apply once the order has been completed (i.e. set to "Processing). | *** ## Customising invoices It's possible to make customisations to your invoices directly within SparkLayer and the built-in tooling allows you to make changes in a variety of ways. :::hint{type="info"} **Please note** When you make customisations to your invoices, these will take effect for **all invoices** that are downloaded via SparkLayer. ::: | Content | Details | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Content Zones` | Content Zones allow you to add content into 'predefined sections' of the invoice such as payment terms, bank details, terms and conditions, or anything else you may require. | | `Default Fields` | SparkLayer automatically captures a range of default fields such as your company name, phone number, and address. These will automatically show on invoices and can also be edited. | | `Theming` | SparkLayer also allows an advanced option with "themes" that can be modified to give you complete control over how the invoice looks. Please note, this does require advanced coding experience and documentation must be reviewed before making changes. | ### Content Zones Content Zones are **predefined sections** of text that automatically show on the invoices your customers see. It's a great way to add content such as payment terms, bank details, additional information, and anything else you need your customers to be aware of when viewing an invoice. To get started with Content Zones, go to the [Settings area](https://app.sparklayer.io/configuration/settings/general) and ensure "Enable Invoices" is switched on. Next, within "Invoice Settings" click the **Edit** button. You'll then see the option to modify three separate content zones, each with a field for title and a description.  | Field | Details | | ------------- | ----------------------------------------------------------- | | `Title` | This will show in larger, bold text within the Content Zone | | `Description` | This will show in smaller text, below the title. | When a Content Zone is populated, it will then show at the bottom of the invoice. If you've included "line breaks" in your content (i.e. starting a new line for a sentence), this will display as you've entered it on the invoice. :::hint{type="info"} **Please note** It's **not** necessary to populate all three Content Zones. You can choose which Content Zones you'd like to use with the title and description both being optional. :::  In our example below, we've illustrated how you could use a Content Zone to specify the payment details your B2B customers must use.  **Including advanced data in Content Zones** If you're using additional fields during the checkout process, you can also include more advanced content within Content Zones. For example, you may be using [custom checkout fields](docId\:o3nDhZBCxisWH6M6satDt) to capture data such as a "Shipping date" or a "PO number".  We've included some ready made code samples below that can simply be copied and pasted into a Content Zone field. ::::ExpandableHeading **Show "Additional Information" field (e.g. Purchase Order)** :::hint{type="info"} **Please note** Before adding this code, you'll need to make sure you have the "Additional Information" field enabled during the checkout. [Learn more](docId\:o3nDhZBCxisWH6M6satDt) ::: ```html {% if purchase.customer_reference %} Customer Reference: {{ purchase.customer_reference }} {% endif %} ``` :::: ::::ExpandableHeading **Show the payment type** :::hint{type="info"} **Please note** This will show the payment type used on the order. [Learn more](docId\:ibIKczvHM085BkeJIfFYv) ::: ```html {% if purchase.payment_method == "upfrontPayment" %} A message for Pay Online by Card {% elsif purchase.payment_method == "paymentOnAccount" %} A message for Payment On Account {% elsif purchase.payment_method == "paymentByInvoice" %} A message for Pay By Invoice {% elsif purchase.payment_method == "quote" %} A message for Quote {% else %} {{ purchase.payment_method }} {% endif %} ``` :::: ::::ExpandableHeading **Show the invoice due date** :::hint{type="info"} **Please note** Before adding this code, you'll need to make sure you have a the Net Terms set up on your customer metafield for due dates to be assigned to invoices. ::: ```html {% if data.purchase.dates.payment_due_at %}
Due Date: {{ data.purchase.dates.payment_due_at | ldate }}
{% endif %} ``` :::: ::::ExpandableHeading **Show a custom "Shipping date"** :::hint{type="info"} **Please note** Before adding this code, you'll need to make sure you have a custom "Shipping date" field added via [custom checkout fields](docId\:o3nDhZBCxisWH6M6satDt). The `field.name` should match the `name` you are using for your custom checkout field. ::: ```html {% for field in purchase.custom_fields %} {% if field.name == "delivery-date" %} Shipping Delivery Date: {{ field.value }} {% endif %} {% endfor %} ``` :::: ::::ExpandableHeading **Show a custom "Order Notes"** :::hint{type="info"} **Please note** Before adding this code, you'll need to make sure you have a custom "Order Notes" field added via [custom checkout fields](docId\:o3nDhZBCxisWH6M6satDt). The `field.name`should match the `name` you are using for your custom checkout field. ::: ```html {% for field in purchase.custom_fields %} {% if field.name == "order-notes" %} Order Notes: {{ field.value }} {% endif %} {% endfor %} ``` :::: ::::ExpandableHeading **Show a custom "Tax ID"** :::hint{type="info"} **Please note** Before adding this code, you'll need to make sure you have a custom "Tax ID" field added via [custom checkout fields](docId\:o3nDhZBCxisWH6M6satDt). The `field.name` should match the `name` you are using for your custom checkout field. ::: ```html {% for field in purchase.custom_fields %} {% if field.name == "tax-id" %} Tax ID: {{ field.value }} {% endif %} {% endfor %} ``` :::: ::::ExpandableHeading **Show an Accounting ID ("Tax ID") from metafield ** :::hint{type="info"} **Please note** Before adding this code, you'll need to make sure you have the Account ID metafield set up on your store (see below). Only the Account ID metafield can be displayed in the invoice - no other SparkLayer or custom metafield can be displayed. ::: | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `accounting_id` | | `Use-case` | This can be used to specify a unique accounting ID for a customer. For example, if you're using an ERP or accounts package, you can associate a unique account ID against a customer record.When an Accounting ID is set, this will be added to the eCommerce platform orders metadata. | ```html {% if purchase.customers.sparklayer.accounting_id %}{{ purchase.customers.sparklayer.accounting_id }}
{% endif %} ``` :::: ### Default Fields Default fields are pre-configured for invoices and include data such as your company name, phone number, address and more. You can manage the default fields via the SparkLayer Dashboard by going to [Settings](https://app.sparklayer.io/configuration/settings/general) and clicking **Edit** within "Store Details". To learn more about how this works, please see [our full guide here](docId\:gznStzTqCRffLFZSTAw0N).  When set, these will show at the top of your invoice, displayed clearly to the customer.  ### Theming :::hint{type="info"} **Please note** Theming is only available on the SparkLayer *Pro,* and *Enterprise* plan. Powering the themes is a special programming language that does require a technical understanding before making modifications. We strongly recommend engaging a web developer should you wish to make use of this feature. ::: SparkLayer supports full "theming" of your invoices, giving you total control over how the invoice looks such as its layout, typography, colour scheme, and anything else you may wish to edit. You can access this within the [SparkLayer Dashboard here](https://app.sparklayer.io/configuration/theme) and learn more about how it works [in our guide here](docId\:gznStzTqCRffLFZSTAw0N). To help get you started, we've included some example customisations you can do using theming. :::ExpandableHeading **Output the product image on an invoice** In the `` adjust the code by adding a new`{{ data.merchant.store_name }}
{% endif %} ``` You will need to host the image logo you'd like to use and you can then use the following. ```html {% if data.merchant.store_name %}Invoices will only be downloaded in the default store language, even if your store is set up with multiple languages.
If you need support for another language, please contact [our support team](docId\:NNUw1G9z7eaJ4M78vk7t9). | | `Part Fulfilment ` | Unfortunately we do not currently support **Part Fulfilled** orders. The SparkLayer invoice will display all products on the order if they have been fulfilled or not. | *** ## Feedback We've love to know if you have feedback on this feature. Let our team know by emailing **product\@sparklayer.io ** [title] Quantity Rules [path] Features/Configurations/ ## Product pack sizing SparkLayer has full support for pack sizing (sometimes called *quantity increments*), that lets you configure the quantities your customers have to order products in (e.g. units of 3, 6, 9, etc). Once set up, when your customers add an item to their order, the quantities will automatically update based on the pack size settings you've configured.  To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `pack_size` | | `Value` | This must be set as an integer, e.g. `6` |  :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | ---------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `pack_size` | | `Value` | This must be set as an integer, e.g. `6` | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: ### Pack size pricing :::hint{type="info"} **Unit of measure pricing** Looking to set up more advanced rules for your pack sizes, e.g. cases or pallets? Read our [guide here](docId\:t2cEaOsmeOHmgZStjCnhe) on how you can set up "unit of measure pricing" :::  By default, if you have pack sizing enabled, the product page widget will display a "pack price" that takes the unit price multiplied by the items within a pack. If you'd like this hidden, simply add the below CSS to your [CSS overwrites](docId\:qCt2Zk8wjhYIV2ZbVBJYy). ```css --spark-pdp-pack-size: none; ``` :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.price.pack-size": "Pack ({packSize}): {price}", } }, /* End of code */ ``` ### Customer-specific pack sizing rules By default, pack sizing will apply to all customers, however it's possible to set up customer-specific pack sizing rules. For example: - For your default B2B customers, they're able to buy a product in `units of 1` - For other B2B customers, they have to purchase in `units of 6.` To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `JSON` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `settings` | | `Value` | This is then set per customer group you want to apply the pack size rules to.
E.g. for the default B2B customer group:`[{"customer_group":"base","pack_size":6}]`
For an additional customer group that had an internal ID of `tier-2`, you would use:`[{"customer_group":"base","pack_size":6}, {"customer_group":"tier-2","pack_size":12}]`
You can find the internal ID from the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard. | :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `JSON` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `settings` | | `Value` | This is then set per customer group you want to apply the pack size rules to.
E.g. for the default B2B customer group:`[{"customer_group":"base","pack_size":6}]`
For an additional customer group that had an internal ID of `tier-2`, you would use:`[{"customer_group":"base","pack_size":6}, {"customer_group":"tier-2","pack_size":12}]`
You can find the internal ID from the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard. | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: *** ## Minimum & maximum quantities SparkLayer has support for a variety of different quantity product settings including: | Type | Details | | ------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `Minimum - Variant` | Minimum product quantities at a variant level (e.g. products that have colours) | | `Minimum - Product` | Minimum product quantities at a parent level (specifies the minimum quantity across all variants required before ordering) | | `Maximum - Variant` | Maximum product quantities at a variant level | | `Maximum - Product` | Maximum product quantities at a parent level (specifies the maximum quantity across all variants required before ordering) | :::hint{type="info"} **Setting order-level quantities** You can also set order-level minimum and maximum rules. [Customers](docId:5_lWMNohhjBJJppg9E6Vh) ::: ### Minimum product quantities It's possible to set **'minimum product quantities**' for any SKU within your Shopify catalogue, meaning that customers must meet this minimum quantity before being able to purchase a product.  To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: **Minimum product quantities: variant-level** | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `min_order_quantity` | | `Value` | This must be set as an integer, e.g. `6, 12, 20` etc | **Minimum product quantities: product-level** | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `min_order_parent_quantity` | | `Value` | This must be set as an integer, e.g. `6, 12, 20` etc | :::: ::::Tab{title="🌐 Other platforms"} **Minimum product quantities: variant-level** | Item | Details | | ------------------ | ---------------------------------------------------- | | `Custom data type` | Variant | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `min_order_quantity` | | `Value` | This must be set as an integer, e.g. `6, 12, 20` etc | :::hint{type="info"} **BigCommerce** merchants can also use the [BigCommerce Minimum and Maximum Order Quantity](https://support.bigcommerce.com/s/article/Minimum-Maximum-Purchase-Quantity) product setting. Please note that the setting will apply per variant, meaning that each variant will get it's own minimum quantity requirement even though the setting in BigCommerce is set at a product level. ::: **Minimum product quantities: product-level** | Item | Details | | ------------------ | ---------------------------------------------------- | | `Custom data type` | Variant | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `min_order_parent_quantity` | | `Value` | This must be set as an integer, e.g. `6, 12, 20` etc | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) :::: ::::: ### Maximum product quantities As with minimum product quantities above, you can also set maximum product quantities to apply. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: **Maximum product quantities: variant-level** | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `max_order_quantity` | | `Value` | This must be set as an integer, e.g. `6, 12, 20` etc | **Maximum product quantities: product-level** | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `max_order_parent_quantity` | | `Value` | This must be set as an integer, e.g. `6, 12, 20` etc | :::: ::::Tab{title="🌐 Other platforms"} **Maximum product quantities: variant-level** | Item | Details | | ------------------ | ---------------------------------------------------- | | `Custom data type` | Variant | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `max_order_quantity` | | `Value` | This must be set as an integer, e.g. `6, 12, 20` etc | :::hint{type="info"} **BigCommerce** merchants can also use the [BigCommerce Minimum and Maximum Order Quantity](https://support.bigcommerce.com/s/article/Minimum-Maximum-Purchase-Quantity) product setting. Please note that the setting will apply per variant, meaning that each variant will get it's own maximum quantity requirement even though the setting in BigCommerce is set at a product level. ::: **Maximum product quantities: product-level** | Item | Details | | ------------------ | ---------------------------------------------------- | | `Custom data type` | Variant | | `Metafield type` | This must be set as an `integer` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `max_order_parent_quantity` | | `Value` | This must be set as an integer, e.g. `6, 12, 20` etc | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) :::: ::::: :::hint{type="info"} **Setting order quantity rules** It's also possible to set minimum and maximum "order-level" quantity rules on a customer-group basis. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) ::: *** ## Quantity pricing (tiered pricing) SparkLayer can support quantity pricing rules (e.g. buy 1 for $10, buy 10 for $8). To learn more, please see [our full guide here](docId\:t2cEaOsmeOHmgZStjCnhe). *** ## Unit of measure pricing Are you looking to set up pricing based on "units of measure" such as boxes, cartons, or pallets? Please refer to our [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) guide to learn more. *** ## Quantity rules display By default, if a product has quantity rules set, it will display a message **'Qty rules apply' **that a customer can interact with.  If you'd prefer to not show this, you can hide this by adding the below CSS to your [CSS overwrites](docId\:qCt2Zk8wjhYIV2ZbVBJYy). ```css --spark-product-qty-rules-display: none; ``` *** ## Order Limit Rules You can also set order limits that allow you to set rules on the criteria a customer needs to meet before they can checkout. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh). *** ## 1-click ordering (product bundles) It's possible to create special buttons on your store that allow customers to add collections of products to an order, rather than having to add them all individually. [Learn more](docId\:m3DF4f0Eyc2rM-vUaRG9H) [title] Diagnosing Issues [path] Dashboard/Price Lists/ :::hint{type="info"} **Troubleshooting common issues** Please refer to our full guide on [Troubleshooting](docId\:BlCEkkx3I30nkUcglsfw7) ::: ## Price list data You can check if price list data has been assigned to an individual product by using the [Data Sync](docId:8XClbafeyxHtt5begKM58) tool or [The Price Editor](docId\:fWW4Oh09nSO1-G9TXUTOP). Simply enter the SKU (or external ID) and you can then see full details of price list data that is setup. If you're using the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT), you can also drill into the JSON detail  [title] Metafields [path] Backend/ ## Introduction Metafields help you to customise the functionality and appearance of your store by letting you save specialised information that isn't usually captured within your eCommerce store. You can use metafields for internal tracking, or to display specialised information on your online store in a variety of ways. In the context of SparkLayer, metafields are used to capture additional B2B data that you can then use in a variety of ways: | Type | Details | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product metafields` | Updating the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) by adding configurations such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [RRP prices](docId\:S_VTlJBorGmnwjjfSMom9), and more | | `Customer metafields` | Updating a customer's information by adding information such as [credit limits](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Order metafields` | Updating an order with [invoicing information](docId\:yWm70oQUosyKOoIqb4Z4G) | The following guide serves as an overview of all available metafields that can be configured within SparkLayer. :::hint{type="info"} **Platform-specific metafields** You can learn more about metafields in the following guides: - [Shopify Metafields & Data Mapping](docId\:BxWnGB6b1n7QFfhTnu7pk) - [BigCommerce Metafields & Data Mapping](docId\:bkHor8d6QhgZX_yxsdt56) ::: *** ## Automatically configure metafields Within the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/integrations/platform), you can speed up the creation of metafields using our built-in tool to automatically configure them. ::::Tabs :::Tab{title="🛍️ Using Shopify"} To get started, go to **Integrations, Platform Connection** 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](https://admin.shopify.com/settings/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](https://admin.shopify.com/settings/custom_data) section within your Shopify store. ::: :::: *** ## Product metafields Please note that all product metafields must be applied at the variant level. | Details | Key | Type | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | --------- | | **Recommended Retail Price (RRP)**
Allows you to set a RRP ("MSRP") price for products at a variant level
[Learn more](docId\:S_VTlJBorGmnwjjfSMom9) | `rrp` | `json` | | **Pack Size**
Allows you to configure pack size rules for products, e.g. 6, 12, 18
[Learn more](docId\:CmxfrPgjQxfz9vJzTVv0D) | `pack_size` | `integer` | | **Minimum Purchasable Quantity (variant-level)**
Allows you to specify the required minimum quantity of the variant customers can purchase.
[Learn more](docId\:CmxfrPgjQxfz9vJzTVv0D) | `min_order_quantity` | `integer` | | **Maximum Purchasable Quantity (variant-level)**
Allows you to specify the maximum quantity of the variant customers can purchase.
[Learn more](docId\:CmxfrPgjQxfz9vJzTVv0D) | `max_order_quantity` | `integer` | | **Minimum Purchasable Quantity (product-level)**
Allows you to specify the required minimum quantity across all variants customers can purchase.
[Learn more](docId\:CmxfrPgjQxfz9vJzTVv0D) | `min_order_parent_quantity` | `integer` | | **Maximum Purchasable Quantity (product-level)**
Allows you to specify the maximum quantity across all variants customers can purchase.
[Learn more](docId\:CmxfrPgjQxfz9vJzTVv0D) | `max_order_parent_quantity` | `integer` | | **Reserve stock for products**
Reserves a specified amount of stock that is not available for regular purchase. Useful for holding inventory for specific customers, events, or direct-to-consumer sales.
[Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) | `reserve_stock_quantity` | `integer` | | **Control product visibility and selling**
Controls whether a product variant is visible on the storefront. If disabled, the variant won’t appear to customers, even if it remains purchasable through other means.
[Learn more](docId\:m3DF4f0Eyc2rM-vUaRG9H) | `display` | `boolean` | | **Enable or disable purchasing**
Determines if a product variant can be added to the cart and purchased. When disabled, the product remains visible but cannot be bought, useful for showcasing upcoming or unavailable items.
[Learn more](docId\:m3DF4f0Eyc2rM-vUaRG9H) | `sell` | `boolean` | | **Customer Group Product Rules**
Allows you to specify B2B product rules (e.g. pack size & orderable quantities) for specific customer groups
[Learn more](docId\:Cm9B1I6Cz0vOlc67g-fJI)
*This "supercedes" the above metafields* | `settings` | `json` | | **Reserved DTC Stock Quantity**
Allows you to specify a stock quantity to reserve for your DTC customers
[Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) | `min_stock_level` | `integer` | | **Restock Date**
Allows you to specify an exact date when a product in a pre-order status is expected to be available
[Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) | `restock_date` | `date` | | **Stock Location Settings**
Allows you to specify B2B stock settings (e.g. minimum stock level & restock date) for specific stock locations
[Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) | `stock_location_data` | `json` | :::hint{type="info"} **Learn more** It's also possible to set **customer-specific product** metafields and you can learn more in [our guide here](docId\:Cm9B1I6Cz0vOlc67g-fJI). ::: *** ## Customer metafields | Details | Key | Type | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ---------------------------------------------- | | **Customer Title**
Captures the customer’s title (e.g., Mr., Ms., Dr.), which can be used for personalisation in invoices, emails, and account records, ensuring a professional and customized experience.
[Learn more](docId\:xXiWZ30EfVbKXnuF3j1G8) | `title` | `single line text` | | **Company Name**
Allows you to specify the name of the company associated to a customer
[Learn more](docId\:xXiWZ30EfVbKXnuF3j1G8) | `company_name` | `single line text` | | **Assigned Groups**
Allows you to specify the group assigned to a customer
*This "supercedes*" any tags assigned to the customer | `group` | `single line text` | | **Customer Specific Price Lists**
Allows you to specify the price lists assigned to a customer
[Learn more](docId\:v8dVUcJ7Ju0fH7BvINrEw)
*This "supercedes*" any price lists assigned to the customer group | `price_lists` | `json`
`single_line_text` | | **Enable invoice payment **
Stores JSON settings that define whether a customer can pay via invoice. Useful for B2B transactions, allowing approved customers to complete purchases without immediate payment.
[Learn more](docId\:yWm70oQUosyKOoIqb4Z4G) | `payment_by_invoice` | `json` | | **Credit Limit and Account Balance**
Contains the customers credit limit and account balance details
[Learn more](docId\:yWm70oQUosyKOoIqb4Z4G) | `payment_on_account` | `json` | | **Accounting ID**
Allows you to specify a unique accounting ID for a customer
[Learn more](docId\:xXiWZ30EfVbKXnuF3j1G8) | `accounting_id` | `single line text` | | **Additional Percentage Discount**
Allows you to specify a flat discount percentage to be applied in addition to other discounted pricing
[Learn more](docId\:v8dVUcJ7Ju0fH7BvINrEw) | `discount_percentage` | `single line text`
`integer`
`float` | | **Assign customer to sales agents**
Lists the sales agent groups assigned to a customer, helping manage accounts through dedicated representatives.
[Learn more](docId\:Uw8mDbMEfwWKqZrVB5CqX) | `sales_agent_groups` | `list.single_line_text` | | **Link customer to parent account**
Links a customer to a parent customer account, useful for businesses with hierarchical structures. Supports multi-level accounts, sub-customers, and centralised purchasing.[Learn more](docId:_WwfeWVJY9xrSuNCQlFoZ) | `parent_customer_id` | `single line text` | | **Assign customer role**
Defines the customer's role in their company or store interactions. Helps segment users, apply permissions, or provide tailored shopping experiences based on their job function or authority.
[Learn more](docId:_WwfeWVJY9xrSuNCQlFoZ) | `role` | `single line text` | | **Default Shipping Address ID**
Allows you to specify which shipping address to use as the default for orders
[Learn more](docId\:xXiWZ30EfVbKXnuF3j1G8) | `shipping_address_id` | `single line text` | | **Default Billing Address ID**
Allows you to specify which billing address to use as the default for orders****
[Learn more](docId\:xXiWZ30EfVbKXnuF3j1G8) | `billing_address_id` | `single line text` | | **Store multiple shipping addresses**
Stores JSON data listing all shipping addresses available for a customer. Useful for businesses with multiple delivery locations, franchises, or multi-site logistics.
[Learn more](docId\:xXiWZ30EfVbKXnuF3j1G8) | `available_shipping_address_ids` | `json` | :::hint{type="info"} **Please note** If you're looking to use our advanced metafields, please [speak to our team](docId\:NNUw1G9z7eaJ4M78vk7t9) to learn more about how it works. ::: *** ## Order metafields | Details | Key | Type | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------------------------------------------------- | | **Store invoice link for orders**
Provides a URL to an invoice linked to an order. Helps businesses offer quick access to digital invoices for record-keeping, payments, and compliance with accounting processes.
[Learn more](docId\:yWm70oQUosyKOoIqb4Z4G) | `invoice_url` | `url`
`list.url`
`file_reference`
`list.file_reference` | | **Track imported orders**
A flag indicating whether an order was imported into SparkLayer. Useful for tracking external order sources, ensuring data consistency, and managing integrations effectively.[Learn more](docId\:BxWnGB6b1n7QFfhTnu7pk) | `sparkOrderImport` | `boolean` | | **Visible ID**
This allows a custom order ID ("Visible ID") to be used instead of the platform default (e.g. Shopify). Typical use case could include showing the ERP order number ensuring its a consistent ID across all systems. Please note, this is only applicable to Shopify.
[Learn more](docId\:BxWnGB6b1n7QFfhTnu7pk) | `visible_id` | `single line text` | [title] Support [path] Useful Links/ ## Ways to contact us We're here to help! If you need technical support, such as assistance in configuring SparkLayer on your website, you can either: - Email [support@sparklayer.io](mailto\:support@sparklayer.io) or - Click the message icon within the [SparkLayer Dashboard](https://app.sparklayer.io/) or on the bottom right of this page.  So that we can best help, please ensure you provide key details including: - What your query is about - Any screenshots that may help us resolve your query as quickly as possible. :::hint{type="info"} **Support Hours:** Our team is available during these hours: - Monday: **24 hour coverage** - Tuesday: **24 hour coverage** - Wednesday: **24 hour coverage** - Thursday: **24 hour coverage** - Friday: **24 hour coverage** We operate with a distributed team, allowing us to provide support across **a full 24-hour period **during the working week. While responses may not always be immediate, we aim to respond to all queries within 24 hours. For Enterprise customers, we have an additional Service Level Agreement (SLA) in place. Please contact us for more details. ::: :::hint{type="warning"} **Messaging via our chat system** It's possible to message our support team via the [SparkLayer Dashboard](https://app.sparklayer.io/) and via the button on the bottom right of this page. Please note, our support is not always available on an immediate 'live chat' basis so we can't always provide a real-time response to your queries. Our support team is normally very responsive and we do tend to reply to queries with a resolution very quickly. ::: *** ## Onboarding support We can assist in the SparkLayer installation process such as adding the frontend widgets to your website or walking you through the data set up process. As with Technical support, just click the message icon to contact our team. If you'd prefer to book a video call, you can arrange an [onboarding call here](https://book.sparklayer.io/) **Installing SparkLayer on your store** In order to use SparkLayer, your website will require the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) to be installed. Our team offers a free service to do this for you, ensuring everything is setup ready for you to begin using. The process works as follows: 1. Via the SparkLayer Dashboard, you can begin the process by [requesting installation](https://app.sparklayer.io/help) 2. Our team will then request access to your website to allow us to edit your code 3. Our team will then proceed to install all the necessary SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) and then perform our own internal tests to ensure everything works 4. We'll then notify you that everything is ready to go and you can proceed to test with our [Launching SparkLayer](docId\:YUfghEGoxe_h7uJfcshna). You'll also be given the option to request a free onboarding call to talk with our expert team and discuss any questions you may have. *** ## Scope of our support ✅ Our support covers queries about our apps' **functionality, integration **and** installation,** help with** configuring app settings,** and addressing any observed bugs. ❌ Our support does not cover **issues caused by third-party plugins**, or those which fall under the scope of support of your theme developers, such as **native theme settings and design-decisions**. In these cases, we will try to refer you to the best support source for your query *** ## Support team location Our head office is located in the beautiful English city of Bath and our team is all based in close proximity. You can learn more [about our story here](https://www.sparklayer.io/our-story/index.html)! Since we're UK based, we typically operate our support on UK timezones (Monday to Friday, 9am to 5pm GMT) however we are able to accommodate specific requests should you require assistance outside of these hours. Please speak to our team and we'll be happy to advise. [title] Troubleshooting [path] Useful Links/ ## Introduction When you're setting up SparkLayer, our team is on-hand to give you the support you need and you can [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) at any time. We've also detailed a number of common issues that are a useful starting point if you're looking to troubleshoot yourself. *** ## Pricing :::hint{type="info"} **See all our pricing FAQs** For further troubleshooting for pricing, please refer to [Pricing FAQs](docId\:smlS3A5lRCGShNu_XLuNN) ::: :::::::hint{type="warning"} **⚠️ Prices aren't showing on the product pages or saying "Unavailable"** You've logged in as a B2B customer but prices aren't showing on your product pages or the product shows as 'Unavailable'. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** - Check that you've installed the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) - Check that you've imported a [price list](docId\:s8XcbZGxQpgdeIGWtXseT) that includes the product you are having issues with and you're signed in with a valid customer group. For example, if you have a [price list](https://app.sparklayer.io/pricing/lists) "Base", make sure you have a [customer group](https://app.sparklayer.io/customers/groups) that is assigned this price list. You can also check your pricing in the [Price Editor tool](https://app.sparklayer.io/pricing/editor). - Check that you've assigned the correct customer tags to the customer record you are logging in with. The customer must have a tag of `b2b` by default and any additional tags that give them additional [customer rules](https://app.sparklayer.io/customers/groups) - Check that you have **SKUs** for products. If you don't already have SKUs in Shopify, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Shopify's 'Import' or 'Edit products' feature to do this in bulk. - Check that the product is set to "**Active**" within the Shopify admin (i.e. not "Draft" or "Pending"). SparkLayer will only import "Active" products. - SparkLayer will only import pricing for SKUs that are assigned to the **SparkLayer B2B & Wholesale** channel within Shopify. Make sure you have **SparkLayer B2B & Wholesale **channel selected in Shopify. - If you're setting up tiered pricing, make sure that you've specified a price for a single unit for all products in your CSV. ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Price are showing different to what I am expecting** When logged in as a B2B customer you are not seeing the correct pricing that you've set up within the SparkLayer Dashboard. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** **On Product Page** When it comes to your pricing, SparkLayer will always output pricing in **NET **(excluding tax). You may need to check that you have the below Shopify store setting turned on in your [Taxes and Duties](https://admin.shopify.com/settings/taxes)  When you are creating an automatic price list you must make sure you click **"Adjust percentage to account for tax"**. This only needs to be clicked once and this will then remove the tax from your Shopify price to then apply the additional discount that you have decided on.  *** When creating a new automatic price list, if you have select a different currency to the native currency on your store, please bare in mind that this **will** convert your Shopify prices to this currency at the live conversion rate. If you do not wish for this to be the case you would need to use a manual price list and manually specify the price you want to sell the SKU for (as shown below).  *** **In the Cart** Go to your Shopify settings and navigate to [Taxes and Duties](https://admin.shopify.com/store/settings/taxes). When scrolling to the bottom, check if you have the **Include sale tax in product price and shipping rate **turned on shown below.  If this is turned **ON**, when creating an [automatic price list](https://app.sparklayer.io/pricing/lists) you will need to ensure that you click on the **Adjust percentage to account for tax** to ensure SparkLayer connects to Shopify with the correct pricing.  *** If you are using a [manual price list](https://docs.sparklayer.io/managing-pricing#QYPMk), check that you haven't uploaded your prices as **gross **(i.e. including tax). In order for tax to be added correctly in the cart, all pricing myst be uploaded at **net **pricing (i.e. excluding tax). *** By default, tax is charged on the overall subtotal of the customer's cart. We have a setting that will allow you tax individual line items, giving you more control over which items are taxed. Please [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) to enable this.  ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ I'm getting errors in the Price List import ** You've imported a CSV file but it's showing errors once you've uploaded it. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** - Check that all your products in Shopify have **unique SKUs** assigned. - If your product has variants (e.g. small, medium, larger), make sure there are **no duplicates** in your SKUs - Check that you've configured the price list CSV file as per the guides within [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) (e.g. ensuring no currency symbols in the **price** column) - Check that the product in Shopify has the B2B ordering channel ticked under 'Sales Channels'. SparkLayer will only import pricing for SKUs that are assigned to the **SparkLayer B2B & Wholesale ** channel within Shopify. - Check that the product in Shopify has been set to **Product Status "Active".** Currently SparkLayer will only import prices for products that are active in Shopify (versus in "Draft" status) - Check the SKU exists within your Shopify catalogue ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Tiered pricing isn't showing when I upload a price list** You've logged in as a B2B customer and when you go to a product page, you can't see the tiered pricing you've uploaded. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** - When you upload your CSV for your price list, make sure the `qty` field is correctly populated. - SparkLayer will only import pricing for SKUs that are assigned to the B2B Ordering channel within Shopify. - Make sure that you've specified a price for a single unit for all products in your CSV. ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ I'm using an Automatic price list but cannot select a "Source"** You've created a new price list and you've selected "Enable automatic pricing" but you cannot select a price list from the list of "Sources". ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** If you're trying to set up an Automatic price list and you can't select a pricing source, it is likely because SparkLayer cannot find SKUs on your store. SKUs are required in order for SparkLayer to synchronise product and pricing data from your store. - Please ensure SKUs are specific for the products you wish to make available to your B2B customers. SparkLayer will only import pricing for SKUs that are assigned to the B2B Ordering channel within Shopify. ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: *** ## Data Sync ::::::hint{type="warning"} **⚠️ I'm getting errors in the Product Data Sync**  If you're viewing the product data sync and you see a warning sign, there could be a number of reasons for this. :::::ExpandableHeading **✅ View possible resolutions** ::::Tabs :::Tab{title="🛍️ Using Shopify"} First of all, we recommend clicking the warning box to see the issues flagged. The issues are typically data-related (e.g. missing a field) and the good news is they can be easily remedied. We've highlighted what the messages mean. | Error message | Diagnosis | | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Check SKUs are assigned to all variants in Shopify` | For this specific product, within Shopify you are likely missing a SKU next to each variant or the main product itself. If you open the product in Shopify, you can add this under Inventory. Note: SparkLayer will only successfully import products that have SKUs assigned for all variants. | ::: :::Tab{title="🌐 Other platforms"} Not applicable ::: :::: ::::: :::::: :::::::hint{type="warning"} **⚠️ The Product Data Sync says "This product cannot be found"**  If you're searching for a product in the Product Data sync and it doesn't return any results, this could be due to a number of reasons. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** - Check that you have valid **SKUs** for products. If you don't already have SKUs in Shopify, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Shopify's 'Import' or 'Edit products' feature to do this in bulk. - Check that the product is set to "**Active**" within the Shopify admin (i.e. not "Draft" or "Pending"). SparkLayer will only import "Active" products. - SparkLayer will only import pricing for SKUs that are assigned to the **SparkLayer B2B & Wholesale **channel within Shopify. Make sure you have "B2B ordering" selected in Shopify for any products you want to show to B2B customers If you're still having issues, please contact our support team and we'll be happy to help. ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ I'm getting errors in the Customer Data Sync**  If you're viewing the customer data sync and you see a warning sign, there could be a number of reasons for this. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} First of all, we recommend clicking the warning box to see the issues flagged. The issues are typically data-related (e.g. missing a field) and the good news is they can be easily remedied. We've highlighted what the messages mean. | Error message | Diagnosis | | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Address - The Country assigned is incomplete or invalid` | Please make sure the customer record within Shopify has a Country assigned (e.g. United States of America). Please note: this must apply to all addresses within the customer's address book | | `Address - The City is missing and is a required field` | Please make sure the customer record within Shopify has a City assigned. Please note: this must apply to all addresses within the customer's address book | | `Address - The address needs a first line added (Line 1)` | Please make sure the customer record within Shopify has the first line of the address assigned. Please note: this must apply to all addresses within the customer's address book | | `Address - the Post/Zip code is invalid and is a required field` | Please make sure the customer record within Shopify has the postal or zip code assigned. Please note: this must apply to all addresses within the customer's address book | | `{"code":"resource-id-not-found","message":"Invalid customer group "tier-1".","....":"group"}` | Please check your customer tags in Shopify. It may be because the customer has a previously used tag which no longer corresponds to the tags in your Customer Groups. E.g. if they have a tag of `b2b-tier-1` but the `b2b-tier-1` customer group doesn't exist in the SparkLayer dashboard any more, it will show this error. | :::hint{type="success" attributes="[object Object]"} **In general, we always recommend the following:** - Check the customer has a **fully completed address,** including Country, Line 1 address, City, and Zip/Post code - Check the customer **doesn't have additional addresses that are incomplete** in Shopify - Check the customer hasn't had their email address recently changed. Whilst this shouldn't cause an issue, sometimes it can cause issues when syncing data ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ The Customer Data Sync says "This Customer ID cannot be found"**  If you're searching for a customer in the Customer Data sync and it doesn't return any results, this could be due to a number of reasons. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} | Area | Diagnosis | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Check the customer ID` | You can also find this ID in the URL when navigating a customer within the Shopify Customers admin. For example, the URL in your browser may look something like this:
`https://your-shopify-store-url.com/admin/customers/5917633347819`
In this example, the external customer ID would be `5917633347819` | | `Check the customer tag` | SparkLayer relies on the customer tag feature within Shopify. For a customer to sync with SparkLayer, they must have a tag of `b2b` set within their customer record in Shopify. Without this, their record will not sync to SparkLayer. | :::hint{type="success" attributes="[object Object]"} **In general, we always recommend the following:** - Check the customer has a tag of `b2b` assigned If you're still having issues, please contact our support team and we'll be happy to help. ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: *** ## Website :::::::hint{type="warning"} **⚠️ A message saying 'An unknown error occurred' shows** You've logged in as a B2B customer and when you go through the checkout, you see an error message showing on the top right of your browser. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="danger"} **Error codes:** If you're using the [latest version](docId\:WDCEwpeMoHPbrR96TaYCL) of SparkLayer, you'll see the following error codes. - **SHOPIFY:001 **You've assigned a price list in a specific currency (e.g. AUD) to a B2B customer but this currency has not been enabled in your [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD). In a market that includes multiple countries / regions, there is a setting to "Show prices to customers in their local currency". SparkLayer does not currently support this setting and **it will need to be disabled** for B2B customers in this market to successfully place orders. - **SHOPIFY:002** You've assigned a price list in a specific currency (e.g. AUD) to a B2B customer but the destination shipping country isn't set up in your [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD). - **SHOPIFY:003** There's an issue with your product data such as a missing variant SKU for the product in your order. Try removing the affected product from the order. - **SHOPIFY:005 **The email being used for the order is failing "DNS checks" by Shopify and is being restricted from checking out. Try checking the email address to ensure it is valid. - **SHOPIFY:006 **You're trying to checkout with a shipping address in a country that is not in any of your store's configured Shopify Markets. Please ensure all available shipping countries have an associated Shopify Market set. - **SHOPIFY:007** You're trying to checkout but your customer record is missing either an email address, shipping phone number, or shipping address. These are all required for stores using Managed Markets. - **PRICING:001 **The B2B customer has two price lists assigned to their customer group with different currencies (e.g. GBP and USD). Try changing their customer group settings to ensure only one currency type is assigned. ::: :::hint{type="success" attributes="[object Object]"} **Other possible resolutions:** - Check that the products in your order don't have prices of **0.00** set in Shopify. In general, SparkLayer relies on the Shopify price being higher than the B2B price in order to place an order with the correct calculations. Prices of 0.00 will throw an error and prevent checking out - If you're using multiple-currencies, make sure you've configured Shopify Markets as per [our guide here](docId\:vex5XjFlT6Pvb0AzhlKQD). You'll need to ensure each market has currencies and shipping methods correctly set - If you're placing an order as a [sales agent](docId\:Uw8mDbMEfwWKqZrVB5CqX), make sure the email address of the customer you're placing an order for is valid. Any invalid emails (e.g. an incorrect domain name) may prevent an order being placed due to Shopify rejecting the details. - Within your [core script](docId\:QWXsYM9X5_pvIOGUteKcP), make sure the `siteId` variable matches that shown in the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/frontend/core). ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Nothing happens when I log in as a B2B customer on my store** You've logged into your Shopify store with a customer account but nothing happens and you don't see the SparkLayer Frontend widgets load ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** - Check that you've assigned the correct customer tags to the customer record you are logging in with. The customer must have a tag of `b2b` by default and any additional tags that give them additional customer rules - Check that your B2B customers have a valid address assigned to them. From the Customer Import, you can see if any customers don't - Check that there are no syncing issues for the customer in the Data Sync tool. If you see a message such as `"code":"resource-id-not-found","message":"Invalid customer group"` it could indicate that the customer has been assigned a tag in Shopify that doesn't correspond to the tags in your [Customer Groups](https://app.sparklayer.io/customers/groups) - Check that you've installed the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) - Check that you are testing on the correct Shopify storefront theme (e.g. you may have installed SparkLayer on a backup theme) ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ The SparkLayer frontend widgets aren't loading on my product pages** You've logged in as a B2B customer and the SparkLayer My Account shows but no B2B prices show on product pages ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** - Check that you've installed the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) - Check that you have **SKUs** for products. If you don't already have SKUs in Shopify, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Shopify's 'Import' or 'Edit products' feature to do this in bulk. - Check that the product is set to "Active" within the Shopify admin (i.e. not "Draft" or "Pending"). SparkLayer will only import "Active" products. - Check that there are no syncing issues for the customer in the Data Sync tool for the customer you are testing with. - SparkLayer will only import pricing for SKUs that are assigned to the **SparkLayer B2B & Wholesale **channel within Shopify. Make sure you have "B2B ordering" selected in Shopify for any products you want to show to B2B customers ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: *** ## Tax :::::::hint{type="warning"} **⚠️Tax shows as zero (e.g. $0.00) ** When placing an order through SparkLayer, the tax is showing as zero (e.g. $0.00) in the SparkLayer checkout or when the order has come through into your website admin. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** Check that the customer account is **not** set as **Tax Exempt.** Go into the [customer record in Shopify](https://admin.shopify.com/store/customers), in the customer settings in the right hand side you are able to **Manage tax exemptions** as show below  *** Check if you are charging tax on the products or variants in your Shopify store. Go into the [product in your store](https://admin.shopify.com/store/products?selectedView=all) and scroll down the pricing to see the below and ensure the **Charge tax on this product** is ticked.  *** Check if you you are charging tax in the country the customer is checking out with. Within the [Taxes and duties](https://admin.shopify.com/store/settings/taxes) section, navigate to the specific country and you'll see a "tick" if the country is collecting tax or not.  ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Tax is being charged when it shouldn't be** When going through the SparkLayer checkout, the customer is being charged tax when they shouldn't be. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** Check that the customer account is **not** set as **Tax Exempt.** Go into the [customer record in Shopify](https://admin.shopify.com/store/customers), in the customer settings in the right hand side you are able to **Manage tax exemptions** as show below  ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Tax is *****not***** being charged in the checkout when it should be** When going through the SparkLayer checkout, the customer is **not** being charged tax when they shouldn't be. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** Check that the customer account is set as **Tax Exempt.** Go into the [customer record in Shopify](https://admin.shopify.com/store/customers), in the customer settings in the right hand side you are able to **Manage tax exemptions** as show below  ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Prices are wrong when I check an order** When placing and order through SparkLayer, the pricing in the SparkLayer checkout is different to the pricing being displayed in the Shopify order. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** Go to your Shopify settings and navigate to [Taxes and Duties](https://admin.shopify.com/store/settings/taxes). When scrolling to the bottom, check if you have **Include sales tax in product price and shipping rate** turned on as shown below.  If this is turned **on**, when creating an [automatic price list](https://app.sparklayer.io/sparklayertrial/live/pricing/lists) you will need to ensure you click on the **Adjust percentage to account for tax** to ensure SparkLayer connects to Shopify with the correct pricing.  *** In addition to this, we also recommend ensuring that the price of the product is **lower** in SparkLayer than it is in Shopify. One way to do this is to go the [Price Editor](https://app.sparklayer.io/pricing/editor) in the SparkLayer Dashboard and searching for the SKU.  You can then compare this price to the price that you have in Shopify.  It's very important to note that if the Shopify price is **lower** than the SparkLayer price, when the customer goes through the SparkLayer checkout, it will default to the **lower** Shopify price. When checking your pricing, you'll also need to consider if the Shopify price is **including** tax or not. If the SparkLayer price is higher "after tax" than your Shopify price including tax then again it will revert to the lower Shopify price. ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Shipping to a different country shows the wrong tax amount ** When a customer is placing an order to a different country from your "default" country in Shopify, the tax is not being calculated correctly. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** Check if you you are charging tax in the country the customer is checking out with. Within the [Taxes and duties](https://admin.shopify.com/store/settings/taxes) section, navigate to the specific country and you'll see a "tick" if the country is collecting tax or not.  ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Tax is being charged twice in the checkout** When a customer is placing an order, they are being charged tax "twice" on their order. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** If you're using a [manual price list](docId\:NX9Q00eWV_kbjxc3tg1ut), check that you haven't uploaded your prices as **gross** (i.e. including tax). In order for tax to be added correctly in the cart, all pricing must be uploaded at **net** pricing (i.e. excluding tax). *** If you are using [automatic price lists](docId\:NX9Q00eWV_kbjxc3tg1ut) and you have [Include sales tax in price and shipping](https://admin.shopify.com/store/settings/taxes) switched on in Shopify, you'll need to ensure that your price list has the **Adjust for Tax** enabled. This will then reduce the price to the correct percentage, whilst taking into account tax charges.   ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ I need to charge tax for some products and not others** I sell products that have different tax rates but the calculations are wrong when the customer checks out. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** By default, tax is charged on the overall subtotal of the customer's cart. We have a setting that will allow you tax individual line items, giving you more control over which items are taxed. Please [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) to enable this. In order to make sure that you're no longer charging tax on specfic line items, you'll then need make sure that the **Charge Tax **is not selected on the variant in Shopify:  ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Shipping costs are not showing the correct amounts** When a customer is checking out, they are not seeing the correct shipping costs as set up in the SparkLayer shipping system. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** When using SparkLayer [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m), the prices listed in the dashboard should always match the prices shown to the customer when checking out. If the shipping rate listed is different, please [contact our support team.](docId\:NNUw1G9z7eaJ4M78vk7t9) ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Tax is being charged but I use a third-party tax app (e.g. Avalara, TaxJar)** When placing an order through SparkLayer, tax is still being charged even though the customer is set to "Don't Collect Tax" in Shopify. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** If you use a third-party tax app such as Avalara or TaxJar to manage your tax calculations, these apps override Shopify's built-in tax settings. This means the Shopify customer setting alone is not enough - you also need to mark the customer as exempt within the tax app itself. SparkLayer does not calculate tax directly. We display the net pricing and pass through whatever tax information Shopify and your tax app return. If a customer is seeing tax when they shouldn't be, the issue is almost always with the tax app configuration. To resolve this: 1. Go to your third-party tax app and add the customer to its exemption list. For example, in Avalara, go to the Exemption Customer List and add the customer using their Shopify customer ID as the Customer Code. 2. Confirm that the customer is also set to "Don't Collect Tax" in Shopify - go to Customers, open the customer, and check Manage tax exemptions. **Please note:** both settings are required. The Shopify customer exemption and the tax app exemption work independently - if either one is missing, tax may still be charged. If you're unsure how to configure exemptions in your specific tax app, we recommend checking their documentation or contacting their support team. ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: *** ## Orders :::::::hint{type="warning"} **⚠️ Orders aren't showing in the Orders admin** You've placed an order via the SparkLayer Quick Order cart but it's not showing up in your Shopify admin ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** - Check that the order has been placed as a B2B customer. You can check this from the "**Notes**" field within the order in Shopify - Unless the order is placed via 'Upfront Payment' (i.e. by card payment), the order will appear as a **Draft order** within Shopify by default. You can access this by clicking Orders and then Draft Orders within the Shopify admin. If you'd prefer for all orders to arrive in Shopify as completed orders (i.e. not draft orders), you can [enable this here](https://app.sparklayer.io/configuration/settings/general). ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Orders show as "Awaiting Merchant"** As a customer, you've placed an order via the SparkLayer Quick Order cart and it shows an order status of "Awaiting Merchant" when you review your orders. ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Notes:** - For orders that are placed via "manual" payment methods such as **Pay by Account** or **Pay by Invoice**, these will initially show in the My Account area with a status of "Awaiting Merchant". When the order is transitioned into a "Completed" order, the status will then update to the appropriate status such as "Processing", "Shipped" etc. [Learn more](docId\:lQXaNI7IVDqna09D9soAP) ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: *** ## Checkout :::::::hint{type="warning"} **⚠️ Customers can't place orders because of incomplete addresses** A signed in B2B customer is trying to complete their order but it says their addresses are incomplete ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** - Make sure that all address fields for the customer are completed within their customer record in Shopify - Make sure they have no incomplete addresses saved against their account ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: :::::::hint{type="warning"} **⚠️ Shipping methods aren't showing for customers**  You've logged in as a B2B customer and when you get to the Shipping Method, you can't see a shipping method to select ::::::ExpandableHeading **✅ View possible resolutions** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="success" attributes="[object Object]"} **Possible resolutions:** - If you're using SparkLayer's built-in shipping, make sure that you've set up your [shipping rules](https://app.sparklayer.io/configuration/settings/shipping-rates) correctly, e.g. by country or by customer group. If the customer doesn't match any of the rules you've set, no shipping method will be shown. Look out for rules you've set based on "weights" or which customer groups are assigned to the shipping rule - If you're using Shopify to set your shipping methods, make sure you have a shipping country specified for your shipping methods, e.g. if the customer is from United Kingdom, ensure that your shipping methods have United Kingdom as an option - If you're using Shopify Markets, make sure that you have [shipping profiles](https://help.shopify.com/en/manual/shipping/setting-up-and-managing-your-shipping/shipping-profiles) set up for your destination countries. ::: :::: :::Tab{title="🌐 Other platforms"} Not applicable ::: ::::: :::::: ::::::: [title] What's New! [path] Useful Links/ ## Introduction Each month, we release new features to SparkLayer and you can see our latest updates below. :::hint{type="success"} **🚀 Upgrading to the latest SparkLayer version** To benefit from our latest updates, please upgrade your [SparkLayer Core Script](https://app.sparklayer.io/integrations/widgets/core). You can learn about how the Core Script works in [our guide here](docId\:QWXsYM9X5_pvIOGUteKcP). ::: ## September, 2026 ### Version 4.10 **🎉 NEW FEATURES** **Dark mode is now universally enabled** In our latest version of SparkLayer, you can now enable dark mode on all the SparkLayer interfaces. Previously, this was limited to just the product pages - with our latest update dark mode now works in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) and the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) to give a much more cohesive experience. To enable dark mode, see [our guide here.](docId\:qCt2Zk8wjhYIV2ZbVBJYy)  *** ## August, 2026 ### Version 4.9 **🎉 NEW FEATURES** **Add to Favourites** Your B2B customers can now save products as they browse by clicking the heart icon on any product or collection page!  Saved products live in a new [Favourites](docId\:BXlogKI2-m4jlJtwji_gQ) section in My Account, right alongside Shopping Lists, where customers can return to them any time and add them straight to the cart. It's a lightweight way to mark products for later - no quantities or variants to manage - and it's personal to each customer.  Learn more in [our full guide here](docId\:BXlogKI2-m4jlJtwji_gQ). **Tax-inclusive price display** You can now show your B2B prices with tax included, clearly labelled "inc. tax", so buyers who think in gross terms see exactly what they expect. It's built for markets where gross pricing is the norm - common in Australia and across trade sectors selling to smaller businesses - and gives you far more flexibility in how you present pricing across different markets. Importantly, this changes presentation only. Your prices are still stored, uploaded, and transacted net, and the tax your buyer actually pays is still calculated by your store's checkout at the point of purchase. Only the figure shown on your storefront changes. - **Show the price your buyers expect** - display gross prices without changing how you upload or transact your pricing. - **Control it per price list** - turn it on for the price lists that need it and leave the rest showing net, so you can serve different markets from one store. - **Set your own rate per product** - supply a display tax rate per SKU, so reduced-rate and zero-rated products show correctly alongside standard-rate ones. - **Clearly labelled throughout** - gross prices and the "inc. tax" label appear across product pages, cart, checkout, and order history, so there's no ambiguity about what a buyer is seeing. Tax-inclusive display is enabled by the SparkLayer team, so simply [contact our team](docId\:NNUw1G9z7eaJ4M78vk7t9) if you'd like it turned on for your store. [Learn more](docId\:S_VTlJBorGmnwjjfSMom9) **🛠️ ****IMPROVEMENTS** - **My Account discount display** When an order is placed with discounts applied, you can now see the discount total breakdown when viewing the order in the My Account. - **A refreshed look across the dashboard** We've given several dashboard pages a visual update as part of standardising the experience - Price Editor, Product Sync, Discounts (including create and edit), and the Configurations pages all now share a cleaner, more consistent design. *** ## July, 2026 ### Version 4.7 **🎉 NEW FEATURES** **Configure SparkLayer from the Dashboard - no code required** Settings that previously had to be added to your theme's core script using JavaScript and JSON can now be managed visually from the new Options page in your SparkLayer dashboard.  Adjust general settings, translations, checkout fields, payment method order, My Account sections, custom slots, and analytics, then save as a draft and publish when you're ready. It works alongside your existing core script, so nothing you've already set up changes. [Learn more](docId\:TlYOdygHE8taYqbi81JJa) **Standard checkout fields** Customer Reference, PO Number, and Requested Shipping Date are now available as standard checkout fields.  Because each one uses a known field ID, it maps to a structured place in your orders - the native Shopify PO Number field, a dedicated shipping date field, and the order notes - so they integrate more cleanly with Shopify, appear in your theme and template editor, and can be searched and filtered. [Learn more](docId\:o3nDhZBCxisWH6M6satDt) **🛠️ ****IMPROVEMENTS** - **Wix dashboard and onboarding experience** We've redesigned our Wix dashboard to make it even easier for merchants to get setup! From right within Wix, you can now view available features, sync health & analytics, manage customer groups, manage price lists, and a new 'Quick Setup' page to get merchants live super fast - **Upload Excel files to AI file upload** You can now upload Excel (.xlsx) files directly to AI file upload, alongside the existing CSV and PDF support. Customers and sales agents can turn a spreadsheet of products straight into an order, without converting it first. [Learn more](docId\:rIAcYwzOMfwSomd5KB5p8) - **More accurate quantity detection in uploaded files** AI file upload is now better at identifying the correct quantities in the files customers upload, making order creation from documents quicker and more reliable. - **Duplicate forms in one click** You can now duplicate any form from within [SparkLayer Forms](https://app.sparklayer.io/forms) - **Hide the Intelligent Cart features ** If you'd prefer not to use the [Intelligent Cart (AI)](docId\:rIAcYwzOMfwSomd5KB5p8) features within the SparkLayer Cart, you can now hide these by going to the [Setttngs > Configurations](https://app.sparklayer.io/configuration/settings/general) section of the SparkLayer Dashboard. *** ## June, 2026 ### Version 4.6 **🎉 NEW FEATURES** **Shopping Lists just got a major upgrade** ::embed[****]{url="https://www.youtube.com/embed/rhuLyeKaMQY"} Managing Shopping Lists is now faster and far more flexible! Products can be saved to a list straight from any product page, and lists can be fully managed from within the My Account area - including previewing, adding, and editing their contents. Your B2B customers and sales agents can also export any list as a CSV, making it easier to share and reorder across teams. [Learn more](docId\:AQJJjc8wJrskIYivjIZrG) **Orders API - build and manage orders** :::hint{type="info"} **Please note** Orders API is currently in beta - if you'd like to be invited, please email support\@sparklayer.io and our team will be happy to help. ::: We've extended our Core API with a new Orders API, giving developers a programmatic way to build and manage orders. The new endpoints let API users create and manage shopping carts and turn them into SparkLayer orders in code - opening up use cases such as creating orders through external integrations, for example drop shipping. Any store with API access has this automatically. See the [API documentation](https://docs.sparklayer.io/tech-docs/create-cart) and the [usage guide](https://docs.sparklayer.io/tech-docs/ordering-api) to get started. **Fetch customer-specific pricing via the API** As part of the same release, a new endpoint lets API users fetch customer-specific pricing for products, so integrations can pull the exact prices a given customer sees. Learn more in the [API documentation](https://docs.sparklayer.io/tech-docs/get-customer-specific-pricing). **🛠️ ****IMPROVEMENTS** - **My Account / My Cart - Expand button moved to the user menu** The "Expand" button now lives in the user dropdown menu, freeing up space for more important actions within each page. - **Clearer impersonation view for sales agents** When viewing as a sales agent, you can now see exactly which customer you're impersonating on every page, making it easier to keep track when ordering on a customer's behalf. *** ## May, 2026 ### Version 4.5 **🎉 NEW FEATURES** **Export Purchase History to CSV** You can now export orders (including quotes and any other purchase types) directly from the Activity view as a CSV file, ready for Excel or Google Sheets. Choose between an order-level summary or a full breakdown with every line item, and any filters you've applied carry through to the export. Available from the customer or sales agent view. Learn more [here](docId\:lQXaNI7IVDqna09D9soAP). (Requires Spark-JS Version 4.4 and above)  **Reply Directly from Your Inbox** No more logging in just to reply to a message. You and your customers can now respond to order communications straight from your email inbox, with replies automatically captured in SparkLayer's Timeline. It works across all order types, making it effortless to keep conversations going - especially on mobile, when you're on the go. Learn more [here](docId\:Kf-Gd3nHSXlrn2zZvla1Y). (Requires Version 4.3 and above) **🛠️ ****IMPROVEMENTS** **Customer & Order Data in Forms** You can now pull customer and order data (including quotes and any other purchase types) directly into your SparkLayer forms. Great for cases like returns forms, where shoppers can select from their previous orders and items without re-entering details, and sales agents can request customer data to be updated. Learn more [here](docId\:BbZC4JyoiO3LbySWcLdVx). **Address improvements** Entering addresses just got easier - especially for international buyers. Address forms now adapt their layout and name ordering to the selected country, and offer address search and auto-fill. The result is faster, more accurate data entry wherever your customers are based. Learn more [here](docId\:lQXaNI7IVDqna09D9soAP). (Requires Version 4.5 and above) **Improvements to Sales Agent Activity Filtering** Sales agents get the same export options across all their customers, and, similar to the customer view, they can now filter by the new purchase type and quote status filters. Making it easy to reconcile orders, forecast inventory, or plan pre-orders. (Requires Version 4.4 and above) :::hint{type="warning"} **Internal Customer API upgrades: **We've released V2 of our Customer API, now available to all Shopify stores (and in June we'll move the other platforms over). For customers who are already using the V1 Customers API, you can continue to use the V1 API for the next 6 months till the 1st of December 2026. The upgrade path is straightforward, and we’ll provide more information about the changes soon. ::: *** ## April, 2026 ### Version 4.4 **🎉 NEW FEATURES** **A better way to onboard customers.** SparkLayer Forms is a flexible way to capture, review, and manage B2B information at every stage of the customer lifecycle — from first enquiry through to ongoing account management or even a contact form for your site. ::embed[]{url="https://www.youtube.com/embed/_M4QphRF9_k"} It includes a powerful workflow editor (available for pro plan customers) which provides functionality for automatically tagging, API calls to push your new customers to your ERP or even automatically approve customers where the tax ID is validated. Learn more [here](docId\:nn5qnfmfGkXlyUmAMpSnq). **Catalogs** [B2B Catalogs](https://apps.shopify.com/sparklayer-b2b-catalogs) is a free SparkLayer app (for Shopify) that gives you control over which products are visible to different types of customers on your Shopify store. Whether you want to hide specific products from B2C customers, restrict certain items to B2B customers only, or show different product ranges to different customer groups - B2B Catalogs makes it easy to manage from your Shopify admin.  **Sales agents' roles.** Sales agent roles let you control what each sales agent can see and do in SparkLayer - so the right people have the right level of access. Instead of managing permissions individually, you can create reusable roles and assign them across your team. Available for anyone with sales agents. Learn more [here](docId\:Uw8mDbMEfwWKqZrVB5CqX).  **Custom email domain** Improve brand recognition and deliverability with support for custom "from" email addresses (e.g. [store@mail.yourstore.com](mailto\:you@yourstore.com)), helping ensure notifications match your brand. Available on Pro and Enterprise plans. Learn more [here](docId\:Kf-Gd3nHSXlrn2zZvla1Y).  **🛠️ ****IMPROVEMENTS** - **Dashboard Customers and Sales Agent page** - New and improved visibility for customers, customers syncing and sales agents. - **Disable specific email templates - **Through a minor template change, it is possible to disable a email template and this could be actioned based on logic. Learn more [here](docId:8A4OpNIndUyfs3Pup-tuo). - **Package level invoicing for Xero/Quickbooks** - Invoices are now shown at package level rather than multiple invoices shown at the order level. - **Company Users** is now available for all plans. *** ## March, 2026 ### Version 4.3 **🛠️ ****IMPROVEMENTS** - **Shopify Company support - **SparkLayer will automatically place orders under the correct Shopify company when a customer is attached to one. Learn more in our full guide, [Shopify Companies](docId\:wrzSu8adFvbXOkF50hX5I) - **Multilingual Shopify Shipping support -** Support for multilingual shipping names when using Shopify shipping. *** ## Feburary, 2026 ### Version 4.1 **🎉 NEW FEATURES** **Payment Visibility within SparkLayer** Cut down on support admin by letting your customers check their financial standing themselves.  This new feature provides real-time account balances, payment statuses, and transaction histories directly in the My Account area. To read more see [Payment Methods](docId\:ibIKczvHM085BkeJIfFYv).  The key elements: - Payment status is now visible within the order listing and the order details tab (Paid, Unpaid, Partially Paid) - Transactions are now visible within the timeline section of the order. - The balance shown in the Account section has now been updated based on payments. This feature can be enabled easily via the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general). Compatible with Shopify, Xero, and QuickBooks Online. **🛠️ ****IMPROVEMENTS** - **Speed, Polish, and Performance Upgrades **(Version 4+) - **Speed Boost:** Enjoy snappier loading for products, carts, and accounts thanks to smarter caching. - **Visual Polish:** A cleaner, more refined look across the interface with improved layouts, spacing, and typography. - **Better Shopping Flows:** More reliable cart updates, smoother reordering, and a simplified quantity selector. - **Accessibility & Fixes:** Upgraded screen reader support, better right-to-left (RTL) language layouts, and a solid round of bug squashing. - **Dashboard Price Lists and Customer Groups page** - New and updated design for the price lists and customer groups page, we'll be rolling out more pages in this design over the coming months. - **Improved Product Selection Dropdowns -** Invalid selections on Product Details Page dropdowns are now hidden rather than disabled, creating a cleaner interface for your customers. (Version 3.17.0+) *** ## January, 2026 ### Version 3.15 **🛠️ ****IMPROVEMENTS** - **Discounts - Exclude Specific Customers** Discounts can now exclude specific customers using email addresses or accounting IDs, giving more control over who can use each promotion. [Learn more](docId\:WrejPw9URyjQwiQeKs_Cg) - **Quotes - New Email Notifications** We’ve added three new quote emails that the customer will receive, to make it clearer when a quote has been created or updated: - First response from a Sales Agent to a quote request - Subsequent quote updates made by a Sales Agent - New quote created by a Sales Agent and sent to a customer :::Paragraph{indent="1"} See the complete list of Quoting emails and their triggers [here](https://docs.sparklayer.io/quoting?_gl=1*1bx4hi3*_gcl_au*MTk0MDY4MDY5OC4xNzY5MDEwMDc2#email-notifications-sent). ::: *** ## December, 2025 🚀**COMING SOON** We're excited to announce that the **SparkLayer Xero and Quickbooks** integration is launching in March!  For early access, you can sign up to our [beta here](https://sparklayer.notion.site/27fddfba557a80f2869cd07e669ed17e?pvs=143). To learn more about how SparkLayer works with Xero, explore [our guide here.](docId\:WGhH4d8L-ys8zjOQmEoVx) *** ### Version 3.14 **🎉 NEW FEATURES** **Timeline & Communications ** Timeline & Communications has expanded beyond Quotes and is now available across **all supported order types**. Messages, internal notes and order updates are brought together in one clear, chronological timeline, giving your team and customers a unified place to track communication and activity as orders progress. :::Iframe{iframeHeight="0" code=""} ::: The result is a consistent, streamlined experience - whether you’re managing standard B2B orders, quotes, or draft orders created by Sales Agents. Learn more in [our guide here](docId\:Kf-Gd3nHSXlrn2zZvla1Y)**. ** *** ## November, 2025 ### Version 3.14 **🎉 NEW FEATURES** **Dashboard Design Updates** We’ve refreshed the SparkLayer dashboard with a streamlined sidebar that makes navigation simpler, faster, and more organised.  - **Customer and Product Sync** now sit under **Integrations**, alongside Platform Connection, Partner Integrations, and Widgets. - **Discounts** is now grouped with **Pricing**, alongside Price Lists and Price Editor, reducing clutter and keeping pricing tools together. The result is a **cleaner layout** and **clearer structure** that lets you focus on what matters most - your store’s performance. **🛠️ ****IMPROVEMENTS** - **Stock Display - Option to hide pre-order status** A new configuration within Customer Groups allows you to hide the “pre-order” stock status from customers. *** ## October, 2025 ### Version 3.14 **🎉 NEW FEATURES** **Quote Status Improvements** You can now **filter quotes by individual status**, giving you greater granularity and control when managing quotes. Previously shown in a single view, quotes can now be broken down by stage for easier tracking and follow-up.  Custom statuses are automatically included, and a new chevron indicator shows when more filters are available to scroll through. Statuses have also been reordered to reflect logical quote progression for a smoother workflow. **Shipping Restrictions by State/Province** You can now limit shipping methods to specific **states or provinces **within the US, Australia and Canada, allowing more precise regional control. This makes it easier to tailor delivery options, manage exclusions, and align shipping availability with your operational areas.  You can configure this directly under **Settings → Shipping Methods. ** **🛠️ ****IMPROVEMENTS** - **Quotes - CC Notifications to Child Company Users** Quote notifications sent to parent company users now CC child company users to keep both informed. - **AI Cart Import - Support for Multiple SKU Columns** AI Cart Import now supports files with multiple SKU columns (e.g. vendor SKU and product SKU) and auto-detects the correct one. - **Cart - Display Unit of Measure** Products with a single unit of measure now show it directly on the cart line item, without needing to hover. *** ## September, 2025 ### Version 3.12 **🛠️ ****IMPROVEMENTS** - **Shopify - Languages: support for product data translations** SparkLayer now has the ability to sync product data translations and show product data in the customer's language. This is currently only supported for Shopify stores. Please contact us if you'd like us to enable it on your store. [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) - **Shopify - Number of Cart Lines Supported** Previously we had a limit of 250, we now support 350 line items or 500 line items (by request due to the performance of the Shopify APIs). - **BigCommerce - Support for Combined Order Limit Rules** You can now use both SparkLayer’s product minimum and maximum order limit rules alongside the native BigCommerce rules, giving greater order management flexibility. - **BigCommerce - Support for Custom Order Visible ID** You can now use a custom order ID instead of the standard BigCommerce-generated ID. This is useful for matching order numbers with back-office systems (e.g. ERP) to ensure consistency across platforms. - **BigCommerce - Discount Rules Based on Product Properties** Discount rules can now check additional BigCommerce product properties when determining if a discount should be applied, such as; categories, brand ID, condition, UPC and search keywords. - **Wix - Removal of RRP Field from Sync** The RRP field has been removed from syncing to prevent it from displaying on frontend widgets. A product resync will be required for the change to take effect. - **Barcodes - Available on Invoices, Quotes & Emails** You can now add barcodes on Invoices, Quote PDFs and emails. - **Sales Agent - “Submit Quote” button update** Sales Agents will now see a “Submit Quote” button instead of “Request Quote” during the quoting process, making the action clearer. - **SparkLayer Core Script - Enhanced Error Codes** Error codes have been added for custom SparkLayer Options hook issues, making it easier for you to identify and resolve the cause of errors more quickly. - **Activity Section - Quote Status Update** The Activity section now shows the “Quote Status” instead of “Quote”, with the column below displaying the actual status (e.g. *Awaiting merchant”*). - **ERP Integration updates - Cin7, Brightpearl, Linnworks & Unleashed** Our ERP integrations have been improved so you can now view connection status, last sync, and any issues via **Settings → Integrations → Partner Integrations**, making it easier to resolve data syncing problems. *** ## August, 2025 ### Version 3.10 **🛠️ ****IMPROVEMENTS** **Use custom order IDs** It's now possible to use a **custom order ID** instead of the standard order ID generated from Shopify. A typical use-case is customising the Order ID to match order numbers generated from a back-office system (e.g. an ERP), ensuring consistency across systems.  When the "Visible ID" is set, this will then take effect when the customer views their orders from the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP). To enable this, please see [our guide here.](docId\:BxWnGB6b1n7QFfhTnu7pk) **Show a message at a cart line-item level**  Extending upon our [Custom Slots ("Targets")](docId\:l_2ooHJiY-rAx2chBMgP2) , you can now display a custom slot on a cart line-item level, such as a message that references the product name and ID ("slug"). This gives a powerful new way to add further customisation to the shopping cart for your B2B customers. *** ## July, 2025 ### Version 3.10 **🎉 NEW FEATURES** **Discount Engine Improvements**  We're excited to announce a range of major improvements to the SparkLayer [Discount Engine](docId\:WrejPw9URyjQwiQeKs_Cg), including the ability to: - Set advanced requirements and rewards. [Learn more](docId\:WrejPw9URyjQwiQeKs_Cg) - More extensive "free products" promotions. [Learn more](docId\:WrejPw9URyjQwiQeKs_Cg) The updates now allow you to configure discounts that apply on more advanced criteria such as matching a specific "tag" or "vendor" (within Shopify), and the ability to set rewards that include multiple free products. These changes now position SparkLayer as having one of the most advanced B2B promotions engines available - we look forward to seeing how creative our customers will be using this! [Learn more](docId\:WrejPw9URyjQwiQeKs_Cg) **🛠️ ****IMPROVEMENTS** - **Invoices - Option to display RRP** You can now choose to show the Recommended Retail Price (RRP) on SparkLayer [Invoices](docId\:NKh8H14Ffna5DD71SwwNd), giving your customers greater visibility on pricing. - **Cart - Clearer messaging when stock is limited** Customers will now see clearer messaging if they try to add more items to their cart than are available in stock, helping reduce confusion during the ordering process. *** ## June, 2025 ### Version 3.9 **🎉 NEW FEATURES** **Katana Integration** We're excited to announce our official integration with Katana, a leading inventory management solution!  If you're using Katana to manage your back-office operation, you can now integrate your B2B pricing and customer data directly with SparkLayer. [Learn more](docId\:goIlaInwUK3DbAJ0snj6t) **Onboarding Landing Page** A great way to encourage your customers to use your new B2B store is to **explain the benefits**. To help you get started, you can use our ready-made "onboarding landing page" that gives a great overview of the features to your customers. [Learn more](docId\:YUfghEGoxe_h7uJfcshna)  **🛠️ ****IMPROVEMENTS** - **My Account - Tax Display** When a customer places an order, they can now see their full tax breakdown when viewing their order details within the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) - **Shopify - New Customer Accounts URL redirect** If you're using Shopify Customer Accounts, you can now configure which URL to send a customer to directly via your Shopify admin. In your Shopify admin, go to Settings, Checkout, and within [Configurations](https://admin.shopify.com/settings/checkout#checkoutprofiles), click "Customize" and you'll see a new field "Redirect Path" within the "B2B Customers Redirect" extension. - **Checkout – Support for Tax ID Requirements** Merchants can now collect the required tax ID details at checkout, ensuring orders to countries with strict import rules can be completed in Shopify. [Learn more](docId\:o3nDhZBCxisWH6M6satDt) - **CSV file upload** When importing a CSV file into the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), products will be added to the cart in the same order as listed in the CSV file. - **New Languages** We now have support for Latvian on the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) - **Duplicate Discounts** It's now possible to create multiple discounts with the same configurations, making setup faster for similar pricing rules. [Learn more](docId\:WrejPw9URyjQwiQeKs_Cg) - **Checkout - Option to disable** You can now fully disable the checkout process and only show the "Request Quote" option, ideal for quote-only workflows. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) - **Sales Agent - Auto sign-in after Customer Creation** Sales agents are now automatically signed in as the customer after creating them, removing the need to search and impersonate separately. **** *** ## May, 2025 ### Version 3.9 **🎉 NEW FEATURES** **SparkLayer Intelligent Cart** SparkLayer Intelligent Cart introduces a revolutionary new way for your B2B customers and sales teams to build orders quickly and effortlessly using the power of AI. ::embed[]{url="https://www.youtube.com/embed/IhpfEUwKZXI"} The magic lies in its simplicity: files and emails containing order details (such as SKUs, barcodes, and quantities) can be uploaded or emailed directly to SparkLayer, instantly creating a shopping cart. In addition, live barcode scanning is supported, providing powerful, fast ways to build orders without manually browsing and searching for product. Learn how Intelligent Cart works in [our guide here](docId\:rIAcYwzOMfwSomd5KB5p8). ### Version 3.8 **🎉 NEW FEATURES** **Cart Search** We've just given our search tool a massive upgrade, making it even easier for your customers to add items to an order! ::embed[]{url="https://www.youtube.com/embed/61IRiGBcR6Q"} The Search tool allows customers to **search by a range of criteria** including product name, product SKU, product variant name, SKU, and barcode. The tool also handles mis-spellings and "partial matching", ensuring results are delivered where possible and allowing for a more user-friendly search. To learn more about how it works and how to enable it, see [our full guide here](docId\:efevur-A3yCJXUHvrR7t-). *** ## April, 2025 ### Version 3.7 **🎉 NEW FEATURES** **The SparkLayer Quoting Engine** We’re excited to announce the launch of the new [SparkLayer Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) , designed to transform how your sales team and wholesale customers manage quotes.  Built to simplify the entire "quote-to-order" process, it helps reduce manual work, speed up order conversion, and create a better buying experience. With the [SparkLayer Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo), you can: - Let customers build and submit quote requests directly from your store - Enable your sales team to edit quotes, apply discounts, and set expiry dates - Keep all communication in one place with a shared conversation timeline - Seamlessly convert approved quotes into ready-to-process orders - Notify customers and sales teams automatically with emails and special workflows - ... and a lot more! Whether you’re handling high-volume B2B orders or need more control over pricing negotiations, the [SparkLayer Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo)[ ](https://docs.sparklayer.io/quoting)brings everything into one streamlined flow, all designed to save time, reduce friction, and strengthen customer relationships. ::embed[]{url="https://www.youtube.com/embed/Lmjwg4RK0r8"} If you'd like to give it a try, head over to the [plan page here](https://app.sparklayer.io/settings/plan) where you can add it to an existing plan or as an exclusive addon. You can also learn more about how it works in [our guide here](docId:8A4OpNIndUyfs3Pup-tuo). **🛠️ ****IMPROVEMENTS** - **Integration with Intuitive Shipping** We've released our new integration with shipping application, [Intuitive Shipping](docId\:ZkesmMUAWX2SQQ7j6as07) making it even easier to connect SparkLayer to their dynamic shipping rate solution - **Pre-orders and stock display** We've improved how stock is shown in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) when a product is on pre-order. If a customer orders more than is in active stock, it will now clearly show what stock is available and what is on pre-order  *** ## March, 2025 ### Version 3.7 **🎉 NEW FEATURES** **SparkLayer Analytics** We're excited to announce a major advancement in how you can report on your B2B sales and performance! We’ve partnered with the leading analytics experts, Conjura, to add unparalleled operational and sales visibility to your SparkLayer account.  [Learn more](https://www.sparklayer.io/analytics/) about how this works and you can also arrange a demo to see how it can fit your business needs. **Automatic metafield creation** Metafields are a powerful way to customise the functionality of your B2B store, allowing you to configure additional data such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [rrp prices](docId\:S_VTlJBorGmnwjjfSMom9), and much more. With our latest update, we've made it really easy to quickly add metafields to your Shopify store without needing to manually configure them within your Shopify admin.  To get started, head over to the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/integrations/platform) or learn more in [our guide here](docId\:OTLHhi8sQ6oS4PAt23-8H). **Improved Shopify B2B Login Page** We've greatly improved our free [Shopify B2B Registration & Login](docId\:Gfc0UW7mJnMNpnNO6EdRl) template, making it really easy for you to add a login and signup form to your Shopify store.  The improvements include full control over the design and content, the ability to set different actions when a customer applies, and much more! [Learn more](docId\:Gfc0UW7mJnMNpnNO6EdRl) **🛠️ ****IMPROVEMENTS** - We've added the following additional [Custom Slots ("Targets")](https://docs.sparklayer.io/custom-slots#BvdCT) - Cart Shipping Step - Cart Payment Step - Account > Purchase Summary Header - Account > Purchase Summary Footer - For our SDK, we've added a `onCartLoad`as an additional function that can be used when the cart is loaded. Read more [here](https://docs.sparklayer.io/tech-docs/javascript-sdk). ### Version 3.6 **🎉 NEW FEATURES** **Sales Agents - Add custom item** We've released a major improvement to our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) tool that your sales team are going to love - the ability to add custom items to a B2B order!  Our new "Add custom item" feature lets your sales agents add additional items to a customer's order that sit outside of your general product catalogue. Use-cases could include adding custom instructions or details specific to an order, additional products (that don't have a specific SKU), or any custom item that needs to be associated with an order. Items can be added at a specific cost or at a zero cost value. [Learn more](docId\:Uw8mDbMEfwWKqZrVB5CqX) **🛠️ ****IMPROVEMENTS** - **My Account - Order details** When viewing an order from the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP), products that have variants (e.g. colour, size) will show the full variant information (previously this wasn't visible). *** ## February, 2025 ### Version 3.5 **🎉 NEW FEATURES** **SparkLayer Invoices** It's here... one of our most requested features of all time has arrived: *SparkLayer Invoices!* The [SparkLayer Invoices](docId\:NKh8H14Ffna5DD71SwwNd) feature allows you to automatically generate professional invoices that your customers can easily download, directly from their My Account.  SparkLayer's invoicing feature **removes the need** for third-party invoicing tools or apps and offers a seamless way to manage and share invoices with your B2B customers. Once you've enabled invoices via the setting detailed above, the process for viewing and downloading invoices is simple for your customers. Watch our short video below to see: ::embed[]{url="https://www.youtube.com/embed/-LeGyR2E3F0"} Interested in trying out SparkLayer Invoices? Learn more in [our guide here](docId\:NKh8H14Ffna5DD71SwwNd). ### Version 3.3 **🎉 NEW FEATURES** **Shipping discounts ** It's now possible to set shipping discounts when using SparkLayer [Discounts](docId\:WrejPw9URyjQwiQeKs_Cg)! This has been one of our most requested features for our Discount Engine, and it gives you the option to set a range of different shipping discount types. From percentage off and fixed discounts, through to setting a specific shipping cost when the discount is applied.  Using this feature does require enabling the SparkLayer [shipping system](docId\:CfZ_ZpGw2umOVAo73Lc5m) and you can learn more in [our guide here.](docId\:WrejPw9URyjQwiQeKs_Cg) **🛠️ ****IMPROVEMENTS** - **Sales Agents - Creating New Customers** For Sales Agents with "Adminstrator" priveleges, when inviting a new customer via SparkLayer, it's now possible to disable the "Invite" email that is sent to the customer. This is available for all merchants using Shopify. [Learn more](docId\:Uw8mDbMEfwWKqZrVB5CqX) ### Version 3.2 **🎉 NEW FEATURES** **Show RRP prices only (for in-store shopping)** If you manage orders in physical locations with customers (e.g. in store), it's possible to enable a setting that sets the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) to **only** show the RRP (or "MSRP) prices when browsing and adding items to an order. This is especially useful if you need to "obscure" your B2B prices from view and you only want to show the full retail prices. :::Iframe{iframeHeight="0" code=""} ::: Use-cases could include: - In-store customer visits where an order needs to be placed and the customer must only be able to see the retail (RRP) prices - Sales teams who are placing orders on behalf of customers (e.g. on the road) and only the retail (RRP) prices must be seen Learn more about how this works in [our guide here](docId\:S_VTlJBorGmnwjjfSMom9). *** ## January, 2025 ### Version 3.1 **🎉 NEW FEATURES** **Sales agents - custom shipping methods** One of the most requested features for our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) tool is to allow sales agents to make changes to the shipping costs during the checkout. We've now released the ability for sales agents to set custom shipping prices for any orders they place on behalf of their customers. :::Iframe{iframeHeight="0" code=""} ::: To learn more about how this works, see [our guide here](docId\:Uw8mDbMEfwWKqZrVB5CqX). **Order searching and filtering by date** It's now possible for B2B customers to search and filter orders by date range within the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP). This is a great way to quickly see orders based on specific criteria and time period, making it easier to keep track of order activity.  To see this in action, click "View All" within "Recent Activity" and you'll see the option to search and filter your orders. **🛠️ ****IMPROVEMENTS** **Mobile layout improvements** We've made improvements to the [Cart & Checkout](docId\:o3nDhZBCxisWH6M6satDt) to better support smaller (mobile) devices. When a B2B customer is using SparkLayer on these devices, the interface will now show more line items and offer an easier way to navigate between checkout steps.  **Shopify - improved handling of B2B prices** :::hint{type="info"} **Please note** From 1st February 2025, this feature is enabled by default. If you started using SparkLayer before this date and you'd like to enable this on your Shopfy store, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and our team will action this for you. This is an optional feature and it is not mandatory to enable. ::: We've improved how SparkLayer handles pricing in Shopify, removing the need for B2B pricing to be applied as a "discount". When a B2B customer now places an order, the price shown against a product will exactly match the B2B pricing you set via SparkLayer [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT). To iillustrate the difference, the screenshot below shows how pricing was calculated previously (using a discount against the line item product price)  With the latest change, the price shown will exactly match your B2B pricing without needing to apply a discount.  **Shopify - support for new customer accounts** If you're using [Shopify](docId:7TmhkOEHbgEGGFdd6EMr1) and you'd prefer to use Shopify's new "Customer Account" feature, SparkLayer is now fully compatible. This means that SparkLayer can now work with Shopify stores that use either new "Customer Accounts" or classic "Legacy Accounts". To learn more, read [our guide here](docId:687ZiSnQ7rsITCGjjKFyb). *** ## December, 2024 ### Version 2.1.0 **🎉 NEW FEATURES** **Change ownership status in the Dashboard** If you have multiple users invited to your [Dashboard](docId\:nzsx6U_DAWtzVzSehf4oR), you can now easily transfer ownership to another user. This is especially useful if you're initally setting up SparkLayer and you want another user to manage the ongoing account management.  To learn more about how this works, head over to [our guide here](docId\:r9NG74uJdtyWlvGbpnB5u). *** ## November, 2024 ### Version 2.1.0 **🎉 NEW FEATURES** **Integrating Google Analytics with SparkLayer** If you're looking to track key events in Google Analytics (GA4) or Google Tag Manager (GTM) through SparkLayer, you can now set this up directly in your integration. This will help you capture valuable B2B events like "add to cart" "checkout," and "purchase" actions. [Learn more](docId\:qD08Q-eiJ2-8k1MweLqca) **New Email Notifications for Company Users** We've now added the ability for Company Users to receive emails when "Limited Users" submit an order for a review. Email notifications are sent to both the "main" and "limited" Company Users at key stages of the order review process, without requiring them to be logged in. You can learn more about how this works in [our guide here](docId:_WwfeWVJY9xrSuNCQlFoZ) *** ## October, 2024 ### Version 2.0.8 **🎉 NEW FEATURES** **Product Matrix Interface** We've introduced a major update to our [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) that now lets you convert your product pages into a special "product matrix" table view, making it even easier for your customers to order products! ::embed[]{url="https://www.youtube.com/embed/cloM8_DJ7eg"} If your products come in multiple variant types (e.g. colour and size), it's a great way to allow customers to quickly see all variants available and purchase them. To learn more about how this works, please see [our guide here](docId:8Go0NYHFDmYnwlJSNfO-S). **Order details** When viewing an order within the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP), if an order has more than 10 unique items, a "View all" link will now show allowing the customer to see all items in one go.  *** ## September, 2024 ### Version 2.0.2 **🎉 NEW FEATURES** **Custom checkout fields - support for new fields** If you need to collect additional data from your B2B customers during the checkout, our [custom checkout fields](docId\:o3nDhZBCxisWH6M6satDt) now supports the ability to add drop-down menus ("select" menus). :::Iframe{iframeHeight="0" code=""} ::: For example, you may want to give customers a list of options to choose from to include in their order and it's even possible to group the options with different headings. You can learn more about how this works in [our guide here.](docId\:o3nDhZBCxisWH6M6satDt) **Stock display improvements** :::hint{type="info"} **Please note** This feature requires being on the latest version of SparkLayer. To benefit from our latest updates, please upgrade your [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). ::: It's possible to display [stock levels](docId\:Gj_Ao_gQ6oA-jx0D27Hys) to your B2B customers when they browse your store, giving them visibility of your inventory. Our latest update now gives you even more flexibility and has a number of major improvements.  Firstly, it's now possible to display stock levels on a per-customer group basis. For example, you may have some customer groups that you don't want to show inventory to or you may want to configure specific stock settings. You can also now hide and show the specific inventory count and just show a stock status (e.g. `In stock` versus `In stock [100 available].`) Beyond this, we've also simplified how you can manage max/low/last stock levels and you can learn more in [our full guide here](docId:5_lWMNohhjBJJppg9E6Vh). **🛠️ ****IMPROVEMENTS** - **My Account Addresses** When adding or editing an address within the My Account area, the `First Name` and `Last Name` fields are now mandatory. *** ## August, 2024 ### Version 1.36.16 **🎉 NEW FEATURES** **Line Item Tax Support**  If you sell products that have different tax requirements, you'll like our latest update! We've just released full support for "line item tax", ensuring your B2B customers see fully accurate tax calcualtions when checking out. This feature is ideal if you have more complex tax requirements for your catalogue (e.g. you're selling coffee, children's clothing, or products that have varying tax obligations). You can see a full overview of how it works in [our full guide here](docId\:ZSsXG6FjRLCod_GxoluTN). **🛠️ ****IMPROVEMENTS** - **Sales Agents within the SparkLayer Dashboard** Based on customer feedback, we've made it easier to access Sales Agents within the SparkLayer Dashboard. You'll see this in the main navigation when signing in, or you can [access it here](https://app.sparklayer.io/sales-agents). *** ## July, 2024 **🎉 NEW FEATURES** **B2B Discount Engine!** It's here... our most request feature EVER! The [SparkLayer Discount Engine](docId\:WrejPw9URyjQwiQeKs_Cg). :::Iframe{iframeHeight="0" code=""} ::: Our new Discount Engine immediately unlocks a range of discount rules, with more to come in the future. Right now, you'll be able to set up: - **Order-level discounts:** eg, spend $1,000 and get 10% off, spend $2,000 and get 15% off - **Percentage and fixed discounts: **eg, 20% off an order total, $100 off an order total - **Coupon codes:** eg, enter code NEWCUSTOMER and get 5% off - **Scheduled discounts:** eg, start discount today and end it on a specific date and time - **Customer-specific discounts:** eg, only allow customer group ‘b2b-vip’ qualify for the discount You can see a full overview of what’s possible in [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg). **Custom slots (add custom code)** Custom slots have arrived! You can now add custom code to a range of the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) allowing you to customise the B2B experience for your customers. ::embed[]{url="https://www.youtube.com/embed/pAfXYvYnY2M"} It's a great way to further enhance your B2B customer experience and use-cases could include displaying promotional messages, links to pages within your store, and much more! [Learn more](docId\:l_2ooHJiY-rAx2chBMgP2) **🛠️ ****IMPROVEMENTS** - **Purchase history re-ordering** When viewing the Purchase History in the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP), you can now add individual items directly to any order *** ## June, 2024 **🎉 NEW FEATURES** **File uploads (checkout and product-level)** We're excited to announce the launch of one of our top 5 most requested features, file uploads! As of today, your B2B customers can now upload file attachments during the checkout process, allowing you to capture additional information such as Purchase Orders, custom files (e.g. for personalisation) and much more. ::embed[]{url="https://www.youtube.com/embed/UgmP800AdKw"} And there's more! In addition to file uploads during the checkout, you can now configure product-level file uploads! Learn more in [our guide here](docId\:o3nDhZBCxisWH6M6satDt). **Stock location support ("inventory locations')** As brands scale their operations and build out more advanced inventory management processes, it’s very common to see multiple ‘locations’ where inventory is managed. This could be based on geographic location (eg by country) or by more niche use cases specific to a brand’s internal workflows, like routing stock based on what type of customer is ordering.  Stock locations allow you to specify which stock (or "inventory") locations you want your B2B customers to use stock from. If your B2B store is set up with **multiple stock locations** (e.g. by geography), it's a great way to ensure your B2B customers are purchasing stock from the correct locations. Learn more in [our guide here](docId:5_lWMNohhjBJJppg9E6Vh) *** ## May, 2024 **🎉 NEW FEATURES** **New Customer Groups interface ** We've just released a major improvement to the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups), making it easier to manage your B2B customer rules! We've completely reworked how your customer groups are displayed with a new and improved way to quickly manage all your customer groups settings from one place. The update also includes new visibility of "customer group inheritance", allowing you to see which rules are being used from another customer group. Check our video below or head on over to the new [Customer Groups area](https://app.sparklayer.io/customers/groups)! ::embed[]{url="https://www.youtube.com/embed/BWRQiC7wL20"} **🛠️ ****IMPROVEMENTS** - **Price list improvements:** It's now possible to set up a price list to support a 100% discount against an automatic price source (e.g. your Shopify retail prices). This is useful if you have a requirement to allow specific B2B customers to purchase products at a zero-rated cost (e.g. $0.00) - **My account credit limits now support multi-currency** If you're store is set up to allow multiple currencies for your B2B customers and you're using [credit limits and account balances](docId\:yWm70oQUosyKOoIqb4Z4G), you can now configure these specific to the customer's currency (e.g. GBP, EUR, USD) *** :::hint{type="success"} You can also browse previous years of SparkLayer updates in the [Archive](docId\:PrMonZpQ1alqecIArYRWb) ::: [title] Refund Policy [path] Useful Links/Policies/ ## Introduction This policy applies to all SparkLayer services across all supported eCommerce platforms and apps. Before requesting a refund, we encourage you to contact us at **support\@sparklayer.io** if you encounter billing questions, technical issues, or need development help. Our team aims to respond within **24 hours on weekdays** and **48–72 hours over weekends**. Refund requests are considered in full once we have reviewed and attempted to resolve the reported issue. *** ## Eligibility Refunds are issued specifically for significant technical problems that cause data loss or major disruption, and only when a fix cannot be provided. - **Monthly Subscriptions:** Requests must be made within **5 days** of the current billing period. - **Annual Subscriptions:** Requests must be made within **7 days** of the current billing period. - If you cancel an annual plan mid-term, approved refunds are calculated by taking the total paid, subtracting the months used (at the original monthly rate), and subtracting any Shopify processing fees. - **Trial Overrun:** If you forget to cancel before a trial ends, you may receive **50% off** the first billing cycle if requested within 5 days (monthly) or 7 days (annual). *** ## Non-refundable scenarios As we provide a free trial for evaluation, refunds are not offered for the following: - Change of mind or accidental purchases. - Apps purchased at a reduced price or used only for testing. - Lack of technical ability to use the app. - Requests for goodwill, previous billing periods, or custom development services. - Conflicts caused by third-party themes or other apps. *** ## How to request a refund 1. **Contact Support:** Email us at **support\@sparklayer.io**. 2. **Provide Evidence:** Include screenshots, videos, or URLs to help us diagnose the issue. 3. **Keep the App Installed:** Do not uninstall the app before reaching out. We can only investigate issues while the app is installed; once uninstalled, data is removed and we cannot assist. *** ## Processing and Shopify Billing - **Approval:** If approved, refunds are processed immediately if you have already been charged. If the charge is pending, you may need to wait for the eCommerce provider to complete the cycle. - **Shopify Users:** App billing and refunds are managed by Shopify’s system, not SparkLayer. We cannot directly stop future Shopify charges. Refunds via Shopify can only be issued after the current billing cycle is complete. You may also contact Shopify directly regarding charges. *** ## Before you uninstall If you plan to remove SparkLayer, please contact us first. We can help remove any remaining app code and ensure the uninstall doesn't affect your store's performance [title] Security Policy [path] Useful Links/Policies/ :::hint{type="info"} This policy has moved to the SparkLayer Trust Center. The current version is at [www.sparklayer.io/trust/security](http://www.sparklayer.io/trust/security). It covers hosting, encryption, authentication, access control, secure development, backups and review. ::: [title] FAQs [path] Useful Links/ ## Introduction Looking to better understand how SparkLayer works? We've included some of our most common questions below! ### ℹ️ General :::ExpandableHeading **What can I do with SparkLayer?** SparkLayer gives you an easy way to enable B2B (wholesale) on your existing website. You don't need to create a new store or spend time and money trying to customise your B2B experience. SparkLayer does all this for you and, once you're set up, you'll be able to: - Enable custom pricing for your B2B customers - Give your B2B customers a self-service ordering experience - Accept B2B payments, such as "net payments" and "payment on account" - Allow your sales team (sales reps) to place orders on behalf of B2B customers using [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) - Configure more advanced pricing rules, such as pack sizing and quantity price price-breaks - Enable rapid re-ordering, making it easy for your customers to repeat order - Manage the full "quote to order" process using our [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) - Allow your B2B customers to save shopping lists - Configure pre-ordering and back-ordering rules - Allow your B2B customers to create company teams And so much more! SparkLayer has over 100 B2B features right out of the box. Plus our team can get everything set up for you with our free onboarding service. ::: :::ExpandableHeading **Do you have a demo store to test SparkLayer?** Yes! Please see [Try our Demo](docId:87ILO_vHmG3XUXKecOLXv) ::: :::ExpandableHeading **Which eCommerce platforms and systems does SparkLayer integrate with?** SparkLayer works Shopify and BigCommerce with more platforms coming soon! For Shopify, our officially approved 5-star rated SparkLayer Shopify App means you can integrate with SparkLayer with total confidence. SparkLayer also integrates with a range of other systems, from payment gateways to multi-channel operations platforms. ::: :::ExpandableHeading **How does SparkLayer compare to other B2B solutions?** A good question! There are many B2B solutions on the market and each offer a variety of benefits that may suit specific use-cases or customer types. Beyond functionality and features, there is one major benefit of SparkLayer that makes it compelling - you get to use your existing website and SparkLayer simply 'layers' on top (hence the name, SparkLayer!). Many other solutions are built as 'web portals' meaning customers have to use an entirely separate website. Whilst this may be useful, if you already have an existing website (e.g. for your DTC retail customers) or you use an eCommerce platform you're already familiar with, you'll need to manage multiple systems and tools which can add operational complexity. We'd be happy to discuss this in more detail! ::: :::ExpandableHeading **How much does SparkLayer cost?** Please refer to our [pricing](https://www.sparklayer.io/pricing/) for more details. ::: :::ExpandableHeading **What support do you have and where are you based?** Our head office is located in the beautiful English city of Bath and our team is all based in close proximity. Since we're UK based, we typically operate our support on UK timezones (Monday to Friday, 8am to 6pm GMT) however we are able to accommodate specific requests should you require assistance outside of these hours. Please speak to our team and we'll be happy to advise. ::: ### 🛠️ Setup & Installation :::ExpandableHeading **How do I enable SparkLayer on my store?** For Shopify and BigCommerce, you'll simply need to install our official [Shopify](https://apps.shopify.com/sparklayer) or [BigCommerce](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/) app and go through our simple onboarding process. When your SparkLayer account is created, our online onboarding process guides you through all the elements of installing SparkLayer on your store and we're here to help if you require assistance. ::: :::ExpandableHeading **How long does SparkLayer take to set up?** If you're using our built-in tools to manage your pricing and customers, it's possible to set up SparkLayer in a matter of hours (or less!). Our team is on-hand to guide you through the set up process and can even help set up on your Shopify store for you. For most extensive integrations - typically merchants using our Enterprise plan that require backend connections - set up times vary and we'll work closely with you to create a full project plan. ::: :::ExpandableHeading **Do I need to hire a developer to integrate the SparkLayer?** No! SparkLayer is really simple to install and we have full step-by-step instructions once you sign up. If you have access to your Shopify storefront theme, it's possible for anyone to do. If you like, we can even install for you if you require any assistance. ::: :::ExpandableHeading **Can I run my B2C store alongside my B2B store?** Yes! It's possible to install SparkLayer onto your existing B2C store (i.e. retail), meaning you can run both B2C and B2B on the same store. We call this a 'hybrid setup'. When your B2B customers sign in, they simply see the special SparkLayer frontend widgets that allow them to see their prices and place orders. ::: :::ExpandableHeading **Can I use SparkLayer on a custom platform?** Yes, providing you're able to integrate your platform with an external API. Learn more about the [SparkLayer API](https://docs.sparklayer.io/sparklayer-technicals/the-sparklayer-api) ::: :::ExpandableHeading **Can I customise how the SparkLayer Frontend looks?** Yes, you're able to change styling such as fonts, colours (e.g. of buttons) and spacing easily via CSS to match your current eCommerce store and typically you can get SparkLayer to fit seamlessly with your website look and feel. ::: :::ExpandableHeading **Do I manage my online product catalogue within SparkLayer?** No, the product catalogue and category management is done through your existing eCommerce platform. SparkLayer simply 'overlays' your existing product catalogue with the B2B-specific data such as product pricing and pack sizes. It does this by associating data to the specific product SKU behind-the-scenes and then showing the appropriate content to the customer. ::: :::ExpandableHeading **Will SparkLayer slow my website down?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (B2C) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **Does SparkLayer work across different devices?** Yes, SparkLayer is fully compatible with mobile, tablet, and desktop devices. ::: ### ⭐ Features :::ExpandableHeading **How do I learn more about the SparkLayer features?** You can learn more in [Frontend](docId\:OgKfvQX13dHW2582D57kJ) ::: :::ExpandableHeading **Does SparkLayer process payments?** No, SparkLayer does not handle payment processing and instead simply uses the payment methods set up within your eCommerce platform, e.g. Shopify. It's possible to set up both offline payment methods for your B2B customers (e.g. Pay on Account or Pay by Invoice) as well having them pay online via card. ::: :::ExpandableHeading **Do I need to have an ERP, PIM, CRM or iPaaS integration to use SparkLayer?** No. With our powerful import tools, you can configure pricing and customer rules all through the SparkLayer Dashboard without the need to have a backend system in place. If you are looking to use a backend system, SparkLayer works by connecting directly to your central data sources to retrieve your B2B data. If you're using an iPaaS solution (integration platform as a service), SparkLayer can connect directly to this instead, negating the need to connect to an ERP directly. If you have the technical expertise, the SparkLayer API lets you connect to any system and we also have a range of 'ready-made' integrations ::: :::ExpandableHeading **I have an ERP integration already, will SparkLayer work with it?** The short answer, it depends! If your online store is already connected to your ERP system, there's a good chance that no further integration work is required to connect SparkLayer. When orders are placed via SparkLayer, they'll simply be created like any other which your ERP system can then subsequently import. The same also applies to product stock data, SparkLayer will use stock levels already available on your eCommerce store. If you're looking for a more in-depth integration, such as synchronising B2B pricing, this would require an integration ::: :::ExpandableHeading **Can I create custom price lists within SparkLayer?** Yes. Within the SparkLayer Dashboard, you can manually create price lists and upload pricing data for each one you create. You can learn more in [Pricing FAQs](docId\:smlS3A5lRCGShNu_XLuNN) ::: :::ExpandableHeading **Can I automate B2B pricing, e.g. a discount off my store's retail prices?** Yes. SparkLayer's powerful pricing engine lets you create automated rules for your B2B price lists. For example, if you're using Shopify, you can easily set up a B2B price list that applies 20% off your Shopify prices. ::: *** ## Explore more You can also explore more FAQs in the following guides: - [Shopify FAQs](docId\:P-7titr2d20hXBeixvKBZ) - [BigCommerce FAQs](docId\:KZrw-fFscozjvGMLwPoIB) - [Pricing FAQs](docId\:smlS3A5lRCGShNu_XLuNN) [title] Product Settings [path] Features/Configurations/ ## Introduction Whilst it’s possible to configure product settings for all customers across your website (e.g pack sizes, reserve stock quantities), you can also apply these product settings to** specific customer groups**, giving you a high degree of control over what product options are available to your customers. *** ## Available product settings You can apply any of the following product settings to customer groups: | Name | Type | Description | | --------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `customer_group` | `string` | Customer Group - settings will be applied to this customer group | | `pack_size` | `integer or null` | Only allow the product to be purchased in multiples of x
`Default: 1` | | `reserve_stock_quantity` | `integer or null` | Reserve stock quantity - always ensure x amount of stock is left (generally used to ensure DTC has availability)
`Default: null` | | `min_order_quantity` | `integer or null` | Only allow the product to be bought in a minimum of x
`Default: null` | | `max_order_quantity` | `integer or null` | Only allow the product to be bought in a maximum of x
`Default: null` | | `min_order_parent_quantity` | `integer or null` | Only allow the product to be bought in a minimum of x across all variants
`Default: null` | | `max_order_parent_quantity` | `integer or null` | Only allow the product to be bought in a maximum of x across all variants
`Default: null` | | `display` | `boolean or null` | Allow the product to display on the frontend
`Default: null` | | `sell` | `boolean or null` | Allow the product to be added to the cart
`Default: null` | *** ## Settings Configuration To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Variants](https://admin.shopify.com/store/oversoles/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `settings` | | `Value` | This must be set up in this format
`[{"customer_group": "base","pack_size": 1,"reserve_stock_quantity": 10,"min_order_quantity": 5,"max_order_quantity": 50,"min_order_parent_quantity": 5,"max_order_parent_quantity": 50,"display": true,"sell": true}]` | :::hint{type="warning" attributes="[object Object]"} **Please note** - You can find the value for `customer_group` in your [dashboard](https://app.sparklayer.io/customers/groups) in the "Name" column, e.g. `Base` - When setting a `customer_group`, always enter it as lowercase. E.g. `Base` becomes `base` - See table *Available settings to apply to customer groups* above for accepted inputs for each `Value` - In the metafield `Value`, you only need to include the settings that you actually want to set - you can either remove the unused settings, leaving only `customer_group` and the settings you wish to configure, or leave them set to `null` - Make sure that every line ends with a comma, **except for the last line** ::: For example, if you only wanted to configure minimum order quantity of 5 and a maximum order quantity of 50 for the customer group 'Gold tier', the `Value` would look like this: ```javascript [ { "customer_group": "gold-tier", "min_order_quantity": 5, "max_order_quantity": 50 } ] ``` *** ## Example use cases ::::ExpandableHeading **Example 1: Exclusive products** Company X has two customer groups: 1. Base (standard B2B customers) 2. Gold tier (a group of preferred customers who have access to discounted pricing and exclusive products) As part of their preferential terms, Gold tier customers have access to a range of exclusive products which are not available to Base customers. ```javascript [ { "customer_group": "base", "display": false, "sell": false } ] ``` :::hint{type="info" attributes="[object Object]"} **Please note** Product variants that have this metafield applied will only be visible to Gold tier customers. By default all products are visible to all customer groups, we do not need to explicitly make these products visible to Gold tier customers, instead we simply need to hide them from Base customers. ::: Please make sure that you add the following metafield to the variants you wish to remain showing to the base group: ```javascript [ { "customer_group": "base", "display": true, "sell": true } ] ``` :::: ::::ExpandableHeading **Example 2: Customer group specific pack sizes** Company X has two customer groups: 1. Wholesale customers (other businesses who stock their products) 2. Influencers (people who advertise their products on social media) Their influencers only need to order single units to showcase their products on social media, whereas their wholesale customers need to order large quantities for their stock. Company X wants to configure their products to be sold individually to the influencer customer group, and in pack sizes of 50 to the wholesale customer group. ```text [ { "customer_group":"base", "pack_size":50 }, { "customer_group":"influencer", "pack_size":1 } ] ``` :::hint{type="info" attributes="[object Object]"} **Please note** When the customer group is set to “base”, this applies to all customer groups. In the second array, we specify that the specific customer group “influencer” is set with a pack size of 1. ::: :::: [title] Product Card Interface [path] Features/Frontend Interfaces/ ## Introduction The Product Card Interface lets you display B2B pricing and the ability to add products to an order anywhere a "product card" is shown on your website. Typically this includes product collection (or "category") pages, and product upsells.  :::hint{type="success"} **SparkLayer Interactive Demo** You can explore how the SparkLayer Product Page Interfaces work in [our interactive demo](https://www.figma.com/proto/5FPCY5hSGl7mlwjsjMZI2t/SparkLayer-Interfaces?page-id=0%3A1\&type=design\&node-id=86-36708\&viewport=554%2C-398%2C0.33\&t=34VlPwbCqpvQOTsh-8\&scaling=min-zoom\&starting-point-node-id=35%3A7920\&hide-ui=1). ::: *** ## How it works The Product Card Interface replaces your existing website's product card pricing and "add to cart" area with a specially-optimised layout. Once set up, it provides B2B customers an easy way to see their pricing and begin adding products to their order. The interface can show the following information: | Item | Details | | ------------------ | ---------------------------------------------------------------------------------------------------- | | `Product pricing` | Their specific B2B pricing and, optionally, RRP pricing | | `Variants` | A drop down list of available variants | | `Quantity` | The ability to select the quantity of a product using [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) | | `Add to order` | The ability to add items to an order | | `Quantity pricing` | Visibility of quantity pricing available | | `Stock level` | The stock status of a product (e.g. pre-order) | | `SKU` | The product code (SKU) | *** ## Integrating the code To add the Product Card Interface to your website, you just need to add a single line of code to the product cards that display on your collection pages. ```javascript
items\[instance1].sku
items\[instance2].quantity
items\[instance2].sku | You typically won’t need to manage this directly — but it helps when building workflows or automations. *** ## 💡 Best practices To keep your forms easy to manage: - Group related fields together - Avoid overly long pages - Avoid multiple levels of nested groups - Use consistent naming [title] Account Credit Request Form [path] Features/Forms/Use Cases/ Use an account credit request form to let logged-in B2B customers request credit for one or more items from a recent purchase. This is useful when customers need to report damaged items, missing items, incorrect products, quality issues, pricing issues, or other order problems. With SparkLayer Forms, you can collect the request from the customer, ask for the right supporting details, review the request internally, and trigger follow-up actions such as emails or API requests. ## What You’ll Build In this guide, you’ll create a form that lets customers: - Select a recent purchase - Add one or more line items they want credit for - Choose a reason for each line item - Provide extra details depending on the reason - Upload photos or supporting files - Submit the request for review You’ll also create internal fields so your team can: - Track the request status - Assign the request to a team member - Approve or decline the request - Record approved credit amounts - Add internal notes - Trigger actions when a request is approved or declined ## How the Process Works A typical account credit request process looks like this: 1. The customer opens the credit request form. 2. The customer selects the purchase they want to query. 3. The customer adds each affected line item. 4. The customer chooses a reason for each line item. 5. The form shows extra fields based on the selected reason. 6. The customer uploads photos or files if needed. 7. The customer submits the request. 8. Your team reviews the request internally. 9. The request is approved, declined, or sent to another system for action. You can start with a simple version and add more automation later. A simple version might only collect the request and notify your team. An advanced version might also use internal approval buttons, automatic credit application to the account on approval, and send data to other systems. ## Before You Start This setup works best when customers are logged in before opening the form. That allows SparkLayer to identify the customer and, where available, use their customer data, purchase data, and customer group data. Before building the form, decide: - Which purchase or order data customers should be able to select from - Which credit reasons you want to support - What evidence is required for each reason - Who reviews requests internally - Whether customers should receive confirmation emails - What should happen after approval or decline For example, approval might send the request to your ERP, helpdesk, finance system, or customer support team. :::hint{type="info"} Please note that as we will use the logged in customer in this form to show the relevant data, it is important to test this form by embedding it on a page (which could initially be private/hidden) on your eCommerce store where SparkLayer Core Script is available and works. The form builder Preview tab will not be able to show the right dynamic purchases options as there is no logged in customer context available. ::: ## Build the Customer Form Create a new form called **Account Credit Request**. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/nVYByWEdqN_Dfz2g7usrb_image.png" size="70" width="1398" height="902" position="center" darkWidth="1398" darkHeight="902" showCaption="false"} In the form builder, go to **Form** and add the main customer-facing fields. Recommended fields: | **Field** | **Type** | **Notes** | | -------------------------------- | --------------- | --------------------------------------------------------------------------------------- | | Purchase / Order | Select | Let the customer choose the purchase this request relates to. | | Credit request items | Field Group | Mark this group repeatable so customers can add multiple line items. | | | | | | **Sub-fields inside the group:** | | | | Reason category | Select or Radio | Example reasons: Damaged, Missing, Incorrect item, Quality issue, Pricing issue, Other. | | Line item | Select | Options should come from the selected purchase. | | Quantity affected | Number | Useful when only part of a line item needs credit. | | Reason for credit request | Long text | Let the customer explain the issue. | | Supporting files | File upload | Use for photos, delivery notes, or other evidence. | | Preferred resolution | Select or radio | Optional. Example: Credit note, replacement, contact me. | For the repeatable group: 1. Add a **Group** field. 2. Name it **Credit request items**. 3. Enable **Repeatable**. 4. Add the line item, reason, quantity, description, and file upload fields inside the group. A repeatable group is useful here because one purchase can have more than one item that needs credit. At this point, the form field setup might look like this:  ## Add Purchase and Line Item Options The **Purchase / Order** field should use a data source instead of manual options. For the **Purchase / Order** field: 1. Select the field. 2. Open **Options**. 3. Choose **Data source:** ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/dGeWsH-ySkDUC_rARU4NV_image.png" size="72" width="928" height="484" position="center" darkWidth="928" darkHeight="484" showCaption="false" indent="3"} 4. Click on *"Select data source..."*, then in the reference picker popup click *"See advanced options"* to see all options and not just the form fields: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/TetWpKAHafFkV6E31pA0A_image.png" size="92" width="1396" height="806" position="center" darkWidth="1396" darkHeight="806" showCaption="false" indent="3"} 5. Add a reference from SparkLayer purchase data for the current entry customer 1. `SparkLayer -> Purchasing -> Entry Customer's Purchases` (click Select) 6. Then, choose a clear label, by clicking on "Option label field" reference. For instance you might want to use the `Purchase Identifiers -> Visible ID` field. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/NODzOLRj-WTKFXrOfrHB3-20260602-135020.png" size="64" width="924" height="318" position="center" darkWidth="924" darkHeight="318" showCaption="false" indent="3"} For the **Line item** field inside the repeatable group: 1. Select the line item field. 2. Open **Options**. 3. Choose **Data source**. 4. Find the reference for the selected purchase (under advanced options again): 1. SparkLayer -> Purchasing 2. Then under "Specific Purchase by SparkLayer ID" input click Reference 3. Select the Purchase / Order field you setup previously ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/88TaL3mi_grFpRc-8srAG-20260602-135311.png" size="100" width="1410" height="1388" darkWidth="1410" darkHeight="1388" position="center" showCaption="false" indent="4"} 5. Now scroll down and click the Select button for the "All Packages' Line Items" option ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/geN27FkOSOo9QSa5Klm2E-20260602-135433.png" size="90" width="1346" height="682" position="center" darkWidth="1346" darkHeight="682" showCaption="false" indent="3"} 6. Then, choose a clear label for the line item select by clicking on "Option label field" reference button. A good option might be "Line item Identifiers -> SKU". ## Optional: Show Extra Questions Based on Reason Use display logic to show only the fields that matter for each reason. Examples: | Reason | Extra fields to show | | ----------------------- | ------------------------------------------ | | Damaged item | Photo upload, damage description | | Missing item | Missing quantity, delivery note upload | | Incorrect item received | Expected item, item received, photo upload | | Quality issue | Description, photo upload | | Pricing issue | Expected price, explanation | | Other | General explanation | To set this up: 1. Select the field you want to show conditionally. 2. Open **Display logic**. 3. Add a rule based on **Credit reason**. 4. Choose when the field should be shown. Example: Show **Damage photos** when **Credit reason** equals **Damaged item**.  ## Add Validation Add validation rules for important fields. Recommended validation: | Field | Validation | | ----------------- | ---------------------------------------------- | | Purchase / Order | Required | | Line item | Required | | Credit reason | Required | | Quantity affected | Required, greater than 0 | | Description | Required for “Other” or complex reasons | | Supporting files | Required for damaged or quality issue requests | Fields can be marked as required by clicking the checkbox in the Basic Properties tab: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/d6gSDHyEn_QGGsaeMyhW5_image.png" size="54" width="950" height="938" position="center" darkWidth="950" darkHeight="938" showCaption="false"} To add more advanced validation, use the [Validation Rules](docId\:IjhTAqJO7CzJCRi98gSxf) feature. ## Optional: Add Internal Review Fields You might handle the review and approval of credit requests in your ERP or other existing system, and in that case you might not need internal admin fields. However, if you want to manage internal processes for this form inside SparkLayer, you can utilise the Internal Fields feature. Internal fields are for the administrative users who will be reviewing and working with the form submissions. They are not shown to the customer. Internal fields show up next to each form submission entry in the SparkLayer dashboard. Go to **Internal fields** and add fields such as: | Internal field | Type | Purpose | | ---------------------- | -------------- | --------------------------------------------- | | Review status | Select | New, In review, Approved, Declined, Actioned | | Assigned to | Text or select | Who is handling the request | | Decision | Select | Approved or declined | | Approved credit amount | Number | Amount approved by the reviewer | | Reviewer notes | Textarea | Internal comments | | External reference ID | Text | Ticket, ERP, or finance system reference | | Approval button | Button | Used to trigger the approval workflow | | Decline button | Button | Optional button to trigger a decline workflow |  Internal fields keep the customer-facing form simple while giving your team a structured administrative info fields area. Customers do not see these internal review fields. ## What Happens After Submission After the customer submits the form, the request appears as a form entry. Your team can open the entry, review the submitted details, check uploaded files, and update the internal fields. A typical internal process might be: 1. Review the request. 2. Set **Review status** to **In review**. 3. Add reviewer notes. 4. Set a decision. 5. Enter an approved credit amount if approved. 6. Click an internal approval or decline button. 7. Let a workflow handle the next action. ## Notify Your Team on Submission When we created the form, we ticked the "Receive new submission notifications?" toggle. This creates a *"New submission notifications"* workflow which by default sends out new submission email notifications to the store administrator email automatically. ## Optional: Send the Customer a Confirmation You may also want to send the customer a confirmation email. You can do this by modifying the "New submission notifications" workflow and adding an extra Email step. See the [Workflows & Automations](docId\:KFk4KgojUGQV3Bolye--b) documentation for more information. ## Optional: Keep Dependent Fields Clean If the line item options depend on the selected purchase, clear the selected line items when the purchase changes. This prevents customers from selecting an order, choosing line items, then changing the order while keeping line items from the old order. Create a workflow called **Reset credit items when purchase changes**. **Setup:** | Part | Value | | ------------- | -------------------- | | Trigger | Answer updated | | Watched field | Purchase / Order | | Step 1 | Clear answer | | Target | Credit request items | **Flow:** :::BlockQuote Trigger: Answer updated ↓ Purchase / Order changed ↓ Clear answer: Credit request items ↓ Customer selects line items again from the new purchase ::: This is a good example of using workflows to keep dependent fields clean and accurate.  ## Approve Requests Once your team has reviewed a request, you can use a workflow to handle the next action. For example, clicking an internal approval button can send the approved request to another system, email the customer, and update the entry status. Create a workflow called **Credit request approved**. Option A: use an internal button | Part | Value | | ------- | ------------------------- | | Trigger | Internal button clicked | | Button | Approval button | | Step 1 | Condition | | Step 2 | API request or Send email | | Step 3 | Update entry or row | Option B: use a status field | Part | Value | | ------------- | ----------------------------- | | Trigger | Internal field updated | | Watched field | Review status | | Condition | Review status equals Approved | | Step 1 | API request or Send email | | Step 2 | Update entry or row | Common approval actions: - Send the approved request to an ERP or finance system using the API Request step - Create a support ticket by calling an external API - Email the customer - Update the review status to Actioned - Update the Customer record using the Update Customer step Please see the [Workflows & Automations](docId\:KFk4KgojUGQV3Bolye--b) documentation for more information. ## Decline Requests If you want a structured decline process, create a second workflow. Create a workflow called **Credit request declined**. Setup: | Part | Value | | --------- | -------------------------------------------------- | | Trigger | Internal button clicked, or Internal field updated | | Condition | Decision equals Declined | | Step 1 | Send email | | Step 2 | Update entry or row | Common decline actions: - Email the customer - Update review status to Declined - Add an internal note - Store the date the request was declined Keep the customer message simple and clear. If the request needs a personal explanation, ask the reviewer to fill in an internal note and include it in the email. ## Optional: Send Approved Requests to Another System If your finance, ERP, helpdesk, or support system accepts API requests, you can send approved credit requests to that system automatically. Use an **API request** workflow step after approval. The API request can include: - Customer details - Purchase or order details - Requested line items - Reasons - Uploaded file references - Approved amount - Reviewer notes - Entry link - External reference ID Use the template editor and Reference picker to build the API request payload and insert the right values. You do not need to type reference paths manually - use the [Data References](docId\:Bj9Tb3GN_VYbi1-Ehm4Rd) system. You can use the template editor Loop function to loop over a list of credit request item repeatable group field, and output the data for each item in the API request JSON payload. For more advanced use-cases, conditional logic inside the template is also supported. Here is an example of a JSON request template that you might setup, though it will depend on your specific requirements: ```json { "purchase_id": "{{sparklayer:purchases.purchases[purchase_identifiers.sparklayer={entry:current.answers.order_id}][0].purchase_identifiers.platform}}", "returns": [{% for item in {{entry:current.answers.returns}} %} { "sku": "{{item.sku}}", "quantity": "{{item.quantity}}", "reason": "{{item.reason}}", "images": [{% for img in item.images %}"{{img}}"{% if not forloop.Last %},{% endif %}{% endfor %}] }{% if not forloop.Last %},{% endif %} {% endfor %}] } ``` Please note that for file attachments, the value of each file will be the SparkLayer file ID. Your external system can use the SparkLayer's [Files API](https://docs.sparklayer.io/tech-docs/get-bulk-files) endpoints to then fetch the actual files in a secure way. ## Publish, Embed, and Test When the form, internal fields, and workflows are ready, publish your changes. Then decide where customers should access the form. Common options: - Add it to an account page - Link to it from an order or support page - Share the form link with selected customers Use the **Preview** tab to check the customer experience before publishing. Please note that in this case the Preview tab is less useful as it won't have the logged in customer context and so in this case and with any more advanced form, you will need to first embed the form on your eCommerce store within a page where the SparkLayer Core Script is available and customers can login and see the SparkLayer account and cart widgets. To embed the form, you can use the various options outlined on the **Embed** tab. ## Testing Checklist Before launching, test the full process. Check that: - A logged-in customer can open the form - The purchase field shows the expected options - The line item field updates based on the selected purchase, where available - Changing the purchase clears old line item selections - Reason-specific fields show and hide correctly - Required fields block incomplete submissions - File uploads work as expected - A submitted request appears as an entry - The correct internal administrative submission fields are visible next to entries - Submission notification emails are sent - Approval and decline workflows run correctly - API requests send the expected data, if used Test with more than one customer account if customer-specific purchase data is used. ## Best Practices - Keep the customer-facing form short. Ask for the purchase, affected line items, reason, and evidence. - Use a repeatable group for line items. This avoids asking customers to submit separate forms for each item. - Use display logic for reason-specific fields. Only show extra questions when they are needed. - Use file upload for evidence. Photos are especially useful for damaged or quality-related requests. - Use internal fields for review. Do not expose admin-only statuses, notes, or approval decisions to customers. - Clear dependent fields when source fields change. If line item options depend on the selected purchase, clear line items when the purchase changes. - Use workflows for background logic, repeatable admin steps and automation. Notifications, approvals, API requests, and status updates are good workflow use cases. - Start simple. You can launch with manual review first, then add API integrations later. - Test with real customer accounts. Make sure purchase and line item options show the expected data. [title] Form Entries [path] Features/Forms/Entries (submissions)/ ## Introduction Entries are the submissions customers send through your SparkLayer Forms. From the **Entries** area, you can review responses, update data, add any admin internal information against the entry, monitor automation workflows, and manage the full lifecycle of each submission. Entries remain linked to the form version they were created with — helping ensure data consistency even when forms evolve over time. *** ## 👀 Viewing entries To access submissions: 1. Open the Forms listing page in SparkLayer 2. Click **View Entries** in the row matching the form you want You’ll see a table listing all submissions for that form. ### Entry table overview  The entries table can be configured using Views. Views allow setting up saved filters and other options to control what entries are shown in the table. You can add as many different views as is needed for different purposes. By default, each form comes with two views: **Default View:** shows the Submitted At date-time, and first three fields in each entry. **All Fields:** shows all columns - this is mostly used for exporting data as a CSV. You can create a new view or edit existing ones to modify what columns are shown, as well as apply filter criteria to find specific entries. For example, you might want to setup a "Awaiting Review" view for your registration form. ### Opening an entry Click any row to open the full entry view. This shows: - All field responses grouped by page - System metadata - Workflow activity - Attached files - Revision history The entry view reflects the form version used when it was submitted, so fields always appear in the correct structure. *** ## 🔄 Entry lifecycle & statuses Entries start with a status of "draft", and remain in that status until the entry is validated, and submitted. At this point the entry changes into the final "complete" status. For tracking other status information against entries, you can add administrative Internal Fields to your form by going to the Internal Fields form builder tab. ### Logged in SparkLayer customer information If the form is filled out by a logged in customer (i.e. a customer that has been synced to SparkLayer and has logged in at the time of filling out the form), this customer ID is attached to the entry, and is accessible in form field display logic, default values, as well as workflow automations. *** ## ✏️ Editing entries Admins can edit entries after submission — useful for correcting mistakes, updating account details, or continuing internal workflows. ### How to edit 1. Open the entry 2. Click **Edit** 3. Update any editable fields 4. Save your changes ### What happens when an entry is edited When you save changes: - Field validation runs again - Conditional logic re-evaluates - Related workflows may trigger (depending on setup) - A new revision is created for audit purposes It is highly recommended to always add a message to specify the reason for the admin edit of an entry. ### Editing restrictions Some fields cannot be modified: - Read-only fields - System-generated values - Calculated or derived fields - Locked workflow outputs If a field appears disabled, it is likely controlled by the form configuration or automation logic. *** ## 🧾 Entry revisions SparkLayer tracks changes made to entries by admin edits automatically. Revisions help you: - See who made changes - Restore previous values - Understand workflow updates over time Each revision records: | Data captured | Example | | --------------- | ------------------------ | | `Editor` | Admin or system | | `Timestamp` | When the change occurred | | `Field updates` | Previous vs new values | This is particularly useful for B2B onboarding or approval workflows where entries evolve over time. *** ## ⚡ Entry actions ### Delete an entry Removes the submission permanently. ⚠️ Deleting an entry will: - Remove associated files - Delete workflow history - Cannot be undone Export data first if you may need it later. *** ## 📎 Files & attachments If your form includes file upload fields: - Uploaded files appear inside the entry - Click to preview or download - File details include name, type, and size Files remain linked to the entry and follow the same permission rules. Deleting the entry removes all associated files. *** ## 📊 Entry metadata Each submission stores system-level information. | Metadata | Description | | -------------- | --------------------------------------------------------- | | `Entry ID` | Internal unique identifier | | `Entry key` | Key required to see and edit the entry in the form client | | `Form version` | Version used at submission time | | `Created at` | Draft entry creation date - when user started filling out | | `Updated at` | Last change timestamp | | `Submitted at` | When user submitted the entry | | `Status` | Current entry state | *** ## 🔎 Workflow runs & debugging The entry view includes a history of workflow runs. You can see: - When a workflow started - Whether it succeeded or failed - Duration and logs - Step-level outputs If a workflow fails: 1. Open the failed run 2. Check which step failed 3. Review input data and error messages 4. Correct the entry or workflow and re-run This helps diagnose issues without needing developer access. *** [title] Features [path] / ## Introduction The SparkLayer Frontend comprises a variety of interfaces (or "widgets") that are installed on your website. Once set up, your logged in B2B customers then get an optimised "self-service" experience that makes ordering and managing their account a breeze! :::hint{type="success"} **🚀 Upgrading to the latest SparkLayer version** To benefit from our latest updates, please upgrade your [SparkLayer Core Script](https://app.sparklayer.io/integrations/widgets/core). You can learn about how the Core Script works in [our guide here](docId\:QWXsYM9X5_pvIOGUteKcP). ::: ## Frontend Interfaces The [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) are the specially optimised B2B "widgets" that get shown to your B2B customers once they log in. They are designed to make ordering and managing their account as easy and "self-service" as possible, helping them save time and automating many of the processes and activities you may have previously done manually. ::::VerticalSplit{layout="middle"} :::VerticalSplitItem  [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) The SparkLayer My Cart Interface provides your B2B customers with a rapid way to build and place orders on your website. It replaces certain elements of your existing website, providing customers a seamless way to order from you. ::: :::VerticalSplitItem  [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) When SparkLayer is installed on your website, it automatically replaces your website's existing my account area and allows your B2B customers to keep track of key information about their account, track orders and much more! ::: :::: ::::VerticalSplit{layout="middle"} :::VerticalSplitItem  [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT) The Product Detail Interface lets your B2B customers quickly and easily add products to their order and automatically loads when a logged in B2B customer visits a product detail page on your website. ::: :::VerticalSplitItem  [Product Card Interface](docId\:Mrp_Z0QIZQ2QksseuJylv) The Product Card Interface lets you display B2B pricing and the ability to add products to an order anywhere a "product card" is shown on your website. Typically this includes product collection (or "category") pages, and product upsells. ::: :::: ::::VerticalSplit{layout="middle"} :::VerticalSplitItem  [Product Matrix Interface](docId:8Go0NYHFDmYnwlJSNfO-S) The Product Matrix Interface lets your B2B customers see your products in a special "matrix table" view making it easy to quickly add products to an order. ::: :::VerticalSplitItem  [Custom Slots ("Targets")](docId\:l_2ooHJiY-rAx2chBMgP2) Custom Slots (or "Targets") allow you to enhance a range of the SparkLayer Frontend Interfaces by adding your own custom code in predefined areas. ::: :::: *** ## Features & Addons Alongside the built-in Frontend Interfaces and customisations, SparkLayer has a number of major features that unlock powerful features for your B2B customers and internal teams. ::::VerticalSplit{layout="middle"} :::VerticalSplitItem  [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) Sales Agent Ordering is a powerful feature of SparkLayer that lets certain users (Sales Agents) place orders and manage accounts on behalf of your B2B customers. ::: :::VerticalSplitItem  [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) Company Users allows companies to create "teams" of users that can share specific actions within their account, optimising company B2B purchasing. ::: :::: ::::VerticalSplit{layout="middle"} :::VerticalSplitItem  [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) The SparkLayer Quoting Engine introduces a unified solution that streamlines the entire "quote-to-order" process for your sales team and B2B customers. ::: :::VerticalSplitItem  [Forms](docId\:nn5qnfmfGkXlyUmAMpSnq) SparkLayer Forms gives you a simple way to capture, review, and approve wholesale customers - directly from your existing eCommerce store. ::: :::: ::::VerticalSplit{layout="middle"} :::VerticalSplitItem  [B2B Catalogs](docId\:plxT_QlDSepZu2YqVuicC) Control which products your B2B and B2C customers see in your store. Tag products as B2B-only or B2C-only, and create tailored catalogs for specific customer groups - free with every plan. ::: :::VerticalSplitItem ::: :::: *** ## Configurations & Customisations SparkLayer has support for a wide range of additional [configurations and customisations](docId\:SBEaOaCq_A7FfbTatX8bD) that you can apply to tailor the B2B experience for your customers. ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) Product pack sizing Minimum quantities Maximum quantities ::: :::LinkArrayItem [Pricing Display](docId\:S_VTlJBorGmnwjjfSMom9) RRP (MSRP) pricing Quantity pricing Unit cost pricing ::: :::LinkArrayItem [Stock Display](docId\:Gj_Ao_gQ6oA-jx0D27Hys) Live stock levels Pre-order & backorders Reserving stock ::: :::LinkArrayItem [Product Display](docId\:m3DF4f0Eyc2rM-vUaRG9H) Layout customisations Product customisations Quick-buy mode 1-click ordering ::: :::LinkArrayItem [Payment Methods](docId\:ibIKczvHM085BkeJIfFYv) Enable B2B payments Setting the defaults Renaming payment methods Request for quotes ::: :::LinkArrayItem [Cart & Checkout](docId\:o3nDhZBCxisWH6M6satDt) Custom checkout fields Custom file uploads Terms & conditions Customising text ::: :::LinkArrayItem [Tax & Shipping](docId\:ZSsXG6FjRLCod_GxoluTN) B2B-only shipping Free shipping rules Tax handling Product tax rules ::: :::LinkArrayItem [Account & Addresses](docId\:xXiWZ30EfVbKXnuF3j1G8) Custom account fields Address editing Address display Sales statistics ::: :::LinkArrayItem [Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G) Credit limits Account balances Net terms Attaching PDF invoices ::: :::LinkArrayItem [Customer Pricing](docId\:v8dVUcJ7Ju0fH7BvINrEw) Customer discounts Customer price lists ::: :::LinkArrayItem [Languages & International](docId\:kLrS7wtxn3WnCDy8z5Zvu) Supported languages Locale support Text overwrites ::: :::LinkArrayItem [Automation & Workflows](docId:7kxW1S6TBM57MlpLJn_Uk) Update order statuses Sending notifications ::: :::LinkArrayItem [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) Advanced product settings Customer-group settings ::: :::LinkArrayItem [Timeline & Communications](docId\:Kf-Gd3nHSXlrn2zZvla1Y) Track communication and activity across all order types ::: :::: [title] Configurations [path] Features/ ## Introduction SparkLayer has support for a wide range of additional configurations and customisations that you can apply to tailor the B2B experience for your customers. :::hint{type="success"} **🚀 Upgrading to the latest SparkLayer version** To benefit from our latest updates, please upgrade your [SparkLayer Core Script](https://app.sparklayer.io/integrations/widgets/core). You can learn about how the Core Script works in [our guide here](docId\:QWXsYM9X5_pvIOGUteKcP). ::: ## Explore features ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) Product pack sizing Minimum quantities Maximum quantities ::: :::LinkArrayItem [Pricing Display](docId\:S_VTlJBorGmnwjjfSMom9) RRP (MSRP) pricing Quantity pricing Unit cost pricing ::: :::LinkArrayItem [Stock Display](docId\:Gj_Ao_gQ6oA-jx0D27Hys) Live stock levels Pre-order & backorders Reserving stock ::: :::LinkArrayItem [Product Display](docId\:m3DF4f0Eyc2rM-vUaRG9H) Layout customisations Product customisations Quick-buy mode 1-click ordering ::: :::LinkArrayItem [Payment Methods](docId\:ibIKczvHM085BkeJIfFYv) Enable B2B payments Setting the defaults Renaming payment methods Request for quotes ::: :::LinkArrayItem [Cart & Checkout](docId\:o3nDhZBCxisWH6M6satDt) Custom checkout fields Custom file uploads Terms & conditions Customising text ::: :::LinkArrayItem [Tax & Shipping](docId\:ZSsXG6FjRLCod_GxoluTN) B2B-only shipping Free shipping rules Tax handling Product tax rules ::: :::LinkArrayItem [Account & Addresses](docId\:xXiWZ30EfVbKXnuF3j1G8) Custom account fields Address editing Address display Sales statistics ::: :::LinkArrayItem [Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G) Credit limits Account balances Net terms Attaching PDF invoices ::: :::LinkArrayItem [Customer Pricing](docId\:v8dVUcJ7Ju0fH7BvINrEw) Customer discounts Customer price lists ::: :::LinkArrayItem [Languages & International](docId\:kLrS7wtxn3WnCDy8z5Zvu) Supported languages Locale support Text overwrites ::: :::LinkArrayItem [Automation & Workflows](docId:7kxW1S6TBM57MlpLJn_Uk) Update order statuses Sending notifications ::: :::LinkArrayItem [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) Advanced product settings Customer-group settings ::: :::LinkArrayItem [Timeline & Communications](docId\:Kf-Gd3nHSXlrn2zZvla1Y) Track communication and activity across all order types ::: :::: ## Platform configurations ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-xrelmh2HotG2vOK1xg-YL-20250228-125249.png"} [Shopify B2B Registration & Login](docId\:Gfc0UW7mJnMNpnNO6EdRl) Setup up a B2B registration form and customise your login page for B2B. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-EymfhHCxjNkVanKt2ndju-20250228-125256.png"} [Shopify B2B-only Content](docId:30hMTg4Cqqv69EhqNvpnf) Hide products, hide prices, display B2B-only content (e.g. a navigation), and more. ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-cDU6DcNV7ecwgFqOfLuzD-20250228-125429.png"} [Shopify Flow for B2B](docId\:uvXV1kUg_VsZEPr5Dlb2z) Automate B2B-specific actions within your Shopify store such as email notifications. ::: :::: :::hint{type="info"} **Explore more** See our full list of Shopify configurations in [Shopify Customisations](docId\:ddIv5TDAnCayWTOJ0Vyb7). ::: [title] Logic & Validation [path] Features/Forms/ [title] Field types [path] Features/Forms/Form setup/ ## Introduction Field types define how your form collects information from customers. Each type is designed for a specific input — from simple text fields to structured address or file uploads. SparkLayer Forms includes a wide range of fields, organised below by category. *** ## ✏️ Standard input fields Use these to collect basic customer information. | Field | Best for | | ----------- | ------------------------------------- | | `Text` | Names, company details, references | | `Email` | Contact email addresses | | `Long text` | Longer notes or requests | | `Number` | Quantities, values, or numeric input | | `Phone` | Phone numbers with country codes | | `Password` | Secure login or gated forms | | `URL` | Link input for websites or other URLs | These fields support validation such as required values, length limits, or numeric ranges. *** ## 📅 Date & time fields Collect scheduling or timeline information. | Field | Use case | | ------------- | ------------------------- | | `Date` | Delivery dates, deadlines | | `Time` | Appointment times | | `Date & Time` | Combined scheduling input | You can control allowed ranges and availability when configuring the field. *** ## 🔘 Selection fields Use these when customers need to choose from predefined options. | Field | Description | | ----------------- | ----------------------------------- | | `Select` | Dropdown with one choice | | `Multiple choice` | Choose multiple options from a list | | `Radio` | Single choice shown inline | | `Toggle` | On/off confirmation | | `Checkbox` | On/off choice shown as a checkbox | | `Slider` | Numeric range input | | `Country` | Single country choice | Options can be created manually or pulled from structured Data Sources using [Data References](docId\:Bj9Tb3GN_VYbi1-Ehm4Rd). *** ## ⭐ Advanced input fields Designed for richer data capture. | Field | Best for | | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Rating` | Feedback or scoring | | `Signature` | Agreements or approvals | | `File Upload` | Documents, images, attachments. Please note that the value of file uploads is a SparkLayer File ID. Use the [Files API ](https://docs.sparklayer.io/tech-docs/get-bulk-files)to get file download links. | | `Hidden` | Tracking values or internal data | | `Tax Information` | Fields for collecting tax-related information such as a VAT number, tax ID, etc | | `Workflow Trigger Button` | Button to trigger an automation workflow. Mostly used for internal entry administration fields rather than the main fields form. | Hidden fields are not visible to customers but can store automation or integration data. *** ## 🧱 Structured fields These fields automatically generate multiple sub-fields to keep data organised. | Field | What it includes | | --------- | ------------------------------- | | `Name` | Title, first name, last name | | `Address` | Street, city, postcode, country | Structured fields help keep submissions consistent — especially for B2B account requests or onboarding workflows. *** ## 📦 Layout & grouping fields Use these to organise your form visually. | Field | Purpose | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Group` | Arrange related fields together. Makes it easier to display related fields together, as well as apply conditional display logic at once to a whole group of fields. | | `Group (with Repeatable option on)` | Allow customers to add multiple entries of a set of fields. | Groups help keep long forms structured and easier to complete. *** ## 🧾 Content fields (display only) These fields don’t collect data — they help you guide customers through the form. | Field | Use case | | ----------- | ------------------------ | | `Heading` | Section titles | | `Paragraph` | Instructions or context | | `Image` | Visual guidance | | `Video` | Embedded content | | `Button` | Link or workflow trigger | | `HTML` | Custom content blocks | Use content fields to improve clarity and reduce form friction. *** ## 💡 Best practices When choosing field types: - Use structured fields (Name, Address) for consistency - Prefer Select or Radio for predefined choices - Break long forms into grouped sections using Pages - Avoid collecting unnecessary information [title] Product Detail Interface [path] Features/Frontend Interfaces/ ## Introduction The Product Detail Interface lets your B2B customers quickly and easily add products to their order and automatically loads when a logged in B2B customer visits a product detail page on your website.  :::hint{type="success"} **SparkLayer Interactive Demo** You can explore how the SparkLayer Product Page Interfaces work in [our interactive demo](https://www.figma.com/proto/5FPCY5hSGl7mlwjsjMZI2t/SparkLayer-Interfaces?page-id=0%3A1\&type=design\&node-id=86-36708\&viewport=554%2C-398%2C0.33\&t=34VlPwbCqpvQOTsh-8\&scaling=min-zoom\&starting-point-node-id=35%3A7920\&hide-ui=1). ::: *** ## How it works The Product Detail Interface replaces your existing website's pricing and "add to cart" area with a specially-optimised layout. It supports a variety of product types, from single variant products, to multi-dimensional products (e.g. colour and size). When a B2B customer visits a product detail page, they'll see this specially-optimised layout and can begin ordering. :::::Tabs ::::Tab{title="Single Variant Product"} This is the most simple product type with just a single option to purchase.  :::hint{type="info"} **What SparkLayer displays** - Product price specific to the customer (including quantity pricing) - RRP Price (if set) - Product SKU (or code) - Stock availability (including pre-ordering) - Quantity, including quantity rules (e.g. pack-sizes) - Add to Order button ::: :::: ::::Tab{title="Multiple Variant Dimensions"} This interface will render for products that have variants (e.g. colour, size, etc). To make purchasing easy, the variants are displayed in a table format.  :::hint{type="info"} **What SparkLayer displays** - Product price specific to the customer (including quantity pricing) - RRP Price (if set) - Variant list: primary variant (e.g. colour) and secondary variants that relate to them (e.g. size) - Pack sizes (if available - Variant specific price and RRP price - Stock availability: if a variant isn't available, it will display accordingly. Note: unless the set up allows purchase of out of stock products, the product will display as unavailable if there is no stock - Quantity, including quantity rules (e.g. pack-sizes) - Add to Order button ::: :::: ::::: *** ## Integrating the code To add the Product Detail Interface to your website, you just need to add a single line of code to your product detail page template. ```javascript
* Order ID * Purchase Order Number * Address (first line, second line, city, zip) | | `Date` | Customers can filter orders by:
* Year * Time period (within a 365 day period) | ### Order details :::hint{type="info"} **Please note** By default, SparkLayer will only show *completed* orders within the My Account. Orders that are in draft (or pending) status will not show in the list. ::: When a customer views the details of an order, they'll be able to see the following details: | Item | Details | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `Order Number` | An order (or quote) reference ID.
On Shopify, this number can be [customised](docId\:BxWnGB6b1n7QFfhTnu7pk) | | `Order Date` | The date the order was placed | | `Order Status` | The order status, e.g. Processing, Shipped, Cancelled based on order status details sent from your website admin or backend system | | `Payment Status` | The payment status, e.g. Unpaid, Paid. [Learn more](docId\:ibIKczvHM085BkeJIfFYv) | | `Payment method` | The payment method used to pay for the order, e.g. Pay on Account. [Learn more](docId\:ibIKczvHM085BkeJIfFYv) | | `Address` | The address the order is being shipped to | | `Products` | A summary of all products ordered, organised by order status | | `Totals` | The order totals including tax and shipping | | `Shipping tracking` | If supplied, the shipping tracking number for the order. [Learn more](docId\:xXiWZ30EfVbKXnuF3j1G8). | ### Offline and archived orders It's possible to display offline orders within SparkLayer. For example, customers may place orders via your website or over the phone and you want them to be able to view a centralised overview of their entire order history. Please refer to the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT) for more details. ### Invoices ::embed[]{url="https://www.youtube.com/embed/-LeGyR2E3F0"} Depending on your setup, you can also allow customers to view and download invoices from the order history. Learn more in [our guide here](docId\:yWm70oQUosyKOoIqb4Z4G). ### Order exporting Customers can export their order activity to a CSV file directly from the Activity view - making it easy to reconcile orders against internal systems, analyse purchasing over time, or share a record with their team. To export your orders, click "View all" within Recent Activity to open the Activity view, then use the **Download** dropdown in the top right. This dropdown will provide two options, depending on how much detail you need: | Option | What you get | | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Activity` | One row per order, with order-level information such as the order number, date, status, and total. Best for a quick overview of orders. | | `Activity with line items` | One row per product line, including product details, quantities, prices, shipping, and tracking. Best for analysing individual products across multiple orders. | If you use custom fields or line item attributes, these are also included as additional columns in the "Activity with line items" export. Custom field columns are prefixed with `custom_` in the resulting CSV file. :::hint{type="info"} **Please note** When exporting orders, any filters or searches applied in the Activity view will be reflected in the orders shown at the time you download. For example, filtering by "Quote" will export only quotes. ::: ### Order Status Each order has a "status" that represents the overall status of all the packages included in that order. For example, you may have an order where half the items are shipped and half are still processing. This will show as `Part-shipped`. You can click on an order to see a list of the packages that are a part of that order and you'll be able to see that status of each individual package. You can find a list of the order statuses below and the circumstances when they show. | Order Status | Package statuses | | --------------- | ------------------------------------------ | | `Processing` | `Processing` or `Processing` + `Cancelled` | | `Shipped` | `Shipped` | | `Cancelled` | `Cancelled` | | `Returned` | `Returned` | | `Part-returned` | `Returned` + `Processing` | | `Part-shipped` | `Shipped` + `Processing` | | `Varied` | All other configurations of packages | ### Special order statuses SparkLayer also supports a range of special order statuses that are "SparkLayer-specific". These will not correspond to the order statuses within your eCommerce platform. | Order Status | Description | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Awaiting Approval` | A limited customer has submitted an order for approval. The main company user has to approve this order. | | `Awaiting Merchant` | The order has been placed and is in a "draft" status, waiting for the merchant to accept the order by turning it into a completed order. It's also possible to do this automatically via the [SparkLayer Dashboard](docId\:gznStzTqCRffLFZSTAw0N)
When a purchase is internal to SparkLayer, it will 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`. This can [be modified here](https://app.sparklayer.io/configuration/settings) | | `Archived` | The order has been archived. For example, if a user cancels an order-for-approval before it is approved, it will become archived. | *** ## Re-ordering The re-ordering feature on SparkLayer is a powerful feature that lets customers quickly "duplicate" their previous orders or products ordered. On any order detail page, the re-ordering button can be accessed on the top right giving the customer two options:  | Option | Details | | ----------------------------- | ------------------------------------------------------------------------------------------------- | | `Add items as new order` | This will **replace and remove** the existing Quick Order contents with the products in the order | | `Add items to existing order` | This will **update** the existing Quick Order contents with the products in the order |  Customers can also individually re-order specific products by clicking the "Order again" button. It's also possible to add products from an entire time period in our [reports feature](docId\:lQXaNI7IVDqna09D9soAP). :::hint{type="info"} **Please note** If products aren't available (e.g. out of stock), these products will not be automatically added unless rules have been configured to allow the ordering of unavailable items. ::: *** ## Shopping lists The saved shopping lists feature in SparkLayer is a great way for customers to be able to quickly re-order items they've previously saved.  For example, they may have a specific range of products they always order from you or they want to create a 'favourites' list to come back to. Each time a shopping list is saved from the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), these will appear in the main My Account area. The interface includes the following items: | Item | Details | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Name` | This is the name the customer gives the shopping list from the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) | | `Updated date` | The last time the saved shopping list was updated (typically when it was created) | | `Actions` | There are two options to choose from:
* *Add items to exiting cart:* this will add the shopping list items on top of any items already in the cart * *Create new cart:* this will remove any existing items in teh cart and add the shopping list items on top. | *** ## Reports The My Account Interface includes a variety of built in report tools that give your B2B customers visibility on key activities within their account. From within the reports, customers can filter by time period and perform actions such as quickly re-ordering to rapidly place new orders. :::Iframe{iframeHeight="0" code=""} ::: Available reports currently include the following: | Report | Details | | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Purchase history by time period` | This report gives customers a breakdown of all products they've purchased over a period of time (e.g. by quarter, by month, by week). In a matter of clicks, they can re-order an entire range of products and then proceed through the checkout to complete their order. It's a great way to allow your customers to more rapidly repeat-order and easily see products they've purchased from your store. | Please note the following limitations for the available reports: | Limitation | Details | | ------------- | ------------------------------------------------------------------------------------------------------- | | `Time period` | It is currently only possible to show the **most recent 4 periods **for a selected time range | | `Products` | It is currently only possible to show a maximum of 100 products for a time period | *** ## Address book SparkLayer is able to display available customer addresses both within the My Account Interface and the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-). These addresses are either fed through directly from your website admin or from your backend system (via the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT)).  The address book interface includes: | Item | Details | | ------------------ | --------------------------------------------------------------------------- | | `Default Billing` | The default billing address used for orders | | `Default Shipping` | The default shipping address used for orders | | `Other Addresses` | A list of all other available addresses which haven't been set as 'Default' | Any available address can then be selected during the checkout process in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-). SparkLayer also supports full address editing and adding, allowing customers to manage their online address book. Within the My Account interface, customers can simply click the icons next to each address to edit, delete an address, or add a new one. ### Address autocomplete When a customer adds or edits an address, they can start typing and choose from a list of suggested addresses that automatically fill in the rest of the form. This speeds up address entry and cuts out the errors that come from typing each field by hand - helping orders ship to the right place first time. Suggestions are weighted towards your store's country, since that's where most of your customers will be based. If a relevant match sits further afield, it will still appear in the results, so international customers can find their address too. ### Region-based address labels The address form adapts to match the local conventions of the customer's selected country, so it always feels familiar wherever your customers are based. Two things adjust automatically: - **Field order and labels** - fields reorder and relabel to suit the region. For example, the first name and last name fields switch order in regions where that's the local convention. - **Region-specific terminology** - labels use the correct local term for each region. For example, customers in Japan see "Prefecture" in place of "Region". These labels are also translated across all available SparkLayer languages, so each customer sees the right term in their own language. :::hint{type="info"} **Customising addresses** Address management is enabled by default. To see available configurations for addresses, please refer to [our guide here](docId\:xXiWZ30EfVbKXnuF3j1G8). ::: *** ## Account information The My Account Interface can also display a summary of the customer's information such as their email address, name, company name, and financial details (such as [credit terms](docId\:yWm70oQUosyKOoIqb4Z4G)). This information is taken directly from the customer's details within your website admin or directly from your backend system (via the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT)).  If you have [credit terms](docId\:yWm70oQUosyKOoIqb4Z4G) set up but you'd prefer to hide the "Financials" section, you can do this by adding the following setting within your [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { hideFinancials: true, /* Other settings should show below */ }, /* End of code */ ``` :::hint{type="info"} **Adding custom fields** You can also add custom fields to the My Details screen (such as website address, sales agent contact, etc). Learn more about this [our guide here](docId\:xXiWZ30EfVbKXnuF3j1G8). ::: *** ## Company Users Company Users is a powerful feature of SparkLayer that allows companies to create "teams" of users that can share specific actions within their account. Sometimes referred to as "company roles" or "sub accounts", this feature is designed to optimise company B2B purchasing and account management. Learn more in [our guide here](docId:_WwfeWVJY9xrSuNCQlFoZ). *** ## Timeline & Communications The Timeline & Communications feature provides a streamlined way to track communication and activity across all order types within SparkLayer, including [Quotes](docId:8A4OpNIndUyfs3Pup-tuo) (if enabled).  It displays messages, internal notes, and order events, and related email notifications in one centralised area. Learn more in [Timeline & Communications](docId\:Kf-Gd3nHSXlrn2zZvla1Y) . *** ## Quick links to view orders SparkLayer has built-in functionality that can optionally 'auto-redirect' a customer or sales agent directly to their order or quote details, simply by clicking a link. This is useful in the following scenarios: | Item | Details | | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Company Users` | You're using the [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) "Limited User" functionality that allows the main user to view and approve an order via an email | | `Quoting Engine ` | You're using the SparkLayer [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) and your customers and/or sales agents are accessing a quote via an email | | `Sales Activity` | You're accessing SparkLayer Dashboard [Activity](docId\:Z3BXNIoOm5g6yetty8pZj) area and want to view the details of the order or quote. | To enable this feature, you'll need to add a special script to your website. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} Within your Shopify store, go to **Online Store**, click **Themes** and edit the code of your live store. Within the closing `` tag, add the following JavaScript. :::CodeblockTabs theme.liquid ```html ``` ::: :::: ::::Tab{title="🌐 Other platforms"} Within your website code, before the closing `` tag, add the following JavaScript. :::CodeblockTabs theme.liquid ```html ``` ::: :::: ::::: :::hint{type="info"} **Please note the following ** - This should code should be added and available to all users of your store (whether they are signed in or not) - If a customer or sales agent is already logged into your store, they will automatically be directed to their order (regardless of whether this script is added). ::: *** ## Re-ordering and hiding sections If you'd prefer to change the order or hide sections within the My Account area, you can customise this using special code that's added to your [SparkLayer Core Script.](docId\:QWXsYM9X5_pvIOGUteKcP) For example, you may want the customer's "Addresses" to be higher up on the page, or want to move the "My Details" section further down. To get started, you'll need to add the following code to the `display` section of the SparkLayer Core Script. ```javascript display: { sectionConfiguration: { 'my-account': { order: [ 'recent-activity', 'shopping-lists', 'financials', 'my-details', 'reports', 'address-book', 'company-users', ], hide: [ ], }, }, }, ``` ::embed[]{url="https://www.youtube.com/embed/7fG35_y1qIc"} | Name | Details | | ----------------------- | ------------------------------------------------------------------------------------------------------ | | `spark-slot-my-account` | If you're using [custom slots](docId\:l_2ooHJiY-rAx2chBMgP2), you can reference this in your ordering. | | `recent-activity` | The customer's order history | | `shopping-lists` | The customer's shopping lists | | `my-details` | The customer's detail summary | | `reports` | The customer's purchasing history reports | | `address-book` | The customer's address book | | `company-user` | [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) within the account (if enabled) | In addition to this, you can also hide sections you don't want to show by updating the below code. In this example, the reports, address book, and company users sections are hidden. ```javascript display: { sectionConfiguration: { 'my-account': { order: [ 'recent-activity', 'shopping-lists', 'my-details', 'reports', 'address-book', 'company-users', ], hide: [ 'reports', 'address-book', 'company-users', ], }, }, }, ``` **Hiding sections conditionally** It's also possible to conditionally apply re-ordering or hiding sections based on basic coding that can be added to your website. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} If you're using Shopify, you may want to hide certain My Account elements based on a [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) role (e.g. a limited customer) and you can adjust the code with specific liquid code (as in our example below). :::CodeblockTabs theme.liquid ```javascript display: { sectionConfiguration: { 'my-account': { hide: [ {% if customer.metafields.sparklayer.role == 'limited-customer' %} 'recent-activity', {% endif %} ], }, }, }, ``` ::: The same principle could be used to hide or show content based on a tag. :::CodeblockTabs theme.liquid ```javascript display: { sectionConfiguration: { 'my-account': { hide: [ {% if customer.tags contains 'b2b-vip' %} 'recent-activity', // Hide recent activity if the customer is b2b-vip {% endif %} ], }, }, }, ``` ::: :::: ::::Tab{title="🌐 Other platforms"} Within your website code, before the closing `` tag, add the following JavaScript. :::CodeblockTabs theme.liquid ```html ``` ::: :::: ::::: *** ## Showing custom content (using "slots") Custom Slots (or "Targets") allow you to enhance the SparkLayer My Account interface by adding your own custom code in predefined areas.  You can learn more in our [custom slots guide here](docId\:l_2ooHJiY-rAx2chBMgP2). *** ## The My Account URL redirect When a logged in customer accesses your website's existing my account area (e.g. `/account`), it will redirect them to the SparkLayer My Account interface instead. If you'd prefer, you can change the default handling and** set a custom URL** to redirect B2B customers to once they log in. You can do this by updating the SparkLayer Core Script on your website. [Learn more](docId\:xXiWZ30EfVbKXnuF3j1G8) *** ## Configurations SparkLayer supports a wide range of configurations you can apply to the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). Please see our [full guide here](docId\:SBEaOaCq_A7FfbTatX8bD) on what's possible! [title] Validation Rules [path] Features/Forms/Logic & Validation/ ## Introduction Validation rules help ensure the data submitted through your forms is accurate, complete, and usable. Alongside built-in field validation, you can create custom rules to enforce specific business logic — such as matching values or formatting requirements. Validation runs automatically during form completion and whenever entries are updated, helping prevent incorrect data from reaching your workflows or storefront processes. *** ## 🧱 Built-in validation Every field type includes basic automatic validation based on its format. | Field type | Built-in checks | | ------------- | -------------------------- | | `Email` | Valid email structure | | `URL` | Valid web address | | `Number` | Numeric value within range | | `Date` | Valid date format | | `Phone` | Contains valid digits | | `File upload` | File type and size limits | These checks run without additional setup, helping catch common errors early. *** ## ⚙️ Custom validation rules Custom rules allow you to define additional conditions beyond standard field validation. ### Adding a validation rule 1. Select a field in the form builder 2. Open the **Validation** tab 3. Click **Add rule** 4. Define the condition and error message 5. Save your changes Each rule includes: | Component | Purpose | | --------------- | -------------------------------------- | | `Condition` | Defines when the field becomes invalid | | `Error message` | Text shown to the customer | :::hint{type="info"} **Please note** A rule's error message displays when the condition evaluates to **false** - not when it matches. This means conditions should describe the values you want to **allow**, not the ones you want to block. ::: For example, if you want to prevent customers from selecting the United Kingdom (because you don't ship there), don't set the condition to "country equals United Kingdom" - this will show the error for every country instead of just the UK. Instead, set the condition to match the countries you **do** ship to (e.g. "country is one of: France, Germany, Spain"), so the error only appears when the customer selects a country outside that allowed list. *** ## 🧠 Types of validation you can build ### 🔎 Simple value validation Check a field’s own value. Example: :::BlockQuote Must be at least 10 characters ::: Used for: - Password strength - Reference numbers - Minimum input requirements ### 🔗 Cross-field and Data Reference validation Compare one field against another, or against other data in the system using [Data References](docId\:Bj9Tb3GN_VYbi1-Ehm4Rd). Examples: - Confirm email matches original email - End date occurs after start date - Purchase ID matches one of the customer's SparkLayer Purchases This is useful when multiple fields need to stay aligned. *** ## 🔎 Supported validation operators Validation uses the same logic operators as conditional logic. ### Text validation | Operator | Example use | | ----------------- | -------------------- | | `Matches pattern` | Regex format checks | | `Contains` | Must include a value | | `Starts with` | Required prefix | | `Ends with` | Required suffix | ### Numeric validation | Operator | Example use | | ---------------------- | ---------------- | | `Greater than / equal` | Minimum quantity | | `Less than / equal` | Maximum value | | `Equals / not equals` | Exact match | ### Length validation | Operator | Example use | | ---------------- | ---------------- | | `Minimum length` | Password rules | | `Maximum length` | Reference codes | | `Exact length` | Postcodes or IDs | ### Format validation | Operator | Example use | | ------------------------- | ---------------------- | | `Is email` | Email format check | | `Is number` | Numeric value | | `Is integer` | Whole numbers | | `Is alpha / alphanumeric` | Character restrictions | These allow you to enforce consistent formatting across submissions. Please note that the availability of operators depends on the type of field you are configuring. *** ## 💬 Writing effective error messages Clear messages help customers fix issues quickly. ### Recommended approach - Explain what’s wrong - Show how to fix it - Avoid technical wording - Keep messages short Example: ✅ “Phone number must include area code” ❌ “Invalid input” Dynamic messages can also reference values using templates — for example showing a required minimum value. *** ## 📊 Validation states ### Entry validation status | State | Meaning | | --------- | ----------------------------------------------------- | | `Valid` | All rules pass - ready to submit | | `Invalid` | One or more rules fail - submitting not allowed | | `Pending` | Async validation in progress - submitting not allowed | ### Field-level feedback Fields may show: - Error message when invalid - Success indicator (optional) - No indicator before interaction These visual cues help guide customers through completion. *** ## 🧾 Common validation patterns ### 📅 Date relationships Ensure end dates occur after start dates. ### 🔁 Unique selections Prevent duplicate items in repeatable groups or multi-select fields. These patterns help maintain clean data across complex forms. *** ## 🔗 Validation in workflows Workflows can extend validation beyond the form itself. ### On submission, form page change, or field update Workflows can: - Perform advanced checks - Validate against external systems - Apply cross-form logic ### Validation steps Add conditions inside workflows to: - Update answers - Notify teams about invalid data - Trigger follow-up actions This creates a layered validation approach across your entire process. *** ## 💡 Best practices **Layer your validation** 1. Built-in field validation for format 2. Custom rules for business logic 3. Workflows for advanced checks **Improve the user experience** - Validate early rather than only on submit - Show clear instructions - Avoid overly strict rules unless necessary **Test thoroughly** Check: - Empty values - Edge cases (min/max) - Special characters - Very long inputs **Keep performance in mind** - Avoid heavy regex where possible - Limit complex cross-field rules - Use workflows for advanced processing These practices help keep forms fast and reliable as they grow. [title] Conditional Logic [path] Features/Forms/Logic & Validation/ ## Introduction Conditional logic lets your forms adapt based on customer input. You can show or hide fields, sections, or pages dynamically — helping keep forms shorter, clearer, and more relevant for B2B customers. Instead of showing every possible field upfront, you can guide users through a progressive experience based on their answers. *** ## 🧠 How conditional logic works Each field can include rules that control when it appears. When a customer changes a value: 1. SparkLayer checks your conditions 2. Visibility updates instantly 3. The form adapts in real time *** ## ⚙️ Adding conditional logic To apply logic to a field: 1. Select a field in the form builder 2. Open the **Display Logic** tab 3. Click **Add condition** 4. Choose the field, operator, and value 5. Save your changes Each condition follows a simple structure: | Part | Description | | ---------- | ------------------------------- | | `Field` | The field you want to reference | | `Operator` | How the value is compared | | `Value` | The condition that must be met | Example: :::BlockQuote Show "State" when Country equals "US" ::: *** ## 👁 Visibility actions When creating logic, you decide how the field behaves. ### Show when The field only appears if the condition is met. Best used for: - Region-specific address fields - Optional business details - Advanced settings ### Hide when The field disappears if the condition is met. Best used for: - Skipping irrelevant questions - Simplifying long forms - Removing unnecessary options Both approaches help reduce form friction and improve completion rates. *** ## 🧩 Building conditions ### Simple conditions Use a single rule to control visibility: :::BlockQuote Show Phone when Contact preference equals "Call" ::: Multiple conditions Combine rules using AND or OR logic: :::BlockQuote Show Shipping Address when: Delivery method = Ship AND Country = United Kingdom ::: ### Condition groups (advanced) Group multiple rules acknowledges more complex workflows: :::BlockQuote Show Discount field when: (Customer type = Premium OR Order total > 1000) AND Promotions enabled = true ::: Condition groups allow more precise control without duplicating fields. *** ## 🔎 Supported condition types SparkLayer supports a range of comparisons so you can build flexible logic. ### Comparison rules | Use case | Example | | ---------------------- | --------------------- | | `Equals / Not equals` | Customer type = Trade | | `Greater or less than` | Order value > 500 | | `Numeric thresholds` | Quantity ≥ 10 | ### Text-based rules | Use case | Example | | ------------- | ------------------------- | | `Contains` | Email contains “@company” | | `Starts with` | Phone starts with +44 | | `Ends with` | Email ends with .edu | ### Value checks | Use case | Example | | ---------------- | ------------------ | | `Has value` | Email is not empty | | `Boolean checks` | Approved is true | ### Length checks Useful for validating structured inputs: - Postcode length - Reference codes - Order numbers These operator types allow forms to respond intelligently to different input patterns. *** ## 🔗 Referencing other fields and data You can build conditions using static values, or [Data References](docId\:Bj9Tb3GN_VYbi1-Ehm4Rd): - Fields on the same page - Fields on earlier pages - Global (non-repeating) fields - Fields within the same repeatable group instance - Fields from other forms - Data table values - Current logged in SparkLayer customer data Inside repeatable groups, logic can applies to the current item — helping keep behaviour predictable when customers add multiple entries. *** ## 🙈 Hidden field behaviour When a field becomes hidden: - It is removed from the UI - Validation rules no longer apply - Required settings are ignored - The value is preserved unless configured otherwise *** ## 🧾 Common SparkLayer use cases ### 🌍 Region-based forms Show different fields depending on country selection. ### ⚙️ Advanced settings Hide complex configuration options until a toggle is enabled. ### 📦 Progressive disclosure Gradually reveal extra options instead of overwhelming customers with long forms. ### 👤 Customer dependent forms Use currently logged in customer data such as IDs, SparkLayer group and role, and other data, to conditionally hide or show sections and fields. *** ## 💡 Best practices **Keep logic simple** - Avoid deeply nested conditions - Use clear field labels - Document complex rules for your team - Utilise the Group field to apply display logic once to a list of sub-fields to reduce duplicated logic **Test thoroughly** - Try every condition path - Test with empty fields **Think about UX** - Don’t hide too much at the start - Give context when new fields appear - Group related logic together **Consider performance** Very complex logic can slow large forms. If your form grows significantly: - Break into multiple pages - Simplify nested conditions - Reduce unnecessary dependencies between field [title] Sales Agent Ordering [path] Features/ :::hint{type="info" attributes="[object Object]"} **Please note** Sales Agent Ordering is available on the SparkLayer *Starter*, *Growth, Pro,* and *Enterprise* plan or as an addon for $39 per agent (per month) *on any 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. ::: ## Introduction Sales Agent Ordering is a powerful feature of SparkLayer that lets certain users (*Sales Agents*) place orders and manage accounts on behalf of your B2B customers. Watch our video below to see how it works! ::embed[]{url="https://www.youtube.com/embed/pAaHBiT-yzY"} Sometimes referred to as *Order Masquerading,* it's a great way to integrate your sales team and centralise your B2B orders. Once enabled, Sales Agents are able to perform any of the following actions against an existing B2B customer account: | Action | Notes | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `View products` | The Sales Agent can view products on the website at the B2B prices assigned to the selected customer | | `Add products` | The Sales Agent can add products to an order | | `Edit prices` | The Sales Agent can edit product prices (if they have "Administrator" priveleges) | | `Edit shipping costs` | The Sales Agent can set a custom shipping price (if they have "Administrator" priveleges) | | `Place an order` | The Sales Agent can place an order using their available payment methods and request payment from the customer | | `Shopping Lists` | The Sales Agent can save and edit Shopping Lists | | `Address Book` | The Sales Agent Add/edit addresses (if enabled for the customer) | | `Re-order` | Re-order from an existing order by viewing the order details within the account | | `Persistent cart` | Products that are added to an order will remain in the customers **My Order** until they checkout or make edits. The order will also be saved for the Sales Agent if they come back later. | In addition to performing actions against an existing B2B customer account, Sales Agents can also: | Action | Notes | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Add new customers` | The Sales Agent can add new customers directly from the frontend, allowing them to then place an order on their behalf right away.
*Note: this requires assigning the Sales Agent a special "Sales Administrator" role, *[learn more](https://docs.sparklayer.io/sales-agent-ordering#_nmxQ)*.* | :::hint{type="success" attributes="[object Object]"} **Want to test out Sales Agents?** Head over to our [B2B Demo store](https://demo.sparklayer.io/pages/b2b-login-register) and give it a go! ::: *** ## Getting set up Setting up sales agents is straightforward. The process works as follows: 1. Go to Customers → [Agents](https://app.sparklayer.io/v2/customers/agents) in the SparkLayer dashboard. 2. Find the customer you want to make a sales agent and click **View**. 3. Scroll to the **Role** section and select **Sales agent** or **Sales administrator**. 4. Click **Save role**. Once activated, the sales agent can log into your website and will be presented with the sales agent interface - where they can search for and select a customer, then place orders or manage accounts on their behalf. :::hint{type="info"} **Please note** The customer must already have an active account in Shopify with a b2b tag before they can be assigned as a sales agent. For details on the difference between the Sales Agent and Sales Administrator roles, see the Roles section below. ::: *** ## Configuring Sales Agents ::::Tabs :::Tab{title="🛍️ Using Shopify"} To assign a customer as a sales agent, go to Customers → [Agents](https://app.sparklayer.io/v2/customers/agents) in the SparkLayer dashboard. You can also navigate to Customers, find the customer in the list, and click **View** to open their detail page. Scroll to the **Role** section and select from the following options: | Option | Details | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customer` | This is the default role for a customer, allowing them to login and place B2B orders.
**This option means the customer is not a sales agent** | | `Sales Agent` | This enables Sales Agent access with the ability to action the following on behalf of a customer: place orders, manage addresses, manage shopping lists, and manage company user access.
**This option means the customer is a sales agent** | | `Sales Administrator` | This enables additional Sales Agent controls: the ability to update B2B prices on an order for a customer, the ability to add new customer records to subsequently place orders for.
**This option means the customer is a sales agent** | | `Custom` | See "**Sales Agent Roles**" below for guidance on setting up custom roles. | Once you've made your selection, click **Save role** to activate the sales agent.  **Editing sales agents** To change a sales agent's role or remove their sales agent access, go to Customers → [Agents](https://app.sparklayer.io/v2/customers/agents) in the SparkLayer dashboard, find the agent in the list, and click **View**. From the **Role** section, you can: - Change their role between Sales agent and Sales administrator - Remove sales agent access entirely by selecting **Customer** Click **Save role** to apply your changes. ::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: :::: *** ## Sales Agent Roles Sales agent roles let you control what each sales agent can see and do in SparkLayer - so the right people have the right level of access. Instead of managing permissions individually, you can create reusable roles and assign them across your team.  With roles, you can: - **Create custom roles** with flexible permissions tailored to specific job functions - **Use built-in system roles** for quick setup without any configuration - **Assign one role to multiple sales agents** - keeping your team organised as you grow - **Update permissions from a single screen** - changes apply automatically to all assigned users Go to [Customers → Roles](https://app.sparklayer.io/companies/roles) in the SparkLayer dashboard. This is your central place to create, edit, and manage all roles. SparkLayer includes two system roles out of the box, and you can create as many custom roles as you need. | Role type | Description | | --------------------------- | ----------------------------------------------- | | `Sales Agent (system role)` | Standard access for day-to-day selling | | `Sales Admin (system role)` | Full access across the SparkLayer app | | `Custom roles` | Create your own roles with specific permissions | :::hint{type="info"} **Please note** System roles cannot be edited or deleted. ::: **Creating a custom role** 1. Go to Companies → Roles and click **Create Role** 2. Enter a role name 3. Check or edit the handle (this is auto-generated from the name) 4. Select the permissions you want to allow - each permission is shown as a checkbox, so select it to grant access or leave it unchecked to restrict access 5. Click **Save** **Editing a role** 1. Find the role in the list and click **Edit** 2. Update the permissions as needed 3. Click **Save** :::hint{type="info"} **Please note** Changes apply immediately to all sales agents assigned to that role - there's no need to update each agent individually. ::: **Assigning a role to a sales agent** 1. Go to [Customers → Agents](https://app.sparklayer.io/companies/agents) in the SparkLayer dashboard 2. Find the sales agent in the list and click **View** 3. Scroll to the **Roles** section 4. Select a role using the radio buttons 5. Click **Save Role** **** **Permissions you can set** It's possible to set any of the following permissions against a role. - Change the price of items that have been quoted to a customer - Add or modify custom line items on an order - Override the shipping method or cost on an order - Bypass product-level rules like minimum order quantities or increments - Place orders via the normal checkout process - Create quotes via the checkout - Edit quotes once created - Finalise quotes once approved - Archive quotes when no longer required - Manage the sales agent assigned to quotes - Add new customer records to the platform - Update shipping and billing addresses on a customer's account - Change which address is set as the default for shipping or billing :::ExpandableHeading **Best practises (click to expand)** - **Create roles based on job function** - for example, a "Sales Rep" role for day-to-day ordering and a "Manager" role with broader access - **Avoid giving full access unless necessary** - use the Sales Admin system role or a custom equivalent only for users who genuinely need it - **Review roles regularly** - as your team grows, check that permissions still match how each role is being used ::: :::ExpandableHeading **FAQs (click to expand)** **Can I edit system roles?** No - system roles (Sales Agent and Sales Admin) are fixed and cannot be changed. If you need different permissions, create a custom role. **Can I assign one role to multiple users?** Yes - roles are designed to be reused. Assign the same role to as many sales agents as you need. **What happens when I update a role?** All sales agents assigned to that role will automatically receive the updated permissions. **Can I delete a custom role?** Yes, but only if no sales agents are currently assigned to it. Reassign them to a different role first. ::: *** ## The ordering experience The key difference in the ordering experience for a Sales Agent versus a standard B2B customer is simply this: the Sales Agent isn't placing an order against their own personal account but instead against **their selected B2B customer.** Once they login, they'll be prompted by a special Sales Agent Ordering search box within the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) that lets them easily search and select a customer. At this point, the Sales Agent will be able to search for **any B2B customer** within your store and place orders on their behalf.  You can also see how the order experience works in our video below. ::embed[]{url="https://www.youtube.com/watch?v=7gVix6BsN64"} :::hint{type="warning" attributes="[object Object]"} **Please note** Only customers that have been tagged as **B2B customers** will show within the search results. Within Shopify, simply add a tag of `b2b` against any customer record. Customers must also always have an email assigned to their account in Shopify. If you don't have an email address, you could always use a test email such as `salesagent123@yourstore.com` ::: The Sales Agent can search customers by: - Company Name - First and Last Name of the customer - Postcode of their default address - Accounting ID (if available) Once they've selected a customer, the Sales Agent is then in 'Sales Agent Mode' with a notification that will follow them around the ordering experience, notifying who they are logged in as.  *** ## Placing an order Once logged in as a customer, the Sales Agent can then browse the website and begin adding items to an order. All prices shown will be the prices you've set up for the specific customer using the [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) functionality of SparkLayer. Once they've added products to an order, they can access the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) at any point and begin the checkout process. Just as with the standard customer experience, they can select an address, shipping method, and see all available payment methods.  :::::Tabs ::::Tab{title="🛍️ Using Shopify"} To understand the payment flow, the payment methods work as follows: | Payment Method | Flow | Status | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | `Pay by Invoice` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | | `Pay on Account` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | | `Pay Online by Card` | The order is submitted as a **Draft order** within Shopify and the customer will **receive a notification** to make payment (see below) | Order is left in Draft status until the payment is successfully made | | `Request for Quote` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | **Creating Draft Orders** As noted above, the payment flow works slightly differently to the standard customer experience when placing an order. When a Sales Agent is logged in and places an order, the order will by default enter Shopify in the **Draft order** status with the customer's details pre-selected. Just as with any order in Shopify, you'll see the customer's details on the top right.  **Making a payment against an order** Depending on the payment method used by the Sales Agent, if the customer is required to make payment, they'll receive an **automatic email notification** detailing their order and a button to checkout. This uses the 'Send invoice' feature of Shopify Draft orders and you can learn more about [how this works here](https://help.shopify.com/en/manual/orders/create-orders#share-checkout-link-with-customers). Once the customer completes their purchase by making payment, the order is then marked as paid and will then display within your **Shopify Orders** area.  :::hint{type="info" attributes="[object Object]"} You can edit this email template by going to **Settings > Notifications** within Shopify and search for the **Draft order invoice** template ::: If the customer hasn't made payment for any reason or you are processing it manually, within Shopify you can open the order and easily resend or manually mark as paid. Please note, the order will stay as a Draft order until action has been taken.  :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: *** ## Creating new customers Sales Agents are also able to add new customers directly from the SparkLayer interface, making it easy for them to quickly place an order (versus having to manually set up a customer record within your website's admin area). To get started, for your selected Sales Agent, you'll need to [follow these steps](docId\:Uw8mDbMEfwWKqZrVB5CqX). When selecting **Customer Role**, choose **Sales Administrator** from the list.  This will activate additional privileges for the Sales Agent, allowing them to create customers on-the-fly the next time they sign into your website. From the main Sales Agent overview page, they'll see the option to **Add a new customer** as shown below.  When **Add a new customer** is clicked, the Sales Agent will then need to complete the basic information for the customer including their First and Last Name, their Email, and their Company.  When the **"Add new customer"** button is clicked, this will then trigger the following actions: | Account status | Actions | | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `If the invitee does not already have an account on the website` | This will send the invitee an email asking them to create a password to activate their account and join the company | | `If the invitee already has an account on the website` | The customer will be able to login with their existing login details to join the company. | :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Preventing notifications being triggered** If you'd prefer for notifications to **not** be sent when a new customer is created, you can manage this within the SparkLayer Dashboard under [Integrations](https://app.sparklayer.io/configuration/integrations/platform). Simply tick the **"Disable new customer invite email"** to prevent notifications being sent. ::: For new customers that do not already have an account, they'll receive an email that looks similar to the below. This is an email that is generated via Shopify and can be easily modified. Within Shopify, this uses the "Activate Account" email notification and can be modified within the **Settings > Notifications** area of your Shopify admin.  :::hint{type="warning" attributes="[object Object]"} **Please note the following** As part of introducing new customers to your B2B customer base, we recommend informing them of the process detailed above to ensure they are familiar with the steps involved. ::: :::hint{type="info"} **Please note the following** When a new customer is added this way by a Sales Agent, the customer will automatically be** assigned the same rules** assigned to the Sales Agent. This includes the following: - Price lists - Discount percentage - Customer Group - Sales agent groups (if applicable) For example, if the Sales Agent has been set up to use price list `ABC`, the new customer will automatically be assigned this **same price list**. This can be modified by subsequently going into the new customer's record and updating as required (e.g. by assigning them an updated customer group tag) ::: :::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: ::::: *** ## Editing prices on-the-fly Sales Agents have the ability to edit prices "inline" for customers; it's a great way to make ad-hoc price changes or apply discounts without requiring adjustments to price lists. :::Iframe{iframeHeight="0" code=""} ::: To get started, for your selected Sales Agent, you'll need to [follow these steps](docId\:Uw8mDbMEfwWKqZrVB5CqX). When selecting **Customer Role**, choose **Sales Administrator** from the list.  This will activate additional privileges for the Sales Agent, allowing them to edit prices on-the-fly the next time they sign into your website. When they add items to a customer's order, they'll see an **Edit** button next to the Unit price to then make changes. :::hint{type="info"} **Please note** It is only possible to **lower** the unit price when editing prices. ::: *** ## Adding custom items Our new "Add custom item" feature lets your Sales Admins add additional items to a customer's order that sit outside of your general product catalogue.  Use-cases could include adding custom instructions or details specific to an order, additional products (that don't have a specific SKU), or any custom item that needs to be associated with an order. Items can be added at a specific cost or at a zero cost value. To get started, for your selected Sales Agent, you'll need to [follow these steps](docId\:Uw8mDbMEfwWKqZrVB5CqX). When selecting **Customer Role**, choose **Sales Administrator** from the list.  This will activate additional privileges for the Sales Admin, allowing them to add custom items the next time they sign into your website. To add a custom item to an order, from the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), go to "**Actions**" and select "**Add custom item**". This will then allow the sales agent to enter the following details: | Item | Details | | ---------- | ------------------------------------ | | `Name` | The name of the custom item | | `Cost` | The per unit cost of the custom item | | `Quantity` | The number of units | When a custom item is added to the order, it is then possible to edit the unit cost, quantity, and fully remove the item if required.  *** ## Setting custom shipping costs Sales Agents have the ability to set a custom shipping cost for customers; it's a great way to create a specific shipping costs without needing to edit shipping rules or costs behind the scenes. :::Iframe{iframeHeight="0" code=""} ::: To get started, for your selected Sales Agent, you'll need to [follow these steps](docId\:Uw8mDbMEfwWKqZrVB5CqX). When selecting **Customer Role**, choose **Sales Administrator** from the list.  This will activate additional privileges for the Sales Agent, allowing them to create a custom shipping cost on-the-fly the next time they sign into your website. When they add items to a customer's order and go through the checkout, they'll see an **Edit** button next to the shipping methods to then make changes. It's also possible to set a custom message that shows when setting a custom shipping cost. If you'd like to make edits, please refer to the instructions below. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ translations: { en: { "cart.checkout.shipping-method.custom-method.message": "Set a custom shipping rate for this order to replace default shipping methods.", } }, /* End of code * ``` :::hint{type="info"} **Please note** When setting up a custom shipping price, it will be labeled as "Custom Shipping" in your store's admin (e.g. Shopify). If you have backend integrations in place, this label might impact how order data is processed. To ensure smooth operation, we recommend testing this feature beforehand to identify and address any potential issues. ::: *** ## Overwriting product settings For Sales Agents with the "Sales Administrator" customer role (see above), it's possible to edit the product settings of items within an order. :::Iframe{iframeHeight="0" code=""} ::: For any products that have pack size or min/max product rules, the Sales Agent can enter "freeform" quantities and increment/decrement the line item quantities as required. If changes are made to the default settings, the Sales Agent will be prompted to confirm their changes before proceeding to complete the order.  *** ## Placing "personal" orders as a Sales Agent :::hint{type="info"} **Please note** To use this feature, your store must be using version `1.4.0` or above in the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) ::: Sales Agents can access their own personal account by clicking the my account icon within the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-). :::Iframe{iframeHeight="0" code=""} ::: Alongside placing orders on behalf of customers, Sales Agents can also add products to their **personal** orders and complete the checkout process independently. Whether it's for buying a product for an upcoming customer demonstration or making a personal purchase at a preferential rate. When a Sales Agent places a personal order, pricing will be applied based on the price list assigned to their [customer group](docId:5_lWMNohhjBJJppg9E6Vh) within the SparkLayer Dashboard. :::hint{type="success"} **Shopping lists** One great use for the the Sales Agent "personal" account is the [shopping lists feature](docId\:efevur-A3yCJXUHvrR7t-). Sales Agents can create their own shopping lists to save in their account. Once they log in as a customer, they can then access the shopping lists to populate an order. It's a great way to quickly start an order for a B2B customer!  ::: *** ## Using Sales Agents across multiple devices An additional feature of Sales Agents is the ability to access customer accounts **across multiple devices** using the same Sales Agent login. This means that you can: - Pick up orders from where you left off - Manage the same order in parallel across different devices - Log in as a different customer on a different device whilst using your sales agent account ::embed[]{url="https://www.youtube.com/watch?v=u5AMtONH11k"} *** ## Restricting Sales Agent Access If you want to restrict which customers a sales agent can see, you can configure this using sales agent groups. This powerful feature gives you full control over how you manage sales agent access - for example, limiting agents to specific territories, regions, or customer types. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as `Single line text` and set to `List of values` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `sales_agent_groups` | | `Validation` | Tick Limit to preset choices and then enter your values |  The values you enter represent how you want to categorise your Sales Agents. Common use-cases may include: | Example use-case | Example Values | | --------------------------------------------------- | ------------------------ | | Limiting by a territory (e.g. Germany, France, UK). | `germany, france, uk` | | Limiting by a geographical region | `north-east, south-west` | | Limiting by a customer type | `vip, new-customer` | :::hint{type="warning" attributes="[object Object]"} **Important**: when entering values, make sure to not include spaces. Instead, you can separate using dashes (e.g. `south-east`) ::: **Assigning Sales Agent Groups to a customer** Once you've created your Sales Agent Groups, you can then easily assign these to a customer. Within Shopify, search for a customer and then scroll down to the Metafields section. From the Sales Agent Groups option, select the appropriate values and then click Save. Note, it's possible to assign more than one value to a customer.  **Configuring rules for the Sales Agent** The final step is to then assign the Sales Agent Group rules to a specific sales agent. This is done through the SparkLayer dashboard. Simply head to "Customer Sync", find your sales agent, and scroll down to "Restrict sales agent access". Then, just enter the groups you would like the sales agent to be able to access. As with customers in Shopify, a Sales Agent can have access to multiple groups. :::hint{type="info" attributes="[object Object]"} **Please note** If you leave the field as blank, the Sales Agent will have **access to all customers**. Any modifications to sales agents/admins must be done through the dashboard. You cannot change the metafields for a sales agent/admin on Shopify. This includes changing their role or sales agent groups they are assigned to. ::: When the Sales Agent next signs into your Shopify store, they'll then be able to search for customers that match the Sales Agent Group rules you've set up. :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: *** ## Notifying sales agents of new orders When a B2B customer places an order, it's possible to also notify the sales agent of any order activity using automations within your eCommerce platform. ::::Tabs :::Tab{title="🛍️ Using Shopify"} Using [Shopify Flow](https://apps.shopify.com/flow), you can set up specific triggers to send emails to specific sales agents when an order is placed.  The flow works by detecting an order (or draft order) being placed, checking which sales agent has been assigned to the customer (see "Restricting Sales Agent Access" above), and then sending an internal email. To get started, you can download a [sample Shopify Flow template here](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Sales_Agents_-_Email_sales_agent_when_order_placed_by_customer.flow?v=1726494991). ::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: :::: *** ## Managing Quotes Do you have Sales Agents who manage quotes on behalf of your B2B customers? The SparkLayer [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) introduces a unified solution that streamlines the entire "quote-to-order" process directly from your existing online store. It allows you to handle quotes more effectively, converting them into completed orders faster than ever! ::embed[]{url="https://www.youtube.com/embed/Lmjwg4RK0r8"} The SparkLayer Quoting Engine works by allowing your B2B customers to easily submit quotes for review, and for your sales team to then communicate with the customer until they're ready to complete their order. Learn more about how it works in [our full guide](docId:8A4OpNIndUyfs3Pup-tuo). *** ## Tracking activity When Sales Agents place orders through your store, a range of **additional data** is tracked against the order, from specific tags through to additional notes. This is useful if you want to be able to filter or analyse Sales Agent activity or integrate this into your backend systems. ::::Tabs :::Tab{title="🛍️ Using Shopify"} To view the available data, you can click into an open Draft order and you'll see the following information. This information will also display on any completed orders once payment has been taken.  | Data field | Details | | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Shopify tags` | The following tags will be added against the order:
* `agent` (denoting an agent order) * `agent-[start of email]` (denoting the agent's email) * `agent-[email domain]` (denoting the agent's email)- b2b (denoting a B2B order) | | `B2B Sales Agent Account ID` | If the sales agent has an accounting ID assigned, this will display within the order | | `B2B Sales Agent email` | The email address of the Sales Agent | | `sparkPaymentType` | This is captured against all B2B orders, and will also include the payment type the Sales Agent has selected | ::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: :::: *** ## Order exporting Sales agents can export order activity to a CSV file directly from the Activity view, making it easy to analyse customer purchasing patterns and report on sales performance across their customers. Use the **Download** dropdown in the top right of the Activity view to export, with the same "Activity" and "Activity with line items" options available to customers. For full details on the export options and the fields included, see our [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) guide. *** ## Barcode scanning Built into SparkLayer is the ability for Sales Agents to easily build orders simply by scanning barcodes via their mobile device. It's a great way to allow sales teams to easily order when they're in-store, at trade shows, or any other location where they have access to product barcodes. You can learn more about this and other time-saving tools in our [Intelligent Cart (AI)](docId\:rIAcYwzOMfwSomd5KB5p8) guide. [title] Form settings & notifications [path] Features/Forms/Form setup/ ## Public form settings The "Settings" tab in the form builder allows configuring the following properties: - **Form title:** The title displayed to users filling out the form - **Form description:** A brief description or instructions for users filling out the form - **Submit button text:** Customise what appears on the submit button - **Success message: **message shown to the user after they submit the form. Supports templates, references, conditions, loops, and HTML. ## Admin settings These are internal form settings: - **Internal title: **Only visible to admins in the SparkLayer dashboard. Useful to give clear internal name to the form that might differ from a public title. - **Read/unread tracking: **Enable marking entries as read or unread for this form. *** ## Notifications When you create a new form, the modal has an option to send new submission email notifications:  When this option is on, a "New submission notifications" workflow is added to the form, which sends an email to the store email address on new submissions. The workflow can be customised to modify the email address, or add any further logic. [title] Backend [path] / ## Introduction The *SparkLayer Backend* is essentially the mechanism whereby SparkLayer connects your B2B data behind the scenes. If you're using the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT), you can connect your backend systems and automatically send your B2B data to SparkLayer. Alternatively, you can use the manual import tools within the [Dashboard](docId\:nzsx6U_DAWtzVzSehf4oR) to configure your B2B data. *** ## Understanding how SparkLayer connects If we look at your *current* system architecture, it's likely that your eCommerce platform will be doing the following: - Talking directly to your backend systems (e.g. ERP, CRM, or iPaaS) to synchronise key data such as product information, customer data, order details - Providing the interface (i.e. a storefront) for retail customers to browse and place orders from  SparkLayer sits outside of this, with the SparkLayer [Backend](docId:-jSDFT3oqvpyda2H0Lw16) connecting to B2B-specific data, and the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) rendering wholesale-specific frontend features. *** ## Explore more ::::LinkArray :::LinkArrayItem [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT) Learn how the SparkLayer API works and what's possible ::: :::LinkArrayItem [Building Integrations](docId\:CmZj_EmE3vX8bU3J-xt3L) Learn how to build your own custom integrations with SparkLayer ::: :::LinkArrayItem [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) Learn how to configure advanced settings for product data ::: :::LinkArrayItem [Data Limitations](docId\:RN0x85hIjIuCz2406Cun9) Review our recommendations on data limits ::: :::LinkArrayItem [SparkLayer Ignite](docId:6b0jvnDWYHE1jmlIqkXtI) Learn about our B2B Commerce Framework for custom integrations ::: :::: [title] Building Integrations [path] Backend/ ## Introduction Are you looking to build your own custom integration to SparkLayer? If you're using the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT), you can connect your backend systems and automatically send your B2B data to SparkLayer. *** ## Understanding how to integrate For merchants using a backend system (e.g. an ERP or CRM), SparkLayer offers two options to connect to your data source of truth. | **Direct Connection** | **Middleware connection** | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Using the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT), you can build an integration to connect SparkLayer directly to your backend system. Implementation requires custom development (in-house or external) | Your existing middleware partner (e.g. an iPaaS) connects directly to SparkLayer to synchronise & map specific B2B data. Implementation is carried out by their technical team |  *** ## Available integrations SparkLayer integrates with a number of leading backend systems which make it rapid to connect your data to send to SparkLayer. [See our full list here](https://www.sparklayer.io/integrations/index.html). :::hint{type="info"} **Learn more** If you'd like to learn more about how SparkLayer interacts with different systems, please speak to our [Support](docId\:NNUw1G9z7eaJ4M78vk7t9) team and we'll be happy to talk further. ::: [title] Integrations [path] Dashboard/ ## Introduction :::hint{type="info"} **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 systems you'll be connecting SparkLayer to. *** ## Platform Integrations For listed third-party platforms, this has the added benefit of automatically connecting your website to SparkLayer. | Platform | Details | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Shopify` | If choosing [Shopify](docId:7TmhkOEHbgEGGFdd6EMr1), you'll be prompted to enter your Shopify store name (or 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 synchronised. | | `BigCommerce` | If choosing [BigCommerce](docId:6zLPH9x8-qEUITCHs2obE) , you'll be prompted to enter your BigCommerce Store ID. When you click "Save", you'll be taken off to BigCommerce to install the SparkLayer app. This will connect your Shopify store to BigCommerce and products and customer data will automatically be synchronised. | | `Wix` | If choosing [Wix](docId\:vEqgPapEA8X0X60U6ZWZe) , you'll be prompted to enter your Wix Site ID. When you click "Save", you'll be taken off to Wix to install the SparkLayer app. This will connect your Shopify store to Wix and products and customer data will automatically be synchronised. | | `Custom` | If choosing Custom, you'll need to manually send SparkLayer all necessary data. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to learn more. | :::hint{type="success"} **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. ::::Tabs :::Tab{title="🛍️ Using Shopify"} | Setting | Details | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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;Payment on Account orders - automatically mark as paidPayment by Invoice orders - automatically mark as paid | ::: :::Tab{title="New Tab"} Not applicable ::: :::: *** ### Configure metafields Within the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/integrations/platform), you can speed up the creation of metafields using our built-in tool to automatically configure them. ::::Tabs :::Tab{title="🛍️ Using Shopify"} To get started, go to **Integrations, Platform Connection** 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](https://admin.shopify.com/settings/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](https://admin.shopify.com/settings/custom_data) section within your Shopify store. ::: :::: *** ## Partner Ingrations SparkLayer supports a number of partner integrations that you can manage within the SparkLayer Dashboard. To see all available integrations, please see [Integrations](docId\:Eewk4JDEtPwyhjhrTwlvp). *** ## Data Sync To learn more about how the Customers Sync and Products Sync work, see [Data Sync](docId:8XClbafeyxHtt5begKM58) *** ## 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). *** [title] Account Settings [path] Dashboard/ ## Introduction The **Account** section in the Dashboard lets you manage your basic account details used on SparkLayer, update your password, and manage team members who have access to your SparkLayer Account. *** ## My Account From the My Account tab, you can edit the following information: | Field | Details | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Name` | Your full name | | `Email address` | Your email address used for logging into the SparkLayer Dashboard | | `Company Name` | The company name registered with SparkLayer | | `Website` | The website address registered with SparkLayer | | `Site ID` | This is used in setting up the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) and the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT) (if enabled) | :::hint{type="warning" attributes="[object Object]"} At this time, it is **not** possible to edit the fields pertaining to your company information. These are intrinsic to SparkLayer operating and any edits may cause errors within the SparkLayer integration. If you do need to make changes, please [contact us here.](https://forms.clickup.com/f/4b3cj-134/QGWV5GH8KV7KHQEBUS) ::: *** ## Plan From the Plan tab, you can check the current plan you're on as well as available options to upgrade or downgrade. ::::Tabs :::Tab{title="🛍️ Using Shopify"} If you're using Shopify, **all billing** is processed via Shopify directly. If you change plan, you'll be taken off to the Shopify admin to confirm the change and then processed monthly via Shopify. ::: :::Tab{title="🌐 Other platforms"} No configurations applicable or necessary ::: :::: *** ## Enterprise plan If you're using the Enterprise plan, you'll see your monthly cost within the **Plan Summary**. As with the Starter and Professional Plan, all payments are managed via Shopify directly. :::hint{type="info"} **Learn more** Looking to learn more about the Enterprise plan? [Get in touch](https://www.sparklayer.io/?demo#contact) with our team and we'll be happy to discuss further. ::: *** ## Password The Password tab lets you modify your existing password used for logging into the SparkLayer Dashboard. It's also possible to perform a password reset via the [SparkLayer login page](https://app.sparklayer.io/forgotten-password). *** ## Team ### Inviting team members If you're looking to invite additional people to your SparkLayer account, you can do so within the Team section. :::hint{type="warning" attributes="[object Object]"} Please note, only Team Owners can invite team members to collaborate on an account. ::: To get started, click the 'Add team member' button and you'll then see the following form:  From here, you can set the email address of the person you'd like to invite to your dashboard. They'll be granted full access to your dashboard to make edits as required. When you invite a team member, they'll then receive an email to activate their account. They'll be asked to "Accept Invitation" and create an account to get started.  ### Creating a new team :::hint{type="info"} **Please note** Any teams you create will be associated with your main SparkLayer account details. You can use these details to access any teams you set up. ::: If you're looking to use SparkLayer on more than one store, it's possible to create a brand new instance of SparkLayer using our built-in **"Create New Team"** feature. Use-cases could include: - You want to trial SparkLayer in "development mode" to allow you to test the features of SparkLayer - You have multiple stores within your brand and you require SparkLayer account for each of them In each scenario, once you've created a team you can then proceed to invite other team To access this, go to the [SparkLayer Dashboard](https://app.sparklayer.io/) and click your current team shown on the top left. You'll then see a button "Create New Team".  You'll then see the option to setup your team with the ability to specify a **Company Name **and **Company Website**.  Once you've created your team, you can access this via the top left of the SparkLayer Dashboard whenever you sign in. When a new team is created, you'll then need to proceed through the SparkLayer onboarding steps to get things setup (you can learn more in our [Launching SparkLayer](docId\:YUfghEGoxe_h7uJfcshna)). You can also proceed to invite any other team members to your new team by following the "Inviting team members" guide above. ### Changing Team Owner If you're the current team owner, it's possible to assign ownership to another individual via the [Team section](https://app.sparklayer.io/settings/team) of SparkLayer. Once you've invited a team member to the account, simply click the **Change owner** button where you'll then be asked to confirm this action.  *** ## Deleting your account Currently it's not possible to delete your SparkLayer account via the Dashboard. By default, if an account becomes inactive (e.g. you disconnect SparkLayer from your online store), our system will **automatically** delete the account associated with that team after 30 days. If an account is scheduled for automatic deletion, you'll see a warning message at the top of the dashboard notifying you. :::hint{type="warning"} **Please note** If you have **multiple** SparkLayer accounts, you may encounter this warning message on any accounts that do not have an active store connected with them. To make sure you're signed into the correct SparkLayer account, please click the menu beneath the SparkLayer logo on the top left and choose the appropriate store. ::: For further information, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Accessing the Dashboard ::::Tabs :::Tab{title="🛍️ Using Shopify"} **Accessing the SparkLayer Dashboard via your Shopify admin** To make accessing your dashboard more convenient, we've introduced a feature that **automatically** logs you into the team owner's SparkLayer Dashboard account linked to your Shopify app installation. For security reasons, if the email you use to log in to Shopify **differs** from the email associated with the SparkLayer team owners email, you will be logged in with **restricted access**. This limited access means you won't be able to: - Changing to other teams - Managing teams - Managing account details If you need full access to the dashboard, please log out and log back in using the team owner's credentials. ::: :::Tab{title="🌐 Other platforms"} No configurations applicable or necessary ::: :::: [title] Shipping [path] Dashboard/ ## Introduction SparkLayer allows you to set shipping rules for your B2B customers that show when they place an order via the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-).  There are two ways to manage your B2B shipping via SparkLayer: ::::WorkflowBlock :::WorkflowBlockItem **Using the shipping methods already set up on your store** You can use your pre-existing shipping methods as set up on your eCommerce store, even if you're using a third-party app to manage this. This is useful if you want to keep your shipping configuration within your eCommerce store and/or you have complex shipping requirements ::: :::WorkflowBlockItem **Using SparkLayer's shipping system** You can use SparkLayer to **set your own B2B shipping rules** that you can vary based on the B2B customer group. This is useful if you're running DTC and B2B on the same store and you want a simple way to differentiate your DTC versus B2B shipping rules. ::: :::: *** ## Understanding the differences ::::VerticalSplit{layout="middle"} :::VerticalSplitItem **Using your eCommerce store** ✅ **ADVANTAGES** - Uses the shipping admin of your existing eCommerce platformand will use rules and configurations you've set up (e.g. specific country/state-level shipping rules) - Handling for more complex shipping rules ⛔️ **DISADVANTAGES** - May not have support B2B-only shipping methods, unless using an app ::: :::VerticalSplitItem **Using SparkLayer** ✅ **ADVANTAGES** - Define B2B shipping rules that vary based on customer group type - Handling for order value and weight ⛔️ **DISADVANTAGES** - Support for only basic shipping types - Managed outside of your eCommerce platform's shipping admin ::: :::: *** ## Using your eCommerce Store *Please click a tab below to learn more* :::::Tabs ::::Tab{title="🛍️ Using Shopify"} Out of the box, SparkLayer uses the Shopify shipping setup. If you need help with setup, we recommend reading their guide [here](https://help.shopify.com/en/manual/shipping/setting-up-and-managing-your-shipping) or contacting Shopify support. Shopify live shipping rates or apps which provide shipping rules can also be used and the information will be pulled through. **Varying shipping for B2B / DTC customers in Shopify** Shopify has limitations in how shipping can be customised meaning that it's **not possible** **natively** to vary Shopify shipping methods and rules based on different customer types. For example, you may want a special 'B2B shipping method' to show when a B2B customer starts the checkout process. The solution to this is to use a **recommended Shopify** **app** to achieve the desired effect. Within the Shopify app store, there are a number of tools that include powerful functionality to enable more customer shipping on your Shopify store. One such is called [Intuitive Shipping](docId\:ZkesmMUAWX2SQQ7j6as07).  The app works by allowing you to set up special shipping rates and rules **based on customer tags**. For example, when a B2B customer signs in (i.e. one assigned with a customer tag of `b2b`), their specific B2B shipping methods can then be applied successfully. :::hint{type="info" attributes="[object Object]"} **Please note** If you're using Intuitive Shipping, we will need to enable a special setting to ensure the full shipping rates load within the SparkLayer widget. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to enable this for you. ::: **Changing shipping rates after an order is placed** You may want to change the shipping charges **after** the order is placed. If orders are left as drafts within Shopify or the customer uses the 'Request a Quote' payment option, it's possible to **adjust the shipping rate** to a custom amount. You can learn how this works [here](https://help.shopify.com/en/manual/orders/create-orders#add-shipping). This means that you could technically allow customers to select your *standard* Shopify shipping methods and then simply edit the shipping amount **once they've placed an order.**  **How shipping works in the SparkLayer Frontend** When a customer adds items to an order, the SparkLayer Frontend will automatically display their shipping rates as defined in your [Shopify Shipping admin](https://help.shopify.com/en/manual/shipping/shopify-shipping), giving them an accurate overview of their order cost. The user-journey works as follows: 1. The customer adds products to their order 2. When they're ready to checkout, they select their preferred shipping address 3. On the summary screen, they'll then be given their available shipping method to select (as you've set up within your Shopify shipping admin) 4. Once they select a shipping method, they'll be given their final total, including tax  If you'd like more details on how shipping works on Shopify, please refer to [Support](docId\:PGHGYVUTEu4gwwXNLAQl0). **Enabling an alternative to local pickup** Shopify allows merchants to enable a special shipping method called **'local pickup**' that allows customers to choose a store (or location) to pick their order up from. If you're using this feature on your Shopify store, unfortunately SparkLayer doesn't yet have direct support. An alternative that can work for merchants is to simply create a new shipping method within Shopify called 'Local pickup' that allows B2B customers to select during the checkout process on SparkLayer. Setting this up works just the same way as you would do when creating/editing other shipping methods with Shopify. Simply go to the shipping admin (`yourstore.myshopify.com/admin/settings/shipping`) and follow the steps to create a new shipping method and associated rates.  Once added, this will then display within the SparkLayer interface. :::hint{type="info" attributes="[object Object]"} **Please note** Unless you're using an app to hide/show shipping methods for B2B customers, this shipping method will show for regular (DTC) customers placing orders via the standard Shopify checkout process. To make this show **only for B2B customers**, you can configure your shipping rates directly in SparkLayer (see below). ::: :::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: ::::: *** ## Using SparkLayer SparkLayer has support for a variety of different shipping rules, allowing you to offer your B2B customers customised shipping rates that will show when they place an order on your website. To get started, within the SparkLayer Dashboard go to **Configuration** and click **Shipping** and you'll see the **Shipping** section. ### How Shipping Rates work Within your eCommerce platform, it's likely that you already have a variety of Shipping Rates set up. The Shipping section within SparkLayer is designed to **replicate this set up** ensuring that shipping rates synchronise correctly between systems. For example, your backend system may have a shipping rate set up whereby customers from the United Kingdom get **free shipping when spending over £100**. Within SparkLayer, this exact rule can be replicated allowing the customer to have a seamless experience when using the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) and using the checkout. ### Shipping Method & Shipping Bands Broadly speaking, when configuring your shipping it's important to understand the following terminologies: | Type | Details | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Shipping Method` | This is the shipping method the customer will see in their order summary and during the checkout process, e.g. Standard Shipping. Shipping Methods are assigned at a Country level | | `Shipping Band` | These are the specific rules you have within each Shipping Method. e.g. for orders under £100, shipping costs £20. For orders over £100, shipping is free. | ### Shipping Methods To create your first Shipping Method, click the **Create new method** button and you'll then see the following screen:  | Item | Details | | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Method Name` | This is the name the customer will see during checkout process so should be clear and easy to understand (e.g. Standard Shipping, Next Day Shipping, etc) | | `Shipping SKU` | This can be anything as long as it's unique across your shipping methods. For example, if the shipping method is called "Express Shipping", you could use express-shipping. Note: if you're using our API, this ID must match the corresponding shipping SKU in your backend system (e.g. ERP) | | `Priority Order` | If you are using multiple shipping methods, you can set which order they show in. e.g. enter "1" to make it show as the first, "2" as the second, etc. You will need to apply this to all Shipping Methods | | `Available countries` | Which countries will trigger this shipping method during the checkout process | | `State (or Region)` | For certain countries, you can optionally specify a specify state (or region/territory). Currently this includes: United States, Canada, Australia | | `Customer groups` | Which B2B customer group(s) the shipping method applies to | Once you've completed this information, you can then then begin adding Shipping Bands ### Shipping Bands Shipping bands let you define rules for the shipping method you've just created, allowing you to create different charges based on criteria being met. Currently, SparkLayer has support for: - Shipping bands based on **order total (NET)** - Shipping bands based on **order weight (in grams)** :::hint{type="info" attributes="[object Object]"} **Please note** Configuring Shipping Bands based on order weight will always be in grams, regardless of the unit of weight that you've set on products in Shopify admin. If you are using any other unit of weight (e.g oz or lb), then you will need to convert this into grams to use in our shipping tool. ::: Click **Add new band** to get started and you'll then see the following screen:  | Item | Details | | ----------------------- | ---------------------------------------------------------------------------------------------------------- | | `Shipping Band Name` | This is an internal name you can give the shipping band, e.g. Orders under £99 | | `Shipping SKU` | If your backend system has support for shipping band SKUs, you can enter it here | | `Shipping Cost Type` | You can choose from:
* Free * Fixed price * Percentage of the Net Total * Custom Message (see below) | | `Applicable Conditions` | Here you can set how the shipping band gets applied, e.g. based on a net total or a total order weight | For example, if you're looking to set up a shipping band that charges £20 for orders under £99, this would look like the following:  ### Custom Shipping Message Using the "Custom Message" shipping cost type (see above), it's possible to show custom text for a specific B2B shipping method. For example, you may want your B2B customers to select a shipping method but you can't confirm the cost at this point.  The messaging works by taking the **Shipping Band Name** (e.g. "Standard Shipping) and then displaying a special language string as the cost. When the order is placed, the shipping cost is simply set to 0.00, allowing you to then make edits accordingly. To customise the shipping cost message, you can add a special language string to your website to amend as you require. Once you set up a shipping band with a custom message, you'll see a **Language String** field at the bottom (e.g. "standard-shipping"). This can then be added as shown below to your website. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* [shipping-band-name] should be replaced with the name of your Shipping Band set in lowercase and uses dashes between words */ translations: { en: { "shipping.custom-message.standard-shipping": "To be confirmed", } }, /* End of code * ``` ### Setting custom shipping rates with Sales Agents If you're using the [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) tool, sales agents with "Administrator" priveleges can set custom shipping rates during the checkout that overright any default shipping rules you may have set up. :::Iframe{iframeHeight="0" code=""} ::: To learn more about how this works, see [our guide here](docId\:Uw8mDbMEfwWKqZrVB5CqX). ### Testing your Shipping Rates Whether you're using the Shopify shipping methods or custom methods via SparkLayer, once you've created your Shipping Methods and assigned Shipping Bands, you will then see these reflected in the [Quick Order Interface](docId\:lX4_OMChJ6reQ4hIW-Fqn) and checkout process.  We recommend trialling a few scenarios during your testing to make sure the shipping methods display as required. *** ## Troubleshooting :::ExpandableHeading **Shipping options not appearing for B2B customers** If shipping methods are not showing during checkout, check the following: - Ensure shipping methods are correctly configured in your e-commerce platform and assigned to the relevant regions. - If you are using SparkLayer Shipping Rules, confirm the method is enabled for the correct Customer Groups. ::: :::ExpandableHeading **Shipping bands (based on weight or order value) not calculating correctly** If shipping costs appear incorrect: - Confirm your shipping bands are set to the correct calculation type (Order Total or Order Weight). - Weight-based rules must always be set in grams. - Review each band to make sure there are no missing or overlapping ranges. ::: :::ExpandableHeading **Local Pickup not displaying** - We do **not** support the Shopify Local Pickup option. If you want to display this to your wholesale customers then you will need to create this as a free shipping method within Shopify or SparkLayer depending on what one you are using. - Confirm the method is available for the regions you are testing. ::: :::ExpandableHeading **Shipping not matching the shipping bands ** - Verify that the shipping rules are configured for the criteria you expect (e.g., weight-based vs. order-value-based). - Check that all products have valid weight and price data so calculations can be applied correctly. ::: :::hint{type="warning"} **⚠️ Having technical issues?** If you're having issues with setting this up or are experiencing error messages, please refer to our [Troubleshooting](docId\:BlCEkkx3I30nkUcglsfw7) guide or contact our [Support](docId\:NNUw1G9z7eaJ4M78vk7t9) ::: [title] Automation & Workflows [path] Features/Configurations/ ## Automatically mark orders as paid ::::Tabs :::Tab{title="🛍️ Using Shopify"} By default, when you set up SparkLayer on your Shopify store, unless you're using 'Upfront Payment', all orders created by customers will be generated as Draft orders within Shopify (learn about [Shopify Draft Orders](https://help.shopify.com/en/manual/online-sales-channels/wholesale/channel/orders/process-orders)). You can access these in the Shopify admin by clicking Orders and then Draft Orders. One of the big benefits of using Draft orders is the ability to make changes before you then take payment and fulfil. For example, you may need to adjust quantities of products ordered or apply a special shipping method. It's possible to automatically mark these orders as paid and then process them like any other order via the SparkLayer Dashboard under [Settings](https://app.sparklayer.io/configuration/integrations/platform).  ::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: :::: *** ## Sending email notifications for draft orders :::::Tabs ::::Tab{title="🛍️ Using Shopify"} If your customers are placing orders and paying by manual payment methods (such as *Pay by Invoice* or *Request for Quote*), these orders will automatically come through to Shopify as Draft orders. By default, Shopify **doesn't notify you of Draft orders** but there are some great ways to solve this. One such way is to use [Shopify Flow](docId\:uvXV1kUg_VsZEPr5Dlb2z), a free app made by [Shopify](http://apps.shopify.com/flow). This allows you to create workflows to automate many tasks in your store and across apps. In our [Shopify Flow for B2B](docId\:uvXV1kUg_VsZEPr5Dlb2z) guide, you can find some ready-made "Flow templates" that can help automate your email notifications. Another option would be to use the highly popular Shopify app called [Mechanic](https://apps.shopify.com/mechanic), which is a **development and automation platform** available to all Shopify merchants. Similarly to [Shopify Flow](https://apps.shopify.com/flow), it gives the flexibility to automate actions to suit your own business workflows. We've provided a sample below that you can simply set up within Mechanic. If customers have opted to pay via manual payment methods, you can automatically **send an email to a specified email address** to notify them to review the order. :::ExpandableHeading **View sample code ** ```json {"docs":"For newly-created draft orders which are quotes from Sparklayer, it sends an email.","halt_action_run_sequence_on_error":false,"name":"SparkLayer - Send email for new quote","online_store_javascript":null,"order_status_javascript":null,"perform_action_runs_in_sequence":false,"script":"{% if options.email_recipient__email %}\n {% assign email = options.email_recipient__email %}\n{% else %}\n {% assign email = shop.email %}\n{% endif %}\n\n{% assign sparkPaymentType = draft_order.note_attributes[\"sparkPaymentType\"] %}\n{% if sparkPaymentType == 'quote' %}\n {% action \"email\" %}\n {\n \"to\": {{ email | json }},\n \"subject\": \"New quote {{ draft_order.name }}\",\n \"body\": \"View the quote here: https://{{ shop.domain }}/admin/draft_orders/{{ draft_order.id }}\",\n \"reply_to\": {{ shop.customer_email | json }},\n \"from_display_name\": {{ shop.name | json }}\n }\n {% endaction %}\n{% endif %}","shopify_api_version":"2022-10","subscriptions_template":"shopify/draft_orders/create","subscriptions":["shopify/draft_orders/create"],"preview_event_definitions":[],"options":{"email_recipient__email":null}} ``` ::: :::: :::Tab{title="🌐 Other platforms"} No configurations ::: ::::: :::hint{type="success"} **Learn more about Shopify Flow** You can see our full Shopify Flow guide in our [Shopify Flow for B2B](docId\:uvXV1kUg_VsZEPr5Dlb2z) guide. ::: [title] Customers [path] Dashboard/ # Introduction The Customers area is where you manage everything related to your B2B customer base and sales team. From here, you can: - **Groups** - configure customer groups with specific ordering rules - such as price lists, payment methods, order limits, and additional settings. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) - **Customers** - view and manage your B2B customer records, including their assigned groups, price lists, and account details. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) - **Agents** - set up and manage your sales agents, including assigning roles and controlling which customers they can access. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) - **Roles** - create and manage roles that control what each sales agent can see and do in SparkLayer. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) *** # Groups The **Customers Groups** section is the heartbeat of your SparkLayer integration and allows you to manage the ordering rules for your customers. 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. This includes: - Setting which price lists they use - Setting which payment methods they can use - Setting order limit rules (e.g. minimum and maximum order totals) - Setting additional settings (such as blocking the ability to edit an address)  *** ## The default customer group By default, SparkLayer has a **Base customer group** that is a catch-all for all your B2B customers. If you're looking to have just a single B2B customer group then the **Base customer group** will be sufficient. Any changes you make will automatically apply to all your B2B customers unless you create new customer groups. :::hint{type="info" attributes="[object Object]"} **Understanding 'Inheriting' ** When you see **Inheriting** in a customer group, it means it will **inherit** settings from another customer group, by default the "Base". For example, if your Base customer group is set to a specific price list or has specific payment methods, any new customer groups you create will start off by **using these same settings**. You can easily modify this by simply clicking the *Edit icon* and changing them as you need. ::: *** ## What can be configured It's possible to configure the following rules | Rule type | Description | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Order Limits` | You can set order limit rules for your customers, such as the minimum **order total **or minimum **quantity of items **they must reach before being able to place an order (and conversely, the **maximum** of these) | | `Payment Methods` | The payment methods that the customer will see when they checkout. For example, "Payment on Account" and "Payment by Invoice". See also [Payment Methods](docId\:ibIKczvHM085BkeJIfFYv) | | `Price Lists` | The [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) that are assigned to that customer group. For example, you may have different price lists per customer group | | `Address Management` | If activated, your customers will be able to edit and add addresses via the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) and the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-). | | `Credit Settings` | If you have [credit limits](docId\:yWm70oQUosyKOoIqb4Z4G) set up, you can optionally choose to prevent customers from being able to checkout if they exceed their credit limit. | | `Stock Display Settings` | Configure if stock levels and units are displayes ans your max, low and last stock values. | | `Stock locations` | If you're store is set up with multiple stock locations ("inventory locations"), you can specific which location the B2B customer orders from. | | `Quoting engine` | If you have the SparkLayer [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) activated, you can specify which customers can submit quotes. | ### Order Limits There are two types of order limits you can set for your B2B customers: | Order Limit Type | Details | | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | | `Order limits by order total` | Set rules based on the customers order total, e.g. the customer must spend more than $100 | | `Order limits by order quantity` | Set rules based on the number of items in the customers order, e.g. the customer must have at least 50 items. | | `Combination` | Set rules based on both an order total AND the order quantity | **Order limits by order total** To configure order limits by order total, click the **Edit** icon next to a customer group and under the **Inherited rules** section, click **Order total limits**. If the customer group doesn't already have an order limit set, click the **plus** icon and then the order limit values you want. | Limit type | Details | Example | | ---------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------- | | `Minimum` | This is the minimum order total the customer must have before being able to checkout | The customer must have an order total of at least $200.00 | | `Maximum` | This is the maximum order total the customer must have before being able to checkout | The customer must have an order total of no more than $400.00 | :::hint{type="info"} **Please note** All order values are in **net** pricing (i.e. excluding tax calculations) ::: Once you've set this, when you access the Quick Order on the frontend, you'll then see corresponding messaging show on the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-).  If you'd prefer to change the default language that is shown, you can use the below language strings. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.validation-message.minimum-order-totals": "Your order must be more than {amount} to meet the order requirements.", "cart.validation-message.maximum-order-totals": "Your order must be less than {amount} to meet the order requirements.", } }, /* End of code */ ``` **Order limits by order quantity** To configure order limits by order quantity, click the **Edit** icon next to a customer group and under the **Inherited rules** section, click **Order quantity limits**. If the customer group doesn't already have an order limit set, click the **plus** icon and then the order limit values you want. | Limit type | Details | Example | | ---------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | `Minimum` | This is the minimum order quantity the customer must have before being able to checkout | The customer must have an order quantity of at least 12 items | | `Maximum` | This is the maximum order quantity the customer must have before being able to checkout | The customer must have an order quantity of no more than 40 items | Once you've set this, when you access the Quick Order on the frontend, you'll then see corresponding messaging show on the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-).  If you'd prefer to change the default language that is shown, you can use the below language strings. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.validation-message.minimum-order-item-quantity": "Your order must have at least {minimum} items to meet the order requirements.", "cart.validation-message.maximum-order-item-quantity": "Your order must not exceed {maximum} items to meet the order requirements.", } }, /* End of code */ ``` ### Payment Methods You can specify what payment methods are shown for each customer group by clicking the **Edit** icon next to a customer group and under the **Inherited rules** section, click **Payment methods**. You'll then see the following options:  :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info" attributes="[object Object]"} **Payment methods in Shopify** By default, when you set up SparkLayer on your Shopify store, unless you're using 'Upfront Payment', **all orders** created by customers will be generated as **Draft orders** within Shopify (learn about [Shopify Draft Orders](https://help.shopify.com/en/manual/online-sales-channels/wholesale/channel/orders/process-orders)). One of the big benefits of using Draft orders is the ability to make changes before you then take payment and fulfil. ::: | Payment method | Description | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by invoice` | The order will be submitted as a "Draft" order which can subsequently be edited. Orders can automatically be converted into "Completed" orders if required. See [Settings](docId\:gznStzTqCRffLFZSTAw0N) | | `Payment on Account` | The order will be submitted as a "Draft" order which can subsequently be edited. Orders can automatically be converted into "Completed" orders if required. See [Settings](docId\:gznStzTqCRffLFZSTAw0N) | | `Upfront Payment` | Customers will be taken through the Shopify checkout. | | `Request for quote` | The order will be submitted as a "Draft" order which can subsequently be edited.
*Please note: as of June 2025, this has been replaced with the *[SparkLayer Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo)* and can no longer be selected within a Customer Group.* | :::: :::Tab{title="🔵 Using Wix "} When customers reach the payment step, they'll see a variety of available payment methods and can select their preference. | Payment method | Description | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment on Account` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** needing to enter any payment details (e.g. via net terms). [Learn more](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details. | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). This is sometimes referred to as "Pro-forma payment". | **How orders arrive into Wix** Depending on which [payment method](docId\:ibIKczvHM085BkeJIfFYv) you've selected, orders will arrive into Wix in the following ways: | Payment Method | Flow | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Pay by Invoice` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay on Account` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay Online by Card` | The order will be created within **Sales > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | | `Request for Quote` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | **"Unpaid" orders and "Paid" orders** By default **all payment methods** other than Upfront Payment will be generated as "Unpaid" orders. **Wix checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the Wix checkout. By default, they will see all Wix payment methods you have set up (e.g. card payment, Paypal, etc). ::: :::Tab{title="🌐 Other Platforms"} | Payment method | Description | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by invoice` | This will allow the customer to place an order without having to enter payment details | | `Payment on Account` | Similar to above, the customer can place an order without needing to enter any payment details | | `Upfront Payment` | The customer will be required to enter credit/debit card details and will see the payment methods you have set up during the checkout process. This is sometimes referred to as Proforma payment within wholesale operations | | `Request for quote` | The customer can submit their order without choosing a payment method. The order will be marked as a 'Draft' order and can subsequently be edited. | ::: ::::: When the customer activates the [Quick Order Interface](docId\:lX4_OMChJ6reQ4hIW-Fqn), they'll see whichever payment methods are allowed and can then select as appropriate. You can also edit how these are named in [Quick Order Interface](docId\:lX4_OMChJ6reQ4hIW-Fqn).  ### Price Lists Depending on which price lists you have set up in the [Price Lists](docId\:lDePanHogqwEGNf-jHZ6L) section, you can assign specific price lists to customer groups. Click the **Edit** icon next to a customer group and under **Inherited rules**, click **Price lists**. If the customer group doesn't already have a price list set, click the plus icon and then choose the available Price List from those shown.  You can also assign **multiple price lists **to a customer group if you want to set up more sophisticated pricing. Simply click **Add price list** to select a price list.  :::hint{type="info"} **Please note** In terms of pricing, if a product SKU exists in multiple price lists, SparkLayer will search through all available price lists and use the first one it finds. For example: - Product `ABC-123`exists in 3 price lists - In `Price List 1`, it is **$10** - In `Price List 2`, it is **$8** - In `Price List 3`, it is **$12** SparkLayer will select the first price it finds. In this case, product `ABC-123` will be shown to the customer at a **price of $10**, using `Price List 1` ::: ### Address Management If activated, your customers will be able to edit and add addresses via the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) and the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-).  You can also optionally choose to prevent billing address editing by unticking "Allow customers to add and edit billing addresses". :::hint{type="warning"} **Please note** 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. ::: ### Credit Settings If you have [credit limits](docId\:yWm70oQUosyKOoIqb4Z4G) set up, you can optionally choose to prevent customers from being able to checkout if they exceed their credit limit.  ### Stock Display Settings :::hint{type="warning"} **Please note** This feature requires upgrading your store to the latest version of the [the Sparklayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). ::: If you'd like to display stock levels to your B2B customers, you can activate the **Stock display** and customise how this works. When a customer visits a product page on your store, they'll then see their specific stock display settings as detailed in [our guide here](docId\:Gj_Ao_gQ6oA-jx0D27Hys). To get started, edit a customer group and under Inherit rules, click **Stock display.** :::hint{type="success"} **Applying this to all customers** If you want to apply this to all customer groups, simply apply the setting to the **Base** customer group and all others will 'inherit' the settings. ::: Once activated, you can then configure how the stock display works: | Configuration | Details | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Show stock availability to customers` | When enabled, customers can see the stock status of the product (and individual SKU) | | `Hide pre-order` | When enabled, this will hide any pre-order messaging shown to customers in the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). You can learn more about how pre-order works in [our guide here](docId\:Gj_Ao_gQ6oA-jx0D27Hys). | | `Show number of units of stock` | When enabled, customers can see the availability of the product (e.g. 50 in stock) | | `Max` | When `Show number of units of stock` is enabled, this will show to the customer in green. Anything above will show as 50+ | | `Low` | When `Show number of units of stock` is enabled, this will show to the customer in amber and denotes low levels of stock | | `Last` | When `Show number of units of stock` is enabled, this will show to the customer in red and denotes the last remaining stock | :::hint{type="success"} **Looking to enable pre-ordering?** You can enable pre-orders and back orders in [our guide here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) ::: ### Stock locations ("inventory locations") :::hint{type="warning"} **Please note ** The stock locations feature is **only** available on the SparkLayer *Growth, 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. ::: Stock locations allow you to specify which stock (or "inventory") locations you want specific customer groups to see stock display settings from. If your B2B store is set up with **multiple stock locations** (e.g. by geography), it's a great way to ensure your B2B customers are viewing stock dispaly settings from the relevant location. For example, your store may be set up with 4 stock locations across the world. Using this feature, you can easily assign B2B customers to a specific geographic location, so that they can only see stock display from their specific region. To begin using stock locations, click the **Edit** button next to a customer group and you'll see the option under the **Inherit rules** section. :::hint{type="info"} **Default stock location** Please note, if stock locations are **not** specifically set, SparkLayer will assume that stock will be taken across **all locations **setup within your store. :::  :::hint{type="info"} **Please note** Currently, it's only possible to select **one stock location** per customer group. ::: :::hint{type="warning"} **Please note ** SparkLayer's Stock Location feature is for stock display purposes only and will not affect which stock location is used to fulfill orders in your eCommerce platform. ::: Using stock locations requires configuration within your specific eCommerce platform and we've detailed how it works below. ::::::Tabs :::::Tab{title="🛍️ Using Shopify"} To get started, you'll nee to ensure that [Locations](https://admin.shopify.com/settings/locations) are enabled within your Shopify store. You can learn more about how locations work in this [Shopify guide](https://help.shopify.com/en/manual/locations). Any active locations will then be automatically synchronised to SparkLayer.  There are a number of configurations that need to be reviewed when setting up your locations in the context of your B2B customers. ::::WorkflowBlock :::WorkflowBlockItem **Fulfilment details** You'll need to ensure any locations that you want to use for your B2B customers have the "Fulfill online orders from this location" checkbox ticked.  ::: :::WorkflowBlockItem **Order routing** You may also want to review how Shopify prioritises your stock locations using [order routing,](https://admin.shopify.com/settings/shipping/order_routing) allowing you to customise the workflow rules for your stock control.  ::: :::WorkflowBlockItem **Store setup (hybrid B2B and DTC)** If you're store is set up to "share" B2B and DTC on the same store, it's important to note the following if you're using Stock locations: 1. Logged in B2B customers will be able to purchase products from the stock locations you've assigned to them. For example, if a customer has the **"London Warehouse" **assigned to their customer group and **Product A** has 100 available from this warehouse, they can order a maximum of 100. 2. Setting up stock locations for your B2B customers will **not** prevent your regular (DTC) customers from purchasing the same stock. Depending on how your Shopify store is configured, regular customers can still access the same stock and place orders. SparkLayer does support the ability to reserve stock and set minimum stock levels and you can [learn more here.](docId\:Gj_Ao_gQ6oA-jx0D27Hys) ::: :::: ::::: :::Tab{title="🌐 Other Platforms"} Please refer to our technical documentation, [Stock Locations](docId\:who9uQj6ZLDP88g2XWdau) ::: :::::: ### Disable checkout By default, all customer groups are configured to allow customers to proceed through the checkout (providing they meet the order requirements). There may be some scenarios where you want to prevent a customer from being able to checkout and you can deactivate this within the "Disable checkout" setting. If you're using the [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo), one use-case would be to deactivate this setting and only allowing the customer to "Submit a quote". *** ## Creating new customer groups New customer groups allow you to create different rules for different customers. When you create a new customer group, you'll see the following screen where you can enter a **Display Name** and a **Handle**. The Handle is a unique identifier that you can then use in your eCommerce platform (e.g. Shopify) to match with (see below for more details).  ## Synchronising customer data :::::::Tabs :::::Tab{title="🛍️ Using Shopify"} :::hint{type="warning" attributes="[object Object]"} Please note: - You need to **always** tag a customer with `b2b` even if you are assigning them to an additional customer group - Customers cannot have **more than two** `b2b` related tags assigned to their customer record in Shopify. For example: ✅ This is correct `b2b` `b2b-vip` ❌ This is incorrect `b2b` `b2b-vip` `b2b-user` ::: For your Shopify store to recognise the customer rules you set up in SparkLayer, it uses the **customer tag** feature within Shopify. Once a customer in Shopify is tagged, when they sign into your Shopify store they will see their unique B2B ordering rules such as pricing and payment methods. For the most simple set up, if you're using just the **Base** **customer group**, you can synchronise your customer rules with Shopify by simply tagging customers with `b2b` as shown below.  If you've set up **additional** customer groups, the process works as follows: ::::WorkflowBlock :::WorkflowBlockItem First, within SparkLayer create your customer group and give it a unique Handle, e.g. `vip` ::: :::WorkflowBlockItem Under the Shopify Tag column, make a note of tags that are shown. You'll note there is an additional tag to b2b, so in our example, the tags we want to note are `b2b` and `b2b-vip` ::: :::WorkflowBlockItem Find the customer record in Shopify and assign it the tags shown. So for our example below, if you wanted to assign them to the VIP group, you would tag them in Shopify with `b2b` and `b2b-vip`. If the tag doesn't already exist in Shopify, you can simply create is as a **new** tag which can then be assigned to other customers. ::: ::::  :::hint{type="warning"} **Assigning customer groups** Please note, a customer can only be assigned to one B2B customer group. If you're looking to assign multiple price lists to a customer, you can do so by [configuring price lists](docId:5_lWMNohhjBJJppg9E6Vh). ::: ::::: ::::::Tab{title="🔵 Using Wix"} To get started, please following the below steps: :::::WorkflowBlock ::::WorkflowBlockItem Within Wix, go to **Customers & Leads** and click **Contacts. **You can either create a new customer or edit an existing one. :::hint{type="warning"} **Please note** Please ensure that a valid address is added and all address fields are populated. Make a note of the email address you’ve added as you will need to access this to login. :::  :::: ::::WorkflowBlockItem To synchronise to SparkLayer, the customer must have a label of `b2b` assigned to them and be a **Site Member**. :::Iframe{iframeHeight="0" code=""} ::: You can set this up by clicking the **Add Label** button when editing a customer.   :::hint{type="warning"} **Please note the following on customer groups** - SparkLayer will only synchronise customers that have a label of `b2b` assigned - If you have created additional [customer groups](https://app.sparklayer.io/customers/groups) within SparkLayer, please ensure that the labels are added to the contact record in Wix exactly as shown. e.g. `b2b` `b2b-additional-group` - Customers must be set up as **Site Members** to be able to sign in to your online store. - When adding a new label in Wix, please ensure that it is not subsequently edited. ::: :::: :::WorkflowBlockItem Once your customers have been set up in Wix (i.e. those with a label of `b2b`), and you've assigned the customer group to **at least** one customer, you can then manage specific rules within the [Customer groups area.](https://app.sparklayer.io/customers/groups)  ::: :::WorkflowBlockItem You'll see a default **Base** customer group that you can use for your B2B customers. If you want to set up additional rules, you can simply click **Create Customer Group** and configure accordingly. For any additional customer groups you create, you'll need to update the labels on the customer record in Wix to match (e.g. `b2b` and `b2b-account`) ::: :::WorkflowBlockItem To simulate logging in as a B2B customer, please see **✅ Testing & launching** below. ::: :::WorkflowBlockItem You can also check if your customer record is syncing by using the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. Within Wix, navigate to a Contact record that has a label of b2b. Within the URL, you'll see a unique ID at the end of the URL. In the example below, the unique ID is `66b4c99a-3431-47d6-995d-309e4e8c5908`  With this unique ID, you can then paste this into the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. If the search results show the customer details, this confirms the customer is synchronosing correctly.  ::: ::::: :::::: :::Tab{title="🌐 Other Platforms"} No configurations applicable or necessary ::: ::::::: *** ## Testing a customer :::hint{type="success"} **🚀 See our full launch check list** You can see our full [launch checklist guide here](docId\:YUfghEGoxe_h7uJfcshna) which covers the key steps to testing and then launching SparkLayer to your B2B customers. ::: To simulate a B2B customer on your store, you can configure a sample customer within your eCommerce store. :::::::Tabs ::::::Tab{title="🛍️ Using Shopify"} :::::WorkflowBlock :::WorkflowBlockItem **Ensure customer accounts are enabled** You’ll need to make sure that customer accounts are **enabled** on your storefront so that customers can sign in. Within your Shopify admin, go to [Customer Accounts](https://admin.shopify.com/settings/customer_accounts) and select either "**Customer Accounts**" or "**Legacy Accounts**" (both are compatible with SparkLayer). ::: :::WorkflowBlockItem **Edit or create a customer record** Within your [Shopify Customers admin](https://admin.shopify.com/customers), find an **existing** customer record or add a **new one**.  Fill in all the form fields, **including the address**. It's important that an address is specified otherwise SparkLayer won't find the customer record. ::: ::::WorkflowBlockItem **Tag the customer** Next, tag the customer with `b2b` From within the customer record in Shopify, go to the **Tags** section and type `b2b` into the field. You can either choose from an existing tag, or add it as a new tag :::Iframe{iframeHeight="0" code=""} ::: :::: :::WorkflowBlockItem **Invite the customer** If you're using Shopify "**Customer Accounts**", you can simply direct your customers to the login page and they can then enter their email to receive a 6-digit access code. You can access this by going to `www.yourstore.com/account`. If you're using "**Legacy accounts**" and you're creating a brand new customer record, you'll need to click "**Send account invite"** and then confirm the account once you've received the activation email ([learn more here](https://help.shopify.com/en/manual/customers/customer-accounts#invite-customers-to-create-accounts)).  The customer will then receive an email asking them to confirm your account by setting a password. Should you require, you can also edit the contents [of this email here](https://admin.shopify.com/email_templates/customer_account_activate/preview).  ::: ::::WorkflowBlockItem **Login as a customer** Finally, return to your website and visit the login page (e.g. `www.yourstore.com/account`) and enter your details. If you're using Shopify "Customer Accounts", you'll be prompted to enter a 6-digit code that will be sent to your email. You'll then see SparkLayer load and you can browse your store as a B2B customer! :::hint{type="info"} **Please note** If you can't access this page, make sure you have [customer accounts enabled](https://admin.shopify.com/settings/customer_accounts). ::: :::: :::WorkflowBlockItem **Inviting customers** To learn more, please see [our full guide here.](docId\:YUfghEGoxe_h7uJfcshna) ::: ::::: :::::: :::Tab{title="🌐 Other platforms"} Please refer to your platform for details. ::: ::::::: :::hint{type="info"} **Checking a B2B customer** You can also check that a B2B customer has successfully synchronised to SparkLayer in the [Customer Sync](https://app.sparklayer.io/data-sync/customers) tool within the SparkLayer Dashboard. ::: *** # Customers The [Customers](https://app.sparklayer.io/customers/list) page shows a list of all B2B customers that can place orders on your store. Each row displays the customer's name, email, assigned role, and customer group - giving you a quick overview of your entire B2B customer base. Use the search bar at the top to find a specific customer by name or email. :::hint{type="info"} **Please note** Customer data is synced from your connected platform (e.g. Shopify). If the sync encounters any issues, you'll see a notification at the top of the page with the option to view errors and resolve them. ::: **Viewing a customer** Click **View** on any customer to open their detail page. From here, you can see: - **Basic information** - email, company name, customer group, price list overwrites, and sales agent group - **Financial details** - discount percentage and accounting ID - **Payment on account** - balance, credit limit, net terms, and currency - **Role** - assign the customer as a standard customer, sales agent, or sales administrator - **Company users** - view all users associated with this customer and their roles - **Addresses** - default shipping and billing addresses :::hint{type="info"} **Please note** Customer information is pulled from your connected platform. To update fields like email or company name, make changes in your Shopify admin and they'll sync across to SparkLayer. ::: *** # Agents The [Agents](https://app.sparklayer.io/customers/agents) page shows all sales agents that have been set up to place orders and manage accounts on behalf of your B2B customers. Each row displays the agent's name, email, role (Sales Agent or Sales Administrator), and their assigned group. Use the search bar to find a specific agent by name or email. You'll also see a summary at the top showing how many sales agents you've assigned out of your total allowance. **Viewing an agent** Click **View** on any agent to open their detail page. From here, you can see their basic information, financial details, and payment on account settings - just as with a standard customer record. **Assigning a role** The Role section lets you control the level of access for each agent. Select one of the following options and click **Save role**: - **Customer** - can log in and place orders (removes sales agent access) - **Sales agent** - can place orders and manage addresses, shopping lists, and company access on behalf of customers - **Sales administrator** - all sales agent permissions, plus the ability to edit order prices and create new customers If you want agents to only see specific customers, you can restrict their access using groups. Select one or more groups from the dropdown beneath the role options - or leave it empty to allow access to all customers. You can learn more about how sales agents work, including the ordering experience, payment flows, and advanced features, in our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) guide. *** # Roles The [Roles](https://app.sparklayer.io/customers/roles) page lets you manage permissions and access levels for your sales team. Instead of managing permissions individually per agent, you can create reusable roles and assign them across your team - keeping things organised as you grow. The list view shows each role's name, type (system role or custom), and how many agents are currently assigned to it. **System roles** SparkLayer includes two built-in system roles that cover the most common setups: | Role | Description | | ------------- | -------------------------------------- | | `Sales Agent` | Standard access for day-to-day selling | | `Sales Admin` | Full access across the SparkLayer app | :::hint{type="info"} **Please note** System roles cannot be edited or deleted. ::: **Creating a custom role** Click **Create role** to build a role with specific permissions tailored to your team. Enter a role name, check or edit the handle (auto-generated), and then select the permissions you want to allow. Permissions are organised into two categories: **Orders** - Edit quoted prices - change the price of items that have been quoted to a customer - Edit custom items - add or modify custom line items on an order - Edit custom shipping - override the shipping method or cost on an order - Override product settings - bypass product-level rules like minimum order quantities or increments - Complete Checkout - place orders via the normal checkout process - Create Quotes - create quotes via the checkout - Edit Quotes - edit quotes once created - Complete Quotes - finalise quotes once approved - Archive Quotes - archive quotes when no longer required - Edit Quote Assignee - manage the sales agent assigned to quotes **Customers** - Create new customers - add new customer records to the platform - Edit addresses - update shipping and billing addresses on a customer's account - Edit address defaults - change which address is set as the default for shipping or billing Click **Save** when you're done. To edit an existing custom role, find it in the list and click **Edit** - any changes will apply immediately to all agents assigned to that role. You can learn more about how sales agents work, including the ordering experience, payment flows, and advanced features, in our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) guide. [title] Installing SparkLayer on Shopify [path] Integrations/Shopify/ :::hint{type="success"} **👋 We're here to help!** Our team can help get everything set up on your Shopify store. You can [book a call here](https://meetings-eu1.hubspot.com/sparklayer/onboarding) and we'll walk you through the process! If you'd prefer, you can also use our guide below to try setting things up yourself. ::: ## Introduction SparkLayer enables B2B functionality on your existing Shopify store, allowing your B2B customers to login, place orders, manage their account, and much more.  To familiarise yourself with SparkLayer, we also recommend reviewing the following guides: ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [How SparkLayer Works](docId:_2g8HwCXnN7OFy4o199y1) The fundamentals of what SparkLayer does ::: :::LinkArrayItem [Frontend](docId\:OgKfvQX13dHW2582D57kJ) The special "interfaces" SparkLayer enables ::: :::LinkArrayItem [Features](docId\:SSzdKXuNMlEIDOOITHQcU) The available features and functions. ::: :::: *** ## What to expect Our customers typically get up and running in a matter of days and the process works as follows:  Our team is available to help support you during the process, from helping set up the special [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa), walking you through how to set up [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) and [Customers](docId:5_lWMNohhjBJJppg9E6Vh), as well as recommending the best ways to go live with our [Launching SparkLayer](docId\:YUfghEGoxe_h7uJfcshna). *** ## ⚠️ Requirements Before installing SparkLayer on your Shopify store, please ensure the following: | Item | Details | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customer Accounts` | Customer accounts must be enabled on your storefront so customers can sign in. Within your Shopify admin, go to [Customer accounts](https://admin.shopify.com/settings/customer-accounts) and choose the version you'd like to use. SparkLayer is compatible with both **Legacy (Classic) and New customer accounts** - see *Shopify customer accounts* below. | | `Product SKUs` | All products must have SKUs assigned so SparkLayer can save B2B prices against them. See [Shopify's SKU](https://help.shopify.com/en/manual/products/details/sku) guide if you need to add them. | | `Customers` | B2B customers must have a **b2b** tag on their customer record and at least one address assigned. | | `Payment Processor` | If you’re installing SparkLayer on a test store, please ensure you have an example [payment method](https://admin.shopify.com/settings/payments) enabled. | *** ## 👤 Shopify customer accounts When setting up your Shopify store, it's possible to choose from two types of 'Customer Accounts' within Shopify: - **Legacy customer accounts (formerly "Classic"):** this is how most Shopify stores are set up and allows compatibility with third-party apps and the ability to customise the look and feel - **New customer accounts**: this uses a 'password-less login' and has a locked down account area that uses Shopify's 'out of the box' functionality (very similar to the checkout) **Setting up customer accounts** To check which version you're using, within your Shopify admin, click **Settings** and go to [Customer Accounts](https://admin.shopify.com/settings/customer_accounts). Under 'Customer accounts', simply click the Edit button to change the version.  If you're using Legacy customer accounts, there's no further action to take and SparkLayer is fully compatible. If you're using New customer accounts, there are some minor configurations to apply to your Shopify store to ensure compatability with SparkLayer (see our guide below). **Which version should I use?** SparkLayer is compatible with both options and there are some advantages and disadvantages with both. | Version | Advantages | Disadvantages | | ------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `Legacy (Classic)` | - Smoother customer experience - No configurations required | * Funcionality is specific to your Shopify store * Not fully supported by Shopify | | `Customer accounts (New)` | - Works on all Shopify stores - Actively maintained by Shopify | * Limited customisations (e.g. you cannot customise the look and feel) * Relies on 6-digit code rather than password | ::::ExpandableHeading **Configuring new customer accounts with SparkLayer (click to expand) ** :::hint{type="info"} **Need assistance?** Please speak to our [suppor team](docId\:NNUw1G9z7eaJ4M78vk7t9) if you require any help setting this up. ::: To ensure new customer accounts are compatible with SparkLayer, there are 2 actions to take: 1. First, enable the SparkLayer "customer account extension" within your Shopify settings (see below) 2. Secondly, you can then optionally update your theme with a special code snippet that makes the login process a little smoother You can see how it works in our video below ::embed[]{url="https://www.youtube.com/embed/xyQ08k19NxM"} **Adding an automatic redirect to the customer account area** The first step is to enable the special SparkLayer customer account extension within your Shopify store. Once setup, if a B2B customer accesses the Shopify customer account area, they will automatically be redirected and taken back to your online store. In your Shopify admin, go to Settings, Checkout, and within [Configurations](https://admin.shopify.com/settings/checkout#checkoutprofiles), click "Customize".  From the top, navigate to the "Orders" page, click "Apps" on the left, and then enable the **"B2B Account Redirect" **extension. You can also include: - Some optional placeholder text that shows before the customer is redirected should you wish to inform them that they are being redirected. - A specific destination URL to take the customer to once they are redirected. For example, you may want to take them to a specific collection page or a landing page.  Finally, click "Save" and that will complete the process. You only need to apply this once and it'll take effect on all pages within the Shopify Customer Account area **Updating your theme** :::hint{type="info"} **Learn more** You can read the official [Shopify technical guide here](https://shopify.dev/docs/storefronts/themes/login). ::: In additional to the automatic redirect detailed above, you can also add some minor customisations to your Shopify theme to make the process a little smoother. With the addition of some minor code, you can redirect a customer back to the page they were viewing prior to logging in. Once set up, when a customer signs in, they'll be taken back to your store and can proceeed to use SparkLayer. To get started, you'll need to locate the Shopify liquid code that controls the My Account link.  In our sample code below, we've modified the link destination with the correct syntax. ```html {%- if shop.customer_accounts_enabled -%} {%- endif -%} ``` Similarly, you can add the route to any URL on your storefront: ```html Login ``` :::: *** ## 🚢 The Onboarding process When you create an account on SparkLayer, you'll get access to the SparkLayer dashboard, which guides you through the steps needed to get up and running. The onboarding process has the following phases: **1. Test how SparkLayer works** Before installing anything on your theme, you'll first experience SparkLayer as a B2B buyer would. The dashboard walks you through three quick steps: | Step | What happens | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Create a price list** | Set up your first B2B price list - either as an automatic discount on your Shopify prices, or by uploading a CSV. Learn more about pricing. | | **Set up a customer** | The dashboard creates a test customer for you, automatically tagged b2b and assigned to the price list you just created. | | **Place an order** | Sign in as your test customer, browse your store, and place a test order to see SparkLayer's full B2B experience. The order appears as a Shopify draft order and won't affect inventory. | This phase is fully guided in the dashboard and takes only a few minutes. **2. Finish theme setup** Once you've placed a test order, you'll move on to installing SparkLayer's frontend widgets on your theme. You can either let our team do this for you (recommended) or install yourself - see Installing the frontend widgets below. While theme setup is in progress, you can continue configuring your B2B pricing and customer groups in the dashboard. **3. Launch** The final step is to run through some launch checks (such as logging in as a real B2B customer and placing an order) and then go live. See our [Launching SparkLayer](docId\:YUfghEGoxe_h7uJfcshna) guide for the full launch checklist. *** ## 🛠️ Installing the frontend widgets SparkLayer comes with ready-made B2B-optimised "widgets" that we collectively call the SparkLayer Frontend. These overlay sections of your existing Shopify store and enable our powerful B2B features for logged-in B2B customers - leaving your regular DTC experience untouched. You can install the widgets in one of two ways: | Option | Best for | Time | | ------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------- | | **Install SparkLayer for me** (recommended) | Most merchants - no coding required | Typically within 1 working day, free of charge | | **I'll install SparkLayer myself** | Merchants comfortable making theme changes and basic Shopify coding | Variable, depending on your theme | Both options are managed from the Theme setup page in the SparkLayer dashboard. ### Option 1: Install SparkLayer for me (recommended) Our team will install SparkLayer on your theme for you, free of charge. Once you click **Install SparkLayer for me**, the dashboard will guide you through a four-stage process: 1. **Requesting access** - we'll request collaborator access to your Shopify store 2. **Approve access** - you approve our access request in your Shopify admin 3. **In progress** - our team installs the SparkLayer widgets on your theme 4. **Complete** - you're notified once everything is ready As part of the install, we will: - Add the required storefront elements (product page and product card widgets) - Match your store's branding (colours and fonts) - Add a B2B login and application page - Run checks to make sure everything is set up correctly - Walk you through everything on a free onboarding call This is the fastest and most reliable way to get SparkLayer installed - most merchants choose this option. ### Option 2: Install SparkLayer myself :::hint{type="info"} **Please note** We recommend duplicating your live Shopify theme and making changes on the duplicate first. You can publish it once you're happy. ::: If you'd prefer to install SparkLayer yourself, there are three steps to follow. :::ExpandableHeading **Step 1: Enable the SparkLayer app embed** The app embed loads SparkLayer's JavaScript on your storefront. From the dashboard, select your theme and click **Enable app embed** - this opens your theme editor in a new tab where you'll click **Save** to activate it. ::: ::::ExpandableHeading **Step 2: Install the product detail interface** The product detail interface replaces your standard product purchasing area with SparkLayer's B2B-specific pricing and quantity controls when a B2B customer is logged in. Add the following snippet to the file that controls your product detail page (typically main-product.liquid or product-template.liquid in your theme's /sections/ directory): :::BlockQuote \
:::
See our Frontend integration checklist for the full list of elements to hide.
::::
::::ExpandableHeading
**Step 3: Install the product card interface**
The product card interface shows SparkLayer pricing and quantity controls on your collection pages, so customers can add items to their order from anywhere on your store.
Add the following snippet to the file that renders product cards on collection pages (typically card-product.liquid, product-grid-item.liquid, or similar in your theme's /snippets/ directory):
:::BlockQuote
\\
:::
Look for the line that renders the product title:
:::BlockQuote
\{\{ product.title }}
:::
Add the SparkLayer snippet directly below it.
**Please note:** depending on your theme, the variable product.id may need to be card\_product.id or similar. Check your theme's existing variable naming.
As with the product detail interface, hide any DTC elements with data-spark="b2c-only".
::::
### Adding CSS customisations
Once the widgets are installed, you can match SparkLayer's styling to your store's look and feel by adding the [CSS snippet from here](docId\:qCt2Zk8wjhYIV2ZbVBJYy) to `theme.liquid` or a standalone CSS file. This lets you control button colours, font sizes, spacing, and typefaces.
:::hint{type="info"}
**Seeing styling conflicts on a supported theme?**
On supported themes, SparkLayer's auto-install applies a small amount of CSS to help the B2B widgets sit cleanly alongside your existing theme. If this is causing styling conflicts with your store, you can disable the auto-install and apply the SparkLayer interfaces manually instead - see **Disabling the auto-install** below.
:::
### App Blocks status
The dashboard shows the live status of each SparkLayer component on your theme:
| Status | Meaning |
| ----------------- | ----------------------------------------------------------- |
| **Enabled** | The app block is installed and active on your theme |
| **Awaiting team** | Our team will install this for you |
| **Pending** | The app block needs to be enabled - typically the app embed |
### Automatic install on supported themes
SparkLayer can be installed on any Shopify theme, but for a range of supported themes, the product detail and product card interfaces are installed automatically. Supported themes include:
- **Dawn family:** Dawn, Refresh, Sense, Studio, Craft, Taste, Origin, Ride, Colorblock, Crave, Spotlight, Publisher, Trade
- **Horizon family:** Horizon
- **Other:** Savor, Ritual, Vessel, Atelier, Dwell, Pitch, Heritage, Tinker
- **Archetype family:** Impulse, Expanse, Streamline
If you're on one of these themes, the manual snippet steps above are handled automatically.
### Disabling the auto-install
If you'd like to install the SparkLayer interfaces manually on a supported theme - for example, to control exactly where they appear, or to avoid the styling adjustments that auto-install applies - you can disable the auto-install behaviour.
Add the following to your theme's theme.liquid file, just before the closing \ tag:
```html
```
Once added, you can follow the manual install steps above to add the product detail and product card interfaces exactly where you'd like them.
### B2B Dawn theme
If you'd prefer not to modify your existing theme, our B2B Dawn theme comes preloaded with all the SparkLayer widgets and can be installed in one click from your Shopify theme library.
:::hint{type="success"}
**Finished installing?**
Once the widgets are in place, run through our Frontend integration checklist to make sure everything is configured correctly. You can also explore the full set of configurations and customisations available on your store.
:::
***
## 📓 Setting up your B2B price lists
Within the [Price Lists ](https://app.sparklayer.io/pricing/lists)area of the SparkLayer Dashboard, you can create and manage your B2B pricing rules.
You can manage your price lists directly inside the **SparkLayer B2B & Wholesale** sales channel in your Shopify admin - go to **Sales channels → SparkLayer B2B & Wholesale → Price lists** for the same controls available in the dashboard.
SparkLayer allows you to set the following pricing types:
| Type | Details |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `Automatic` | You can use your Shopify prices and apply a discount, e.g. 50% off Shopify retail prices or 40% off your Comare-at Shopify price |
| `Manual` | You can manually upload a CSV file with specific prices and even enable quantity pricing |
:::hint{type="success"}
**Ready to set your pricing?**
To learn more about pricing, please see our [full guide here](docId\:s8XcbZGxQpgdeIGWtXseT).
:::
***
## 👪 Setting up your B2B customer groups
[Customer Groups](https://app.sparklayer.io/customers/groups) let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out.
You can manage customer groups via the SparkLayer dashboard or directly inside the **SparkLayer B2B & Wholesale** sales channel in your Shopify admin (under **Sales channels → SparkLayer B2B & Wholesale → Customer groups**).
Much like with Price Lists, you can fully manage this via the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups).
:::hint{type="warning"}
**Please note**
- For any customers that you want to place B2B orders, they must have a tag of `b2b` assigned to them in Shopify within their customer record
- If you intend to set up Customer Groups that apply different rules per customer, you'll also need to tag customers with additional tags (e.g. `b2b` `b2b-group-2`)
- Customers cannot have more than two `b2b` related tags assigned to their customer record in Shopify. For example:
✅ This is correct `b2b` `b2b-vip`
❌ This is incorrect `b2b` `b2b-vip b2b-user`
If the tag doesn't already exist in your Shopify store, you can simply create it as a new one within Shopify by adding it to an existing customer record.
- At least one valid and fully completed address must be assigned to their record in Shopify. This is to ensure the customer can go through the checkout process
:::
:::hint{type="success"}
**Ready to set up your customer groups?**
To learn more about customer groups, please see our [full guide here](docId:5_lWMNohhjBJJppg9E6Vh).
:::
:::hint{type="info"}
**Using Shopify Companies?**
Please refer to [our full guide](docId\:wrzSu8adFvbXOkF50hX5I) on how Shopify Companies is compatible with SparkLayer.
:::
***
## ✅ Testing & launching
The final step is to run some tests and checks to ensure SparkLayer is fully configured. Within the SparkLayer Dashboard, you'll see a number of [Launch checks](https://app.sparklayer.io/?expand=launch) to perform, from logging in as a B2B customer, through to placing an order.
:::hint{type="success"}
**🚀 See our full launch check list**
You can see our full [launch checklist guide here](docId\:YUfghEGoxe_h7uJfcshna) which covers the key steps to testing and then launching SparkLayer to your B2B customers.
:::
***
## 📁 Troubleshooting
To troubleshoot the most common issues (such as issues with pricing), please see [our guide here](docId\:BlCEkkx3I30nkUcglsfw7). You can also [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to assist.
***
## 🚀 Best-practice configurations
Once you've completed the SparkLayer integration on your store, you may want to consider enhancing your B2B experience with the following.
:::hint{type="success"}
**Customer experience**
✅ [Set up a B2B login page](docId\:Gfc0UW7mJnMNpnNO6EdRl)
✅ [Set up a B2B registration page](docId\:Gfc0UW7mJnMNpnNO6EdRl)
✅ [Hiding B2B products from regular DTC customers](docId:30hMTg4Cqqv69EhqNvpnf)
✅ [Show B2B-only content](docId:30hMTg4Cqqv69EhqNvpnf)
✅ [Create a B2B-only navigation menu](docId:30hMTg4Cqqv69EhqNvpnf)
✅ [Modify your B2B email notifications](docId\:FAW11UwvEk1KN06woxik0)
****
**Checkout process**
✅ [Configure B2B-only shipping](docId\:ZSsXG6FjRLCod_GxoluTN)
✅ [Customise your B2B payment methods](docId\:ibIKczvHM085BkeJIfFYv)
✅ [Configure custom checkout data fields](docId\:o3nDhZBCxisWH6M6satDt)
**Product configurations**
✅ [Setup product pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D)
✅ [Setup minimum and maximum quantities](docId\:CmxfrPgjQxfz9vJzTVv0D)
✅ [Show live inventory levels](docId\:Gj_Ao_gQ6oA-jx0D27Hys)
✅ [Setup pre-orders and backorders](docId\:Gj_Ao_gQ6oA-jx0D27Hys)
✅ [Set "reserve inventory" for your DTC customers](docId\:Gj_Ao_gQ6oA-jx0D27Hys)
Automations****
✅ [Shopify Flow (Ready-made automations)](docId\:uvXV1kUg_VsZEPr5Dlb2z)
You can explore our full list of [configurations here](docId\:SBEaOaCq_A7FfbTatX8bD).
:::
***
## ℹ️ Frequently Asked Questions
### Shopify setup
:::ExpandableHeading
**What Shopify plan do I need to be on to use SparkLayer?**
SparkLayer works on all versions of Shopify, from Shopify Basic right through to Shopify Plus. All you need is an active Shopify store and you're good to go.
:::
:::ExpandableHeading
**How does SparkLayer compare to Shopify B2B?**
Shopify expanded native B2B features to all plan tiers, including company accounts, up to 3 pricing catalogs, net terms, PO numbers, and easy reorders. For merchants with a handful of wholesale accounts on simple terms, this covers the basics.
SparkLayer is designed for merchants who need more. Here are the key differences:
**Pricing flexibility** - Shopify's free B2B tier limits you to 3 pricing catalogs assigned to Markets (customer groupings). If you need more than 3 pricing tiers or per-customer pricing, you'd need Shopify Plus at $2,300/month. SparkLayer gives you unlimited price lists on all plans, assigned directly to customer groups.
**Sales team ordering** - Shopify offers staff accounts that can create draft orders in the admin. SparkLayer has a dedicated Sales Agent Portal where reps log in, switch between customer accounts, see customer-specific pricing, and place orders on behalf of buyers. It's a fundamentally different workflow.
**B2B ordering features** - Several capabilities are only available through SparkLayer and don't exist on any Shopify plan, including Plus: CSV and bulk order upload, AI Intelligent Cart (auto-builds carts from emailed POs), saved shopping lists, advanced discounts, a Quoting Engine for quote-to-order workflows, and self-service invoicing.
**Works on any theme** - SparkLayer overlays a B2B experience on top of your existing Shopify theme. Shopify's native B2B works best with their Trade theme.
**Transaction fees** - SparkLayer charges no transaction fees on any plan. Shopify charges variable platform fees on B2B orders across all plan tiers.
**Shopify Companies compatibility** - SparkLayer works alongside Shopify's Companies feature. Draft orders created through SparkLayer are automatically associated with the correct Shopify Company, Contact, and Location for accurate order attribution and reporting.
SparkLayer and Shopify's native B2B can't currently run side by side for the same customer session - it's one or the other for the ordering experience.
For a full feature-by-feature breakdown, read our detailed comparison: [SparkLayer vs Shopify B2B - What You Need to Know](https://sparklayer.io/blog/2026/04/03/shopify-b2b-all-plans/)
:::
:::ExpandableHeading
**Can I use SparkLayer with my development website?**
Yes! If you're setting up SparkLayer on a development store (e.g. a test account), we can enable a special developer-mode that lets you use SparkLayer until you're ready to activate a billing plan. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) for more details.
:::
:::ExpandableHeading
**Can I have DTC and B2B on the same Shopify website?**
Yes, It's possible to install SparkLayer onto your existing Shopify DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup' and [we've a guide here](https://www.sparklayer.io/blog/2022/04/04/shopify-hybrid-b2c-b2b/) that explains how works. When your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders.
If you want to see this in action, you can try our [B2B/B2C demo store here](https://b2b-demo-store-usd.myshopify.com/)
Sometimes it can be better to separate out your B2B store onto a secondary Shopify store and we've detailed some of the [common reasons](https://www.sparklayer.io/blog/2021/12/15/shopify-b2b-store-setup/).
:::
:::ExpandableHeading
**Which version of Shopify "Customer Accounts" is SparkLayer compatible with?**
When setting up your Shopify store, it's possible to choose from two types of 'Customer Accounts' within Shopify:
- **Legacy (Classic) customer accounts:** this is how most Shopify stores are set up and allows compatibility with third-party apps and the ability to customise the look and feel
- **New customer accounts**: this uses a 'password-less login' and has a locked down account area that uses Shopify's 'out of the box' functionality (very similar to the checkout)
**Compatibility with SparkLayer**
SparkLayer works with both versions of accounts. You can learn more in [Shopify Customisations](docId\:ddIv5TDAnCayWTOJ0Vyb7) under "Shopify customer accounts"
:::
:::ExpandableHeading
**Is there support for Shopify "Companies"?**
Yes, please refer to our full guide, [Shopify Companies](docId\:wrzSu8adFvbXOkF50hX5I).
:::
:::ExpandableHeading
**What is the "SparkLayer B2B & Wholesae" (B2B Ordering) pixel that's added to my Customer Events within Shopify?**
When a customer places an order via the Shopify Checkout, SparkLayer needs to know when the order is completed. By adding a special Shopify pixel, this then resets contents of the customer's order and allows them to place additional orders if they wish. **Please note, this step is fully automated when you install SparkLayer and no action is typically required.**
To check the SparkLayer pixel has been added to your Shopify store, go to **Settings** and click **Customer events**. You should see a pixel added by SparkLayer and this should be set to the Connected state. When you view the pixel, you will see it called **"B2B Ordering" **which corresponds to the Sales Channel used by SparkLayer.
If you don't see the SparkLayer "B2B Ordering" pixel, you will need to reconnect your Shopify store via the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/integrations/platform). Simply click the "Save" button at the bottom, and this will activate the pixel for you.
:::
### Theme setup
:::ExpandableHeading
**Can you help me install SparkLayer on my Shopify website?**
Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works.
:::
:::ExpandableHeading
**Does SparkLayer work on any Shopify theme, include Online Store 2.0?**
Yes! SparkLayer is compatible with all Shopify themes, even fully customised. If you need help in the setup, our team can add all the code snippets for you. You can even try our [Shopify B2B Dawn Theme](docId\:LHkU0_G_4GVef1jAmgXmo)
:::
:::ExpandableHeading
**Can SparkLayer work with my variant "image switcher"**
SparkLayer works by updating the product page templates with our special frontend widgets - these automatically pull in your variants, SKUs, and any associated product data that is required for your B2B customers. When they are loaded into your Shopify store, they essentially 'replace' the existing Shopify purchase area that your regular DTC (retail) customers see. Very often, we see Shopify themes that have functionality whereby changing variants will auto-update the main product imagery.
This itself is almost always very specific "custom coding" to the theme that is being used - on a technical level, it will be using Shopify theme specific JavaScript coding to do this and will be engineered in a particularly way for the theme. When our SparkLayer widgets are loaded in, they won't have any handling for this specific JavaScript that controls the imagery, so this functionality isn't compatible for logged in B2B customers. As a solution to this, we have released a guide (aimed at Shopify developers) to point them in the right direction to make SparkLayer compatible based on the specific theme they are using. [Learn more](https://docs.sparklayer.io/tech-docs/javascript-sdk#qReb9)
:::
:::ExpandableHeading
**If I update my Shopify theme, will I need to re-install SparkLayer?**
SparkLayer requires adding specific code to your Shopify store and normally involves updating 3 or 4 files within your theme. When you perform a theme update, it's likely that these changes will be removed and the SparkLayer code will need adding back in. We are always happy to perform this re-install for you, please [get in touch](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help.
:::
:::ExpandableHeading
**How does SparkLayer affect my current Shopify theme?**
The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been tagged with b2b successfully signs in to your store.
For all other users, your store will remain completely unaffected.
This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders.
:::
:::ExpandableHeading
**What if I'm already using a wholesale B2B app on my website?**
If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Shopify store, you may want to ask the app developer to remove these although this is optional.
:::
:::ExpandableHeading
**Will SparkLayer slow down my Shopify website?**
No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (B2C) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders.
:::
:::ExpandableHeading
**How do I set up a B2B registration form?**
If you're looking to enable a wholesale/B2B registration form, we recommend the following options:
- **SparkLayer Forms (recommended)** - Our built-in, no-code form builder lets you create and manage B2B registration forms directly within SparkLayer. Get started with the ready-made Customer Registration Form template which includes approval workflows, automatic customer tagging, and email notifications. No third-party apps needed. Learn more about [SparkLayer Forms](docId\:nn5qnfmfGkXlyUmAMpSnq) or get started in the [SparkLayer Dashboard](http://app.sparklayer.io/forms).
- **B2B Login and Registration Page** - We offer a free, ready-made template that adds a dedicated B2B login and registration page to your Shopify store (e.g. yourstore.com/pages/b2b-login). It includes a login form for existing wholesale customers, a registration form for new applicants, and is fully customisable via the Shopify Customizer. Our team is happy to install this for you at no charge. Learn more in [Shopify B2B Registration & Login](docId\:Gfc0UW7mJnMNpnNO6EdRl)
It's also worth noting that you can manually add customers via the Shopify Customers admin and from there you could moderate your wholesale applications.
:::
:::ExpandableHeading
**How do I stop my Shopify pricing showing on Google Search?**
By default, Google will almost certainly index your Shopify store to show on their search listings. A result of this is your Shopify prices (retail prices) may also show within Google.
It's very important to note that this is not related to SparkLayer and is in fact a built-in feature of Shopify. If you do not want your prices to show on Google this is a customisation that would need to be applied via your Shopify store (not via SparkLayer directly). The Shopify support team may be able to best advice here but there are a range of [Shopify community articles](https://community.shopify.com/c/forums/searchpage/tab/message?advanced=false\&allow_punctuation=false\&filter=location\&location=category\:en\&q=hide%20prices%20from%20google) that you can review.
Please note, making any changes to your Shopify store in this manner may effect your Google search results and we strongly advise speaking with a Shopify expert before making any changes.
:::
### Discounts
:::ExpandableHeading
**How do I set up discount promotional codes at checkout?**
It's possible to set up discount codes that customers can use during the checkout process. For example, you could set up a discount coupon that gives them 10% off their order.
To learn how discounts work, please see [our guide here.](docId\:WrejPw9URyjQwiQeKs_Cg)
:::
:::ExpandableHeading
**How do I set up discounts to apply across a product range? **
Within the SparkLayer [Discounts](docId\:WrejPw9URyjQwiQeKs_Cg) , using the "Advanced requirements and rewards", you can setup discounts to apply to products with specific tags setup within your store (e.g. in Shopify). For example, you could set the discount to only apply if products within the cart have a tag of `dog-toy` applied, or match a broad term of `dog`. This allows you to setup discounts to apply to collections and product ranges easily.
There are also other workarounds without using discounts:
- You could create a brand new product in Shopify and set up a range of variants within it (e.g. all the products you want to offer within the discount)
- We have a special setting called *minimum product quantity* ([See our guide here](docId\:CmxfrPgjQxfz9vJzTVv0D)) which forces the customer to order at least X of the product (e.g. 3)
- Using the [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe), you can then set up your discounted rates (e.g. buy 3 and the price is 10% cheaper)
- Within Shopify, you could make these products 'hidden' from standard B2C customers simply by not associating them to a collection
:::
:::ExpandableHeading
**How do I set up discounts based on an order total?**
It's possible to set up discounts that apply based on a certain threshold, e.g. the order total or the number of items in a cart. To learn more about discounts, see [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg)
:::
### Payments
:::ExpandableHeading
**How do B2B payments work with SparkLayer and Shopify?**
SparkLayer supports a range of B2B-specific payment methods that can be tailored on a per-customer basis. Our diagram below illustrates how they work in the context of SparkLayer and Shopify. To learn more, please see our [full guide here](docId\:efevur-A3yCJXUHvrR7t-).
:::
:::ExpandableHeading
**Do vaulted credit cards work with SparkLayer?**
Yes! Shopify's vaulted credit card feature is fully compatible with SparkLayer. For it to work, the customer placing the order must be assigned to a Shopify company (under Customers > Companies in the Shopify admin). Once a customer within that company location has saved a card - either during checkout or via their customer account - any other customer linked to the same company location can use it.
Vaulted cards appear as an option when a customer selects "Pay Online by Card" during the SparkLayer checkout process. They can also be charged against draft orders created by SparkLayer - for example, if a customer places an order using "Pay by Invoice", you can collect payment on the resulting draft order using a vaulted card directly from the Shopify admin.
To get started, you need Shopify Payments enabled and your B2B customers linked to company records in Shopify. No additional SparkLayer configuration is required. You can learn more in our [Shopify Companies](docId\:wrzSu8adFvbXOkF50hX5I) guide.
:::
:::ExpandableHeading
**Can I use my existing payment methods on the checkout?**
In terms of payment methods supported by SparkLayer and Shopify. If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the Shopify checkout. From there, any payment methods you have set up in Shopify (e.g. Paypal, Shop Pay, Affirm Pay) will show up, allowing the customers to pay by this method. We've attached a screenshot to illustrate this.
In short, if Shopify support this payment method, your B2B customers could select it during the checkout providing they choose "Pay Online by Card".
:::
:::ExpandableHeading
**Can I additional charges on a B2B order based on the payment type used?**
There may be scenarios where you want to add an additional charge on an order based on the payment type used (e.g. if the customer is paying by credit card, you may want to charge an additional 2%).
Currently, there is no way to do this directly via SparkLayer. One potential option is to allow the customer to place an order via a manual payment method (e.g. Pay by Invoice), and when the order arrives into Shopify as a draft order, adjust the order totals accordingly. From the draft order within Shopify, you can then use their "Collect payment" functionality to take the card payment.
:::
### Products
::::ExpandableHeading
**How do I hide products or set up B2B-only products?**
[B2B Catalogs ](https://apps.shopify.com/sparklayer-b2b-catalogs)is a free SparkLayer app that lets you control which products are visible to different types of customers on your Shopify store. Hide products from B2C customers, restrict items to B2B-only, or show different product ranges to different customer groups - all using simple tags, no code required.
[Install B2B Catalogs](https://apps.shopify.com/sparklayer-b2b-catalogs) from the Shopify App Store, then head to our [B2B Catalogs documentation](https://docs.sparklayer.io/b2b-catalogs/) for the full setup guide.
:::hint{type="info"}
**Hiding variants**
Looking to hide variants for specific B2B customer groups?
:::
::::
:::ExpandableHeading
**Can I use my Shopify prices for my B2B pricing?**
Yes! SparkLayer allows you to automatically synchronise your Shopify prices (e.g. your main Shopify price, Compare-at price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Shopify prices and we can even make provisions for your tax set up in Shopify (e.g. exclusive or inclusive of tax).
:::
:::ExpandableHeading
**How do I set up pre-order and backorder products?**
In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within Shopify, but it's relatively easy to do!
We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility.
:::
:::ExpandableHeading
**Do I need to use product SKUs?**
In terms of product SKUs, SparkLayer relies on these being added to your products within Shopify so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this.
If you don't already have SKUs in Shopify, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Shopify's 'Import' or 'Edit products' feature to do this in bulk.
:::
::::ExpandableHeading
**How do I restrict B2B customers from DTC inventory (and vice versa)**
If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges.
SparkLayer has a way to "reserve" stock for your DTC customers, essentially blocking B2B customers from ordering too much inventory for a specific product. [Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys)
:::hint{type="info"}
**Important**
It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Shopify to do this. If you are wanting to implement this, you will need to consider:
- Creating B2B-specific products on your store (e.g. you could use an app such as [Locksmith](https://apps.shopify.com/locksmith) to do this)
- Creating a separate store just for your B2B customers, effectively separating out your inventory completely. Learn more in [our guide here](docId\:ddIv5TDAnCayWTOJ0Vyb7)
:::
###
::::
### Customers
:::ExpandableHeading
**How do I set up a customer in Shopify as B2B**
To enable a customer as B2B, this works by adding a special tag in Shopify against their customer record. This tag by default is always `b2b` and you can add additional tags based on the rules you've set for the customer in the SparkLayer [Customers](docId:5_lWMNohhjBJJppg9E6Vh) admin.
To learn more about setting up customers as B2B, see [our guide here](docId:5_lWMNohhjBJJppg9E6Vh).
:::
:::ExpandableHeading
**How do I invite a B2B customer to my website?**
Please refer to [our guide here](docId:5_lWMNohhjBJJppg9E6Vh).
:::
### Orders
:::ExpandableHeading
**Where do I find my B2B orders in Shopify?**
For non-card payment orders (e.g. Payment by Invoice), the order is saved as a "Draft order".
- You can view these in Shopify within **Orders** and then click [Draft Orders](https://admin.shopify.com/draft_orders?selectedView=all)
- You can then convert these into approved orders by marking them as paid or marking them with payment terms (please [see this guide](https://help.shopify.com/en/manual/orders/create-orders#accept-payment) for more details).
- It's also possible to automatically convert Draft Orders into Completed Orders with [our feature here ](https://app.sparklayer.io/configuration/settings/general)"Auto-complete Shopify Draft orders"
- By default Shopify will not send an email for Draft orders but we have a [guide here](docId:7kxW1S6TBM57MlpLJn_Uk) that explains how to do this.
When a customer places an order via non-card payment methods, it will show with a status of "**Awaiting Merchant" **until the order ("Draft" order) is converted into a Completed order.
:::
:::ExpandableHeading
**How do I edit orders?**
Firstly, it is possible to edit orders within Shopify when an order is placed via SparkLayer. If you have it configured to create orders as 'Draft orders' you can go into the order and make changes. If you subsequently then manually complete the order (i.e. Mark as paid), you can still edit the order up until the point of fulfilment.
The issue arises in one scenario we know about which is a limitation of Shopify. If you have 'Auto-complete Shopify Draft orders' turned on within the [SparkLayer Dashboard > Settings](https://app.sparklayer.io/configuration/settings/general) this will skip the ability to make subsequent orders. This is why, when you try and edit a 'Completed order', you are seeing the "Unable to edit order" message. At this point in time, we don't have a solution to this, other than switching 'off' the SparkLayer setting that automatically completes a draft order.
:::
:::ExpandableHeading
**Can I stop pricing showing as a discount within a Shopify order?**
Yes! By default, prices from SparkLayer into Shopify will show exactly as you've set them up in the SparkLayer [Price Lists](docId\:Zv2wCfqf7CUC5j_pYJ8Pt).
If you'd prefer to show the original Shopify price, please contact our team.
:::
:::ExpandableHeading
**How do I change the wording for "custom discount" on an order**
You can change the wording of "Custom discount" by editing the languages within your Shopify store.
- Go to Themes and click the 3 dots next to the theme name. Select "Edit default theme content"
- Search for "Custom discount" and then edit as required.
:::
:::ExpandableHeading
**How do I send an invoice?**
Please see our guide: [Invoices](docId\:NKh8H14Ffna5DD71SwwNd)
:::
:::ExpandableHeading
**How do I set a minimum order quantity?**
Within SparkLayer, we do have support for minimum (and maximum) quantities, but you're only able to set these at a product or product-variant level. It's not possible to currently set minimum order-level quantities but it's something we are considering as part of a future update!
There is a potential workaround for product-variant requirements and we've included our recommend approach
- You could create a brand new product in Shopify and set up a range of variants within it (e.g. all the products you want to offer within the discount)
- We have a special setting called [Minimum product quantity](docId\:CmxfrPgjQxfz9vJzTVv0D) which forces the customer to order at least X of the product (e.g. 3)
- Using the [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe), you can then set up your discounted rates (e.g. buy 3 and the price is 10% cheaper)
:::
:::ExpandableHeading
**How do I set up multi-currency using Shopify Markets?**
Please refer to [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD)
:::
:::ExpandableHeading
**How do I send order notifications to customers and my team?**
At the moment, Shopify doesn't have a built-in 'notification' for when a draft order is placed so it does require workarounds for now. There are a few options:
**Receive notifications as store owner:**
- if you are a merchant on the Shopify, Advanced or Shopify Plus plans, you can use Shopify Flow to do this. We've an example you can [download here](docId\:ddIv5TDAnCayWTOJ0Vyb7)
- It's also possible to automatically convert Draft Orders into Completed Orders with [our feature here](https://app.sparklayer.io/configuration/settings/general)
**Receive notifications as a customer:**
- If you want your customers to receive a notification, there are a few ways to do this. As above, you could activate the auto-complete [orders feature above](https://app.sparklayer.io/configuration/settings/general).
- We also recommend a really good one called Mechanic that lets you set rules/flows based on criteria. We have some ready-made templates [you can use here](docId:7kxW1S6TBM57MlpLJn_Uk)
:::
:::ExpandableHeading
**Can I import historic B2B orders into Shopify**
Yes, there are methods to do this. Please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk)
:::
:::ExpandableHeading
**Can I change the order number "prefix" in Shopify, e.g. B2B-123**
Due to current limitations in Shopify, there is currently no way to differentiate the Shopify Order Number (e.g. #123456) between regular (DTC) and B2B orders. In terms of filtering and segmenting orders between retail and B2B, SparkLayer will by default add a tag to an order `b2b`. Within Shopify, or systems you may have integrated (e.g. shipping, 3PLs), this can then be used as a way to separate out workflows to allow you to differentiate between the customers who are placing orders.
:::
:::hint{type="info"}
**Need assistance?**
We'd be happy to help guide you through this process. Please refer to [our guide here](docId\:NNUw1G9z7eaJ4M78vk7t9).
:::
[title] Cart & Checkout
[path] Features/Configurations/
## Custom checkout fields
Custom checkout fields allow you to capture additional information from customers during the checkout process. It's a great way to allow customers to add data such as preferred shipping date, Purchase Order numbers, and more!
Once enabled, the *custom checkout fields* will display on the 'Shipping' step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) before the customer selects their shipping address.
### How custom checkout field data is stored
When a customer completes a custom checkout field, these will be attached to their order data as special 'Notes'.
:::::Tabs
::::Tab{title="🛍️ Using Shopify"}
In the context of Shopify, these will display as "Additional details" within "Order Notes". From a data perspective, these are referred to as **"custom attributes"** which can then be retrieved and used to display on packing slips, [email notifications](docId\:ddIv5TDAnCayWTOJ0Vyb7), and even sent through to a backend system (via the API) and more.
If you're using automation apps such as [Shopify Flow](https://apps.shopify.com/flow), you can also set up triggers based on specific custom fields that the B2B customer has filled in. To see some examples, you can review our [ready-made Shopify Flow templates](docId\:ddIv5TDAnCayWTOJ0Vyb7).
:::hint{type="info"}
Some third-party Shopify apps may also support displaying "Additional details" on the invoices they generate and we recommend speaking directly with the specific app to learn more.
:::
From a B2B customer's perspective, any checkout custom fields you set up will also show against their orders when viewing order history within [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP)
::::
:::Tab{title="🌐 Other platforms"}
No configurations applicable
:::
:::::
### How to add custom checkout fields
Custom checkout fields work by adding special code to your website within the SparkLayer Core Script.
:::Iframe{iframeHeight="0" code=""}
:::
In our example, we've included how this would work with an example 'shipping date'. This can also be adapted with a wide range of other field types such as radios, date pickers, text fields (see below for the full list).
:::hint{type="info"}
**Updating the display**
You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP).
[Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer
:::
::::Tabs
:::Tab{title="Example with a shipping date"}
```javascript
/* Add the below code into the SparkLayer Core Script */
/* Please refer to our help guide on how to do this */
checkoutCustomElements: [
{
name: "delivery-date",
translations: {
en: {
title: "Delivery Date",
detail: "Delivery unavailable on weekends."
}
},
attributes: {
required: true,
type: "date"
}
},
],
/* End of code */
```
:::
:::Tab{title="Example with multiple custom fields"}
```javascript
/* Add the below code into the SparkLayer Core Script */
/* Please refer to our help guide on how to do this */
checkoutCustomElements: [
{
translations: {
en: {
title: "Text field",
detail: "Explains what the field is for. Must be 2 letters followed by 2-4 digits"
}
},
name: "text-field",
attributes: {
required: true,
type: "text",
placeholder: "Placeholder shows inside the empty input",
minlength: 4,
maxlength: 6,
pattern: "[a-zA-Z]{2}[0-9]{2,4}"
}
},
{
translations: {
en: {
title: "Number field",
}
},
name: "number-field",
attributes: {
type: "number",
step: 5,
min: 15,
max: 25,
}
},
{
translations: {
en: {
title: "Date field",
}
},
name: "date-field",
attributes: {
type: "date"
}
},
{
translations: {
en: {
title: "Time field",
}
},
name: "time-field",
attributes: {
type: "time"
}
},
{
translations: {
en: {
title: "Week field",
}
},
name: "week-field",
attributes: {
type: "week"
}
},
{
translations: {
en: {
title: "Datetime field",
}
},
name: "datetime-field",
attributes: {
type: "datetime-local"
}
},
{
translations: {
en: {
title: "Checkbox field",
}
},
name: "checkbox-field",
attributes: {
type: "checkbox"
}
},
{
translations: {
en: {
title: "Month field",
}
},
name: "month-field",
attributes: {
type: "month"
}
},
{
translations: {
en: {
title: "Telephone field",
}
},
name: "telephone-field",
attributes: {
type: "tel"
}
},
{
translations: {
en: {
title: "Email field",
}
},
name: "email-field",
attributes: {
type: "email"
}
},
{
translations: {
en: {
title: "URL field",
}
},
name: "url-field",
attributes: {
type: "url"
}
},
],
/* End of code */
```
:::
::::
**Custom element configuration options**
| Key | Details |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | The name of the custom field. This is shown in your eCommerce platform but is not visible to customers. **(required)** |
| `translations` | An object containing customer-facing strings. Keys must be 2 letter language codes ([ISO 639-1](https://www.wikiwand.com/en/ISO_639-1)). **(required)** |
| `attributes` | HTML attributes applied to the element. Use these to specify the type of input and validation rules. These include:
* max * maxlength * min * minlength * name * pattern * placeholder * required (default is "false") * disabled (default is "false") * step * type (default is "text") | | `title` | It's also possible to customise the text that is shown to the customer using translations. Text shown in bold above the input **(required)** | | `detail` | Small 'helper' text shown beneath the input. Useful for explaining what the field is for and acceptable values. | :::hint{type="info" attributes="[object Object]"} **Supported element attributes** Some attributes only apply to certain input types and you can find more detailed documentation [can be found here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attributes). ::: ### Example custom checkout fields To get started, we've included some of our most popular customer checkout field types. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: :::ExpandableHeading **Date picker, e.g. 'Shipping date'** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { name: "shipping-date", translations: { en: { title: "Shipping Date", detail: "Please select your preferred shipping date" } }, attributes: { required: true, type: "date" } }, ], /* End of code */ ``` ::: :::ExpandableHeading **Custom text, e.g. 'Tax ID Reference'** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Tax ID Reference", detail: "Please enter your Tax ID reference" } }, name: "tax-id", attributes: { required: false, type: "text", placeholder: "Enter Tax ID reference", minlength: 4, maxlength: 600 } }, ], /* End of code */ ``` ::: ::::ExpandableHeading **Drop-down menu ("select" menu), e.g. 'Seasonal information'** :::Iframe{iframeHeight="0" code=""} ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Option Title", detail: "Select Option Detail" } }, name: "select-option-test", attributes: { required: true, type: "select", }, options: [ { translations: { en: {groupName: "Group A"}, }, items: [ {value: "Option 1", translations: { en: { label: "Option 1" } } }, {value: "Option 2", translations: { en: { label: "Option 2" } } } ], }, { translations: { en: { groupName: "Group B" } }, items: [ {value: "Option 3", translations: { en: { label: "Option 3" } } }, {value: "Option 4", translations: { en: { label: "Option 4" } } } ], } ] } ], /* End of code */ ``` :::: :::ExpandableHeading **Custom text, e.g. 'Shipping instructions'** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Shipping instructions field", detail: "Please confirm any shipping instructions for us" } }, name: "shipping-instructions", attributes: { required: true, type: "text", placeholder: "Shipping instructions field", minlength: 4, maxlength: 600 } }, ], /* End of code */ ``` ::: :::ExpandableHeading **Number, e.g. 'Contact phone number'** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Contact phone number", detail: "Please supply a phone number to allow us to contact you" } }, name: "number-field", attributes: { type: "number", min: 10, max: 25, } }, ], /* End of code */ ``` ::: :::ExpandableHeading **File attachments (e.g. Purchase Order file upload) ** If you're looking to add file uploads to the checkout process, you can manage this via custom checkout fields. Please refer to our full guide below ::: :::ExpandableHeading **Date picker that requires date at least 1 day in future ** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { name: "delivery-date", translations: { en: { title: "Delivery Date", detail: "Delivery date must be at least one day in future." } }, attributes: { required: true, type: "date", min: ((d) => { d.setDate(d.getDate() + 1); return d.toISOString().slice(0,10); })(new Date()) } }, ], ``` ::: :::ExpandableHeading **Date picker that restricts by weekends and specific dates ** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Delivery Date", detail: "Delivery unavailable on weekends.", 'select-mon-fri': "Date must be Monday-Friday", 'select-date-in-future': "Select a date in the future", 'select-non-bank-holiday': "Select another date which is not a UK bank holiday", }, }, name: "delivery-date-requested", attributes: { required: true, type: "date" }, onChange(val, el) { const [year, month, date] = val.split('-'); const selectedDate = new Date( Number(year), Number(month)-1, Number(date), 0, 0, 0, 0 ); const now = new Date() const ukTime = now.toLocaleString( 'en-GB', { hour: '2-digit', hour12: false, timeZone: 'Europe/London' } ); const earliestDeliveryDate = new Date( now.getFullYear(), now.getMonth(), now.getDate() + (Number(ukTime) >= 12 ? 1 : 0) ) const ukBankHolidays = [ '07/04/2023', '10/04/2023', '01/05/2023', '08/05/2023', '29/05/2023', '28/08/2023', '25/12/2023', '26/12/2023', ]; const selectedDateStr = new Intl.DateTimeFormat('en-GB', { dateStyle: 'short' }) .format(selectedDate); let messageTranslationKey switch (true) { // Date is in the past case selectedDate < earliestDeliveryDate: messageTranslationKey = 'select-date-in-future' break; // Day is weekend case [0, 6].includes(selectedDate.getDay()): messageTranslationKey = 'select-mon-fri' break; // Is bank holiday case ukBankHolidays.includes(selectedDateStr): messageTranslationKey = 'select-non-bank-holiday' break; } return { valid: messageTranslationKey === undefined, messageTranslationKey } } } ], /* End of code */ ``` ::: :::ExpandableHeading **Checkbox to require customer confirmation** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "I agree to the terms and conditions", detail: "Please confirm you've read and agree to the terms and conditions", }, }, name: "confirmation", attributes: { required: true, type: "checkbox" }, }, ], /* End of code */ ``` ::: ### Supported form field types Custom checkout fields currently support the following field types: | Field Type | Notes | | ---------------- | -------------------------- | | `text` | Freeform text entry | | `select` | Drop down menu | | `number` | Number entry | | `date` | Date, DD/MM/YYYY | | `time` | Specific time, 00:00 | | `week` | Week (4) | | `month` | Month of year (12) | | `datetime-local` | DD/MM/YYY 00:00 | | `checkbox` | Allows multiple selections | | `tel` | Number entry for phone | | `email` | Email entry | | `url` | Website URL entry | | `file` | File attachment | *** ## Standard checkout fields Alongside the freeform custom checkout fields above (which use a name), SparkLayer supports a set of standard checkout fields. These use a known `id` instead of a `name`, so SparkLayer recognises them and integrates them more deeply with your store. Because they're recognised fields, each one is mapped to a structured location in your orders (rather than a generic order note), is available in your theme and template editor, and can be searched and filtered. This makes them a better choice than a freeform field when you're capturing a customer reference, purchase order number, or requested shipping date. The following standard fields are available: | Field | Field ID | | ----------------------- | ------------------------- | | Customer Reference | `customer-reference` | | PO Number | `po-number` | | Requested Shipping Date | `shipping-requested-date` | :::hint{type="info"} **Please note** The **id** must match exactly for SparkLayer to recognise the field and apply the integration described below. ::: ### Adding standard checkout fields  To get started, you can enable the standard checkout fields via [Storefront Options](docId\:TlYOdygHE8taYqbi81JJa) within the SparkLayer Dashboard. For a more advanced setup, you can also add the standard fields to your core script using their id. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { id: "customer-reference" }, { id: "shipping-requested-date" }, { id: "po-number" }, ], /* End of code */ ``` Standard fields support the same attributes and onChange keys as custom checkout fields, so you can apply validation such as `required: true`, along with more advanced configurations (see **Customer checkout fields** above for the full list of supported attributes). ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { id: "customer-reference", attributes: { required: true, }, }, ], /* End of code */ ``` ### Where standard fields appear in your orders Unlike freeform custom fields, which are stored as generic order notes, each standard field is mapped to a structured location on the order: | Field | Where it appears | | ------------------------- | ---------------------------------------------------------------------------- | | `PO Number` | The native Shopify PO Number field on the order. | | `Requested Shipping Date` | A dedicated custom field on the order (shown as sparkShippingRequestedDate). | | `Customer Reference` | The Shopify order notes field. |  Because these fields map to structured data, they're also available in your theme and template editor, so you can display them on documents such as invoices.  ### Searching and filtering by standard fields Mapping each field to structured data also means you can find orders by the information customers enter. From the order and activity views you can: - Search by Customer Reference - Search by PO Number - Filter by Requested Shipping Date (using a date range) ****  ### Migrating to standard fields If you're already capturing any of these fields using the older approach, you can move over to the standard fields to gain the deeper integration. :::ExpandableHeading **Customer Reference** If you previously used the additional information field (via the customerReferenceHidden and customerReferenceRequired display settings), switch to the standard field: ```javascript /* Add the below code into the display object within the SparkLayer core script */ display: { customerReferenceHidden: false, customerReferenceRequired: true, }, /* End of code */ ``` New code to add: ```javascript /* Add the below code into the SparkLayer core script */ checkoutCustomElements: [ { id: "customer-reference", attributes: { required: true, }, }, ], /* End of code */ ``` ::: :::ExpandableHeading **Requested Shipping Date** If you previously added a shipping date as a freeform field using a `name`, switch it to the standard `id`: Old code: ```javascript /* Add the below code into the SparkLayer core script */ checkoutCustomElements: [ { name: "my-shipping-requested-date" }, ], /* End of code */ ``` New code to add: ```javascript /* Add the below code into the SparkLayer core script */ checkoutCustomElements: [ { id: "shipping-requested-date" }, ], /* End of code */ ``` The `id` must be `shipping-requested-date`. Previously the name could be anything you chose - switching to the standard id is what enables the structured storage, searching, and filtering. ::: *** ## File Upload (file attachments) :::hint{type="warning"} **Please note ** The file upload feature is **only** available on the SparkLayer *Growth, 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. ::: SparkLayer supports the ability for B2B customers to upload files during the checkout process. This is a great way to capture additional details from the customer such as a "Purchase Order", details specific to the order, or any other file that is relevant to their account. ::embed[]{url="https://www.youtube.com/embed/UgmP800AdKw"} SparkLayer also supports customers to upload details per line item (such as logos or name customisations) and you can learn more below. ### File upload at checkout **The file upload at checkout flow works as follows:** The B2B customer will see a special field during the checkout process where they can upload relevant files.  When the order is completed, any files uploaded to an order will then display in their [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) area against the order they have just placed. The customer can then easily download any files associated against the order.  **Enabling file uploads** The file upload feature works by adding special code to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) that lets you customise how you accept files from your customers. To get started, you can use our sample code below. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "File Upload", detail: "Files must not be larger than 10MB. You can upload between 1 and 4 files" }, }, name: "file-upload", attributes: { type: "file", required: false, // Optional. Default: false minlength: 1, // Optional. Default: 1 maxlength: 4, // Optional. Default: 20 maxsize: '10MB', // Optional. Default: 20MB, Must be a number followed by `B`, `KB` or `MB` fileextensions: [ // Optional. Default: ['txt', 'csv', 'pdf', 'json', 'png', 'jpeg', 'gif', 'webp', 'svg', 'psd', 'xls', 'xlsx', 'ods', 'fods', 'ppt', 'pptx', 'odp', 'fodp', 'doc', 'docx', 'odt', 'fodt'] 'png', 'txt', 'pdf', 'xls' ] } } ], /* End of code */ ``` To customise how you accept files from your B2B customers, you can adjust the special settings: | Setting | Description | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `required` | Setting as `true` will force the customer to have to upload a file | | `minlength` | This sets the **minimum** number of files the customer must upload (e.g. entering `1` would force them to upload 1 file) | | `maxlength` | This sets the **maximum** number of files the customer must upload (e.g. entering `4` would prevent them from uploading more than 4 files) | | `maxsize` | By default, SparkLayer sets a maximum file size of 20MB and this **limit cannot be increased**. If you'd prefer to limit file size, you can adjust this. For example entering `10MB` would set a maximum file size limit of 10MB | | `fileextensions` | If you'd prefer to limit the file types your customers can upload, you can specify file extensions. By default, SparkLayer will support all the following file extensions.
`['txt', 'csv', 'pdf', 'json', 'png', 'jpeg', 'gif', 'webp', 'svg', 'psd', 'xls', 'xlsx', 'ods', 'fods', 'ppt', 'pptx', 'odp', 'fodp', 'doc', 'docx', 'odt', 'fodt']` | | `translations` | You can edit the default text that shows for customers by editing the default language string (see example above). | **Retrieving file uploads** Due to how files are stored within SparkLayer, there are some very specific methods in which to download any files that have been uploaded. When a B2B customer uploads a file against an order, there are **3 ways** to retrieve the files that have been uploaded. | Method | Details | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customer` | The customer themselves can login to their account and download the attachments from their order | | `Sales Agent` | As a user with access to the [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) tool, they can login on behalf of the customer, navigate to their account and download any attachments. | | `API` | Via the *SparkLayer Files API*, file uploads will be associated with order data and this can then be routed into a back-office (e.g. an ERP). For more details on how this works, please speak to our [support team](docId\:NNUw1G9z7eaJ4M78vk7t9). | **How file upload are referenced ** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} When a customer uploads a file and the order arrives into Shopify, files will be referenced within the `file-upload` section on the top right of an order detail. If you'd prefer to use a different naming convention to `file-upload`, you can modify this within the checkout code sample above `name: "file-upload"` :::hint{type="warning"} **Please note** This will include a 'raw link' to the file and it's important to note that this **cannot** be accessed via Shopify. Please refer to our steps above on the methods to retrieve files that have been uploaded. :::  :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: ### File upload per line item :::hint{type="warning"} **Please note** This is an advanced configuration of SparkLayer and will require a developer to implement on a store that requires this feature. Please refer to our [JavaScript SDK](docId\:KqOyqBdWzsiRlt7j-S6CU) for full details. ::: The file upload per "line item" feature allows for item-level customisation control, enabling B2B customers to clearly outline their order requirements and streamline the order process. Once enabled, the B2B customer will see a special field on the product page where they can upload relevant files. The design and layout of this field can be configured as detailed in [JavaScript SDK](docId\:KqOyqBdWzsiRlt7j-S6CU)  In some instances, there may be a need for more than one file upload section. When the files are uploaded to the product page, they will appear above the **"Choose file"** button.  The files uploaded by the customer will then show in the cart as separate line items.  After "line item" file uploads have been added there is still the option to enable the "checkout-level" file upload feature too (see "*File upload at checkout"* above). Whilst the line item file upload option may be ample customisation for some customers, enabling checkout-level file uploads will allow for any order-level attachments to be added such as a "Purchase Order". When the order is completed, all files uploaded to an order (at line item *and* checkout level) will then display in their [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) area against the order they have just placed. The customer can then easily download any files associated against the order.  :::hint{type="info"} **Enabling file uploads for line items** To implement this line item file upload feature, please refer to [our technical guide here.](docId:315uNbM85_FWnh6FU9KkK) ::: *** ## Discounts & promotions SparkLayer supports the ability to have discounts and promotions applied during the checkout and these can either be redeemed via discount codes, or applied "automatically" to the customer's order. :::Iframe{iframeHeight="0" code=""} ::: The SparkLayer Discount Engine unlocks a range of discount rules including: - **Order-level discounts:** eg, spend $1,000 and get 10% off, spend $2,000 and get 15% off - **Percentage and fixed discounts: **eg, 20% off an order total, $100 off an order total - **Coupon codes:** eg, enter code NEWCUSTOMER and get 5% off - **Scheduled discounts:** eg, start discount today and end it on a specific date and time - **Customer-specific discounts:** eg, only allow customer group ‘b2b-vip’ to qualify for the discount - And more :::hint{type="info"} **Learn more about discounts** You can see a full overview of what’s possible with discounts in [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg). ::: *** ## The "Additional Information" field (PO Number) The Additional Information field is useful if you want to capture additional details from a customer whilst their placing an order.  Typical use-cases include capturing a Purchase Order number (sometimes referred to as PO number), delivery instructions, or instructions. ::::Tabs :::Tab{title="🛍️ Using Shopify"} When completed by a customer, the data will then show within the Shopify order under the **Notes** section (this can also be sent to a backend system using the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT)).  ::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: :::: :::hint{type="info"} **Please note** The additional information is a separate field to the 'custom checkout fields' detailed above. The Additional Information field is also limited to 512 characters in total ::: **Make "Additional information" mandatory** You can force customers to complete the 'Additional information' field before proceeding to place their order.  :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the display object within the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { customerReferenceRequired: true, }, /* End of code */ ``` :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.notes.label": "Additional Information", "cart.checkout.notes.placeholder": "Order notes e.g. PO Number", "cart.checkout.notes.helper-text": "Please note, this is required before placing your order", /* Only shown if the field is set to required */ "cart.checkout.notes.default-helper-text": "", /* Add a helper message below the form field */ } }, /* End of code */ ``` **Limiting characters of the "Additional information" field** It's possible to set a character limit for the additional information field should you have requirements to restrict what can be added. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the display object within the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { customerReferenceMaxLength: 512, /* update 512 as required */ }, /* End of code */ ``` **Hiding the "Additional information" field** Alternatively, if you'd prefer to hide the additional information field from showing, you can update this via the SparkLayer Core Script. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the display object within the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { customerReferenceHidden: true, }, /* End of code */ ``` *** ## Custom payment messages On the final step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), Review & Pay, it's possible to display a "custom payment messages" that let you add additional details about a payment method. For example, if a customer is paying by "Pay by Invoice", you could add some additional text to inform them on how this process works.  The "custom payment message" works by adding a special code snippet to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) that lets you define the text you want to show. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.payment-providers.paymentByInvoice.message": "This is a message for Payment by Invoice", "cart.checkout.payment-providers.upfrontPayment.message": "This is a message for Pay Online by Card", "cart.checkout.payment-providers.paymentOnAccount.message": "This is a message for Pay on Account", "cart.checkout.payment-providers.quote.message": "This is a message for Request for Quote", } }, /* End of code */ ``` :::hint{type="warning"} **Please note** It's important to note that this text will show to **all customers **during the checkout process and it's not possible to vary it based on who the customer is. ::: *** ## Custom checkout message On the final step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), Review & Pay, it's possible to display a "custom checkout message" that lets you inform customers of any special notes or information they need to be aware of. It's a great way to highlight information about shipping, payment, or anything else!  The "custom checkout message" works by adding a special code snippet to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) that lets you define the text you want to show. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.review-step.custom-message": "Add your custom checkout message here", } }, /* End of code */ ``` :::hint{type="warning"} **Please note** It's important to note that this text will show to **all customers **during the checkout process and it's not possible to vary it based on who the customer is. ::: ### Styling the message  If you'd like to customise how the message looks, you can do this by adding special [CSS](docId\:qCt2Zk8wjhYIV2ZbVBJYy) to your website. Simply add the below CSS to your website's CSS file and you can then set styling such as colours and spacing. ```css ``` *** ## Search SparkLayer has a built-in tool allowing customers to quickly add items to an order, directly from the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-). You can learn more in [our guide here](docId\:efevur-A3yCJXUHvrR7t-).  *** ## Terms and conditions When customers checkout via the SparkLayer [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), they'll be asked to confirm the store's terms and conditions before completing their order.  By default, the terms and conditions link will point to a URL of `policies/terms-of-service` but it's possible to change this via the SparkLayer Core Script. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ termsAndConditionsLink: "/policies/terms-of-service", /* End of code */ ``` ::::Tabs :::Tab{title="🛍️ Using Shopify"} You can customise the link based on a customer's tag by using code within your Shopify store. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ {% if customer.tags contains 'b2b' %} termsAndConditionsLink: '/policies/b2b-terms', {% elsif customer.tags contains 'b2b-2' %} termsAndConditionsLink: '/policies/b2b-2-terms', {% elsif shop.locale == "fr" %} termsAndConditionsLink: '/policies/fr-terms-and-conditions', {% else %} termsAndConditionsLink: '/policies/terms-and-conditions', {% endif %} /* End of code */ ``` If your store is set up with multiple languages, you can also configure the code to show a different link based on the customer's location ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ {%- if shop.locale == "fr" -%} termsAndConditionsLink: '/policies/fr-terms-and-conditions', {%- else -%} termsAndConditionsLink: '/policies/terms-and-conditions', {%- endif -%} /* End of code */ ``` ::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: :::: :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.terms.start": "I agree to the ", "cart.checkout.terms.link": "terms and conditions", "cart.checkout.terms.end": " ", } }, /* End of code */ ``` *** ## Payment methods Please refer to the [Payment Methods](docId\:ibIKczvHM085BkeJIfFYv) guide for more information. *** ## Tax & shipping messaging :::hint{type="info"} **Tax & shipping** To learn more about how SparkLayer handles tax and shipping, see [our guide here](docId\:ZSsXG6FjRLCod_GxoluTN). ::: When a customer proceeds through the checkout, they'll be notified about tax and shipping with messaging beneath the main call to action.   If you'd like to modify what is shown here, you can do so by updating the default language within your store. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.tax-shipping-note": "Tax and shipping costs calculated during checkout", "cart.tax-shipping-message": "Tax and shipping costs shown on next step", } }, /* End of code */ ``` *** ## Tax ID Requirements Some countries require you to collect your customer’s Tax ID or equivalent during checkout. This helps ensure orders comply with local tax laws and avoids delays or fines at customs. [Learn mroe](docId\:ZSsXG6FjRLCod_GxoluTN) *** ## The order complete screen You can modify the confirmation screen that shows to the customer by adding the below to the language overwrites within the SparkLayer Core Script.  :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.thanks.payment.main": "Thank you for your order!", "cart.thanks.payment.blurb": "Your order has now been placed and you will shortly receive email confirmation to {email}. You can check the status of your order at any time by going to 'My Account'.", "cart.thanks.quote.main": "Thank you for requesting a quote!", "cart.thanks.quote.blurb": "We can confirm that your request for a quote has been received and we'll be in touch once our team has reviewed it.", } }, /* End of code */ ``` *** ## Order limits (minimum and maximum order values) It's possible to set minimum and maximum order values that a customer has to meet before being able to place an order. Please refer to [our full guide here](docId:5_lWMNohhjBJJppg9E6Vh). *** ## Showing custom content (using "slots") Custom Slots (or "Targets") allow you to enhance the SparkLayer [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) by adding your own custom code in predefined areas.   You can learn more in our [custom slots guide here](docId\:l_2ooHJiY-rAx2chBMgP2). *** ## Pricing Display If you have [RRP pricing (MSRP)](docId\:S_VTlJBorGmnwjjfSMom9) set up, by default the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) will display this below the main selling price.  If you'd prefer to hide this, you can add the below CSS to your [CSS overwrites](docId\:qCt2Zk8wjhYIV2ZbVBJYy). ```css --spark-cart-rrp-display: none; ``` *** ## Cart Image It's possible to change how the product image is rendered in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) by using special CSS overwrites. This is especially useful if your product images aren't square in ratio and you want to prevent the image being cropped.  Simply add one of the below options to your [CSS overwrites](docId\:qCt2Zk8wjhYIV2ZbVBJYy). ```css --spark-cart-background-size: cover /* Set image to fill the space*/ --spark-cart-background-size: contain /* Set image to be fully visible*/ ``` [title] Account & Addresses [path] Features/Configurations/ ## Custom My Account fields Within the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP), the customer can see a summary of their details such as email address, company name, and financial details from the "My Details" section. It's possible to set up additional "custom fields" within the My Details area, allowing you to include other information that may be relevant to your B2B customers.  Setting custom fields for the My Details area works in a very similar way to the [custom checkout fields feature](docId\:o3nDhZBCxisWH6M6satDt), by adding special code to your website within the SparkLayer Core Script. You can use our sample below to get started. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ customAccountDetails: [ { title: "Website", value: "{{ customer.metafields.global.company_website }}", type: "website", displayText: "Visit Website", }, { title: "Phone", value: "01234567890", type: "phone", }, { title: "Email", value: "contact@sparklayer.io", type: "email", displayText: "Click to email", }, { title: "Some normal text", value: "This is a normal value with no formatting", }, ], /* End of code */ ``` **Custom element configuration options** | Key | Details | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `title` | The label name to show to the customer, e.g. "Website" | | `value` | The value, this can either be set manually or dynamically generated, e.g. via a metafield or setting | | `type` | The field type, with the following options
* `email` This will set a link in the following format: `displayText` * `phone` This will set a link in the following format: `displayText` * `website` This will set a link in the following format: `displayText` | | `displayText` | By default, the value will be shown to your customers. If you'd prefer to show custom text, you can use the `displayText` field. For example, for a link, you could use
`displayText: "Click here"` | :::hint{type="warning"} **Please note** If you are using our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) functionality, there is an important limitation to be aware of that applies to custom fields that are based on a customer metafield. When a sales agent signs in as a B2B customer, they will not see the value inputted in the metafield on the customer's account - rather they will see the value inputted in the agent's account itself. ::: *** ## Order statuses SparkLayer supports a range of orders statuses (e.g Processing, Shipped) and you can learn more about how this works in [our guide here](docId\:lQXaNI7IVDqna09D9soAP).  If you'd like to change the naming conventions for the order statuses shown, you can update these using special language string settings. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "account.order-status.incoming": "Incoming", "account.order-status.returned": "Returned", "account.order-status.cancelled": "Cancelled", "account.order-status.shipped": "Shipped", "account.order-status.part_shipped": "Part-shipped", "account.order-status.part_returned": "Part-returned", "account.order-status.varied": "Varied", "account.order-status.processing": "Processing", "account.order-status.awaiting_approval": "Requires approval", "account.order-status.awaiting_merchant": "Awaiting merchant", "account.order-status.archived": "Archived", } }, /* End of code */ ``` *** ## Payment status Alongside shipping status, you can give your customers a real-time view of their Payment status (e.g. Paid, Unpaid). Learn more in [Payments Visibility](docId\:ibIKczvHM085BkeJIfFYv).  *** ## Show shipping address summary If you want to give customers an easy way to show their shipping address for an order, you can optionally display this from their My Account overview.  :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the display object within the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ orderListShowShippingAddress: true, /* End of code */ ``` *** ## Allow address editing SparkLayer supports full address editing and adding, allowing customers to manage their online address book. With the My Account interface, customers can simply click the icons next to each address to edit or delete an entry or add a new one. Learn how to configure this in [our guide here](docId:5_lWMNohhjBJJppg9E6Vh).  :::hint{type="info"} **Please note** Address management is enabled by default. If you'd prefer customers to not be able to edit or add addresses, you can turn that off via the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general). There is also an option to prevent addition and modification of the default billing address. This still allows for addition and modification of other addresses. ::: *** ## Order tracking (shipping) details SparkLayer has support to show order tracking information against an order, allowing customers to view shipping tracking details. This also works for part-shipments for an order, giving the customer great visibility of their order details. ::::Tabs :::Tab{title="🛍️ Using Shopify"} Within Shopify, go to an order and go through the fulfilment process. Under "Tracking information (optional)" enter the tracking number and shipping carrier (this can be automated via a third-party app)  Once added, this will then show in the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) for the customer when viewing an order detail page.  ::: :::Tab{title="🌐 Other platforms"} For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: :::: *** ## Account credit and credit balances Please refer to [Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G) *** ## Timeline & Communications The Timeline & Communications feature provides a streamlined way to track communication and activity across all order types within SparkLayer, including [Quotes](docId:8A4OpNIndUyfs3Pup-tuo) (if enabled).  It displays messages, internal notes, and order events, and related email notifications in one centralised area. Learn more in [Timeline & Communications](docId\:Kf-Gd3nHSXlrn2zZvla1Y) . *** ## Account redirect When a logged in customer accesses your website's existing my account area (e.g. `/account`), it will redirect them to the SparkLayer My Account interface instead. If you'd prefer, you can change the default handling and set a custom URL to redirect B2B customers to once they log in. You can do this by updating the SparkLayer Core Script on your website. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ accountRedirect: { urlRegex: /\/account/g, goTo: "/index", // page to redirect logged in users to }, /* End of code */ ``` ::::Tabs :::Tab{title="🛍️ Using Shopify"} **Using Shopify Customer Accounts (New Accounts)** If you're using Shopify Customer Accounts, you can configure which URL to send a customer to directly via your Shopify admin. In your Shopify admin, go to Settings, Checkout, and within [Configurations](https://admin.shopify.com/settings/checkout#checkoutprofiles), click "Customize".  From the top, navigate to the "Orders" page, click "Apps" on the left, and then enable the "B2B Account Redirect" extension. You can include: - Some optional placeholder text that shows before the customer is redirected should you wish to inform them that they are being redirected. - A specific destination URL to take the customer to once they are redirected. For example, you may want to take them to a specific collection page or a landing page. **Setting up redirect URLs based on a customer tag** If you're using *Legacy* Shopify accounts (Classic Accounts), you can also add handling to vary the destination redirect URL based on a customer group. E.g. customer group ABC goes to` /collections/wholesale-page` whereas customer group XYZ goes to `/collections/wholesale-vip` Within your SparkLayer Core Script, you can replace the above code sample with the following Liquid code logic (and adapt accordingly): ```javascript accountRedirect: { urlRegex: /\/account/g, {% assign goTo = "/index" %} {% for tag in customer.tags %} {% if tag == "b2b-group-1" %} {% assign goTo = "/collections/wholesale-page" %} {% elsif tag == "b2b-group-2" %} {% assign goTo = "/collections/another-wholesale-page" %} {% endif %} {% endfor %} goTo: {{ goTo | json}}, }, ``` ::: :::Tab{title="🌐 Other platforms"} No configurations available. ::: :::: *** ## Quick links to view orders SparkLayer has built-in functionality that can optionally 'auto-redirect' a customer directly to their order or quote details, simply by clicking a link. To learn how this works, please see [our guide here](docId\:lQXaNI7IVDqna09D9soAP). *** ## Order invoices It's possible to attach invoices (e.g. a PDF) to a B2B customer's order. Please refer to [our guide here](docId\:yWm70oQUosyKOoIqb4Z4G) to learn more. *** ## Showing a custom Order ID ("Visible ID") It's possible to overwrite the standard order ID that is shown when a customer views their orders, allowing you to have consistent order IDs across systems  ::::Tabs :::Tab{title="🛍️ Using Shopify"} To learn how this works, see [our full guide here](docId\:BxWnGB6b1n7QFfhTnu7pk). ::: :::Tab{title="🌐 Other platforms"} Not applicable ::: :::: *** ## Showing custom content (using "slots") Custom Slots (or "Targets") allow you to enhance the SparkLayer My Account interface by adding your own custom code in predefined areas.  You can learn more in our [custom slots guide here](docId\:l_2ooHJiY-rAx2chBMgP2). *** ## Advanced account settings It's possible to extend how you manage the account information for your B2B customers by using special metafields. For example, if you're using a backend system (e.g. an ERP) that requires very specific address and customer data, these advanced address settings offer more granular flexibility in how data is stored. You can explore our available metafields below. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: :::ExpandableHeading **Accounting ID ** | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `accounting_id` | | `Use-case` | This can be used to specify a unique accounting ID for a customer. For example, if you're using an ERP or accounts package, you can associate a unique account ID against a customer record.
When an Accounting ID is set, this will be added to the eCommerce platform orders metadata. | ::: :::ExpandableHeading **Title** | Item | Details | | ------------------ | ------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `title` | | `Use-case` | This can be used to specify a "title" for the customer. | ::: :::ExpandableHeading **Company Name** | Item | Details | | ------------------ | ------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `company_name` | | `Use-case` | This can be used to specify a "Company Name" for the customer. | ::: :::ExpandableHeading **Shipping Address ID** | Item | Details | | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `shipping_address_id` | | `Use-case` | This can be used to specify a unique shipping address ID for the customer.
When specified, this will be set as the default address for the customer. | ::: :::ExpandableHeading **Billing Address ID ** | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `billing_address_id` | | `Use-case` | This can be used to specify a unique billing address ID for the customer.
When specified, this will be set as the default address for the customer. | ::: :::ExpandableHeading **Available Shipping Addresses by ID ** | Item | Details | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as `JSON` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `available_shipping_address_ids` | | `Example Value` | `[9840404758756,9840404758756]` | | `Use-case` | This can be used to specify the available shipping addresses for the for the customer (by Shopify ID). You can provide multiple address IDs in a comma separated list. | ::: :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `rrp` | | `Value` | This must be set up in the following format
`[{"value":15.99,"currency_code":"usd"}]`
Where `value` is the retail price and `currency_code` is the currency code (e.g. usd, gbp, eur).
You can define prices for additional currencies by using this example format
`[{"value":15.99,"currency_code":"usd"},{"value":10.99,"currency_code":"gbp"}]` | For more information, please refer to the [SparkLayer Technical Do](https://docs.sparklayer.io/tech-docs) ::: ::::: [title] Company Users [path] Features/ ## Introduction Company Users is a powerful feature of SparkLayer that allows companies to create "teams" of users that can share specific actions within their account. Sometimes referred to as "company roles" or "sub accounts", this feature is designed to optimise company B2B purchasing and account management.  Once enabled on your store, Company Users allows the following activities to be shared across team members once they log into their account: | Area | Actions | | ---------------- | ------------------------------------------------------------------------------------------------------------ | | `Order history` | Users of the same company can see all orders placed for the entire company, check order status, and re-order | | `Shopping lists` | Users of the same company can view and delete shopping lists that have been created | | `Address book` | Users of the same company can view, edit, and delete all addresses within the company | It's also possible to set "roles" of Company Users that grant users specific permissions during the B2B ordering process (see below). Please note, the following activities **are not shared** across team members. | Area | Actions | | --------------- | -------------------------------------------------------------------------- | | `Shopping Cart` | If a user has items in their order, these will not be shared across users. | *** ## Getting started To get started with Company Users, you'll need to enable a special setting within SparkLayer. Within the SparkLayer Dashboard, go to the [Settings area](https://app.sparklayer.io/configuration/settings/general) and switch on "Enable company users".  When this setting is enabled, this will then activate a special "widget" within the My Account area called "Company Users". *** ## How it works The Company Users functionality works as follows: ::::WorkflowBlock :::WorkflowBlockItem An active B2B customer logs into their account on your website ::: :::WorkflowBlockItem From their My Account area, they then navigate to the **"**Company Users" widget (at the bottom). From here, they can see all other active company users and invite other users ::: :::WorkflowBlockItem Once another user has been invited to the Company, that **specific user** can subsequently login and begin placing B2B orders ::: :::: Once a company user logs in, they'll also have access to a variety of shared actions and activities that all other company users can see. This currently includes: - **Orders** - users will see all orders placed by the company - **Shopping lists** - users will see all shopping lists created by the company - **Address book** - users will see all addresses added by the company *** ## Inviting users ::embed[]{url="https://www.youtube.com/watch?v=fjunRXufeTs"} Essentially, the customer who begins the *inviting* process becomes the **"main user"** (or "admin") and can control which other users have (or do not have) access to the company. To invite users, from the My Account area, the customer clicks the 'Invite new user" link in the "Company Users" widget.  Once the "Invite new user" link is clicked, they are then asked to complete an invite form. This form includes the ability to: - Specify a first and last name and an email address - Specify the "role" of the Company User (see below) :::hint{type="info" attributes="[object Object]"} **Please note** The email address specified here will be the email address used to login :::  When the **"Send invite"** button is clicked, this will then trigger the following actions: | Account status | Actions | | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `If the invitee does not already have an account on the website` | This will send the invitee an email asking them to create a password to activate their account and join the company | | `If the invitee already has an account on the website` | The customer will be able to login with their existing login details to join the company.
If the invitee is already registered as a B2B customer in your store, they will not be able to become a sub-account. In this instance, the invitee will need to be "manually" associated. This can be actioned by using metafields to associate records and you can learn more in [our guide here.](docId\:OTLHhi8sQ6oS4PAt23-8H) | :::::Tabs ::::Tab{title="🛍️ Using Shopify"} For invitees that do not already have an account, they'll receive an email that looks similar to the below. This is an email that is generated via Shopify and can be easily modified. Within Shopify, this uses the "Activate Account" email notification and can be modified within the Settings > Notifications area of your Shopify admin.  :::hint{type="warning" attributes="[object Object]"} **Please note** As part of introducing Company Users to your B2B customer base, we recommend informing them of the process detailed above to ensure they are familiar with the steps involved. ::: :::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: ::::: *** ## Logging in as an invited Company User When an invited Company User logs in, they'll see the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) as normal along with additional messaging confirming they are part of a company.  In addition, they'll also see the company they are connected to within their **My Details** area.  *** ## Placing an order The invited Company User can browse the website and begin adding items to an order. All prices shown will be the prices set up for the "main user" using the [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) of SparkLayer. Once they've added products to an order, they can access the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) at any point and begin the checkout process. Just as with the standard customer experience, they can select an address, shipping method, and see all available payment methods. ::::Tabs :::Tab{title="🛍️ Using Shopify"} To understand the payment flow, the payment methods work as follows: | Payment Method | Flow | Status | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | `Pay by Invoice` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | | `Pay on Account` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | | `Pay Online by Card` | The order is submitted as a **Draft order** within Shopify and the customer will **receive a notification** to make payment (see below) | Order is left in Draft status until the payment is successfully made | | `Request for Quote` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | ::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: :::: ### Creating Draft Orders ::::Tabs :::Tab{title="🛍️ Using Shopify"} The payment flow works broadly the same for a Company User as for a standard customer. When the Company User places an order, the orders will by default enter Shopify in the **Draft order** status with the order saved in the account of the "main user". Within the "Notes" section, under "Additional details", you'll find the email address of the company user who placed the order (within the "Company User Email" field). Just as with any order in Shopify, you'll see the customer's details on the top right.  ::: :::Tab{title="🌐 Other platforms"} No configurations applicabMaking a payment against an order ::: :::: ### Making a payment against an order :::::Tabs ::::Tab{title="🛍️ Using Shopify"} Depending on the payment method used by the Company User, if the customer is required to make payment, they'll receive an **automatic email notification** detailing their order and a button to checkout. This uses the 'Send invoice' feature of Shopify Draft orders and you can learn more about [how this works here](https://help.shopify.com/en/manual/orders/create-orders#share-checkout-link-with-customers). Once the customer completes their purchase by making payment, the order is then marked as paid and will then display within your **Shopify Orders** area.  :::hint{type="info" attributes="[object Object]"} You can edit this email template by going to **Settings > Notifications** within Shopify and search for the **Draft order invoice** template ::: If the customer hasn't made payment for any reason or you are processing it manually, within Shopify you can open the order and easily resend or manually mark as paid. Please note, the order will stay as a Draft order until action has been taken.  :::: :::Tab{title="🌐 Other platforms"} No configurations applicabMaking a payment against an order ::: ::::: *** ## Roles "Roles" let you set up specific privileges for Company Users that are invited. To set a role for a Company User, from the main My Account overview click the "**Invite new user**" link to get started. Within the invitation screen, you'll see a section "**User role**".  There are currently two types of roles available: | Role | Details | | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `Standard` | This will allow users to place orders and view all account activity within your shared company account | | `Limited` | Users will be able to add items to an order but not complete orders. All orders will be sent to the company account owner for approval | ### Limited access If the invited Company User is set to "Limited", they will be prompted during the checkout process that their order will need reviewing by a team member before it can be completed.  Orders placed this way are essentially "pending" orders that will be invisible to the merchant. Once the order has been approved, this will then create a full order which can then be reviewed, completed, and fulfilled as normal. ### Reviewing orders When an order is submitted for review, this will show within the main Company User's account under "Recent Activity" with a status of "Requires Approval". The Order ID will be prefaced with a special identifier (e.g. #P-1234), differentiating it from other orders. You can [learn more](docId\:gznStzTqCRffLFZSTAw0N) about how this works.  When clicking through to an order, within the Actions menu, the Company User can then perform the following actions: | Action | Details | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `Complete Order` | This will load the contents of the order into a new "Cart", allowing the Company User to proceed through the checkout and place the order | | `Cancel Order` | This will cancel the order and remove it from the "Requires approval" list. | :::hint{type="info"} **Please note** Previously, submitting an order for review did not trigger email notifications to the main Company User. With the new update, **notifications are now sent automatically**. ::: **Email notifications** are sent to both the "main" and "limited" Company Users at key stages of the order review process, without requiring them to be logged in: - **Main User Notification**: When a limited user submits an order for review, the main Company User will receive an email alert, notifying them of the pending order that requires their attention. - **Limited User Confirmation**: Once the main Company User approves or amends the order, the limited user will receive a confirmation email, updating them on the status of their order. :::ExpandableHeading **Email notifcation examples (click to expand) **  ::: :::hint{type="info"} **Please note** The name displayed at the top of Company User emails, as shown in the dropdown example above, is synchronised directly from your eCommerce platform by default. If you’d like to customise this information, you can learn how to modify and overwrite your [default store details](docId\:gznStzTqCRffLFZSTAw0N). ::: *** ## Removing users As with inviting new users, the "main user" can also easily remove users. From the "Company Users" widget, simply click the icon to remove the user's access to the company.  *** ## Manually associating users As well as the "main user" being able to invite users, it's also possible to associate users to a company manually by using special settings against a customer. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `parent_customer_id` | | `Value` | This must be the customer ID of the main user (see below) | The manual association works by simply adding the **main account customer ID** into the `parent_customer_id` metafield.  You can find the **main account customer ID** in the URL when navigating a customer within the admin. For example, the URL in your browser may look something like this: `https://your-shopify-store-url.com/admin/customers/6494756339930` In this example, the main account customer ID would be `6494756339930` In addition, you can manually set the user's role to Standard or Limited using the following metafield: :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://hub.sparklayer.io/tech-docs) ::: ::::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `role` | | `Value` | To set the customer's role as Standard: `main`
To set the customer's role as Limited: `limited-customer` | :::hint{type="info"} **Please note** In addition to adding the metafields above, any customers added manually will also require the appropriate b2b tags to be associated to their customer record in Shopify. For example, if the main user has tags `b2b` and `b2b-company-1`, these must also be added to the customers being associated. ::: *** ## Compatibility with Sales Agents Company Users is fully compatible with the [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) allowing sales agents to add users to a company, just as a "main user" would. The inviting users works in the same fashion as detailed above. *** ## Customising text It's possible to adjust the text specific to the Company Users functionality by adding special code to the SparkLayer Core Script. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "account.main.company-users.actions": "Actions", "account.main.company-users.title": "You're signed into a Company User account", "account.main.company-users.child-account-notice": "Any activity will be shared across all users from your company. This applies to orders, shopping lists, and addresses. Please speak to your company account owner if you have any queries.", "account.main.company-users.email": "Email", "account.main.company-users.delete-confirm-message": "Are you sure you want to remove this user from your company?", "account.main.company-users.delete-failed-message": "Failed to delete user.", "account.main.company-users.header": "Company Users", "account.main.company-users.invite-button-text": "Invite new user", "account.main.company-users.invite-user.header": "Invite new user", "account.main.company-users.invite-user.invite-sent": "User invite sent", "account.main.company-users.invite-user.invite-failed": "Sorry, something has gone wrong and we have not been able to invited this user", "account.main.company-users.invite-user.form.first-name": "First Name", "account.main.company-users.invite-user.form.last-name": "Last Name", "account.main.company-users.invite-user.form.email": "Email", "account.main.company-users.invite-user.form.send-invite": "Create Company User", "account.main.company-users.invite-user.form.cancel": "Cancel", "account.main.company-users.invite-user.form.description": "When you invite company users, any activity will be shared across your team including orders, shopping lists, and addresses. If the user you're inviting doesn't already have an account to login to our store, they'll receive an Account Activation email and they'll be asked to set a password to gain access. If they already have an account, they can login with their existing details by visiting the login page. If you're unsure about inviting users, please speak to your contact within our company." } }, /* End of code */ ``` *** ## Limitations Please note the following limitations of Company Users: - **Inviting users**: when a new user is invited, they will receive the "Activate Account" email from Shopify. It is not currently possible to create a custom email notification for this - **Restricting access**: when Company Users is activated in the SparkLayer Dashboard, it will apply to all customers that login. It is not possible to manually specify which customers have access to Company Users. [title] How SparkLayer Works [path] Introduction/ ## Introduction SparkLayer is an eCommerce platform that enables brands to rapidly scale and grow their B2B operation. It works alongside your existing online store, enabling a powerful self-service portal for your B2B customers to place orders, manage their account, and much more. ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once SparkLayer is set up, your B2B customers can simply login via your website and they'll then see all the B2B pricing and other B2B rules you've set up (e.g. payment methods, minimum spend shipping rules, and more). Under the hood is a technical feature-set that allows you to connect your mission-critical systems (such as an ERP or CRM) allowing automation of your processes. SparkLayer enables this in one complete solution, helping you achieve your ambitious B2B goals! SparkLayer works out-of-the-box with major eCommerce platforms, including: ::::LinkArray :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/PIEXshl0tG1QL9mwDUrSZ_shopify.png"} [Shopify](docId:7TmhkOEHbgEGGFdd6EMr1) Works with all versions ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/MfTGR03MBhkc_usK1Rlo3_bigcommerce.png"} [BigCommerce](docId:6zLPH9x8-qEUITCHs2obE) Works with all versions ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-AHbuSveltgWw9xRDwxWOk-20250210-144900.png"} [Wix](docId\:vEqgPapEA8X0X60U6ZWZe) Works with all versions ::: :::: *** ## The key elements to SparkLayer To better understand how SparkLayer works, there are a number of key elements: ::::WorkflowBlock :::WorkflowBlockItem **🔗 Connecting to your website** Firstly, SparkLayer connects to your existing eCommerce website (e.g. [Shopify](docId:7TmhkOEHbgEGGFdd6EMr1)). Once connected, it then synchronises specific data such as product and customer information. ::: :::WorkflowBlockItem **📋 B2B data configuration** Secondly, it allows B2B data and rules to be configured, such as [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) and settings for your [Customers](docId:5_lWMNohhjBJJppg9E6Vh) (e.g. what payment methods they can use). You can manage this manually via the SparkLayer [Dashboard](docId\:nzsx6U_DAWtzVzSehf4oR) or you can even automate this by connecting SparkLayer to your backend system (e.g. ERP or CRM) via the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT) ::: :::WorkflowBlockItem **😊 B2B frontend experience** Thirdly, it enables a beautiful [Frontend](docId\:OgKfvQX13dHW2582D57kJ) "self-service" experience for your B2B customers, allowing them to place orders, manage their account, re-order, and much more. This all happens on your existing website by enabling special "widgets" within your code. ::: :::WorkflowBlockItem **👪 Sales teams support** If you have a sales team within your business, our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) tool empowers them to manage B2B customer accounts. They can also manage the full "quote to order" process using our powerful [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo). ::: :::WorkflowBlockItem **🔄 B2B order processing** Once everything is set up, any orders placed by B2B customers will arrive into your website's admin (e.g. [Shopify](docId:7TmhkOEHbgEGGFdd6EMr1)) where you can then review them, make edits, or simply process them for shipment. This all uses your existing process and workflows that you've already got set up! ::: :::: *** ## Next steps Visit our [Getting Started](docId:-5djX1YCIgzAI6MRkq0u6) guide on how to get up and running with SparkLayer or [try our demo](docId:87ILO_vHmG3XUXKecOLXv) to see it in action! [title] Technical Information [path] Frontend/ ## Introduction SparkLayer is designed to be as lightweight as possible and uses modern JavaScript technology to power the frontend. *** ## How SparkLayer is loaded All elements of SparkLayer are fully-hosted using a best-of-breed server infrastructure, meaning there's no code for you to self-manage, host, or maintain going forward. For performance, SparkLayer Frontend **only** loads when a customer successfully logs into a website; all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. *** ## Browser Support We currently support the latest two versions of the following major browsers: - Google Chrome - Mozilla Firefox - Apple Safari - Microsoft Edge - Apple Safari for iOS - Google Chrome for Android and iOS Please note, SparkLayer may not work fully with beta or pre-release versions of these browsers *** ## Mobile support The [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) work across all devices (e.g.desktop, tablet, mobile), ensuring customers can easily browse your website no matter which device they are using.  *** ## Building custom interfaces It's possible to extend the frontend of SparkLayer to create more custom layouts. Please refer to [JavaScript SDK & Headless](docId\:B-blQYlOC3QNKrit7XLgw) *** ## Event tracking for analytics (Google Analytics, GA4) :::hint{type="warning"} **Please note** This integration requires some technical setup, so please ensure a developer is available to assist. For full instructions, consult our [our technical docs here.](docId\:nRnplHclcT3sLJt_C_9pF) ::: **Integrating Google Analytics with SparkLayer** If you're looking to track key events in Google Analytics (GA4) or Google Tag Manager (GTM) through SparkLayer, you can set this up directly in your integration. This will help you capture valuable B2B events like "add to cart" "checkout," and "purchase" actions. **Key details to note:** - Supports GA4, GTM, and custom analytics. - Configuration is done using `sparkOptions`. Detailed code examples and setup steps are available in [our technical docs here.](docId\:nRnplHclcT3sLJt_C_9pF) :::ExpandableHeading **Available Events (expand to see)** | Event Name | Description | | -------------------- | -------------------------------------------------------- | | `addToCart` | Triggered when a product is added to the cart. | | `cartUpdate` | Fired when the cart is updated (e.g., quantity changes). | | `shoppingListSave` | Occurs when a shopping list is saved. | | `shoppingListLoad` | Occurs when a shopping list is loaded. | | `shoppingListDelete` | Occurs when a shopping list is deleted. | | `csvUpload` | Triggered when a CSV file is uploaded. | | `quickAdd` | Fired during quick add actions. | | `finalStageCheckout` | Occurs at the final stage of the checkout process. | | `shippingUpdate` | Fired when shipping details are updated during checkout. | | `beginCheckout` | Triggered when the checkout process begins. | | `purchase` | Occurs upon successful purchase completion. | | `viewCart` | Fired when the cart is viewed. | ::: ::::ExpandableHeading **Sample code to add (expand to see)** :::hint{type="info"} **Updating sparkOptions and text** You can enable this feature by adding some special code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). ::: ```javascript window.sparkOptions = { // ... other SparkLayer options ... analytics: { providers: [ { handler: 'ga', // Use 'ga' for Google Analytics events: { addToCart: true, cartUpdate: true, shoppingListSave: true, shoppingListLoad: true, shoppingListDelete: true, csvUpload: true, quickAdd: true, finalStageCheckout: true, shippingUpdate: true, beginCheckout: true, purchase: true, viewCart: true } }, { handler: 'gtm', // Use 'gtm' for Google Tag Manager events: { addToCart: true, cartUpdate: true, shoppingListSave: true, shoppingListLoad: true, shoppingListDelete: true, csvUpload: true, quickAdd: true, finalStageCheckout: true, shippingUpdate: true, beginCheckout: true, purchase: true, viewCart: true } }, { handler: function(eventName, eventParam) { console.log('Event fired to custom provider:', eventName, eventParam); // Implement your custom analytics logic here }, events: { addToCart: true, cartUpdate: true, shoppingListSave: true, shoppingListLoad: true, shoppingListDelete: true, csvUpload: true, quickAdd: true, finalStageCheckout: true, shippingUpdate: true, beginCheckout: true, purchase: true, viewCart: true } } ] } }; ``` :::: [title] Frontend [path] / ## Introduction SparkLayer comes with ready-made B2B-optimised "widgets" that we collectively call the *SparkLayer Frontend*. The widgets simply overlay sections of your existing eCommerce store and enable our [powerful B2B features](docId\:SSzdKXuNMlEIDOOITHQcU).  The best part? You can do away with having to build and maintain these yourself, it's super lightweight, and works with leading eCommerce platforms. *** ## Explore more ::::LinkArray :::LinkArrayItem [Integration Guide](docId\:QWXsYM9X5_pvIOGUteKcP) Learn how to add SparkLayer to your website with our special frontend widgets ::: :::LinkArrayItem [Features](docId\:SSzdKXuNMlEIDOOITHQcU) Explore the available features and configurations available out of the box ::: :::LinkArrayItem [Customising the Design](docId\:qCt2Zk8wjhYIV2ZbVBJYy) SparkLayer can be tailored to match your website branding via CSS configurations ::: :::LinkArrayItem [JavaScript SDK](docId\:B-blQYlOC3QNKrit7XLgw) Looking to build a more custom interface? Extend SparkLayer with our frontend SDK. ::: :::LinkArrayItem [Technical Information](docId\:qD08Q-eiJ2-8k1MweLqca) Learn about how SparkLayer is loaded, browser support, and more! ::: :::: [title] Product Price Interface [path] Features/Frontend Interfaces/ ## Introduction The Product Price Interface lets you display B2B pricing for a product anywhere on your website. It can be used alongside (or instead of) the other product interfaces and gives you flexibility to customise how you want your pricing to be shown to your customers.  :::hint{type="success"} **SparkLayer Interactive Demo** You can explore how the SparkLayer Product Page Interfaces work in [our interactive demo](https://www.figma.com/proto/5FPCY5hSGl7mlwjsjMZI2t/SparkLayer-Interfaces?page-id=0%3A1\&type=design\&node-id=86-36708\&viewport=554%2C-398%2C0.33\&t=34VlPwbCqpvQOTsh-8\&scaling=min-zoom\&starting-point-node-id=35%3A7920\&hide-ui=1). ::: *** ## How it works The Product Price Interface lets you show B2B pricing anywhere on the product pages on your website. This could include product collection (or "category") pages or product detail pages. There are two configurations available: | Item | Details | | ------------- | --------------------------------------------------------------------------------------------------------------------- | | `B2B pricing` | This shows logged in customers their specific B2B pricing | | `RRP pricing` | This shows logged in customers the RRP pricing you've set for the product. [Learn more](docId\:S_VTlJBorGmnwjjfSMom9) | *** ## Integrating the code To add the Product Price Interface to your website, you just need to add a single line of code to your product detail page template based on which pricing type you'd like to show. You can also combine the pricing types anywhere on your website. ```javascript
`["price-list-handle-one"]`
For two, use commas:
`["price-list-handle-one", "base-list"]` | :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | Customers | | `Metafield type` | This must be set as a `json` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `price_lists` | | `Value` | An example of just one price list:``
`["price-list-handle-one"]`
For two, use commas:
`["price-list-handle-one", "base-list"]` | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: :::hint{type="success"} Learn more about how price lists work [our guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: [title] Data Tables [path] Features/Forms/ # Introduction Data tables let you store reusable structured data for your forms. Think of them as a simple spreadsheet inside the Forms system. They’re useful when you want to: - power select, radio, or multi-select fields from a central list - reuse the same data across multiple forms - look up table rows and values in calculations, conditions, and workflow logic - keep your form logic cleaner by managing data in one place ### How data tables work Each data table contains: - columns, which define the data you want to store - rows, which hold the actual records - views, which let you filter rows and control which columns are shown Data tables currently support these column types: - Text - Number - Date ### Common use cases You can use data tables for things like: - product lists - branch or store locations - pricing bands - sales reps or account managers - internal reference codes - approved option lists for advanced forms ### How to set one up 1. Create a new data table. 2. Add the columns you need. 3. Add rows manually, or import them from CSV. 4. Connect the table to a choice-based field in your form, or reference it inside calculations and workflows. You can also export table data to CSV when needed. ### Example You might create a Products table with columns for: - product name - SKU - category - price You can then use that table to populate a choice field in a form, and use the same table data later in workflow logic or calculations. ### Best practice Use data tables when the same list or lookup data needs to be managed in one place and reused across multiple forms. This makes updates easier and helps keep forms consistent. [title] B2B Catalogs [path] Features/  B2B Catalogs is a free SparkLayer app that lets you control which products are visible to different types of customers on your Shopify store. Hide products from B2C customers, restrict items to B2B-only, or show different product ranges to different customer groups - all using simple tags, no code required. [Install B2B Catalogs](https://apps.shopify.com/sparklayer-b2b-catalogs) from the Shopify App Store, then head to our [B2B Catalogs documentation](https://docs.sparklayer.io/b2b-catalogs/) for the full setup guide. [title] Workflows & Automations [path] Features/Forms/ ## Introduction Workflows let you automate actions when something happens in a SparkLayer Form — for example sending notifications, updating data, or triggering internal processes. Instead of building manual processes around form submissions, workflows allow you to create automated flows using a visual editor. Typical SparkLayer use cases include: - Trade account approvals - Internal notifications - Order request processing - Conditional routing based on customer data :::hint{type="info"} Please note that creating and editing of workflows is only available on the Growth plan and above. ::: *** ## 🧠 What is a workflow? A workflow is an automated sequence that runs when an event occurs. Every workflow follows a simple structure: :::BlockQuote Trigger → Step → Step → Step → End ::: Each workflow contains: | Component | Description | | ------------- | ----------------------------------- | | `Trigger` | The event that starts the workflow | | `Steps` | Actions performed after the trigger | | `Connections` | Paths that link steps together | Workflows are created visually by connecting nodes together on a canvas. :::hint{type="info"} If you chose to receive notifications on new submissions when creating a form, then your form already has a workflow! Click on the Workflows tab to see it. ::: *** ## Available Triggers Triggers define when a workflow starts. | **Trigger** | Use this to | | ----------------------- | ---------------------------------------------------------------------------------- | | Form submitted | Run the workflow when a form is completed and submitted. | | Entry created | Run the workflow when a new entry is created (user starts filling out the form). | | Answer updated | Run the workflow when one or more selected form answers change. | | Internal field updated | Run the workflow when one or more selected internal fields change. | | Page loaded | Run the workflow when a selected form page is loaded. | | Button clicked | Run the workflow when a button field on the form is clicked. | | Internal button clicked | Run the workflow when an internal fields button field is clicked by an admin user. | | API request | Run the workflow when it is triggered by an API request. | Common examples: - Send an internal notification when a form is submitted - Recalculate a value when an answer changes - Start an approval process when an internal button is clicked - Update internal fields when an admin changes review data - Trigger a workflow from another system using an API request ## Available Steps Steps define what the workflow does after the trigger runs. | **Step** | **What it does** | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | Send email | Sends an email to one or more recipients. | | Condition | Branches the workflow based on rules. | | Calculation | Performs calculations using numbers, formulas, and Data References. | | For each loop | Repeats a set of steps for each item in a list, such as line items, repeatable fields, or Data Table rows. | | Update entry or row | Updates a field value on a form entry or Data Table row. | | Clear answer | Clears one or more values from a form entry or Data Table row. Useful when a value should be reset after related data changes. | | Read/Unread entry | Marks an entry as read or unread. | | Create entry or row | Creates a new form entry or Data Table row. | | Delete entry or row | Deletes a form entry or Data Table row. | | API request | Sends an HTTP request to an external system. | | Get customer | Looks up an existing SparkLayer customer by ID, platform ID, or email. | | Create customer | Creates a customer in the eCommerce platform and SparkLayer. | | Update customer | Updates an existing SparkLayer customer. | ## Step Paths Some steps have multiple paths. Paths control what happens next. | **Step** | **Paths** | | ---------------- | ---------------------------------------- | | Condition | True, False | | For each loop | Loop body for each iteration, After loop | | API request | Success, Error | | Get customer | Found, Not found, Error | | Create customer | Success, Error | | Update customer | Success, Error | | Most other steps | Next | Example: an API request can continue on the success path if the request works, or follow the error path if the request fails. ## Choosing the Right Step - Use **Condition** when the workflow needs to make a decision. - Use **Calculation** when you need to calculate totals, scores, discounts, or other numeric values. - Use **Update entry or row** when you want to write a value back into the current entry, an internal field, another form entry, or a Data Table row. - Use **Clear answer** when a previous value is no longer valid and should be removed. This is useful for dependent fields, such as clearing a selected option after the field that controls its available options changes. - Use **For each loop** when you need to process every item in a list, such as repeatable fields, line items, or filtered Data Table rows. - Use **API request** when another system needs to receive form or workflow data. - Use the **SparkLayer** **customer** steps when the workflow needs to find, create, or update customer account data. *** ## 🚀 Creating a workflow To create a workflow: 1. Open your form in SparkLayer 2. Go to the **Workflows** tab 3. Click **Add workflow** 4. The visual editor will open ### Add a trigger Triggers define when the workflow runs. Examples: - Form submitted - Entry answer updated - Internal field updated - Workflow trigger button clicked To add a trigger: 1. Click **Add Trigger** on the canvas 2. Select the trigger type 3. Configure any options Steps can use [Data References](docId\:Bj9Tb3GN_VYbi1-Ehm4Rd) to read and write values to current entry, workflow run data, and other data sources. ### Add steps Steps define what happens after the trigger. To add a step: 1. Click the **Add step** button, or drag the path handle out from an existing step 2. Choose a step type 3. Configure the action 4. Connect to additional steps if needed You can build simple linear workflows or create branches using conditions. *** ## 🧾 Publishing workflows Workflows are part of your form version. This means: - Changes remain in **Draft** until published - The live workflow only updates when the form version is published - Older entries continue using the workflow version they were created with To activate a workflow: 1. Save your changes 2. Publish the form version This keeps automation stable even while you make updates. *** ## 🎛 Understanding the workflow canvas The workflow editor uses a visual canvas where you arrange nodes and connections. ### Navigation | Action | How it works | | -------------- | ---------------------- | | `Pan` | Click and drag | | `Zoom` | Scroll or use controls | | `Select node` | Click the node | | `Multi-select` | Shift + click or drag | ### Nodes Nodes represent triggers and steps: | Node type | Purpose | | --------------- | ---------------------------------- | | `Trigger nodes` | Starting point for workflows | | `Step nodes` | Actions performed during execution | | `Connections` | Paths between nodes | Click a node to: - Edit settings - View input/output data - Delete or reconnect it *** ## 🔗 Connecting steps You connect steps by dragging from one node to another. ### Connection types | Path | Meaning | | -------------- | ------------------------- | | `Next` | Continue to the next step | | `True / False` | Conditional branching | | `Error` | Run when a step fails | | `Loop` | Used in repeat processes | A single step can branch into multiple paths, allowing complex automation flows. *** ## ⚙️ How workflows run Workflows execute **synchronously**, meaning steps run one after another in order. Execution flow: 1. Trigger fires 2. Steps execute sequentially 3. Entry data updates 4. Workflow completes During execution, workflows can access: - Entry data - Form structure - Outputs from previous steps - Data tables or stored values *** ## 📊 Workflow runs & history Every time a workflow runs, SparkLayer records a run log. ### Viewing workflow runs 1. Open an entry 2. Go to **Workflow Runs** 3. Select a run to view details Each run includes: | Data | Description | | ------------------ | ---------------------------- | | `Start & end time` | When execution occurred | | `Duration` | Total runtime | | `Status` | Completed or failed | | `Step logs` | Inputs, outputs, and results | This helps diagnose issues without needing developer access. *** ## 🧪 Debugging workflows When something doesn’t work as expected: 1. Open the workflow run 2. Review each step 3. Check error messages or failed conditions 4. Adjust the workflow or entry data You can see exactly which path was taken through the workflow — including conditional branches. ## 🧩 Example workflow patterns ### 📩 Simple notification :::BlockQuote Trigger: Form submitted ↓ Send internal email ::: ### 🔀 Conditional routing :::BlockQuote Trigger: Form submitted ↓ If category = Sales → Notify sales team Else → Notify support team ::: ### 🧾 Multi-step approval process :::BlockQuote Trigger: Form submitted ↓ Calculate totals ↓ Update entry fields ↓ Send confirmation email ↓ If total > threshold → Request approval ::: ### 🧾 Dependent Field Reset Use this pattern when one field controls the valid options for another field. Example: A customer selects a country. A second field shows regions for that country. If the customer changes the country, the previously selected region may no longer be valid, so the workflow clears it. Pattern: :::BlockQuote Trigger: Answer updated ↓ Answer changed: Country ↓ Clear answer: Region ↓ The user can now select a valid region for the new country ::: Common uses: - Country → Region - Customer group → Available products - Product category → Product - Department → Approval reason - Order type → Required supporting details *** ## 💡 Best practices **Keep workflows focused** - One workflow per process - Avoid combining unrelated automation - Use clear naming **Test before publishing** - Use preview mode - Submit test entries - Check workflow runs for errors **Plan for errors** - Add error paths where needed - Log important outputs - Avoid breaking critical workflows **Optimise performance** - Limit unnecessary API calls - Avoid overly long step chains - Keep automation logic clear and maintainable [title] Forms [path] Features/ ## Introduction SparkLayer Forms provides a **native, no-code form builder** that lets you capture, manage and act on customer data directly within SparkLayer. ::embed[]{url="https://www.youtube.com/embed/_M4QphRF9_k"} Forms can be used across your B2B journey - from **registration**, to **editing sales agent details** - all without relying on third-party apps or custom development. Forms are built and managed in the [SparkLayer Dashboard](https://app.sparklayer.io/forms) and can be embedded into your storefront or used internally by your team. Common use-cases include: - Wholesale / B2B registration forms - Internal contact or enquiry forms - Capturing structured customer data (e.g. VAT IDs, trade references, licences) - Streamlining approval and onboarding workflows - Reducing reliance on third-party form builders *** ## Features At a top-level, [SparkLayer Forms](https://app.sparklayer.io/forms) supports the following range of features and configurations. | Item | Details | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Form Builder` | - Build forms visually using a drag-and-drop builder - Add flexible field types including text, email, phone, dropdowns, checkboxes, dates, addresses and file uploads - Set fields as required or optional - Apply validation rules (e.g. email, phone or tax ID formats) - Show or hide fields using conditional logic - Structure forms into multiple pages with headers, dividers and progress indicators - Save progress and return later | | `Internal Fields` | * Setup a internal fields for entry administration * Internal Fields act as it's own form that will be shown to administrative users when reviewing the form submissions * Internal Fields are not exposed to the end customer at any time * Use these to setup internal workflows: - Changes to internal fields can trigger workflows - Use the Workflow Trigger field to add a button that can trigger a workflow * You can use any features available in the main form for the internal fields setup including field display logic, custom validation, integration with workflows, adding multiple pages, etc. | | `Publishing` | - Preview forms before publishing - Embed forms on your storefront - Create internal-only forms for team use - Customise success or confirmation pages after submission | | `Branding` | * Style forms to match your site using CSS variables * Customise labels, help text and messaging | | `Entries & Management` | - View all submissions in one place - Review individual responses and uploaded files - See and update Internal Fields against a submission entry - Track timestamps and submission status - Export submissions to CSV for reporting or external systems | | `Workflows & Actions` | * Build custom automations that can be triggered by field updates, entry submissions, internal admin field updates, API calls and other triggers * Workflows can perform a series of actions (called Steps) including: - Assign approved users to customer groups - Automatically apply tags based on responses - Map form data into your connected platform (e.g. metafields or customer data) - Perform an API request to your ERP or external system - Send an email * Build custom review and approval workflows that fit your business, or start with a template | *** ## Getting started To begin using SparkLayer Forms, go to **Forms** within the [SparkLayer Dashboard](http://app.sparklayer.io/forms). You'll then be prompted to create a new form or edit an existing form. :::ExpandableHeading **1️⃣ Create your first form** 1. Go to **SparkLayer → Forms** 2. Click **New Form** 3. Enter a form name (e.g. *Trade Account Request*) 4. Click **Create** You’ll be taken to the form builder. ::: :::ExpandableHeading **2️⃣ Add fields to your form** Use fields to collect the information you need from customers. Common field setup | Field Type | Example Use | | ---------- | -------------------------- | | Text | Company name, contact name | | Email | Customer email address | | Textarea | Notes or messages | **To add a field:** - Click **Add field** - Choose the field type - Configure: - Label - Required toggle - Placeholder text - Click **Save** ::: :::ExpandableHeading **3️⃣ Configure form settings** Open the **Settings** tab to control how the form behaves. | Setting | What it does | | ------------------ | ----------------------------------- | | Form title | Public name shown to customers | | Submit button text | Customise CTA wording | | Success message | Confirmation shown after submission | ::: :::ExpandableHeading **4️⃣ Preview your form** When you have added all the fields: 1. Click **Preview** 2. Fill out the form to test it 3. Make any required tweaks ::: :::ExpandableHeading **5️⃣ Publish your form** When your form is ready: 1. Click **Publish** 2. Confirm changes Your form is now live inside SparkLayer. ::: :::ExpandableHeading **6️⃣ Add your form to your storefront** Once published, you can embed the form where needed using one of the options: 1. On Shopify stores, you can use the **SparkLayer Form** block in your themes. - If you can't select your required form from the dropdown, you may need to re-visit the Sparklayer B2B & Wholesale sales channel app, and confirm any new permissions. 2. On all platforms, you can use the embed code directly: - Copy the embed snippet from the **Share** tab - Add it to your theme or page content - Save your changes ::: :::ExpandableHeading **7️⃣ View submissions** When customers complete your form: 1. Open your form in SparkLayer 2. Go to **Entries** 3. Click any submission to view full details ::: *** ## Start with a Template A few common form templates are available to get you started quickly. Forms created from templates can be further customised and extended with custom automations and extra fields. ### Customer Registration Form Use this template to get a fully working customer registration form with the following features: - Common registration form fields already setup - New registration submission email notifications - Internal approval workflow fields setup allowing easy approval or rejection of new applications - On approval, automatic creation of the customer in the eCommerce platform - Extendible with custom automations or extra fields ### Contact Form Use this template for a customisable contact form: - Add any required or optional fields - Receive an email notification for new submissions - Setup automations and administrative workflows ### *** ## Explore more After creating your first form, explore: [Form setup](docId\:ZMxs_yKAM14ynYNEoEMNw) Configure how your form behaves, including settings, publishing, and version control. [Field types](docId\:zJqYfItNqFnZq-kGLD2TS) Choose the right inputs to capture structured data from your customers. [Form Entries](docId\:uSPvWmmpbtmrtHSpcNyOk) View, manage, and update submissions sent through your forms. [Conditional Logic](docId\:JZ1KsJxZIS72g2JNq8lee) Show or hide fields dynamically based on customer responses. [Validation Rules](docId\:IjhTAqJO7CzJCRi98gSxf) Ensure form data meets your requirements before it’s submitted or processed. [Workflows & Automations](docId\:KFk4KgojUGQV3Bolye--b) Automate actions and processes triggered by form activity. [title] Form setup [path] Features/Forms/ [title] Shopify [path] Integrations/ ## Introduction SparkLayer is the powerful platform that transforms your existing Shopify website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed the [official SparkLayer for Shopify app](https://apps.shopify.com/sparklayer), SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your Shopify store. The best part is you can retain your *existing* Shopify store design and layout and enable B2B alongside your retail operation (DTC). ## Supported Shopify Plans  SparkLayer works on all versions of Shopify, from Shopify Basic through to Shopify Plus. No matter which version of Shopify you use, you can easily enable SparkLayer on your Shopify store. :::hint{type="success"} **Try our demo** Want to test SparkLayer on an example Shopify Store? [Try our Demo](docId:87ILO_vHmG3XUXKecOLXv) ::: *** ## Get started ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Installing SparkLayer on Shopify](docId:687ZiSnQ7rsITCGjjKFyb) Learn about the steps to install SparkLayer on your Shopify store ::: :::LinkArrayItem [Shopify Customisations](docId\:ddIv5TDAnCayWTOJ0Vyb7) Explore our tips and tricks on Shopify B2B customisations ::: :::LinkArrayItem [Shopify B2B Dawn Theme](docId\:LHkU0_G_4GVef1jAmgXmo) Get a head start with our ready-made Shopify B2B theme ::: :::LinkArrayItem [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD) Take your B2B international with Shopify Markets ::: :::LinkArrayItem [Shopify Metafields & Data Mapping](docId\:BxWnGB6b1n7QFfhTnu7pk) Learn how to use the powerful Shopify metafields feature ::: :::LinkArrayItem [Shopify FAQs](docId\:P-7titr2d20hXBeixvKBZ) See some of our most commonly asked questions! ::: :::LinkArrayItem [Shopify Companies](docId\:wrzSu8adFvbXOkF50hX5I) How SparkLayer works alongside Shopify Companies. ::: :::: [title] Product Matrix Interface [path] Features/Frontend Interfaces/ ## Introduction The Product Matrix Interface lets your B2B customers rapidly add products to an order in bulk via a special "matrix table" display. If your products come in multiple variant types (e.g. colour and size), it's a great way to allow customers to quickly see all variants available and quickly purchase them.  :::hint{type="success"} **SparkLayer Interactive Demo** You can explore how the Product Matrix Interface works on our [example product here](https://demo.sparklayer.io/collections/b2b-grid-mode/products/example-running-shoes). ::: *** ## How it works :::hint{type="info"} **Please note** We only recommend using the Product Matrix Interface if you have products that have multiple variant option types (e.g. colour and size) with a large number of options. ::: The Product Matrix Interface replaces elements on your website's product detail page with a specially optimised layout that shows all the product options (variants) in **one single view**. ::embed[]{url="https://www.youtube.com/embed/cloM8_DJ7eg"} Once set up, the interface will be presented in a table and show the following information to the customer: | Item | Details | | ------------------ | ---------------------------------------------------------------------------------------------------- | | `Product pricing` | Their specific B2B pricing and, optionally, RRP pricing | | `Variants` | A matrix table of all available variants | | `Quantity` | The ability to select the quantity of a product using [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) | | `Add to order` | The ability to add items to an order | | `Quantity pricing` | Visibility of quantity pricing available (this is shown in an information popup) | | `Stock level` | The stock status of a product (e.g. pre-order) | | `SKU` | The product code (this is shown in an information popup) | The Product Matrix Interface also has handling for more than two variant groups. For each additional variant group, these will be presented within the table matrix for the customer to view. In the example below, the product is set up with Colour, Size, and an option to add a logo.  *** ## Integrating the code To add the Product Matrix Interface to your website, you just need to add a single line of code to your product detail page. ```javascript
It also enables you to add products to your cart in the same way as the SKU/Barcode Lookup option.
*This type gives your customers the more feature-rich user experience.* | | `SKU / Barcode Lookup` | This allows you to search by **SKU / Barcode** and will add items to an order only if an exact match is found.
*This type is useful if your customers use the tool purely for adding exact SKUs or Barcodes.* | ### How to enable Depending on your preference, you can enable these via the configuration area of the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general). :::hint{type="info"} **Hiding the search / lookup** It's also possible to fully hide the search / lookup feature, you can manage this in the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general) by selecting **Hide search** from the **Cart search type**. ::: ### Understanding the types ::::Tabs :::Tab{title="🔍 Search"} The Search tool offers an easy way for your customers to quickly add items, allowing them to search by a range of criteria including product name, product description, product SKU, product variant name, product variant option name and barcode. ::embed[]{url="https://www.youtube.com/embed/61IRiGBcR6Q"} The tool also handles mis-spellings and "partial matching", ensuring results are delivered where possible and allowing for a more user-friendly search. For example, when searching coffee, results will be returned for entries such as `coffe`, `cofee`, `cofe` In the example below, searching `example coffee` returns results of any products that match this term, prioritising those most relevant.  Similar to the main cart, the customer will see the ability to add items to an order using the quantity entry box as well as full visibilty of any quantity discounts, pack size rules, and inventory status. ::: :::Tab{title="➕ SKU / Barcode Lookup"} The SKU / Barcode Lookup adds products to your order simply by typing in the SKU or Barcode (if you're store is set up to use barcodes, you can [read our guide here](docId\:m3DF4f0Eyc2rM-vUaRG9H)). If it finds a match, it will immediately add the item and you can subsequently make edits.  ::: :::: :::hint{type="info"} **Please note** Each type noted above automatically add products to the order **using the rules** you've set. For example, if the product has been configured to use [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D) or minimum or maximum quantities, this will automatically be applied at the point of adding to the order. ::: ### Customising the text It's also possible to adjust the text that shows by default in the search box by adding a special text overwrite as shown below. For example, if you're using barcodes, you may want to inform customers that they can use both a SKU and a barcode to search. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.quick-order.search-placeholder": "Add products by SKU or barcode", } }, /* End of code */ ``` *** ## Intelligent Cart (AI) SparkLayer Intelligent Cart introduces a revolutionary new way for your B2B customers and sales teams to build orders quickly and effortlessly using the power of AI.  The magic lies in its simplicity: files and emails containing order details (such as SKUs, barcodes, and quantities) can be uploaded or emailed directly to SparkLayer, instantly populating a cart. Learn more about how this works in [our full guide here](docId\:rIAcYwzOMfwSomd5KB5p8). *** ## CSV file importing It's possible to quickly bulk upload products by using the "Import CSV file" feature within the 'Options' menu.  SparkLayer supports two ways to upload the contents of a CSV file: | Type | Details | | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `File upload` | Customers can manually upload a CSV file by specifying two columns:
* **If using SKUs:** `sku` and `qty` (you can also customise these names, please see below) * **If using barcodes: **`barcode` and `sku` | | `Pasting` | Customers can paste the contents of a CSV file into the text entry box |  By default, SparkLayer will accept a CSV file that has two columns, `sku` (or `barcode`) and `qty`  It's possible to configure customised titles for these columns, if you have a requirement for them to be more personalised for your customers. In the example below, the columns have been changed to `Item No.` and `Quantity`.  To get started, within your [language string overwrites](docId\:kLrS7wtxn3WnCDy8z5Zvu), simply add the below code and update accordingly. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.import.csv-headers.sku": "Item No.", "cart.import.csv-headers.barcode": "Barcode No.", "cart.import.csv-headers.qty": "Quantity", } }, /* End of code */ ``` :::hint{type="info"} **Please note** Providing the contents of the CSV file includes valid SKUs (or barcodes), all products will be added to the customer's order and **replace** the existing contents. If a product requires specific pack sizes to be specified, the CSV Import will round up to the nearest valid pack size. ::: *** ## Shopping lists Shopping Lists let your customers save the contents of an order for future use, making it quick and easy to reorder the products they buy regularly. ::embed[****]{url="https://www.youtube.com/embed/rhuLyeKaMQY"} Products can be saved to a list straight from any product page, and lists can be fully managed from within the My Account area - including previewing, adding, and editing their contents. Your B2B customers and sales agents can also export any list as a CSV, making it easier to share and reorder across teams. [Learn more](docId\:AQJJjc8wJrskIYivjIZrG) *** ## Checkout process When a customer is ready to place their order, they can then begin the checkout process. This is split into 4 steps: ::::WorkflowBlock :::WorkflowBlockItem **My Cart** This contains the summary of the products they want to order ::: :::WorkflowBlockItem **Shipping** This allows the customer to set their shipping address and complete additional fields (such as PO number) ::: :::WorkflowBlockItem **Review & Pay** The customer can confirm their preferred shipping cost, select payment method and confirm their order ::: :::WorkflowBlockItem **Complete** This is the final step of the checkout and completes the customer's order ::: :::: ### My Cart The My Cart step is essentially a summary of the customer's order and lets them: - View item level costs for products - Change quantities and remove products - Clear and empty the contents of an order - Perform actions such as saving shopping lists or importing CSV files (see above) - See their order sub-total (typically excluding tax and shipping costs)  :::hint{type="info"} **Order limit rules** It's possible to set minimum and maximum order rules (by order total and order quantity) that a customer has to meet before being able to place an order. Please refer to [our full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: ### Shipping The Shipping step allows the customer to select their shipping address and complete any data entry fields you may have enabled.  **Data entry fields** The data entry fields include the following configurations: - **Additional Information: **this is useful if you want to capture additional details from a customer whilst they are placing an order. Typical use-cases include capturing a Purchase Order number (sometimes referred to as PO number), delivery instructions, or instructions. [Learn more](docId\:o3nDhZBCxisWH6M6satDt) - **Custom checkout fields: **Custom checkout fields allow you to capture additional information from customers during the checkout process. It's a great way to allow customers to add data such as preferred shipping date, shipping instructions, and more! [Learn more](docId\:o3nDhZBCxisWH6M6satDt) - **File uploads: **SparkLayer supports the ability for B2B customers to upload files during the checkout process. This is a great way to capture additional details from the customer such as a "Purchase Order", details specific to their order (e.g. customisations they require), or any other file that is relevant to their account. [Learn more](docId\:o3nDhZBCxisWH6M6satDt) **Addresses** By default, any addresses for the customer are automatically taken from their address book information within your website admin. :::Iframe{iframeHeight="0" code=""} ::: Customers can also manually add addresses by clicking the '"Add new address" button or via the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP).  If they're adding an address via the My Cart interface, they can also select from the following: | Item | Details | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `Set as default shipping address` | This will become the default shipping address for future orders | | `Set as default billing address` | This will become the default billing address for future orders | | `Save address to address book` | This will save the address to their address book and this can be edited from the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) | If a customer has more than 4 addresses saved, the interface will also adapt to show all saved addresses within a drop down menu.  :::hint{type="info"} **Please note** It's possible to disable the ability to edit addresses, learn more in our [guide here](docId:-O7CpOLTlCJA2ChYChdoa) ::: ### Review & Pay The Review & Pay step is the final step of the checkout process and lets customers: - Select and confirm their preferred shipping method - Select and confirm their preferred payment method - See a full breakdown of the cost of their order, including tax and shipping - Confirm to your terms and conditions  **Shipping method** The shipping methods work in one of two ways: 1. Shipping is automatically calculated from the rules set up within your website admin 2. Shipping is calculated by the rules set up in the SparkLayer Dashboard You can learn more about how shipping works in [our guide here](docId\:CfZ_ZpGw2umOVAo73Lc5m). **Payment methods** :::hint{type="info"} Please see [payment methods](docId\:efevur-A3yCJXUHvrR7t-) below ::: ### Complete Once the customer has completed their order, this is then sent through to your eCommerce platform just like any regular order. Depending on the payment method selected, this will either arrive into your website admin as a *Draft* order or a *Completed* order.  If you've additionally configured orders to connect to the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT) this will then be sent directly to your backend system or via a middleware solution. :::hint{type="info"} **Customising the order complete screen** You can modify the text that shows to a customer, learn more in [our guide here](docId\:o3nDhZBCxisWH6M6satDt). In addition, you can also add custom content using "Slots". [Learn more](docId\:l_2ooHJiY-rAx2chBMgP2) ::: *** ## Payment methods SparkLayer supports a range of B2B-specific payment methods that can be tailored on a per-customer basis.  When customers reach the payment step, they'll see available methods and can select their preference. | Payment method | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment on Account` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** needing to enter any payment details.
**🏦 For merchants:**
It's essentially an 'offline' payment method and you can even set credit limit rules and net payment terms such as `Net 30, Net 60, etc`[Learn more](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details.
**🏦 For merchants:**
Like "Payment on Account", this is essentially an 'offline' payment method. You can then process the order and take payment via offline channels (e.g. by bank transfer) | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). This is sometimes referred to as "Pro-forma payment".
**🏦 For merchants:**
This will come through as a paid (or "completed") order and no further action should be required to collect payment. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | | `Request for quote` | **👪 For the B2B customer:**
The customer can submit their order **without** choosing a payment method.
**🏦 For merchants:**
The order will be marked as a 'Draft' order and can subsequently be edited (e.g. changing the shipping cost, adding additional discounts, adding or removing products from an order).
*Please note: as of June 2025, this has been replaced with the *[SparkLayer Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo)* and can no longer be selected within a Customer Group.* | ::::Tabs :::Tab{title="🛍️ Using Shopify"} The diagram below helps to illustrate how payments working with SparkLayer and Shopify, based on the payment method the B2B customer selects.  **Draft orders** If you're using Shopify, by default **all payment methods** other than Upfront Payment will be generated as [Draft orders](https://help.shopify.com/en/manual/orders/create-orders). If you'd prefer to automatically convert Draft orders into *Completed* orders, you can enable this via the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general). **Shopify checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the Shopify checkout. By default, they will see all Shopify payment methods you have set up (e.g. card payment, Paypal, etc). It's possible to set rules on which payment methods show for your B2B customers and we recommend [exploring available apps here](https://apps.shopify.com/payfy-conditional-payments). Please note that if a customer uses "Pay Online by Card" and doesn't complete their order, this will still show in your Shopify Draft Orders admin for review. ::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://hub.sparklayer.io/tech-docs) ::: :::: :::hint{type="info"} **Customising the B2B payment methods** You can edit the names and priority of payment methods easily. Learn more in [our guide here](docId\:ibIKczvHM085BkeJIfFYv) ::: *** ## Managing Quotes The SparkLayer [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) introduces a unified solution that streamlines the entire "quote-to-order" process directly from your existing online store. It allows you to handle quotes more effectively, converting them into completed orders faster than ever! ::embed[]{url="https://www.youtube.com/embed/Lmjwg4RK0r8"} The SparkLayer Quoting Engine works by allowing your B2B customers to easily submit quotes for review, and for your sales team to then communicate with the customer until they're ready to complete their order. Learn more in [our full guide](docId:8A4OpNIndUyfs3Pup-tuo). *** ## Discounts & promotions SparkLayer supports the ability to have discounts and promotions applied during the checkout and these can either be redeemed via discount codes, or applied "automatically" to the customer's order. :::Iframe{iframeHeight="0" code=""} ::: The SparkLayer Discount Engine unlocks a range of discount rules including: - **Order-level discounts:** eg, spend $1,000 and get 10% off, spend $2,000 and get 15% off - **Percentage and fixed discounts: **eg, 20% off an order total, $100 off an order total - **Coupon codes:** eg, enter code NEWCUSTOMER and get 5% off - **Scheduled discounts:** eg, start discount today and end it on a specific date and time - **Customer-specific discounts:** eg, only allow customer group ‘b2b-vip’ to qualify for the discount - And more :::hint{type="info"} **Learn more about discounts** You can see a full overview of what’s possible with discounts in [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg). ::: *** ## File uploads (file attachments)  SparkLayer supports the ability for B2B customers to upload files during the checkout process. This is a great way to capture additional details from the customer such as a "Purchase Order", details specific to their order (e.g. customisations they require), or any other file that is relevant to their account. [Learn more](docId\:o3nDhZBCxisWH6M6satDt). *** ## Showing custom content (using "slots") Custom Slots (or "Targets") allow you to enhance the SparkLayer My Cart interface by adding your own custom code in predefined areas.  You can learn more in our [custom slots guide here](docId\:l_2ooHJiY-rAx2chBMgP2). *** ## Persistent saved order A great feature of the SparkLayer My Cart Interface is the "persistent saved order". When a customer adds items to their order, the contents are automatically saved to their browsing session for up to 90 days. If the customer then signs out and logs back in, all previous items in their order will be saved. This feature also works across different devices, e.g. a customer could build an order on a desktop computer and then complete it the next day on a mobile device. *** ## Cart "Locking" SparkLayer has built-in handling for concurrent users making changes to an order, termed cart "locking". This is specifically relevant to our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) tool where sales agents may be building an order on behalf of a customer. If there is an active cart and a customer subsequently accesses it, they'll see a message shown at the to of the page.  By clicking "Take control", this will then allow the customer (or sales agent) to make further edits before completing the order. *** ## Tax :::hint{type="info"} **Understanding tax** Please refer to our [guide here](docId\:ZSsXG6FjRLCod_GxoluTN) for details on how tax works with SparkLayer. ::: *** ## Configurations SparkLayer supports a wide range of configurations you can apply to the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). Please see our [full guide here](docId\:SBEaOaCq_A7FfbTatX8bD) on what's possible! *** ## Using Hardware (e.g. barcode scanners) ::embed[]{url="https://www.youtube.com/embed/BGnL56nZ8Jk"} Did you know SparkLayer can also support hardware such as barcode scanners? SparkLayer automatically synchronises [barcode data](docId\:m3DF4f0Eyc2rM-vUaRG9H) from your store, meaning you could technically use the My Cart Interface to accept barcode-scanned orders! If you have products with barcodes assigned in your admin then the below option will automatically be displayed in the cart for you to simply scan a product and add it to the cart.  The Quick Search tool (see below) allows you to insert both SKUs and Barcodes, meaning you can quickly add items to an order simply by entering codes into this input field. You'll need to configure your hardware to "target" this input field, but it's a great way to bring powerful B2B ordering to your warehouse or in-store experience.  [title] Pricing Display [path] Features/Configurations/ ## Displaying a RRP price (MSRP price) Within the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ), it's possible to show RRP prices (or "MSRP prices") alongside your specific B2B pricing. For example, you may want logged in users to see what non-B2B customers pay for a specific item, allowing them to easily see their pricing savings.  To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `rrp` | | `Value` | This must be set up in the following format
`[{"value":15.99,"currency_code":"usd"}]`
Where `value` is the retail price and `currency_code` is the currency code (e.g. usd, gbp, eur).
You can define prices for additional currencies by using this example format
`[{"value":15.99,"currency_code":"usd"},{"value":10.99,"currency_code":"gbp"}]` | :::hint{type="success"} **Automate the RRP pricing** You can automatically populate the SparkLayer RRP metafield from your live Shopify prices using Shopify Flow. See [our guide](docId\:uvXV1kUg_VsZEPr5Dlb2z) for ready-made templates. ::: You can also watch our video tutorial on how to set this up. ::embed[]{url="https://www.youtube.com/embed/Duue-ZGKp3A"} :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `rrp` | | `Value` | This must be set up in the following format
`[{"value":15.99,"currency_code":"usd"}]`
Where `value` is the retail price and `currency_code` is the currency code (e.g. usd, gbp, eur).
You can define prices for additional currencies by using this example format
`[{"value":15.99,"currency_code":"usd"},{"value":10.99,"currency_code":"gbp"}]` | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.price.rrp": "MSRP: ", "product-card.price.rrp": "MSRP: ", "cart.price.rrp": "MSRP: ", } }, /* End of code */ ``` If you'd like to adjust the appearance of the RRP pricing, you can do so via adding special CSS overwrites to apply formatting.  Simply add the below CSS to your [CSS overwrites](docId\:qCt2Zk8wjhYIV2ZbVBJYy) and adjust accordingly. ```css ``` *** ## Quantity pricing :::hint{type="info"} **Learn more** For our full guide on quantity pricing and available configurations, please see our [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) guide. ::: ### Quantity pricing table If you've set up [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) for your products, SparkLayer will by default show this to your customers within the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT). :::Iframe{iframeHeight="0" code=""} ::: This will also show to customers when they add items to the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-).  It's also possible to display the tiered pricing breaks table anywhere on your product detail page by adding a special code snippet to your website.  Simply add the below in the source code of your product pages to display an additional quantity breaks table. ```html
```
### Quantity pricing savings
You can also customise how the "savings" column displays to customers.
| Area | Details |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Decimal places` | If you'd prefer to show **two decimal places** in the savings percentage (e.g. 9.45% off instead of 9% off), you can add the following setting to your [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) (within the `display` settings).
`roundPriceBreakPercentages: true,` | | `Hiding savings` | You can optionally hide the savings percentage from showing by adding the following setting to your [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) (within the `display` settings).
`showPriceBreakSavings: false,` |  ### Quantity pricing discount percentage based off RRP If you're using [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) in your price lists, this will display additional information to make it clear to the customer how much they are saving based on how many units they purchase. By default, the 'Savings' will be calculated based on the** single unit price **of the particular product (or variant). For example, if the single unit price is $2.00 and if you purchase 5 or more the price reduces to $1.00, the savings will display as `-50%`  If you'd prefer for the savings to instead be** calculated off the RRP** (i.e. retail price) of a product, you can enable this by adding a special setting. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { savingsUseRrp: true, /* Other settings should show below */ } /* End of code */ ``` *** ## Unit of measure pricing Are you looking to set up pricing based on "units of measure" such as boxes, cartons, or pallets? Please refer to our [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) guide to learn more. *** ## Customising the pricing text It's possible to *prefix* the pricing display on a product detail page with custom language such as `'Your price'`.  :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.price.from-prefix": "Your Price:" } }, /* End of code */ ``` In addition to this, you can also adjust any of the default language used for pricing using the below language strings. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.price.from": "From:", "pdp.price.rrp": "RRP:", "pdp.price.pack-size": "Pack ({packSize}): {price}", "product-card.price.from": "From:", "product-card.price.rrp": "RRP:" } }, /* End of code */ ``` *** ## Display a 'unit cost' price If you sell products that comprise 'multiple units', it's possible to display an automatically calculated "Unit Price" on your product pages. For example, you may sell a product that comes in packs of 10, but you want to make it clear to your customers how much a "single unit" costs. Or you may sell products that come in specific weights (e.g. kg) and you want to show a "price per kg".  To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `integer` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `case_size` | | `Value` | This must be set up in the following format
`1, 2, 3, etc` | Once the setting has been set up, you can then use and modify the below code sample to display on your product pages. :::ExpandableHeading **Click here to view code sample** ```javascript {%- if customer.metafields.sparklayer.authentication -%} {% if product.metafields.sparklayer.case_size %} {% endif %} {% endif %} ``` ::: **Combining with Shopify's unit price feature** If you're using Shopify's built-in unit price feature, you can also dynamically display the 'reference unit' e.g. kg, lb, ml.  Within the code sample above, simple change `el.textContent` to the below: ```javascript el.textContent = `Unit price per {{ item.unit_price_measurement.reference_unit }}: ${formatter.format(priceData.fromPrice / Number(caseSize))}`; ``` :::hint{type="warning"} **Important to note** If you are looking to customise the behaviour of how this works, we recommend engaging a Shopify expert to assist. ::: :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | --------------------------------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `integer` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `case_size` | | `Value` | This must be set up in the following format
`1, 2, 3, etc` | For more information, please refer to the [SparkLayer Technical Doc](https://docs.sparklayer.io/tech-docs) ::: ::::: *** ## Adjusting the "Unavailable" message When a product has no B2B pricing set against it, the [Product Card Interface](docId\:Mrp_Z0QIZQ2QksseuJylv) and [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT) will display a message that shows "Unavailable". This indicates to the B2B customer that the product cannot be purchased.  If you'd prefer, you can adjust this to display a different message by updating the language settings on your store. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.messaging.un-sellable": "Unavailable", "product-card.messaging.un-sellable": "Unavailable", "product-card.messaging.select-option": "Unavailable, please select another option" } }, /* End of code */ ``` *** ## Discounts & promotions SparkLayer supports the ability to have discounts and promotions applied during the checkout and these can either be redeemed via discount codes, or applied "automatically" to the customer's order. :::Iframe{iframeHeight="0" code=""} ::: The SparkLayer Discount Engine unlocks a range of discount rules including: - **Order-level discounts:** eg, spend $1,000 and get 10% off, spend $2,000 and get 15% off - **Percentage and fixed discounts: **eg, 20% off an order total, $100 off an order total - **Coupon codes:** eg, enter code NEWCUSTOMER and get 5% off - **Scheduled discounts:** eg, start discount today and end it on a specific date and time - **Customer-specific discounts:** eg, only allow customer group ‘b2b-vip’ to qualify for the discount - And more :::hint{type="info"} **Learn more about discounts** You can see a full overview of what’s possible with discounts in [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg). ::: *** ## Show RRP prices only (for in-store shopping) If you manage orders in physical locations with customers (e.g. in store), it's possible to enable a setting that sets the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) to **only** show the RRP (or "MSRP) prices when browsing and adding items to an order. This is especially useful if you need to "obscure" your B2B prices from view and you only want to show the full retail prices. :::Iframe{iframeHeight="0" code=""} ::: Use-cases could include: - In-store customer visits where an order needs to be placed and the customer must only be able to see the retail (RRP) prices - Sales teams who are placing orders on behalf of customers (e.g. on the road) and only the retail (RRP) prices must be seen :::hint{type="info"} **Please note** Behind the scenes, the B2B prices associated with the logged in B2B customer will still be used to create the order. This feature is solely for display purposes. ::: To enable this feature, you'll just need to update the SparkLayer Core Script. This will then apply to all B2B customers that log in. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { showRrpToggle: true, /* Other settings should show below */ } /* End of code */ ``` If you'd prefer to make this display for specific customers, you can configure the code as shown below: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { {% for tag in customer.tags %} {% if tag == "b2b-group-1" %} showRrpToggle: true, {% elsif tag == "b2b-group-2" %} showRrpToggle: true, {% endif %} {% endfor %} /* Other settings should show below */ } /* End of code */ ``` *** ## Tax-Inclusive Price Display Tax-inclusive price display lets you show your B2B prices with tax included, labelled clearly as "inc. tax" so buyers know exactly what they're looking at. It's designed for markets where buyers expect to see gross prices - common in Australia as well as in trade sectors selling to smaller businesses. :::hint{type="info"} **Please note - this changes presentation only.** Your prices are still stored, uploaded, and transacted net, and the tax your buyer actually pays is still calculated by your store's checkout at the point of purchase using any rules or 3rd party integration as set up in the eCommerce platform. Tax-inclusive price display is enabled for your store by the SparkLayer team. If you'd like it turned on, please get in touch with our support team. ::: ### Key features - **Show the price your buyers expect** - display gross prices to buyers who think in tax-inclusive terms, without changing how you upload or transact your pricing. - **Control it per price list** - turn it on for the price lists that need it and leave the rest showing net, so you can serve different markets from one store. - **Set your own rate per product** - supply a display tax rate per SKU, so reduced-rate and zero-rated products show correctly alongside standard-rate ones. - **Clearly labelled** - key pricing areas will add an extra "inc. tax" label, so there's no ambiguity about which basis a buyer is seeing. ### How to enable There are three parts to the setup, and all three need to be in place before buyers see gross prices. 1. **Ask us to enable the feature** Tax-inclusive display is controlled by a store-level switch that **only the SparkLayer team can change**. [Contact support](docId\:NNUw1G9z7eaJ4M78vk7t9) to have it enabled on your account. You'll be able to see it as enabled in your settings once it's on. 2. **Turn it on for a price list** Each price list has its own Tax Inclusive Display setting. Turn it on for the price lists whose customers should see gross prices, and leave it off elsewhere. Price lists with the setting off continue to show net prices exactly as before. 3. **Add a display tax rate to your products** Add a display\_tax\_rate column to your price CSV. This is the percentage used to work out the gross price from your net price, given as a number between 0 and 100. | Column | Value | Required | | ------------------ | -------------------------------- | ----------------------------------------------------------------- | | sku | Your product SKU | Yes | | price | Your net price | Yes | | quantity | Quantity break | No - leave the column out and every price applies from quantity 1 | | display\_tax\_rate | Display tax percentage, 0 to 100 | No | An example with quantity breaks: :::BlockQuote sku,quantity,price,unit\_of\_measure,display\_tax\_rate ABC-123,1,10.00,each,20 ABC-123,10,9.00,each,20 ::: And the same product without them: :::BlockQuote sku,price,display\_tax\_rate ABC-123,10.00,20 ::: :::hint{type="info"} **Please note** **I**f you include the quantity column, every row needs a value in it. An empty cell in a quantity column will fail the import - to price from quantity 1, leave the column out altogether. The rate applies to the whole SKU on that price list, so it must be the same on every row for a given SKU. Rows may leave the column blank, but conflicting rates for the same SKU will cause the import to fail. A product on a tax-inclusive price list with no rate supplied, or a rate of 0, still shows the "inc. tax" label - at 0%. This is deliberate, so a genuinely zero-rated product isn't indistinguishable from one where the rate simply hasn't been uploaded yet. ::: ### How it works Once enabled, gross prices and the "inc. tax" label appear throughout the buying journey. - **Product pages and product cards** The price shown on product detail pages and product cards is the gross price, with the label alongside key pricing info (the label is not repeated for every price in pricing tables for UX purposes). Where a product has several prices, the "from" price follows whichever price wins. - **Cart** Each cart line shows its gross line total, and the cart subtotal and total show gross with the label. The cart's shipping message also changes to make the basis clear, reading "Prices include tax. Shipping costs calculated during checkout" instead of the standard net wording. - **Checkout** The order total on the checkout review step shows gross with the label. Minimum and maximum order value rules are also assessed on the gross figure, so a buyer seeing gross prices is measured against the total they can actually see. - **Order history** In the customer's account area, order line items and the order total display on the same basis, so a buyer looking back at a past order sees it presented the way they bought it. ### Notes and limitations This is the part worth reading closely before you enable it - this feature is only suitable for stores with simple tax configurations where you can consistently provide a tax percentage rate for each SKU in price lists that you want to show tax-inclusive pricing. - **Your store's checkout is the authority on tax charged.** The display tax rate is the figure you upload, used for presentation. The actual tax your buyer pays is calculated by your store's checkout. If the two disagree, your buyer will see one figure in the cart and pay another. It's critical to keep your uploaded rates aligned with your store's tax configuration. - **Tax-exempt customers always see net prices.** If a customer is marked as tax exempt, SparkLayer shows them net prices with no label, regardless of the price list setting. This is intentional, since a gross price would be wrong for them. - **Mixed carts fall back to net totals.** If a cart contains a mixture of tax-inclusive and tax-exclusive products, the cart totals show net and drop the label. Individual lines still show on their own basis. A single gross total spanning both would understate the tax on the exclusive lines, so we show net instead. - **Custom items and unpriced products affect cart totals.** Custom line items added to a cart carry no display tax rate. A cart containing a product with no price but a manually quoted price will show net totals. - **Quoted prices are always net.** When a sales agent edits a quoted unit price, that price is entered and stored net. The editor is labelled "(excluding tax)" when surrounding prices are shown gross, so there's no confusion. - **RRP prices are never tax-adjusted.** RRP values display exactly as you upload them. On a tax-inclusive price list this means a gross B2B price sits next to a net RRP, and any savings percentage calculated from RRP compares the two different bases. We recommend uploading RRP values on the same basis as your display prices if you show both. - **Display mode can vary within a product.** Variants of the same product can resolve to different price lists, so one variant may be tax inclusive while another is not. This is a configuration issue - please ensure customers are only offered either tax inclusive or exclusive prices though careful price list and customer group configuration. ### FAQ :::ExpandableHeading **Does this change the prices I upload or the amount my customer is charged?** No. Prices are stored and transacted net exactly as before, and your checkout calculates tax as it always has. Only the figure displayed on your storefront changes. ::: :::ExpandableHeading **Can I use it for some customers and not others?** Yes. The setting is per price list, so you can show gross prices to the customer groups on one price list and net prices to everyone else. ::: :::ExpandableHeading **What happens if I don't upload a display tax rate?** Products on a tax-inclusive price list with no rate show their net price, still labelled "inc. tax", at an effective 0%. We recommend uploading rates for every product on a tax-inclusive price list so buyers see accurate gross figures. ::: :::ExpandableHeading **Why does my cart total show net when my product prices show gross?** Your cart most likely contains a mixture of tax-inclusive and tax-exclusive products, a custom item, or a product with a quoted price and no uploaded price. In these cases the cart totals fall back to net rather than show a gross figure that would understate the tax due. Please ensure the price list and customer group setup is consistent so a customer would either see only tax inclusive price lists or tax exclusive ones, but not a mixture. ::: :::ExpandableHeading **Will my buyers see gross prices at card checkout?** The SparkLayer cart and checkout review show gross prices with the label. Once a buyer moves into your store platform's own checkout, that platform's tax display rules apply. ::: [title] Product Display [path] Features/Configurations/ ## Product detail interface ### Table-view mode By default, the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT) shows single variant products with the option to change quantity and an "Add to Order" button.  If you'd prefer, you can force all products to render in the special "table-view" mode, even if they only have a single variant.  To enable this, simply add the below code: ```html
`[{"customer_group":"base","display":false}]`
To apply to multiple customer groups, you can use this format:
`[{"customer_group": "base","display": true},{"customer_group": "b2b-group1","display": false}]` | **Set specific variants to "un-sellable"** | Item | Details | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as `JSON` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `settings` | | `Value` | This must be set in the following format
`[{"customer_group":"base","sell":false}]`
To apply to multiple customer groups, you can use this format:
`[{"customer_group": "base","sell": true},{"customer_group": "b2b-group1","sell": false}]` | :::: :::Tab{title="🌐 Other platforms"} For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: :::hint{type="info"} **Product settings** You can learn more about product settings in [our full guide here](docId\:Cm9B1I6Cz0vOlc67g-fJI). ::: *** ## Add to Favourites Your B2B customers can save products for later using the heart icon, which appears on the product detail interface next to the Add to cart button and on product cards across your collection pages. Saved products are collected in a Favourites section within My Account, where customers can return to them and add them to the cart whenever they're ready.  Favourites are turned on by default. If you'd prefer not to show the heart icon, you can turn Favourites off from **Storefront → Options** in the SparkLayer dashboard, under My Account Settings. Learn more in [our full guide here](docId\:BXlogKI2-m4jlJtwji_gQ). *** ## Quick Buy Mode :::hint{type="warning"} **Important - please note** The customisations detailed in this guide are recommendations only and may vary in complexity, depending on how your store is set up. Whilst the SparkLayer team can advise on how to approach implementing these recommendations, our team may not be equipped to implement them on your Shopify store. We recommend engaging a developer assist should you wish to proceed with any of the recommendations below. ::: It's possible to adapt the SparkLayer interface to display in **"Quick buy mode"** that allows customers to more rapidly build orders from your product collection pages.  To enable this feature, you can adapt the [Product Card Interface](docId\:Mrp_Z0QIZQ2QksseuJylv) with a special setting that adjusts the layout to a "table-view". Simply add the code below to any product collection page. ```html\ \
:::
1. **Add to your B2B login page** - In your Shopify admin, go to Online Store > Themes and click "Customize". Navigate to your B2B login page, then select "Embed custom contact form" from the "Form Action" menu. Paste in the embed code you copied.
2. **Save and test** - Save your changes, then visit the page in your browser to check the form is displaying and working as expected.
You can build and customise your form in the [SparkLayer Dashboard](https://app.sparklayer.io/forms) - learn more about [SparkLayer Forms](docId\:nn5qnfmfGkXlyUmAMpSnq).
### Embed custom contact form
If you'd prefer to use a custom form to manage applications to your B2B store rather than the Shopify contact form, you can enable this via the Customizer.
Simply select the "Embed custom contact form" from the "Form Action" menu and paste in your contact form HTML code.
### Go to new page URL
If you'd prefer to not include an application form on this page, you can instead direct the user to a specific page URL. For example, you may have an existing registration page on your store or a URL on a different website address.
Simply select the "Go to new page URL" from the "Form Action" menu and specify the URL within the "Redirect URL" field.
### Important notes & considerations
Please note the following:
- The example login and registration page detailed above is essentially standard Shopify code and is not technically part of the SparkLayer App. It is built using best-practice Shopify Liquid code and standard CSS and can easily be modified by a Shopify developer
- The built-in registration form uses the standard Shopify contact form system - it is no different to adding a generic contact page to your Shopify store and as such is technically a form supported by Shopify (and not SparkLayer)
- If a customer submits the login form with incorrect credentials (e.g. an incorrect email and/or password), the page will redirect to the standard Shopify login page with the standard validation to notify the customer that their login details are incorrect.
***
## Translating the B2B Login & Register Page
If your Shopify store uses Shopify Markets to display different languages based on a user's location, you can fully translate the SparkLayer B2B Login and Registration forms to match.
:::hint{type="info"}
**Please note**
Before starting, ensure your Shopify store is correctly configured to use **Shopify Markets**. You must have languages specified for your target markets (e.g., French for France, German for Germany).
:::
We recommend using Shopify's native solution for the best compatibility. Install the [Shopify Translate & Adapt app](https://apps.shopify.com/translate-and-adapt) from the Shopify App Store. This app provides a visual interface to apply translations side-by-side with your default content.
Open the **Shopify Translate & Adapt** app. At the top of the dashboard, use the dropdown menu to select the language you wish to edit.
Then click "**Templates**" under "**Themes**".
In the resource list, search for and select the B2B Login page. This is typically named **Page: B2B Login**, unless you have manually renamed the page title.
Once the page is selected, you will see the translatable fields on the right side of the screen. You have two options:
- **Manual Translation:** Type your specific translations into the corresponding fields.
- **Auto-translate:** Click the **Auto-translate** button (if enabled) to automatically generate translations for all fields using Shopify's translation engine.
***
## SparkLayer Forms
::embed[]{url="https://www.youtube.com/embed/_M4QphRF9_k"}
If you're looking for more control over your B2B registration process, SparkLayer Forms is our built-in, no-code form builder that lets you create and manage registration forms directly within SparkLayer - no third-party apps needed.
With SparkLayer Forms, you can:
- Build forms visually using a drag-and-drop builder with flexible field types including text, email, dropdowns, file uploads, addresses and more
- Set up approval workflows to review and approve applications before granting access
- Automatically tag customers, assign them to customer groups, and sync data to your platform
- Get started quickly using the ready-made Customer Registration Form template
Since everything is managed within SparkLayer, you can handle the entire process from application through to approval and customer creation in one place.
[Learn more about SparkLayer Forms](docId\:nn5qnfmfGkXlyUmAMpSnq)
***
## Inviting & activating B2B customers
To begin inviting and activating B2B customers, please see [our full guide here](docId\:YUfghEGoxe_h7uJfcshna).
***
## Forcing customers to login
If you're wanting to **restrict your entire website** to be locked down until a customer successfully logs in, you can do so by editing the `theme.liquid` file within your storefront theme.
We've included an example on how to setup this up and works as follows:
::::WorkflowBlock
:::WorkflowBlockItem
Code is added to the `theme.liquid` file
:::
:::WorkflowBlockItem
For **logged out** users, all visitors are redirected to the account login page `/account/login`
:::
:::WorkflowBlockItem
For **logged in** users and those tagged with `b2b`, they'll then be able to view the entire website as normal.
:::
::::
```html
{%- if customer.metafields.sparklayer.authentication -%}
{%- else -%}
{%- if request.design_mode -%}
{%- else -%}
{%- if template contains 'customers/'
or request.path == '/challenge'
or request.path == '/pages/contact-us'
or request.path == '/pages/b2b-login'
or request.path == '/pages/about-us'
or request.path == '/pages/terms-and-conditons'
-%}
{%- else -%}
{%- endif -%}
{%- endif -%}
{%- endif -%}
```
***
## B2B Onboarding page
A great way to encourage your customers to use your new B2B store is to **explain the benefits**. To help you get started, you can use our ready-made "onboarding landing page" that gives a great overview of the features to your customers.
:::::ExpandableHeading
**To install the onboarding landing page, please follow these steps:**
::::WorkflowBlock
:::WorkflowBlockItem
In Shopify, go to **Online Store** and click **Pages** (or [go here](https://admin.shopify.com/pages))
:::
:::WorkflowBlockItem
Click the "Show HTML" button and then paste in the [code from here](https://gist.github.com/cm-sl/47d750425f90d527e1210efe3735dc7f)
:::
:::WorkflowBlockItem
You can then customise the page title, URL, and any of the content as required.
We recommend give the page a URL of `b2b-onboarding`
Finally, set the page to "**Visible**" to publish it on your store and you can then click "**View**" to see the page.
:::
:::WorkflowBlockItem
To make customers aware of your new page, you could add this to your website navigation (such as your website header or footer). If you're using our ready-made [Shopify B2B Registration & Login](docId\:Gfc0UW7mJnMNpnNO6EdRl) you can also link to the page from there.
:::
::::
:::::
***
## B2B Activation Emails
Depending on how your Shopify accounts are set up, you can also customise the activation emails that your B2B customers receive when you invite them to your Shopify store. Learn more in [Shopify Email Notifications](docId\:FAW11UwvEk1KN06woxik0).
[title] Credit, Net Terms, & Invoicing
[path] Features/Configurations/
## Setting Credit Limits & Account Balances
If some of your B2B customers have a credit limit in place, it's possible to display this when they login to your website, giving them visibility on their credit status.
Credit limits work by specifying an amount against a customer record and, when the customer signs in, and places an order using [Pay on Account](docId\:efevur-A3yCJXUHvrR7t-), they'll be notified if they are about to place an order that exceeds their credit limit.
In our example below, the customer has exceeded their credit limit and their ability to "Pay on Account" has been blocked (i.e. they are only able to "Pay Online by Card")
This feature works by enabling a special setting against a customer that can then be manually adjusted according to their agreed terms. You can also specify an account balance that will automatically update each time a successful order is placed (this can also be adjusted manually if required).
:::hint{type="success"}
**Payments Visbility**
Looking to allow your customers to see their current financial standing right in the 'My Account' area? See our guide to setting up [Payments Visibility](docId\:ibIKczvHM085BkeJIfFYv).
:::
:::hint{type="info"}
**Please note**
By default, if a customer exceeds their credit limit, the "Pay on Account" payment method will be disabled. If you'd prefer to still allow the order to be placed by this payment method, you can [enable this setting here](https://app.sparklayer.io/configuration/settings/general).
:::
:::::Tabs
::::Tab{title="🛍️ Using Shopify"}
:::hint{type="info"}
**Setting up metafields on Shopify**
🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform).
📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk)
:::
| Item | Details |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) |
| `Metafield type` | This must be set as an `JSON` string |
| `Namespace` | This must be set as `sparklayer` |
| `Key` | This must be set as `payment_on_account` |
| `Value` | This is applied on a specific customer record.
This must be specified in the following format:`{"credit_limit":1000,"balance":250}` | :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | Customers | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `payment_on_account` | | `Value` | This must be specified in the following format:`{"credit_limit":1000,"balance":250}` | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: If you're using multiple currencies for your B2B customers (see [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD)), you can specify their exact currency when viewing the credit limit and account balanace. To set this up, simply change the value key against a customer to the below format, changing `usd` to your required currency: | Item | Details | | ------- | --------------------------------------------------------------------------------------------------------------- | | `Value` | This is applied on a specific customer record.
`{"credit_limit":1000,"currency_code":"usd","balance":250}` | :::hint{type="info"} **Real-time "Account Balance"** SparkLayer also has the ability to show a real-time Account Balance with the use of our **Payments Visibility** toggle. You can [find our guid on this here](https://docs.sparklayer.io/payment-methods#payments-account-balance) ::: You can also modify the text that is shown to a customer by updating the SparkLayer language strings.  They'll see special messaging both in their My Account area and during the checkout if they exceed their credit limit.  :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "account.main.my-details.payment-on-account.detail": "Your account balance is {balance} with a credit limit of {creditLimit}.", "account.main.my-details.payment-on-account.detail-without-limit": "Your account balance is {balance}.", "account.main.my-details.payment-on-account.net-terms": "Your payment terms are {type}.", "account.main.my-details.payment-on-account.sub-text": "Payments may take some time to be updated. Please contact us to discuss payments or credit.", "cart.checkout.payment-method.credit-unavailable.title": "Your cart currently exceeds your available credit limit", "cart.checkout.payment-method.credit-unavailable.message": "Please choose an alternative payment method to complete your order. If you'd like to discuss your payment terms, please contact us.", "cart.checkout.payment-method.credit-limit-hit.title": "Your cart currently exceeds your available credit limit", "cart.checkout.payment-method.credit-limit-hit.message": "You can place an order but it may be delayed and subject to approval. If you'd like to discuss your payment terms, please contact us.", } }, /* End of code */ ``` *** ## Setting Net Terms (Payment on Account) It's possible to set specific "Net terms" for a customer (such as Net 30, Net 60) giving the customer visibility on their payment terms. Once it's set up, this will display in the customer's [My Account](docId\:lQXaNI7IVDqna09D9soAP) area under "Financials'.  When the customer then goes through the checkout, they can simply select "Pay on Account" to trigger their net payment terms.  :::::Tabs ::::Tab{title="🛍️ Using Shopify"} First, you'll need to ensure the "Payment on Account" payment method is enabled within the **Customer Groups **area of the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups) for your chosen customer group. Click the **Edit** icon and you'll see a section called **Payment Methods**. From here, simply ensure that "Payment on Account" is ticked.  When an order then arrives into Shopify, it will be created as a **Draft** order. With the payment terms set (as above), this will then update the "Payment due later" setting and populate the "Payment terms" and "Issue date" fields.  You can even automatically convert the **Draft** order into a **Completed** order within Shopify and then manually collect payment at a later date (such as offline via your accounting system). To activate this, from the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general), turn on "Auto-complete Shopify Draft orders" and ensure "Payment on Account orders - automatically mark as paid" is **turned off**. If you do want to automatically mark the order as paid, you can achieve this via Shopify Flow. [Learn more](docId\:ddIv5TDAnCayWTOJ0Vyb7).  :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `payment_on_account` | | `Value` | This is applied on a specific customer record.
This must be specified in the following format:`{"net_terms":"30_days"}`
If you're also the credit feature (see above), this should be populated as follows:`{"credit_limit":1000,"balance":250,"net_terms":"30_days"}` | In terms of configuring the net terms, the following values are supported: | **Net terms** | **Value** | | ------------- | --------- | | `7 days` | 7\_days | | `15 days` | 15\_days | | `30 days` | 30\_days | | `45 days` | 45\_days | | `60 days` | 60\_days | | `90 days` | 90\_days | :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: :::hint{type="info"} **Please note** If you're using the SparkLayer setting to [automatically mark 'Payment on Account' orders as Paid](https://app.sparklayer.io/configuration/settings/general) on your store setup, this will not work in parallel to customers using "Payment on Account" with specific net terms (as detailed above) ::: :::hint{type="success"} **Shopify automations** You can also automate how your net payments work with our ready-made Shopify Flows. You can learn more in [our guide here](docId\:ddIv5TDAnCayWTOJ0Vyb7) ::: *** ## Sending invoices Are you looking to create and send invoices for your B2B customers? SparkLayer offers a variety of ways to allow invoices to be sent, streamlining your B2B operations: | Method | Details | Use-case | | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SparkLayer Invoices` | Customers can view & download invoices directly via SparkLayer. | Your invoicing requirements are relatively simple and you don't want to use additional third-party apps.
[Learn more](docId\:NKh8H14Ffna5DD71SwwNd) | | `Send invoices via your online store` | Depending on which eCommerce platform you're using, it's also possible to send invoices directly from your store administration area. | You have relatively basic requirements and you want to use your existing eCommerce platform to manage the process.
*Learn more in the guide below.* | | `Metafield and attaching invoices` | Add custom invoice details within your store using special metafields that can be associated with an order (manually or automatically). | You have an existing back-office system that is already generating invoices for your store and you can access these as files (e.g. a PDF).
*Learn more in the guide below.* | | `Third-party app` | Tools such as Sufio allow you to automatically integrate their solution into SparkLayer. | You require invoicing beyond B2B (e.g. for your regular cusotmers also) and need more design customisation.
*Learn more in the guide below.* | ### SparkLayer Invoices To learn about SparkLayer's own invoicing solution, please see [our guide here](docId\:NKh8H14Ffna5DD71SwwNd). ### Send invoices via your online store Depending on which eCommerce platform you're using, it's also possible to send invoices directly from your store administration area. Whilst the functionality may be basic, it can act as a good way to start testing your B2B invoicing process before using a more comprehensive invoicing solution. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} **When an order is placed (as a draft order)** When a customer places an order via your website via a [manual payment method](docId\:ibIKczvHM085BkeJIfFYv) (such as *Payment by Invoice*), it's possible to have this order come into Shopify as a 'Draft' order.  Shopify then has the ability to **'Send an invoice' **that allows you to send a customise message and a link to the Shopify checkout to make payment. This uses the 'Send invoice' feature of Shopify Draft orders and you can learn more about [how this works here](https://help.shopify.com/en/manual/orders/create-orders#share-checkout-link-with-customers). Once the customer completes their purchase by making payment, the order is then marked as paid and will then display within your **Shopify Orders** area.  :::hint{type="info" attributes="[object Object]"} You can edit this email template by going to **Settings > Notifications** within Shopify and search for the **Draft order invoice** template ::: If the customer hasn't made payment for any reason or you are processing it manually, within Shopify you can open the order and easily resend or manually mark as paid. Please note, the order will stay as a Draft order until action has been taken.  :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://hub.sparklayer.io/tech-docs) ::: ::::: ### Metafield - attaching an invoice to an order When a customer places an order and payment has been completed against it, the order will appear in their [My Account](docId\:lQXaNI7IVDqna09D9soAP) area. When viewing an order, in addition to the order details (such as products ordered, order status, address), it's possible to attach an invoice against an order that the customer can subsequently download. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} To get started, you'll need to add a custom metafield to your Shopify store, using the "Orders" metafields :::hint{type="info"} **Setting up metafields on Shopify** To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Orders](https://admin.shopify.com/settings/custom_data/order/metafields) | | `Metafield type` | This must be set as an`URL` or `File`. One value or lists of values are supported. | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `invoice_url` | | `Value` | **NOTE: It's very important the file name or URL is not guessable. We recommend having a **[UUID](https://www.uuidgenerator.net/)** placed within the URL which makes it impossible to guess.** | Once you've set up the metafield, simply navigate to an order in Shopify and you'll see the field appear to specify the invoice URL.  If you don't already have the invoice file(s) hosted, you can use the built-in [Shopify content system](https://admin.shopify.com/content/files?selectedView=all) to do this. Simply upload the file and copy the link to your clipboard. This can then be pasted within the filed detailed above.  Once the B2B customer logs in, they'll then be able to download this from their order history on your website. As this is using the Shopify metafield system, the process of attaching invoices could be actioned in bulk or you could even automate this process from your backend system (e.g. ERP, CRM).  :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | Orders | | `Metafield type` | This must be set as a text string.
We strongly recommend the file names are secure and you can even use a [tool such as this to help](https://www.uuidgenerator.net/). | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `invoice_url` | | `Value` | N/A | For more information, please refer to the [SparkLayer Technical Docs](https://hub.sparklayer.io/tech-docs) ::: ::::: ### Using third-party apps for invoices If you're looking for a more feature-rich invoicing solution, you may also want to consider using a third-party app such as [Sufio Invoicing](docId\:qlBasATpzOCOF5eXC99O3) [title] Custom Slots ("Targets") [path] Features/Frontend Interfaces/ :::hint{type="success"} **🚀 Upgrading to the latest SparkLayer version** To benefit from our latest updates, please upgrade your [SparkLayer Core Script](https://app.sparklayer.io/integrations/widgets/core). You can learn about how the Core Script works in [our guide here](docId\:QWXsYM9X5_pvIOGUteKcP). ::: ## Introduction Custom Slots (or "Targets") allow you to enhance a range of the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) by adding your own custom code in predefined areas. ::embed[]{url="https://www.youtube.com/embed/pAfXYvYnY2M"} It's a great way to further enhance your B2B customer experience and use-cases could include any of the following: | Use-Case | Details | | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Promotional content` | Adding promotional content to the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) that customers see as soon as they login (e.g. announcing a new product line) | | `Adding links` | Adding links in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) area that your B2B customers can access (e.g. downloadable CSV templates) | | `Upsell content` | Adding upsells and promotional content when a customer [completes an order](docId\:efevur-A3yCJXUHvrR7t-) (e.g. asking for a rating) | In addition to this, you could also set up more advanced content that varies based on specific rules: | Use-Case | Details | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customer-specific` | Based on who the customer is and which [customer group](docId:5_lWMNohhjBJJppg9E6Vh) they belong to, show different content (e.g. customer group `VIP`, show a promotional message) | | `Order-specific` | Based on the order contents or order total, show a message (e.g. if the order is under $100, encourage them to add more products) | Custom Slots allow a lot of flexibility in how they're used and it's really up to you how creative you can be! *** ## How it works Custom Slots work by adding special **template slots** to your website that are then displayed in specific locations of the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). You can learn how to begin using them under *"Getting Started"* below. ### My Account The "My Account" template slot is displayed at the top of the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) when a B2B customer signs in.  ### My Order The "My Order" template slot is displayed at the top of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) when a B2B customer signs in.  ### Order Complete The "Order Complete" template slot is displayed when a B2B customer customer [completes an order](docId\:efevur-A3yCJXUHvrR7t-).  ### Cart Shipping Step The "Cart Shipping Step" template slot is displayed on the "Shipping" step of the checkout. ### Cart Payment Step The "Cart Payment Step" template slot is displayed on the "Payment" step of the checkout. ### Purchase Summary Header The "Purchase Summary Header" template slot is displayed above the purchase summary when viewing a purchase. ### Purchase Summary Footer The "Purchase Summary Footer" template slot is displayed below the purchase summary when viewing a purchase. ### Cart Line Item The "Cart Line Item" template slot is displayed below a product line item within the My Cart. *** ## Getting Started ### Configuring your store To begin using Custom Slots, you'll need to add some specific code to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) within the `display` section. :::Iframe{iframeHeight="0" code=""} ::: Based on the locations you intend to add to your website, you can include the below code in your SparkLayer Core Script. ```javascript display: { showSlots: [ 'spark-slot-my-account', 'spark-slot-my-cart', 'spark-slot-order-complete', 'spark-slot-cart-shipping-step', 'spark-slot-cart-payment-step', 'spark-slot-purchase-summary-header', 'spark-slot-purchase-summary-footer', 'spark-slot-my-cart-line-item', ], }, ``` | Name | Details | | ------------------------------------ | ----------------------------------------------- | | `spark-slot-my-account` | This enables the "My Account" slot | | `spark-slot-my-cart` | This enables the "My Order" slot | | `spark-slot-order-complete` | This enables the "Order Complete" slot | | `spark-slot-cart-shipping-step` | This enables the "Cart Shipping Step" slot | | `spark-slot-cart-payment-step` | This enables the "Cart Payment Step" slot | | `spark-slot-purchase-summary-header` | This enables the "Purchase Summary Header" slot | | `spark-slot-purchase-summary-footer` | This enables the "Purchase Summary Footer" slot | | `spark-slot-my-cart-line-item` | This enables the "Cart Line Item" slot | ### Adding & customising the slots Once you've adjusted the SparkLayer Core Script with the above changes, you can then proceed to add custom content for each of the locations. To get started, you simply need to add a **template element** within your website code, referencing the `id` of one of the slot locations above. ```html
```
:::
:::ExpandableHeading
**Show a message that shows customer metafields**
```html
{% if customer.metafields.custom.field_name %}
Your message here.
You can output a metafield like this
{{ customer.metafields.custom.field_name }}
{% endif %}
```
:::
:::ExpandableHeading
**Show a message that includes the customer's name **
```html
Hello {{ customer.name }}, here's a message for you.
Hello {{ customer.name }}, here's a message for you.
Hello {{ customer.name }}, here's a message for you.
```
:::
:::ExpandableHeading
**Show a message based on the Shopify tag assigned to a customer (e.g. b2b-vip) **
```html
{% for tag in customer.tags %}
{% if tag == "b2b-group-1" %}
As a Group 1 customer, you qualify for special B2B pricing!
{% elsif tag == "b2b-group-2" %}
As a Group 2 customer, you qualify for special B2B pricing!
{% else %}
Message to show for regular B2B customers
{% endif %}
{% endfor %}
```
:::
:::ExpandableHeading
**Show a message that includes text and an image**
```html
```
:::
::::ExpandableHeading
**Show a message at a cart line-item level**
This allows you to display a custom slot on a cart line-item level, such as a message that references the product name and ID ("slug").
We recommend using web components to isolate state for slots that need unique messaging or functionality per line item such as the example below.
This slot can access the following `data-` attributes from the parent node using \`this.parentNode.dataset:
- `data-sku`
- `data-slug`
- `data-spark-id`
- `data-platform-id`
- `data-item-key`
```html
(defaults to 1) |  The quantity field in the sample CSV file (named `qty`) lets you define the price the customer pays for that **specific** **quantity** of the item. In example below, we've illustrated how the price for SKU `123-abc` changes from a quantity of `1` to a quantity of 5 e. :::hint{type="warning"} **Please note** When setting up quantity pricing, you must specify a unit price for a quantity of `1` even if you don't intend to allow customers to be able to purchase single units (i.e. you intend to set up minimum quantities or pack sizing: see [our guide here](docId\:CmxfrPgjQxfz9vJzTVv0D).) ::: In addition to using the manual CSV upload to configure your pricing, you can also configure quantity pricing manually via [The Price Editor](docId\:fWW4Oh09nSO1-G9TXUTOP) tool, allowing you to make manual adhoc changes if required.  On set up, the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT) will clearly show the quantity pricing to your customers. :::hint{type="info"} **Please note** By default, the quantity pricing will show a 'Savings' amount based off **the single unit price** of the product (or variant). If you'd prefer for the savings amount to be based off the RRP (i.e. retail price), you can set this via [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD) ::: ### Quantity pricing for multi-variant products When setting up quantity pricing for products that have variants (e.g. colour, size), it's possible to configure how the quantity pricing gets applied. | **Type** | **Behaviour** | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Applying across all variants` | `Default behaviour`
The quantity pricing will take affect** across all variants **of the product. For example, if a product comes in Small, Medium, and Large and you've set up quantity pricing to take effect with a quantity of 5, the customer would receive the discounted pricing no matter the combination. e.g.
1 x Small
2 x Medium
3 x Large | | `Applying to a single variant` | `Configuration`
If you'd prefer to restrict quantity pricing to a specific variant, you can do this by *disabling* a special setting within the [Dashboard](docId\:nzsx6U_DAWtzVzSehf4oR). In this example, if a product comes in Small, Medium, and Large, you can set the quantity pricing to **only** apply to the Large size.
To disable this, [please click here](https://app.sparklayer.io/configuration/settings/general). | ### Understanding the unit price calculation When using quantity pricing, the** unit price** for an item will be dependent on the quantity the customer is adding to their order. When calculating the unit price, SparkLayer will take the "requested quantity" and calculate the quantity "tier" the pricing is applicable to. If the customer has any discounts configured, these will then additionally be deducted from the unit price. *** ## Unit of Measure Pricing SparkLayer supports the option to configure your pricing with **units of measure**, allowing you to offer discounted prices based on specific purchasing quantities. :::Iframe{iframeHeight="0" code=""} ::: It's a great way to allow customers to order in pre-defined units such as boxes, pallets, or cases. When setting these up, you can then specify how pricing works for these specific units, as well as handle units that 'fall outside' these. Generally speaking, unit of measure pricing works in a similar way to quantity pricing - customers are essentially buying in quantity and you're giving a discount on the price (per unit). How it differs to quantity pricing is how the "line total" and "unit price" for a product is calculated. Let's use an example: :::hint{type="success"} **Unit of Measure Example** You have a product that can be purchased as **single units**, in **boxes **or in **pallets**. To fill a box you require **7 units**. To fill a pallet you require **150 units**. - The **single unit** price for a product is `$14.99` - For a **box** of a product, the **unit price** to pay is $10.99 - For a **pallet** of a product, the **unit price** to pay is $8.99 If a customer is requesting to purchase **320** units of a product, SparkLayer will distribute the requested quantity across the configured units of measure and then calculate the line total and unit price as so: - 300 units at the **pallet **unit price: $8.99 \* 300 = $2,697.00 *(2 pallets)* - 14 units at the **box **unit price: $10.99 \* 14 = $153.86 *(2 boxes)* - 6 units at the **single unit** price: $14.99 \* 6 = $89.94 - **Line total **= $2940.80 - **Unit price **= Average price across all units = $2940.80 / 320 = $9.19 ::: :::hint{type="warning"} **Please note** The unit price displayed will be the average unit price across the total quantity purchased. ::: ### How it shows to a customer Within the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT), SparkLayer widget we will provide a breakdown detailing how the unit price has been calculated and the applicable units of measure. This will also carry through to the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), ensuring the customer can clearly see how the overall and unit pricing has been calculated.  ### Configuring Unit of Measure To get started, you'll need to use the [manual pricing upload](docId\:NX9Q00eWV_kbjxc3tg1ut) feature within the [SparkLayer Dashboard](https://app.sparklayer.io/pricing). In order for the CSV file to import your quantity pricing successfully, it must have the following columns, with the addition of `unit_of_measure` as shown below.  | **Column** | **Details** | **Required** | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------- | | `sku` | The product SKU as set up in your eCommerce platform or backend system | `Yes` | | `price` | The unit price for the SKU at the quantity set in column 3 (qty) | `Yes` | | `qty` | The quantity of the SKU for the specified price for quantity pricing (see below) | `No`
(defaults to 1) | | `unit_of_measure` | The unit of measure the quantity is associated to. The `unit_of_measure` value may only be alpha numeric and use **hyphens** as a separator.
For example: `box` `pallet` `pallet-box` | `No` | :::hint{type="info"} **Please note** When setting up unit of measure pricing, you must specify a unit price for a quantity of `1` even if you don't intend to allow customers to be able to purchase single units (i.e. you intend to set up minimum quantities or pack sizing: see [our guide here](docId\:CmxfrPgjQxfz9vJzTVv0D).) ::: You can also configure unit of measure pricing manually via [The Price Editor](docId\:fWW4Oh09nSO1-G9TXUTOP) tool simply by adding (or editing) your prices and specifying the unit of measure and the associated unit price. :::Iframe{iframeHeight="0" code=""} ::: ### Unit of Measure Language Strings You may configure language strings for unit of measure. This allows us to pluralise quantities when displaying feedback to the customer. To modify how a unit of measure is translated and pluralised, specify the translation using the key configured for the unit of measure when setting up the price list. For example: ```javascript /* Add the below code into the SparkLayer Core Script */ translations: { en: { "unit-of-measure.unit-type.box": "{uomQuantity, plural, =1 {box} other {boxes}}", "unit-of-measure.unit-type.pallet_box": "{uomQuantity, plural, =1 {pallet box} other {pallet boxs}}" } }, /* End of code */ ``` :::hint{type="info"} **Learn more** You can [read more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about updating language strings that contain dynamic variables. ::: *** ## Display a quantity pricing widget If you've set up [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) for your products, SparkLayer will by default show this to your customers within the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT). :::Iframe{iframeHeight="0" code=""} ::: It's also possible to display the tiered pricing breaks table anywhere on your product detail page by adding a special code snippet to your website. Learn more in [Pricing Display](docId\:S_VTlJBorGmnwjjfSMom9)  *** ## Pack sizing SparkLayer has full support for pack sizing (sometimes called *quantity increments*), meaning you can ensure customers to always add items to an order in your predefined packs (e.g. packs of 3, packs of 6). Learn more in [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) *** ## Minimum and Maximum quantities SparkLayer has support for a variety of different quantity product settings including: - Minimum product quantities at a variant level (e.g. products that have colours) - Minimum product quantities at a parent level (allowing you to apply rules to the product as a whole. If it has variants, it can apply across multiple variants) - Maximum product quantities at a variant level - Maximum product quantities at a parent level You can learn more about this in [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) [title] Settings [path] Dashboard/ ## 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.  *** ## 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  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).  :::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**.  :::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. ::: :::: [title] Payment Methods [path] Features/Configurations/ ## Enabling payment methods :::hint{type="info"} **Payment methods** Please refer to [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) for full details on what payment methods SparkLayer supports and how they work. ::: *** ## Request for Quote The SparkLayer [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) introduces a unified solution that streamlines the entire "quote-to-order" process directly from your existing online store. It allows you to handle quotes more effectively, converting them into completed orders faster than ever! ::embed[]{url="https://www.youtube.com/embed/Lmjwg4RK0r8"} The SparkLayer [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) works by allowing your B2B customers to easily submit quotes for review, and for your sales team to then communicate with the customer until they're ready to complete their order. Learn more in [our full guide](docId:8A4OpNIndUyfs3Pup-tuo). *** ## Enabling net payment terms :::hint{type="info"} **Looking to enable net payment terms?** Please refer to [our guide here](docId\:yWm70oQUosyKOoIqb4Z4G) for full details on how this works. ::: *** ## Credit & Credit Limits :::hint{type="info"} **Looking to enable credit limits?** Please refer to [our guide here](docId\:yWm70oQUosyKOoIqb4Z4G) for full details on how this works. ::: *** ## Custom payment messages On the final step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), Review & Pay, it's possible to display a "custom payment messages" that let you add additional details about a payment method. For example, if a customer is paying by "Pay by Invoice", you could add some additional text to inform them on how this process works.  Learn more about how to set this up in [our guide here](docId\:o3nDhZBCxisWH6M6satDt). *** ## Updating payment method names By default, SparkLayer will show the payment methods to customers with the names shown below: | Payment method | Name shown to customers | | -------------------- | ----------------------- | | `Payment by invoice` | Pay by Invoice | | `Payment on Account` | Pay on Account | | `Upfront Payment` | Pay Online by Card | | `Request for quote` | Request for Quote | :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.payment-method.full.paymentByInvoice": "Pay by Invoice", "cart.checkout.payment-method.full.paymentOnAccount": "Pay on Account", "cart.checkout.payment-method.full.upfrontPayment": "Pay Online by Card", "cart.checkout.payment-method.full.quote": "Request for Quote", "cart.checkout.payment-providers.quote.message": "Please note: when requesting a quote for your order, our team will review and notify you within 2 working days before processing.", } }, /* End of code */ ``` **Custom payment messages** On the final step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), Review & Pay, it's possible to display a "custom payment messages" that let you add additional details about a payment method.  For example, if a customer is paying by "Pay by Invoice", you could add some additional text to inform them on how this process works. See [our guide here](docId\:o3nDhZBCxisWH6M6satDt) to get started. *** ## Changing the order of payment methods :::hint{type="info"} **Setting up payment methods** If you're looking to adjust which payment methods your B2B customers can see, you can manage this via the [SparkLayer Customer Groups](https://app.sparklayer.io/customers/groups) area. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) ::: When a customer reaches the payment step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), they'll see all available payment methods you've set against their customer group.  If you'd like to configure the order of the payment methods and which payment method shows by default, you can apply a special setting to your website as shown below. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ paymentMethodsOrder: [ "paymentOnAccount", "paymentByInvoice", "upfrontPayment", "quote", ], /* End of code */ ``` *** ## Setting the default payment method :::hint{type="info"} **Setting up payment methods** If you're looking to adjust which payment methods your B2B customers can see, you can manage this via the [SparkLayer Customer Groups](https://app.sparklayer.io/customers/groups) area. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) ::: If you'd like to change the default payment methods customers see, you can modify the code sample detailed in "Changing the order of payment methods". In the example detailed above, *Payment on account* is listed first, making it the default shown to customers. You can amend the ordering using the naming conventions below. | Payment method | Setting name | | -------------------- | ------------------ | | `Payment by invoice` | `paymentByInvoice` | | `Payment on Account` | `paymentOnAccount` | | `Upfront Payment` | `upfrontPayment` | | `Request for quote` | `quote` | For example, if you wanted "Upfront Payment" to be the default, you would modify the code as shown below: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ paymentMethodsOrder: [ "upfrontPayment", "paymentOnAccount", "paymentByInvoice", "quote", ], /* End of code */ ``` *** ## Customising "upfront" payment methods SparkLayer supports a payment method called "Pay Online by Card" that B2B customers can select during the payment step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-).  Once selected, the customer will then be directed through to your standard checkout process to make payment. Depending on which platform you're using, it's possible to customise which payment methods show. ::::Tabs :::Tab{title="🛍️ Using Shopify"} By default, when your B2B customers select "Pay Online by Card", they'll be taken to the Shopify checkout and will see all Shopify payment methods you have set up (e.g. card payment, Paypal, etc). You can learn more about [Shopify payment methods here](https://help.shopify.com/en/manual/payments/additional-payment-methods).  ::: :::Tab{title="🌐 Other platforms"} No customisations applicable., they'll be directed to the Shopify checkout. ::: :::: It's possible to **conditionally** hide and show payment methods should you require your B2B customers to only see specific payment types when they checkout. - To get started, visit the Shopify App store and search for apps that support "hiding payment methods". One such app is ["ETP Hide and Sort Payment Methods"](https://apps.shopify.com/etp-hide-sort-payments?) - Within the app, you can then configure rules. To detect a B2B customer, simply add a rule that filters on a tag of `b2b` being present. - It's important to note that the payment type "Credit card" can only be hidden if your Shopify store is on the Shopify Plus plan (this is due to limitations with the *Shopify Payment Customization API*) In the example below, the payment types "Paypal" and "Cash on Delivery (COD)" have both been hidden for B2B customers.  *** ## Payments Visibility Give your customers full transparency over their payment statuses directly within the My Account area.  By enabling Payments Visibility, customers can track order payment statuses, view detailed transaction histories, and track outstanding balances without needing to contact your support team. To get started, go to your SparkLayer Dashboard, open **Settings** from the left-hand menu, and select [Configurations](https://app.sparklayer.io/configuration/settings/general). Find the **Enable Payments Visibility** option, switch the toggle to **On**, and save your changes. ::::Tabs :::Tab{title="🛍️ Using Shopify"} When updating the payment status within Shopify, this will simply reflect within the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) giving the customer an easy way to see the full status of their order.  For any order, the customer can see the Payment status in a new column "Payment".  In addition to the payment status updating, the [Timeline & Communications](docId\:Kf-Gd3nHSXlrn2zZvla1Y) view will also give a log of when the payment was made and the payment total.  ::: :::Tab{title="🌐 Other platforms"} This feature is not currently available for other platforms. ::: :::: *** ## Payments - Account Balance SparkLayer calculates a real-time "Account Balance" for your customers. To get started, go to your SparkLayer Dashboard, open **Settings** from the left-hand menu, and select [Configurations](https://app.sparklayer.io/configuration/settings/general). Find the **Enable Payments Visibility** option, switch the toggle to **On**, and save your changes.  It does this by taking a starting point (the **Opening Balance**) and then automatically tracking all subsequent orders and payments. - **Self-service tracking:** Customers can see exactly which orders are paid or outstanding. - **Reduced admin:** Decreases "balance inquiry" emails and phone calls to your team. - **Multi-platform support:** Compatible with Shopify, Xero, and QuickBooks Online. **Setting an Opening Balance** To show an accurate balance, SparkLayer needs a starting point. This is a "point-in-time" snapshot of what the customer owes your business. You can set this up using **Customer Metafields**. If you haven't enabled these yet, please see our [Credit, Net Terms, & Invoicing guide](https://docs.sparklayer.io/credit-net-terms-and-invoicing). To set the opening balance, update the **Credit Limit and Account Balance** metafield for a specific customer using the format below: | Property | Description | Example | | -------------- | --------------------------------------------------- | --------------------------- | | `balance` | The amount owed at a specific date. | `150.00` | | `balance_date` | The date the balance was recorded (RFC3339 format). | `2025-01-01T18:00:00+08:00` | :::CodeblockTabs Example snippet ```json { "credit_limit": 10000, "balance": 150, "balance_date": "2025-01-01T18:00:00+08:00" } ``` ::: :::hint{type="info"} **Need help formatting the balance\_date? ** You can use a free online [RFC3339 converter](https://time.now/tool/rfc-3339-converter/) to generate the correct string. ::: Whenever you manually update the metafield values, SparkLayer will automatically recalculate the customer's balance based on the new information. **FAQs** :::ExpandableHeading **How often does the customer's balance update?** SparkLayer recalculates the balance automatically whenever a new order is placed or a payment is synced from your store or accounting tool (Xero/QuickBooks). ::: :::ExpandableHeading **Can I update balances in bulk?** Yes, you can use Shopify’s bulk editor or a CSV import tool to update the "Credit Limit and Account Balance" metafield for multiple customers at once. ::: :::ExpandableHeading **Why is the "Payment on Account" metafield not updating?** When using the real-time account balance then the metafield will not update from the time you first set it up. The balance will be calculated and held within SparkLayer ::: [title] Languages & International [path] Features/Configurations/ ## Supported languages SparkLayer supports a range of languages and when a customer signs in, they'll see the appropriate language native to your store. SparkLayer currently supports the following languages: | Variable | Language | | -------- | ---------------------------------------------- | | `en` | English (default) | | `ar` | Arabic (with full RTL support) | | `zh` | Chinese | | `hr` | Croatian | | `cs` | Czech | | `da` | Danish | | `nl` | Dutch | | `fi` | Finnish | | `fr` | French | | `de` | German | | `el` | Greek | | `he` | Hebrew (with full RTL support) | | `hu` | Hungarian | | `is` | Icelandic | | `it` | Italian | | `ja` | Japanese | | `lt` | Lithuanian | | `lv` | Latvian | | `no` | Norwegian | | `pl` | Polish | | `pt` | Portugese | | `ro` | Romanian | | `ru` | Russian | | `sk` | Slovak | | `sl` | Slovenian | | `es` | Spanish | | `sv` | Swedish | | `th` | Thai | By default, SparkLayer **automatically** detects the default language of your store but it is possible to manually overwrite this with the modification of the language variable in the SparkLayer Core Script. ```javascript /* Modify the below code with the language variable above, e.g. fr*/ language: {{ request.locale.iso_code | json }}, /* End of code */ ``` :::hint{type="info"} **Need a language not listed above?** If you require a language that isn't on our list, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we can send details on how to supply translations. ::: ### Product data translations SparkLayer also supports showing product data in the customer's language. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Please note** This is not enabled by default and you'll need to follow the steps below ::: There are a few things to consider if you'd like this enabled on your store: - You'll need to define your translations in Shopify - You'll need to assign languages to Shopify markets - Languages must be published in Shopify - Your SparkLayer Core Script must be at [least version 3.13](https://app.sparklayer.io/configuration/frontend/core) - Within your Shopify theme, inside `theme.liquid` , set the language SparkLayer Core Script option (see below) - You'll need to [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to enable syncing translations into SparkLayer **Setting language in SparkLayer Core Script** ```javascript language: "{{ localization.language.iso_code }}-{{ localization.country.iso_code }}", ``` Once set up, product data displayed by SparkLayer should align with the rest of your site, according to the languages you have set up in Shopify and assigned to markets. :::: :::Tab{title="🌐 Other platforms"} Not currently supported ::: ::::: *** ## Locale configuration SparkLayer provides an intuitive formatting system for dates and currency symbols by utilising the **locale** of the user's browser. This ensures dates and currency symbols are displayed according to the user's regional setting, enhancing the user experience. However, if you prefer to implement a standard formatting across your user base, SparkLayer offers the option to set a specific locale. By adjusting the locale option, you can establish a fixed format for all of your users, irrespective of their individual browser settings. ```javascript /* Modify the below code with the locale required e.g. en-AU*/ locale: 'en-AU', /* End of code */ ``` The locale option requires a string input, comprised of a combination of a language code and a two-letter country code, delineated by a hyphen (-). - For instance, to set the locale for British English, you would use `'en-GB'` - For American English, `'en-US'` - For Australian English, `'en-AU'` - For German `'de-DE'` - etc This format ensures that the chosen locale accurately reflects both the language and the regional conventions for date formatting and currency symbols. For your B2B pricing, any currency prefixes will be removed and instead default to the locale you've set. For example, if you set the locale to `locale: 'en-US',` this would remove the `US` prefix before your pricing.  :::hint{type="info"} The locale option only affects the *formatting* of prices, not the values. ::: *** ## Text and language overwrites SparkLayer uses "language strings" to render the text used in the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) and any string can be modified with custom text (i.e. overwritten). If you're wanting to update specific text elements, it's possible to turn on a special setting within the SparkLayer Core Script that exposes specific code snippets that you can then reference with your overwrites. ```javascript /* Add the below to your SparkLayer Core Script */ showTranslations: true, /* End of code */ ``` When this setting is enabled, the SparkLayer interface will then render the special language code snippets. In our example below, you can see the language code for the Product Page Interface  :::hint{type="info"} **Please note** We recommend enabling this setting temporarily or onto a non-published theme to ensure it isn't seen by your logged in B2B customers. ::: ### Modifying languages ::::Tabs :::Tab{title="🛍️ Using Shopify"} Add the following to your theme's `theme.liquid` file, just before the closing `` tag: For example, to set the language and account redirect URL: ```html ``` ::: :::Tab{title="🌐 Other platforms"} To overwrite the text, you need to add specific code snippets to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). To install the SparkLayer Core Script, it simply needs to be included within the main "header" of your website's source code within the `...` tags. For BigCommerce, this is typically within the file `/templates/layout/base.html`  To get started, head over to the SparkLayer Dashboard and you'll see your customised SparkLayer Core Script within the [Frontend Configurations](https://app.sparklayer.io/configuration/frontend/core). ```html ``` When you first install SparkLayer, you'll automatically use the latest version and you can also manually update this via the "SparkLayer Core Script version" section. To see what's new, please see make sure to bookmark [What's New!](docId\:WDCEwpeMoHPbrR96TaYCL). ### Technical details From a technical point of view, the Core Script provides SparkLayer with key information that controls how it works on your website. ```html ``` This information includes: | Item | Details | | ----------------- | ----------------------------------------------------------------------------------- | | `siteId` | The website's unique identifier ([learn more](docId\:r9NG74uJdtyWlvGbpnB5u)) | | `platform` | The eCommerce platform of the website | | `language` | The language to be used | | `accountRedirect` | The URL to redirect logged in customers to | | `display` | Which display configurations to enable ([learn more](docId\:SBEaOaCq_A7FfbTatX8bD)) | | `auth` | The authentication details of the logged in customer | ::: :::: Some important items to note: - The variable `en` must be replaced with the specific language of your store (see our [supported languages](docId\:kLrS7wtxn3WnCDy8z5Zvu) with their special codes) - The text overwrites must always end the line with a comma ### Updating text that contains dynamic variables For some text content, SparkLayer includes dynamic variables, such as pack sizing or special settings.  Dynamic variables are always wrapped in 'camel case' , for example `{packSize}` and you can find a list of all dynamic text below: ```javascript ``` [title] Magento Limitations [path] Integrations/Magento/ ## Introduction Currently, there are a small number of limitations to be aware of with the SparkLayer and Magento Integration. | Limitation | Notes | | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product SKUs` | Within Magento, the product must have a SKU and this must be unique per product. | | `Price lists` | Currently price lists can only be managed though SparkLayer. | | `Sales Agents` | [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) lets your sales team place orders on behalf of customers. During the checkout process, sales agents won't be able to select "Pay Online by Card" for a customer, payments must be "offline" methods (e.g. net terms, pay by invoice) | | `Company Users` | If you're using [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) and a customer is inviting a team member, the team member will not receive a 'confirmation email' asking them to approve access. They will need to be manually informed of their login email address and to use the "Forgot password" feature on the Magento store to create a password for their account. | | `Multi-stock Inventory module is required` | The magento setup must have the MSI (Multi-Stock Invenetory) module enabled. | [title] Sufio Invoicing [path] Integrations/Customer Experience/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to Sufio - Platform: Merchants must be using Shopify ::: ## Introduction :::hint{type="success"} **Sending invoices via SparkLayer** SparkLayer has it's own built-in invoice solution and you can [learn more here](docId\:NKh8H14Ffna5DD71SwwNd). ::: [Sufio](https://sufio.com/shopify/invoice/?ref=sparklayer-2) is a leading invoicing solution for major eCommerce platforms such as Shopify and BigCommerce, allowing merchants to create and send beautifully designed invoices. With powerful features such as customizable design and support for multiple currencies, Sufio makes it easy for merchants to automate their invoicing and grow their business. Learn more about Sufio in the [Shopify App Store](https://apps.shopify.com/sufio) *** ## How it works The Sufio integration for SparkLayer is available for all Shopify merchants that already use Sufio and allows you to enable **downloadable invoices** for your B2B customers.  Each time a B2B customer places an order on your store, they can view and download their invoice right from within the [SparkLayer My Account](https://docs.sparklayer.io/sparklayer-frontend/overview-of-features/my-account-interface#order-history) area. You can see this in action in our video below\.Within the order detail view, the customer simply clicks the button and they are then taken off to their specially designed, Sufio-powered invoice where they can view details and download as a PDF. :::hint{type="success"} See this in action in our [B2B demo store](https://b2b-demo-store-usd.myshopify.com/pages/b2b-login-register). Simply sign in and view an order from the My Account area. ::: **Emailing customers an invoice** Sufio also allows you to email customers a copy of their invoice as well as set reminders, giving you a simple way to manage your invoicing process. [Learn more here](https://sufio.com/articles/shopify/send-invoices-customers/when-send-invoices/custom/) *** ## Configuring on SparkLayer :::hint{type="warning"} Please note, your Shopify store must already have the [Sufio Shopify App](https://apps.shopify.com/sufio) installed before enabling this feature. ::: Once the Sufio app has has been installed on your Shopify store, you're ready to activate it on SparkLayer! Within the [SparkLayer Dashboard](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard), go to the **Integrations** section and click **Partner Integrations. **Under **Invoicing**, click the toggle on the right to activate the Sufio integration.  This completes the set up process and you can follow the below steps to test the integration. - Log in to your Shopify store as a B2B customer - Place an order using the available payment methods - If the order is via a manual payment method (e.g. Payment by Invoice), within Shopify, mark this as complete to ensure it shows up in the **Orders** area of Shopify - Within your Shopify store, as a B2B customer, click the My Account tab, click the order and you will see the option to **View or Download Invoice**. *** ## Known limitations Please note the following: - If you're installing Sufio for the first time, invoices will only show for **new orders** placed :::hint{type="info"} If you're looking for a more manual way to attach invoices to an order, see [Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G) ::: [title] WooCommerce Limitations [path] Integrations/WooCommerce/ ## Introduction Currently, there are a small number of limitations to be aware of with the SparkLayer and WooCommerce Integration. | Limitation | Notes | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product SKUs` | Within WooCommerce, the product must have a SKU and this must be unique per product. | | `Price lists` | Currently price lists can only be managed though SparkLayer. | | `Sales Agents` | [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) lets your sales team place orders on behalf of customers. During the checkout process, sales agents won't be able to select "Pay Online by Card" for a customer, payments must be "offline" methods (e.g. net terms, pay by invoice) | | `Company Users` | If you're using [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) and a customer is inviting a team member, the team member will not receive a 'confirmation email' asking them to approve access. They will need to be manually informed of their login email address and to use the "Forgot password" feature on the WooCommerce store to create a password for their account. | | `HTTPS Compatibility` | The SparkLayer B2B plugin will only work with WooCommerce stores which have HTTPS **enabled** | | `Permalink Structure` | In order for the SparkLayer B2B plugin to interact with the WordPress & WooCommerce API, the WordPress permalink structure must be configured to a setting other than *"Plain"* | [title] Uninstalling & Transferring accounts [path] Integrations/BigCommerce/ ## Uninstalling SparkLayer SparkLayer works just like any other app in BigCommerce and you can uninstall it very easily.  Please follow the below steps: ::::WorkflowBlock :::WorkflowBlockItem From your BigCommerce admin, click **Apps**, and then click **My Apps.** ::: :::WorkflowBlockItem Click **Uninstall** ::: :::: Once you've removed the sales channel, this will then **cancel** the SparkLayer recurring billing charges with immediate effect. :::hint{type="info"} **More information** You can learn more about removing apps in this [BigCommerce guide](https://support.bigcommerce.com/s/article/How-do-I-access-and-install-the-new-single-click-apps-within-my-Bigcommerce-store-control-panel?language=en_US#uninstalling). ::: :::hint{type="warning"} **Please note** - If you've also added the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) to your BigCommerce store, these will need to be removed manually. - When you follow the uninstall process, this will disable customers, product and order updates to SparkLayer but will **not** delete the data until you [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to remove your account. - Please note, depending on when your billing cycle to SparkLayer began, you may see charges you're not expecting. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) if you would like us to investigate. ::: *** ## Pausing your account If you'd prefer to pause your SparkLayer account and resume your subscription in the near future, we recommend the following steps: - Follow the uninstall process above to remove the **B2B Ordering** sales channel. - Retain any codes changes in your BigCommerce storefront theme (you can always 'Duplicate' the theme to create a backup). - Notify our team and once you're ready to resume your subscription, we can assist where necessary. :::hint{type="info"} **Please note** Any configurations you've set up in the SparkLayer [Dashboard](docId\:nzsx6U_DAWtzVzSehf4oR) will be retained such as price lists and customer group set up. ::: *** ## Transferring to another BigCommerce store When you first sign up to SparkLayer, you'll be asked to associate your account with your BigCommerce store. Once that's done, SparkLayer will be locked to that URL and will begin synchronising products, customers, and enable you to install the Frontend code snippets to test it out. You may be wanting to trial SparkLayer on a **test or development BigCommerce store** just to see how it works before you fully commit to using it. The good news is, it's possible to transfer accounts by following the below steps! - First, sign into your BigCommerce store and uninstall SparkLayer via the steps above. This will disconnect SparkLayer from the BigCommerce store - Next, [sign into SparkLayer](https://app.sparklayer.io/Login) with the original account you created and go to Configuration and click [Integrations](https://app.sparklayer.io/configuration/integrations/platform) - Select **BigCommerce** and re-enter the new BigCommerce URL you wish to connect - You'll then be taken to the BigCommerce admin and asked to reinstall SparkLayer and select a plan. - Once that's completed, you'll then be returned to the SparkLayer Dashboard. SparkLayer will then begin synchronising your products and customers and you can then re-install the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) on the new store :::hint{type="info" attributes="[object Object]"} **Need assistance?** If you require any assistance in transferring your BigCommerce store, please feel free to [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. ::: [title] BigCommerce Metafields & Data Mapping [path] Integrations/BigCommerce/ ## Introduction Metafields help you to customise the functionality and appearance of your BigCommerce store by letting you save specialised information that isn't usually captured in the BigCommerce admin. You can use metafields for internal tracking, or to display specialised information on your online store in a variety of ways. In the context of SparkLayer, metafields are used to capture additional B2B data that you can then use in a variety of ways: | Type | Details | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product metafields` | Updating the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) by adding configurations such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [RRP prices](docId\:S_VTlJBorGmnwjjfSMom9), and more | | `Customer attributes` | Updating a customer's information by adding information such as [credit limits](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Order metafields` | Updating an order with [invoicing information](docId\:yWm70oQUosyKOoIqb4Z4G) | *** ## How to add metafields to BigCommerce BigCommerce has a variety of ways to access and edit metafields and you may already have your preferred way of doing this. You can also refer to our guide below. ### Useful resources | Item | Details | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Approved apps | [Metafields Manager ](https://www.bigcommerce.co.uk/apps/metafields-manager-by-space-48/)This provides a simple way to manage metafield data within BigCommerce with the exception of "Customers" | | Developer docs | We also recommend referring to the [official BigCommerce guide](https://developer.bigcommerce.com/docs/rest-catalog/products/metafields) on accessing metafield data | ### Configuring different types of metafields :::ExpandableHeading **Product metafields** We recommend using an app listed above in "Approved apps". This allows you to access metafield data at both a product parent and product variant-level. ::: :::ExpandableHeading **Order metafields** We recommend using an app listed above in "Approved apps" ::: :::ExpandableHeading **Customer attributes** There are currently no BigCommerce apps that allow customer attribtues to be added to Customer data. We therefore recommend a more technical approach to accessing and updating this data. Currently customer settings can be added though the use of BigCommerce customer attributes. Before these attribute fields are shown on the customer "Create" and 'Edit" screens in BigCommerce, the attribute types** must be manually created f**or each store. This can be done using the shell command below. You will need to replace `YOUR_STORE_HASH` and `YOUR_STORE_API_TOKEN` values. You can find the store hash in the URL of the store admin page:  You will need to create an API token by going to **Settings -> Store-level API accounts,** clicking the **Create API Account **button, entering a descriptive name (e.g. SparkLayer Support), and selecting the **Modify** value of the **Customers** scope:  Click **Save**. You will now see a popup with the credentials, which are also downloaded to your computer. You will need the access token value. Replace the two values in the command below and run it in your terminal (please note that you can remove the attributes that are not needed to only create the required attributes): ```curl curl --request POST \ --url https://api.bigcommerce.com/stores/YOUR_STORE_HASH/v3/customers/attributes \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: YOUR_STORE_API_TOKEN' \ --data '[ { "name": "SparkLayer - Price Lists", "type": "string" }, { "name": "SparkLayer - Payment On Account", "type": "string" }, { "name": "SparkLayer - Accounting ID", "type": "string" }, { "name": "SparkLayer - Discount Percentage", "type": "number" }, { "name": "SparkLayer - Sales Agent Groups", "type": "string" }, { "name": "SparkLayer - Parent Customer ID", "type": "string" } ]' ``` You will now see the attributes and be able to edit them in the customer create and edit pages.  ::: *** ### Order history: importing historical orders into SparkLayer It's possible to import historical B2B order data into SparkLayer, allowing customers to see their previous order history once they access their account on your store. To do this add a metafield to the order as shown below: | Item | Details | | ----------- | -------------------------------------- | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `order_import` | | `Value` | This must be set as a string of `true` | Any orders that are imported this way must also belong to a customer that has a B2B customer group assigned. Even though the order metafield above can be setup manually using one of the many metafield management apps available, for large numer of orders you might want to automate this using the BigCommerce Order Metafields API. :::hint{type="info"} **Please note** The note attribute must be added to the order **after** SparkLayer is installed for the order to be synchronised correctly. Orders synced in this way can then be reported upon and will appear in the Orders section of the SparkLayer Dashboard. ::: :::hint{type="warning"} **Troubleshooting** If your store was installed before the ***14th of November, 2024***, you might need to contact the SparkLayer customer support to re-save your BigCommerce integration in order to register the required order metafield webhooks. These webhooks notify our system of new metafields added to orders. ::: *** ## Order Data ### Order ID ("Visible ID") and setting a custom order number It's possible to use a custom order ID instead of the standard order ID generated from BigCommerce. A typical use-case is customising the Order ID to match order numbers generated from a back-office system (e.g. an ERP), ensuring consistency across systems. When the "Visible ID" is set, this will then take effect when the customer views their orders from the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP).  | Item | Details | | ------------------ | ----------------------------------------- | | `Custom data type` | Order | | `Metafield type` | This must be set as an `single line text` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `visible_id` | :::hint{type="warning" attributes="[object Object]"} **Please note** If you're using the "Visible ID" configuration, any orders that do not have this populated will fallback to the standard BigCommerce order number. ::: *** ## Important considerations In order for SparkLayer to work with BigCommerce metafields, please note the following: :::hint{type="warning"} **Product metafields** Metafields are always added at the product variant level, even if the product only comes in a single variant. **JSON data** Some SparkLayer settings require metafields to be set up as JSON strings. These will need to be carefully added, making sure the formatting is set correctly. ::: *** ## Advanced settings To learn about more advanced settings, including customer-level product metafield settings, please see [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) [title] Cin7 Core [path] Integrations/ERPs & Operations/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to the Professional or Enterprise plan - Platform: Merchants must be using Shopify ::: ## Introduction **Cin7 Core** is a powerful inventory management system designed for retailers, wholesalers, and manufacturers. From inventory and stock control, to order management and fulfilment, Cin7 Core helps automate and streamline your eCommerce operations. You can learn more about Cin7 Core [here](https://www.cin7.com/solutions/core/?utm_term=cin7%20core\&utm_campaign=mm_search_brand_emea\&utm_source=google\&utm_medium=cpc\&hsa_acc=9060130901\&hsa_cam=18133732967\&hsa_grp=149955377884\&hsa_ad=655886024565\&hsa_src=g\&hsa_tgt=kwd-1942910059907\&hsa_kw=cin7%20core\&hsa_mt=e\&hsa_net=adwords\&hsa_ver=3\&gad_source=1\&gbraid=0AAAAABIS0PhOnUtzfradDOQy0k8dbkFvX\&gclid=Cj0KCQjwzrzABhD8ARIsANlSWNMwImmV0ASbE-CkR02KSmpeD1_CXtjX8K6GG-JAFKFXpD2ZucWP8DkaArZFEALw_wcB). *** ## How it works The Cin7 Core integration for SparkLayer is available for all [Shopify merchants](https://docs.sparklayer.io/integrations/shopify-introduction#introduction) that already use Cin7 Core and allows you to bring **B2B pricing and B2B ordering ** into SparkLayer and your Shopify store. The integration works in the following ways: | **Item** | **Details** | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customers` | Cin7 becomes the 'master' of your B2B customer data, and any changes to customer records that have the assigned Customer Type will automatically be synchronised to Shopify and SparkLayer. SparkLayer will maintain a customer on your E-Commerce platform for every contact of each customer it syncs from Cin7. The Customer's Default contact is treated as the Main account with its other contacts treated as [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) under it. | | `Orders` | Orders placed via SparkLayer are synchronised from your E-Commerce platform into Cin7 using your [existing Cin7 integration](https://help.core.cin7.com/hc/en-us/articles/9034589848335-Shopify-Integration). Prices that show on orders will be the special B2B pricing as set up in Cin7. | | `Pricing` | Price lists and product prices are imported into SparkLayer via pricing rules you set up in Cin7 | | `Sync` | The automatic sync is carried out **every hour**. | :::hint{type="info"} **Please note** We recommend also familiarising yourself with the "Known limitations" below ::: *** ## Configuring the integration :::hint{type="info"} **Before you begin** You'll need to have an approved account with Cin7 Core - Please visit the [Cin7 website](https://www.cin7.com/solutions/core/?tm=tt\&ap=gads\&aaid=adaCskrnITi18\&utm_term=cin7%20core\&utm_campaign=mm_search_brand_emea\&utm_source=google\&utm_medium=cpc\&hsa_acc=9060130901\&hsa_cam=18133732967\&hsa_grp=149955377884\&hsa_ad=655886024565\&hsa_src=g\&hsa_tgt=kwd-1942910059907\&hsa_kw=cin7%20core\&hsa_mt=e\&hsa_net=adwords\&hsa_ver=3\&gad_source=1\&gclid=CjwKCAiA9bq6BhAKEiwAH6bqoN9Zbb8pUMLtFpMfCor1fMKdHdEJRPTDznpBDkKQO2T_1xAiwqwu-RoCkIwQAvD_BwEC) to learn more. ::: To get started, the integration needs to be enable within the [SparkLayer Dashboard. ](https://app.sparklayer.io/configuration/integrations/partners)Go to the **Integrations** section and click **Partner Integrations.** Under **Multi-channel management**, click the toggle on the right to activate the Cin7 Core integration.  You'll then be prompted to enter the following details:  | **Item** | **Details** | | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `API ID` | You can find this within your Cin7 Core admin under **Integration, API** | | `API Key` | You can find this within your Cin7 Core admin under **Integration, API** | | `Customer Sync Tags` | Customers that have any of these tags within Cin7 Core will be **synchronised to Shopify** by SparkLayer. The customer tag should match a customer group that exists in SparkLayer.
**Please note:** The tag must match the SparkLayer **customer group name** exactly and be seperated by a **comma** (e.g. `GROUP1, GROUP2)`. For the purposes of testing, we recommend creating a new group and testing with a dummy customer first before using an existing group. | | `Additional Customer Tags` | When a customer is syncronised to Shopify, **if it has any of these tags within Cin7 Core: it will have those tags within Shopify** as well (prefixed with `spark-`). These must be **valid Shopify tags**, and must not **conflict with your SparkLayer customer groups**.
This feature is **currently exclusive to Shopify** If your store uses a different E-Commerce platform this setting will be ignored. | | `Tax-Exempt Codes`
| This is the code that you want to sync across the customer across as tax-exempt. | | `Ignore Non-Default Contacts` | When checked, **only the Default contact** of each customer will by synced through to SparkLayer. | *** ## Configuring Customers Broadly speaking, Cin7 Core is your **central location **for managing B2B customer data. When customers are configured in Cin7 as B2B customers, SparkLayer can **automatically** retrieve this data and then enable the B2B ordering experience on your Shopify site. ::::ExpandableHeading **Step 1 - setting up a customer ** When you have set up the [integration with SparkLayer](https://app.sparklayer.io/configuration/integrations/partners) within your Cin7 Dashboard, go to **Sale** and then **Customer**. In this page you are able to set up the customer account with your required customer details. You **must **have a first and last name set in General and Contacts  Next, navigate to your **SparkLayer Dashboard** and [Customer Groups](https://app.sparklayer.io/customers/groups). Here you'll need to create the customer groups and, once you have done this, you are then able to add the customer group name as tags within your customer in Cin7 under "Tags".  In our example, we have `Base` and `Gold`. Within Cin7, and add the tag `base` and `gold`.  You will also need to select the **Tax Rule. **Once you have done this, take the tax exemption rule and add this into the final stage of the SparkLayer integration. This means any customers that have been set as tax exempt in Cin7 will automatically be tax exempt in Shopify. Next, go to the [Partner Integrations](https://app.sparklayer.io/configuration/integrations/partners) section of SparkLayer and click **Modify** within the Cin7 integration. Finally, add the **Customer Tags** you have created for your customer groups that you want to sync across the customer from Cin7 to SparkLayer/Shopify. In our example, we've added them for `base` and `gold`. :::hint{type="warning"} **Please note** Customer Tags **must** be seperated by a comma with **no** spacing to sync correctly e.g. `base, gold` :::  :::: ::::ExpandableHeading **Step 2 - syncing your customers ** To sync your customers, you'll need to create your customers in your Cin7 Dashboard if you haven't already. When doing this you are able to allocate them add a **Tag. **This will assign them into the specific [customer group](https://app.sparklayer.io/customers/groups) within SparkLayer when they are synced across. The **Tag **that you assign must match a customer group name that you have created in your SparkLayer dashboard already. For example, if you are using the tags in the above screenshots, your customer groups would look like the below:  :::hint{type="info"} **Please note** The customer would not need be tagged with this customer group within Shopify. Instead, the customer group information is synced to Shopify as a metafield. ::: When setting up your customers in Cin7, please ensure you set up: **General:** - Name (first and last) - Currency - Sale Price Tier - Tax Rule - Tags **Addresses** - A full address **Contacts** - Name (first and last) - Assign a valid email address. This must be set up in order to sync to SparkLayer and Shopify. - Tick main contact as "Default" :::hint{type="info"} **Please note** If you have multiple contacts to sync, the primary contact must be marked as **Default** in Cin7 Core. All additional contacts will be synced as child accounts under the Default (parent) contact. ::: **Syncing across to SparkLayer and Shopify** Ensure the correct **Customer Tag** is added in Cin7 Core to match what you've configured in SparkLayer. SparkLayer syncs with Cin7 Core every 4JJ hours. During each sync, any new or updated records are automatically pushed to Shopify. Customers are mapped between the systems based on the ** contact email** set within Cin7 Core. Once this is mapped, SparkLayer will then synchronise the following data into Shopify. | **Cin7 Core** | **Shopify / Spark Layer** | | ---------------------------------------------------- | ---------------------------------------------------------------------------- | | Address | Shows against customer record in Shopify | | Primary Telephone | Shows against customer record in Shopify | | First / Last Name | Shows against customer record in Shopify | | Customer Group | Shown via metafields in Shopify (see above) | | Credit Limit / On hold | Shown via metafields in Shopify | | Tax Codes (using the mapping in config) | Shows against customer record in Shopify | | Cin7 Core Price List Tier / Customer specific prices | Shown via metafields in Shopify to show the correct pricing for the customer | | Tags | Only **Additional Tags** show against customer record in Shopify. | :::hint{type="warning"} **Please note** All customer data is managed via Cin7 and any amends made directly in Shopify will **not** synchronise back to Cin7. ::: :::: :::ExpandableHeading **Step 3 - giving access & notifying new customers** Since Cin7 is the central source for customer data, any new customers created in Cin7 will **automatically** be added to Shopify (following the above steps). When new customer records are added to Shopify, they will by default be added as **Pending** customer accounts and receive an **automatic email** to enable their account by setting a password.  This uses the **Customer account invite** notification email which can be edited in the [Notifications section within Shopify](https://admin.shopify.com/settings/notifications/customer). If you prefer **not** to send the customer account invite automatically, you can easily check if this option has been activated. Simply go to your SparkLayer Dashboard, navigate to [Partner Integrations](https://app.sparklayer.io/sparklayerunleashedtest/live/configuration/integrations/partners). When modifying your Cin7 integration, you can enable or disable this via the setting at the bottom.  ::: *** ## Configuring Pricing In Cin7, you can utilise **up to 10 price lists**, allowing you to create multiple pricing tiers tailored to your various customer levels. On top of this limit, you have the flexibility to set customer-specific and product-specific discounts, providing even more granular control over your pricing strategy. ::::ExpandableHeading **Step 1 - price list setup** In Cin7, navigate to **Settings **> **General Settings** > **Sell Price Tier Names**. Here, you can customise the names of your price tiers, which are initially labelled as "Sell Price Tier 1" through to "Sell Price Tier 10". :::hint{type="warning"} **Please note** SparkLayer **does not** support the custom names meaning they will show in SparkLayer as "Sell Price Tier X" ::: :::: :::ExpandableHeading **Step 2 - viewing price lists** When you view a product within your Cin7 Dashboard, under the **Prices** tab you’ll see the available price tiers listed. For products offered to your wholesale customers, you can specify the exact price for each tier, depending on which pricing list is assigned to the customer.  ::: ::::ExpandableHeading **Step 3 - assigning a price list** Within your Cin7 Dashboard, navigate back to the customer account that you are working on. You are then able to assign them a price list directly to the customer account within **Sell Price Tier**. This means when they login they will see the product pricing you've assigned to them.  :::hint{type="warning"} **Please note** These price lists will be asigned directly to the customer account through the SparkLayer price list metafield which is set up differently to standard price lists. You can learn more in [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) ::: :::: :::ExpandableHeading **Setting up product specific discounts** Within the Cin7 Dashboard, navigate to a customer record and click Product Prices. Here you are able to set product specific pricing for this customer account. You are able to search for a product, specify a fixed price on the product. When doing this, it will create a new price list within the [SparkLayer Price Lists](https://app.sparklayer.io/pricing/lists) section.  ::: :::ExpandableHeading **Assiging prices to the Shopify Customer account** Once you have finished configuring your customers pricing and a sync has taken place, you can then check the customer account in Shopify to ensure they have been assigned the correct pricing. The price list will be assigned directly to the customer account in a **Price List metafield** (this gets added automatically when you first set up the SparkLayer integration). It will also create the price list within your SparkLayer Dashboard > Price lists as an "Integration" Price List. With this metafield it will **always** work in a hierarchy order, which means when a customer searches a SKU it will check the first price list and will cascade through the price lists untill it finds a price. In the example below you are able to see a number of price lists. 1. Any** customer product specific discounts** you have created within the customer in Cin7. 2. The **normal price list **that you have assigned to the customer  ::: *** ## Data mapping We've detailed how data is mapped between SparkLayer and Cin7. :::ExpandableHeading **Customer data mapping** | Item | Details | | --------------------------- | ----------------------------------------------------------------------------------------------------- | | `First and Last name` | Assigned to the customer account in Shopify | | `Email and Phone number` | Assigned to the customer account in Shopify | | `Addresses` | Assigned to the customer account in Shopify | | `Tax Exemptions` | Assigned to the customer account in Shopify | | `SparkLayer Customer Group` | This will be assigned to the customer account through a Shopify Metafield called "Group" | | `Company Name` | This will be assigned to the customer account through a Shopify Metafield called "Company" | | `Discount Percentage` | This will be assigned to the customer account through a Shopify Metafield called "Disount Percentage" | | `Credit limit` | This will be assigned to the customer account through a Shopify Metafield called Payment On Account | ::: :::ExpandableHeading **Pricing data mapping** | Item | Details | | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Creating Price Lists` | SparkLayer generates several types of price lists based on the product prices available in Cin7. | | `Sell Price Tiers` | If Cin7 has specific Sell Price Tiers set up (e.g., "Sell Price Tier 1", "Sell Price Tier 2", etc.), SparkLayer creates separate price lists for these tiers. Cin7 supports up to 10 Sell Price Tiers that you can assign to different groups of customers. | | `Customer-Specific Prices` | If any customer has unique prices specified under the Customer/Product Price tab in Cin7, SparkLayer creates a Customer-Specific Price List for that customer. This ensures that individual customer agreements or special pricing arrangements are captured. | | `Handling Different Currencies` | If a customer uses a currency other than the base currency, SparkLayer will create Alternative Currency Price Lists based on the existing price lists. For example, if your store is GBP you will have "Dear Tier Price 1" set as GBP, if you assign a customer USD then SparkLayer will create a new price list "Dear Tier Price 1 USD"set as USD. This will take the GBP and convert it at the live going rate to USD | | `Assigning Price Lists to Customers` | Price lists will be assigned directly to the customer account through the use of a Customer Metafield. When assigning prices to customers, SparkLayer follows this order of priority:
* First, the Customer-Specific Price List (if available). * Then, a Sell Price Tier (if assigned in Cin7).
If a customer has multiple currencies or discounts, they will get additional price lists accordingly. | | `Why Prefixed Price Lists?` | SparkLayer may apply generic "prefixed" price lists to every customer. This is to ensure that a basic Sell Price Tier is always in place, even if the customer’s Cin7 configuration doesn’t explicitly assign one. | ::: *** ## Known limitations The following limitations apply: - Internally SparkLayer will use the internal SellPriceTier naming for simplicity between mapping, not the custom naming that can be setup via the Cin7 Core Settings - Changing the customer's email address, will create an additional customer in Shopify. The old account will need to be disabled manually. - When you change a customer's default contact in Cin7 Core: you will need to manually disable the account in Shopify that corresponds to the the old default contact. - A customer that is removed by removing the tag will not be disabled within Shopify. - Default addresses in Cin7 Core will be mapped to Shipping and Billing address in Shopify (Shopify doesn't support independent addresses). - Addresses are a 1-way sync from Cin7 Core into Shopify. It's recommended to not allow address editing in SparkLayer otherwise new addresses added won't appear in Cin7 Core and will be replaced on next integration run. *** ## Troubleshooting :::ExpandableHeading **My customers are not appearing in Shopify** - Ensure that customers in Cin7 Core have been assigned the correct tags matching the **SparkLayer Customer Group Names.** - Confirm the tag formatting: tags must be separated by commas without spaces (e.g., base,gold). - Check that the customer has a valid Default Contact with a valid email address. ::: :::ExpandableHeading **Customer account invites are not being sent** - By default, Shopify will send a Customer Account Invite email when a new customer is created. - Check if automatic invitations are disabled in the SparkLayer Partner Integration settings. ::: :::ExpandableHeading **Customer-specific pricing is not displaying** - After updating pricing, allow up to 6 hours for the next sync to complete. - Verify that the correct Price List metafield exists against the Shopify customer record. ::: :::ExpandableHeading **Changes made in Shopify are not reflected in Cin7 Core** - The integration is one-way (Cin7 Core ➔ Shopify). Changes must always be made in Cin7 Core. - If you update customer information directly in Shopify, it will be overwritten by the next sync. ::: :::ExpandableHeading **Product pricing appears incorrect for customers** - Double-check that the customer is assigned to the correct Sell Price Tier or Product-Specific Pricing. - In Cin7 Core, ensure that price tiers have the expected values for your products. - Confirm that no old price lists or tags are incorrectly linked to the customer in SparkLayer. ::: :::ExpandableHeading **Customer duplicates appear in Shopify** - Double-check that the customer is assigned to the correct Sell Price Tier or Product-Specific Pricing. - In Cin7 Core, ensure that price tiers have the expected values for your products. - Confirm that no old price lists or tags are incorrectly linked to the customer in SparkLayer. ::: [title] Shopify B2B-only Content [path] Integrations/Shopify/Shopify Customisations/ :::hint{type="warning"} **Important to note** If you are looking to customise the behaviour of your Shopify store, we strongly recommend engaging a Shopify expert to assist. Whilst we can provide an overview of how to approach making customisations, our team cannot assist in applying any code changes. ::: ## B2B-only products (hiding products)  If you're running both B2B and DTC within the **same Shopify store**, there may be a range of products that you want to only show and be purchasable to logged in B2B customers. Perhaps they can only be purchased in high-volumes or they are exclusive to your B2B customers. [B2B Catalogs ](https://apps.shopify.com/sparklayer-b2b-catalogs)is a free SparkLayer app that lets you control which products are visible to different types of customers on your Shopify store. Hide products from B2C customers, restrict items to B2B-only, or show different product ranges to different customer groups - all using simple tags, no code required. [Install B2B Catalogs](https://apps.shopify.com/sparklayer-b2b-catalogs) from the Shopify App Store, then head to our [B2B Catalogs documentation](https://docs.sparklayer.io/b2b-catalogs/) for the full setup guide. :::hint{type="info"} **Hiding variants** Looking to hide variants for specific B2B customer groups? [Read our guide](docId\:m3DF4f0Eyc2rM-vUaRG9H) ::: *** ## Hiding prices If you have a dedicated B2B Shopify store and want to fully hide prices from your logged out customers, you can do this by adding special code to your storefront theme. Typically you could apply this to: - The product cards that show on your collection pages (e.g. on `/collections/all`). The code for product cards is typically found in the /snippets/ directory, e.g. `/snippets/card-product.liquid` - The product details page. This is typically found in the /sections/ directory, e.g. `/sections/main-product.liquid` To get started, you can adapt our example code below. This code simply shows some HTML code if the customer browsing the site is not a logged in B2B customer. ```html {%- if customer.metafields.sparklayer.authentication -%}
Controls whether SparkLayer should create contacts in Xero during the invoice synchronisation process.
When creating invoices, each invoice must be associated with a contact in Xero. We first attempt to match an existing contact (as outlined in the Contact Matching section). If no match is found, this setting determines what happens next:
* **Enabled - **SparkLayer will automatically create a new contact in Xero using the customer data held in SparkLayer. You can read more about contact creation [here](https://docs.sparklayer.io/xero#ZR11G). * **Disabled -** SparkLayer will not create new contacts in Xero. This assumes that contacts are either: - Being created by another system, or - Being managed manually within Xero. * In this case, if no matching contact is found, invoice creation may fail. | | `Default Line Item Account Code` | **Default: 200**
Specifies the Xero account code that invoice line items will be associated with. For example, `200`
You can find your account codes within the **Chart of Accounts** section in Xero. | | `Shipping Line Account Code` | **Default: Falls back to what is configured for "Default Line Item Account Code"**
Allows you to specify a Xero account code to use for shipping line items. For example, `260`
If left empty, the account code used will fallback to what is configured for the `Default Line Item Account Code` setting.
You can find your account codes within the **Chart of Accounts** section in Xero. | | `Invoice creation for Payment on account orders` | **Default: On order**
Controls when an invoice should be created for orders using the payment on account payment method.
* **On order **will create an invoice for the whole order one it reaches the `processing` status. * **On shipment **will create an invoice per shipment, once any fulfilments on the order have been created.
You can read more about payment on account orders below. | | `Invoice Line Item Mapping` | `Map Line Items to Item Codes`
**Default: Disabled**
Controls whether or not, during the creation of invoices, we map invoice line items to Xero Items (Products) based on the SKU held for the line item in SparkLayer.
* **Enabled **- When creating an invoice, we will map the line item to an existing item (product) held in Xero based on the SKU. If no item in Xero exists for a given SKU, the invoice will not be created. * **Disabled **- When creating an invoice, we will not attempt to map line items to items (products) held in Xero.
You can read more about **Invoice Line Item Mapping **below. | | `Tracking categories` | **Default: None**
Allows you to specify which tracking category or categories we should map line items to when creating SparkLayer invoices.
Mappings pairs should be formatted as a comma-separated list in the format:
`CategoryName:Option`
**For example;**
`Channel:B2B,Source:SparkLayer`
**In this example:**
* The **Channel** tracking category will be set to **B2B** * The **Source **tracking category will be set to **SparkLayer**
**Note:** Xero supports a maximum of two tracking categories per line item. Any additional mappings beyond this limit will be ignored. | *** ## Invoice Creation SparkLayer automatically creates invoices in Xero for eligible customer orders as soon as the order is received from your platform. :::hint{type="info"} **Please note** This process runs in the background to keep the checkout experience fast and uninterrupted, which means there may occasionally be a short delay before the invoice appears in Xero. ::: ### Orders eligible for invoicing Whether an invoice is created depends on several conditions, including your integration settings and the specific details of the order. | Item | Details | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Fulfilment status` | We only create invoices for orders that are in either the *processing* or *shipped* fulfilment status. | | `Payment method` | Invoices are generated only for orders using either the **Payment by Invoice** or **Payment on Account** payment methods.
* **Payment by Invoice** For Payment by Invoice orders, the invoice is created as soon as the order reaches the `processing` status. * **Payment on Account** For Payment on Account orders, invoices are created depending on the integrations configuration. You can read more about payment on account orders here.
You can learn more about configuring these methods [our guide here](docId\:ibIKczvHM085BkeJIfFYv) | ### Payment on account orders & split shipments The integration configuration allows you to decide when invoices are created for orders that use the payment on account payment method. Invoices can be created either **on order ** or **on shipment.** If you have configured your integration for **on order **then an invoice will be created when the SparkLayer order reaches the `processing` state. If the integration is configured for **on shipment **then an invoice will be created at the time an fulfillment has been fulfilled on the order. This handling caters for **split fulfillments **as will we will create an invoice per fulfillment, containing only the line items fulfilled. Customers will be able to download all invoices associated with an order from their my account section. :::hint{type="info"} **Shipping** In the case of split shipments, the shipping method associated with the order will always be attached to the invoice created for the **first **shipment on the order. ::: :::hint{type="warning"} **Rounding issues** Split shipments are in some cases susceptible to rounding issues. This is due to the differences between how your platform, SparkLayer and Xero calculate tax for line items across shipments. If we detect a rounding issue on an invoice, we will automatically apply a "Rounding adjustment" line item to the affected invoice, assigned to Xeros rounding account code 860. This ensures totals on the Xero invoices match the order in SparkLayer. ::: ### How invoices are created Invoices are generated using the Xero API. You can verify that an invoice was created via the SparkLayer integration by checking the **History & Notes** section in Xero, where an automatic note identifies SparkLayer as the source. Each invoice is created using a combination of: - Data from the SparkLayer order - Your integration configuration - Relevant settings within Xero The specific fields and logic used are outlined below. | Item | Details | | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Invoice Status` | By default, invoices are created in a **Submitted** status in Xero.
In some cases, invoices may be created in a **Draft** status if we are unable to determine a valid due date. | | `Contact` | We attempt to match the invoice to an existing Xero contact using the customer details from the SparkLayer order. If a match is found, the invoice is associated with that contact. You can read more about how contact matching and syncing works in detail [here](https://docs.sparklayer.io/xero#ZR11G). | | `Billing Address` | The billing address shown on the invoice is taken from the billing address associated with the matched Xero Contact. | | `Due Date` | The due date calculated for an invoice is dependant on three factors:
* The order date * The payment type * The customers payment terms | | `Due Date for Payment by Invoice orders` | For orders using the **payment by invoice **payment method, the due date is set to the order date. | | `Due Date for Payment on Account orders` | For orders using the **payment on account** type, the due date is calculated in the following hierarchical order:
1) If the customer has **net terms** configured in SparkLayer, these are applied to the order date. You can read more about configuring net terms [here](docId\:yWm70oQUosyKOoIqb4Z4G). 2) If not, any **payment terms** configured for the contact in Xero are applied. 3) If neither of the above are set, any **global payment terms** configured in Xero are applied. 4) If none of these are set, the due date defaults to the order date. | | `Line Item` | - **Item Code** If you have configured your integration to map line items to item codes in Xero, we'll use the line items SKU as the item code. - **Account Code** Each line item uses the default account code set in your integration settings. - **Description** A combination of the line item’s SKU and parent / child name is used as its description. If the item also has any custom attributes associated with it, these are also appended. - **Quantity** The quantity matches the value recorded on the order in SparkLayer. - **Unit Amount, Line Amount & Tax Amount** All monetary values, unit amount, line amount, and tax amount, are calculated by SparkLayer and passed directly to Xero. | | `Shipping` | We attach shipping details to the invoice as a line item at the bottom of the invoice. We'll use the shipping method name & SKU to form the line item description alongside the relevant monetary values.
The account code used is the same as other line items, using the default account code set in your integration settings. | | `Tracking` | Xero allows you to associate each invoice line item with up to two tracking categories.
If tracking category mappings are configured in the integration settings, **all** line items on generated invoices will automatically be assigned to the specified tracking categories. | :::hint{type="info"} **Please note ** Xero supports only a single billing address per contact. If a SparkLayer customer has multiple addresses, the billing address shown on the invoice may differ from the one stored in SparkLayer. We sync a customer’s billing address only when the contact is first created in Xero. Any changes made afterwards in SparkLayer are not automatically reflected and may require manual updates on the invoice or Xero contact record. ::: ### Mapping Line Items to Xero Items (Products) In the integration configuration section `Invoice Line Item Mapping` you may enable `Map Line Items to Item Codes`. This setting assumes you have already pre-configured items in Xero for all of the products in your platform, using the product SKU as the item code in Xero. When enabled, we'll map each line item to its corrersponding item in Xero based on the SKY held in SparkLayer. :::hint{type="warning"} If a line item is for a SKU which **does not **exist as an item (product) in Xero then we'll fail to create the invoice. Once any missing items are added, the invoice will be created. ::: *** ## Viewing Invoices Once an invoice has been created in Xero, customers can access it directly from the **My Account** section of your store. When the invoice is ready, a **View & Download Invoice** button will appear on the relevant order.  Selecting this button will take the customer to the publicly accessible invoice URL generated by Xero. If this button is not visible, please review our troubleshooting steps below. *** ## Contact matching & creation When creating an invoice, we first attempt to associate it with the correct Xero contact using the customer details from the SparkLayer order. ### How contact matching works Contacts are matched in the following order: 1. **Account number match **- we check for an existing Xero contact with an account number that matches the accounting ID configured against the customer in SparkLayer. [Read more on how to configure accounting IDs](https://docs.sparklayer.io/account-and-addresses#advanced-account-settings) 2. **Email match **- If no account number match is found, we attempt to match using the customer’s email address. If a match is found for either of these conditions, the invoice is associated with the matching contact. ### Multiple contacts for a single email In SparkLayer, email addresses are unique - only one customer account can exist per email address. In Xero, email addresses are not unique, meaning multiple contacts can share the same email. If multiple Xero contacts exist for the customer’s email address, we will create the invoice for the first matching contact returned by Xero. :::hint{type="warning"} **Please note** If your organisation uses multiple contacts with the same email address, we recommend configuring unique account numbers for each contact to ensure reliable matching. ::: ### Automatic contact creation If no existing contact can be matched using the methods above, SparkLayer will automatically create a new contact in Xero using the customer data from the order. This behaviour is controlled by the **Automatic Contact Creation** setting in your integration configuration. ### Data synced on contact creation When a contact is created in Xero, the following information is synced once and is not automatically updated if changes occur later in SparkLayer: - Company name - First name & last name - Email address - Billing & shipping address (based on the order being invoiced at the time of matching) - Payment terms (if configured via the payment terms metafield). Contacts are created using Xero’s *days after bill date* payment term type. ### Unique contacts in Xero Xero requires each contact **name** within an organisation to be unique. To ensure successful contact creation, we use a multi-stage naming strategy when creating new contacts. **Contact creation stages:** - **Stage 1: **If the [SparkLayer Company Name ](https://docs.sparklayer.io/account-and-addresses#advanced-account-settings)metafield is populated, this is used as the contact name. *Example: “The Company”* - **Stage 2: **If a contact with this name already exists in Xero, we append the customer’s first and last name. *Example: “The Company (Jane Doe)”* - **Stage 3: **If the above name is also already in use, we fall back to using only the customer’s first and last name. *Example: “Jane Doe”* If all of the above naming conventions fail to create a unique contact in Xero, to ensure an invoice is created we'll attempt each again but with a timestamp appended to the end. *Example:* "*The Company (20260520093837)*" *** ## Payment Visibility If [payment visibility](https://docs.sparklayer.io/payment-methods#payments-visibility) is enabled in your SparkLayer Dashboard configuration then you will see any payments made against invoices in Xero reflected as transactions on the order in SparkLayer. We track the following Xero payment types as transactions on orders: - Payments / Offline Payments - Credit Notes applied to invoices - Overpayments applied to invoices All payment types will be displayed as transactions on the order and modify the balance due on the order held in SparkLayer. :::hint{type="info"} **Please note** Even if the payment visibility setting is **disabled **we will continue to track Xero payments as transactions on SparkLayer orders in the background. ::: ### Refunds We do not currently track refunds on card payments as refunds are not typically applied directly to an invoice but instead reflected as a credit note on the customer account. We do however track when any of the above payment types are removed from an invoice, and reflect this accordingly on the order in SparkLayer. ### Credit Limits As SparkLayer tracks payments made against invoices, if you have configured credit limits and account balances as outlined in [Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G), any payments made on Xero invoices for **Payment on Account** orders will automatically modify the customers unpaid balance accordingly. :::hint{type="warning"} **Xero Contact Credit Limits** In Xero you ahve the ability to set credit limits for contacts. Unforunately this information is not exposed in the Xero APIs. As a result, we’re unable to automatically sync credit limits configured in Xero with customers in SparkLayer. To apply credit limits to customers, you will need to follow our documentation on[Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G) ::: ### Credit Notes Whilst we are able to sync credit that's been applied to invoices as a payment, we are currently unable to reflect any unallocated credit held against the contact record in Xero, against the customer balance in SparkLayer. Currently, in order to keep these in sync we'd recommend manually modifying the balance on the customers metafield to reflect any unallocated credit. Once you have allocated the credit to an invoice, you will then need to modify the balance back accordingly. *** ## Disabling the integration To disable the integration, log in to your SparkLayer Dashboard and navigate to **Integrations → Partner Integrations → Accountancy → Xero**, then toggle the integration off. To disable the integration, log in to your SparkLayer Dashboard and navigate to **Integrations → Partner Integrations → Accountancy → Xero**, then toggle the integration off. :::hint{type="warning"} **Please note** If the integration is disabled, all related features will stop working. - No invoices will be created for orders placed while the integration is disabled. - Customers will no longer be able to access their Xero invoices via the link in their **My Account** section. ::: *** ## FAQ's :::ExpandableHeading **How do I disconnect from Xero?** To disconnect from your Xero organisation from SparkLayer you will need to login to your SparkLayer Dashboard and navigate to **Integrations -> Partner Integrations -> Accountancy -> Xero **then disable the integration. This will remove the connection from your Xero organisation. Please read further information here on what happens when the integration is disabled [here](https://docs.sparklayer.io/xero#OjTtC). ::: :::ExpandableHeading **Does the integration work for D2C orders?** No. The integration only supports B2B orders that are created through your platforms connection with SparkLayer. Direct-to-consumer (D2C) orders are not included in the sync and will not be pushed to Xero as invoices. ::: :::ExpandableHeading **What level of access does the integration require in Xero?** When connecting SparkLayer to your Xero organisation, you’ll see a list of the exact permissions requested. We follow Xero best-practice and only ask for the minimum access needed for the integration to function. Currently, this includes: - **View & manage contacts** - To match invoices to existing contacts and create new contacts for SparkLayer customers if your integration configuration allows. - **View & manage business transactions** - To create invoices in Xero for SparkLayer B2B orders and in the future, view payments made on invoices. - **View organisation settings** - To read configuration details such as global payment terms when calculating invoice due dates. ::: *** ## Troubleshooting Below are some common issues and steps to help resolve them. If your issue isn’t listed, or the problem persists after following these steps, please contact our support team. :::ExpandableHeading **Customers cannot access their invoice from the My Account section** If links to invoices are not showing in a particular customers My Account section, it could be due to a number of reasons. - Ensure the integration is enabled in the SparkLayer Dashboard by navigating to **Integrations -> Partner Integrations -> Accountancy -> Xero**. - Ensure the order is in a `processing` or `shipped` fulfilment status. We **do not **create invoices for orders which are in the `awaiting merchant` status. - Ensure an invoice exists in Xero for the given order. In some cases it may take a little time for orders to sync across. If there appears to be a large delay, or an invoice has not been created, please contact support, providing the customer and order id. - Ensure the invoice is not in a **draft **status. Xero does not provide public urls for invoices which are in a **draft **status. If you are still experiencing issues after checking the above, or invoice urls are not showing for **all **of your customers, please contact support. ::: :::ExpandableHeading **The address on the invoice is different to the address the customer used during checkout** The address(es) used on an invoice in Xero come directly from the related contact record. Whilst in SparkLayer we allow for a customer to have multiple billing & shipping addresses, Xero only offers support for a single billing and shipping address per contact record. We will only use the addresses held in SparkLayer if we create the contact as part of the contact matching and creation flow detailed above. If any of these addresses change after the contact has been created, we will not automatically update them. ::: *** ## Known limitations Please note the following: - Multiple tax rates per line item are not currently supported. - Invoice creation in Xero is one-way. Any changes made to invoices in Xero, such as modifications to line items or customer details will **not **be reflected back in SparkLayer or your platform. [title] Shopify Reporting & Filtering [path] Integrations/Shopify/Shopify Customisations/ ## Introduction Because SparkLayer works as a [Sales Channel](https://help.shopify.com/en/manual/online-sales-channels) within Shopify, it makes filtering and reporting by SparkLayer orders easier. In most areas of the Shopify Admin, it's possible to filter by Sales Channel and, in the case of SparkLayer, you simply need to filter by Sales Channel **B2B Ordering** to apply specific filters.  As well as this, SparkLayer also adds tags and additional data against orders placed by B2B customers and this can also be a used to generate reports within Shopify. | Attribute | Notes | | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tag` | A tag of `b2b` is added to any order placed via SparkLayer. This is particularly useful for filtering and segmenting orders, or even adding more advanced automations | | `note` | Order Note: `sparkCartId`
This is added as an **order note.**
This is primarily for internal use for debugging | | `note` | Order Note: `sparkPaymentType`
This is added as an **order note.**
This contains the name of the payment option used:
* upfrontPayment * paymentOnAccount * paymentByInvoice * quote |  [title] Shopify Companies [path] Integrations/Shopify/ ## Introduction :::hint{type="info"} **Please note** It is not necessary to use Shopify Companies alongside SparkLayer. This guide gives an overview of how SparkLayer works alongside Shopify Companies. Using Shopify Companies may incur additional transaction costs from Shopify and we recommend speaking to Shopify Support to confirm. ::: SparkLayer and Shopify's "Companies" feature are **two different systems for managing B2B customers**. They don't currently share data - but we're actively building compatibility so they can work alongside each other. If you're a SparkLayer merchant, your B2B customer management, pricing, and ordering continues to work exactly as it does today. Shopify's Companies feature doesn't interfere with SparkLayer - but you should understand how the two systems relate. *** ## What Is Shopify Companies? Shopify has expanded its native B2B features to all plan tiers. At the core of this is the **Companies** feature (found at Customers > Companies in your Shopify admin).  A Shopify Company is a structured record that represents a business you sell to. It includes: - **Company profile** - the business name, tax ID, and general information - **Company locations** - physical locations (offices, warehouses, branches) with their own shipping/billing addresses - **Customers** - individual buyers linked to a company location, each with their own login and permissions - **Catalogs** - pricing and product visibility assigned to the company or location - **Payment terms** - net terms, deposit requirements, and checkout rules per company When a B2B customer logs in via Shopify's native B2B, they select their company and location, and Shopify automatically shows them the right pricing, products, and payment options. *** ## How SparkLayer Works SparkLayer uses a **tag-based system** to identify and manage B2B customers. Instead of Shopify's Company → Location → Customer hierarchy, SparkLayer works like this: - **Customer tags** in Shopify identify which customers are B2B buyers - **Customer groups** in SparkLayer define pricing tiers, payment methods, and rules - Customers are assigned to groups, and those groups control their B2B experience - SparkLayer overlays a full B2B frontend on top of your existing Shopify theme This means SparkLayer doesn't use Shopify's Company or Company Location records to determine who sees what pricing. You can learn more [in our guide here](docId:5_lWMNohhjBJJppg9E6Vh). *** ## Do They Conflict? **No.** SparkLayer and Shopify Companies can coexist on the same store without breaking anything. However, they currently operate independently: - SparkLayer reads **customer tags** to identify B2B buyers and assign them to groups - Shopify's native B2B reads **Company records** to determine pricing and catalogs - If a customer is set up in both systems, each system handles them separately The important thing to understand: **SparkLayer does not currently read from or write to Shopify's Company, Company Location, or Catalog records.** Your SparkLayer pricing, groups, and ordering features are managed entirely within SparkLayer. *** ## Draft Order Company Association When SparkLayer creates a draft order on behalf of a B2B customer, it **associates that order with the correct Shopify Company, Contact, and Location IDs**. This means: - B2B orders created through SparkLayer appear correctly under the Company in Shopify's admin - Order attribution is accurate - Shopify's reporting recognises these as B2B orders from a specific company - This addresses the Shopify warning: *"Some apps may not attribute B2B orders correctly on your current plan. Check that B2B orders are assigned to a company, not just an individual customer."* ### How It Works 1. B2B customer places an order via SparkLayer 2. SparkLayer creates a draft order in Shopify 3. The order is linked to both the **customer** AND their **Shopify Company and Location** 4. In Shopify's admin, the order appears correctly under both the customer and the Company  *** ## What You Need to Do **If you're an existing SparkLayer customer:** **Nothing changes with your B2B setup.** SparkLayer continues to manage your customer groups, pricing, and ordering independently of Shopify's Companies feature. The company association feature is now live - if your Shopify customers are linked to Company records, SparkLayer will **automatically** associate draft orders with the correct Company and Location. To take advantage of this: - Ensure your B2B customers in Shopify are linked to the appropriate Company records - Orders placed through SparkLayer will then appear under the Company in Shopify's admin - No additional SparkLayer configuration is needed **If you're setting up SparkLayer for the first time:** You can set up Shopify Companies alongside SparkLayer from day one. The two systems work independently, and SparkLayer's company association ensures orders are attributed correctly from the start. **Do I need to create Shopify Companies?** It depends on your needs: - **If you want Shopify's admin to show B2B orders grouped by company** → Yes, create Company records for your B2B customers. When SparkLayer's company association feature goes live, orders will be linked automatically. - **If you only use SparkLayer for B2B management** → Company records are optional. SparkLayer's customer groups handle everything. - **If you want the best of both worlds** → Create Company records for reporting and admin organisation, and use SparkLayer for the full B2B ordering experience. *** ## Vaulted credit cards Because SparkLayer associates draft orders with the correct Shopify company and location, your B2B customers can take advantage of [Shopify's vaulted credit card](https://help.shopify.com/en/manual/b2b/checkout-and-orders/vaulted-cards) feature - allowing them to securely save a card once and reuse it across future orders without re-entering payment details. ### How it works Shopify's vaulted cards **are tied to a company location. **When a customer saves a card - either at checkout or through their customer account - that card becomes available to any customer linked to the same company location. With SparkLayer, vaulted cards work in two ways: **Pay online by card** When a B2B customer checks out via SparkLayer and selects **"Pay Online by Card"**, any vaulted cards saved against their company location will appear as a payment option. The customer can select a saved card to complete the order without re-entering their details.  **Draft orders and invoices** When a customer places an order using another payment method in SparkLayer (e.g. pay by invoice), the **resulting draft order** in Shopify can have a vaulted card charged against it. This means you can collect payment on invoice orders directly from the Shopify admin using a card already on file.  ### Getting started To use vaulted cards with SparkLayer, you need the following in place: 1. **Shopify Payments must be enabled** - Vaulted cards require Shopify Payments as your payment provider. 2. **Customers must be linked to a Shopify company** - The customer's account in Shopify needs to be assigned to a company record. SparkLayer's company association feature handles the order attribution, but the customer-to-company link must exist in Shopify's admin. 3. **A card must be saved** - A customer within that company location needs to have saved a card during a previous checkout, or added one via their customer account. Once saved, the card is available to all customers at that location. No additional SparkLayer configuration is needed. As long as your customers are linked to Shopify company records and Shopify Payments is active, vaulted cards will work automatically during the SparkLayer checkout process. ### Controlling access If you want to prevent certain team members from using vaulted cards, SparkLayer's [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) feature gives you a simple way to do this. When a company user is assigned the "Limited" role, they can browse products and build an order - but they can't complete the checkout themselves. Their order is sent to the main company user for approval instead. Because limited users never reach the Shopify checkout, they won't have access to any vaulted cards saved against the company location. This makes the limited role an easy way to restrict who can charge a saved card while still allowing them to participate in the ordering process. :::hint{type="info"} **Please note** Vaulted cards are available on all Shopify plan tiers that support the companies feature. We recommend confirming any transaction fee implications with Shopify support, as using Shopify companies may incur additional costs depending on your plan. ::: *** ## Limitations While SparkLayer now supports Shopify Companies for order attribution, there are some scenarios to be aware of: - **Multiple companies or locations:** If a customer is connected to more than one Shopify Company, or to multiple locations within a company, the draft order will not be placed against a company. SparkLayer requires a single, unambiguous company-location match to associate the order correctly. - **Company records must exist first:** SparkLayer doesn't create Shopify Company records - it reads them. If a B2B customer doesn't have a Company record set up in Shopify's admin, the order will be linked to the customer only (as before). - **SparkLayer doesn't read Shopify catalogs or payment terms:** Pricing, product visibility, and payment rules are still managed entirely within SparkLayer's customer groups. Shopify's catalog assignments and payment term settings on Company records are not used by SparkLayer. - **No two-way sync between systems:** Changes made in SparkLayer's customer groups (adding a price list, changing a payment method) are not reflected in Shopify's Company records, and vice versa. The two systems are linked for order attribution but managed independently. - **Customer must be linked in Shopify:** The customer placing the order must be associated with a Company record in Shopify's admin. If the customer exists in SparkLayer's customer groups but isn't linked to a Shopify Company, the association won't happen. *** ## Migrating Companies to Customers If you'd prefer to manage your B2B customers entirely through SparkLayer's tag-based system and don't need Shopify Company records for reporting, you can remove customers from Companies and convert them to regular Shopify customers. This simplifies the setup and avoids any potential conflicts between the two systems." :::ExpandableHeading **How to migrate a customer manually** The easiest way to migrate a customer is to go into a company record within Shopify and, in the right hand side, click the "Remove customers" button. This will then allow you to remove a customer from the company record.  Next, go to the "Customers" area of Shopify and locate the customer. From the top right, click "Send account invite". When you click this button, this will then send the customer an "activation email", allowing them to set a password (not a 6 digit code) and subsequently be able to login to your store.  ::: :::ExpandableHeading **How to migrate a customer in bulk** If you're looking to migrate customers in bulk, our recommended approach is to the Shopify App, [Matrixify](https://apps.shopify.com/excel-export-import?st_source=autocomplete). Built-in to this tool is the ability to bulk 'Un-assign" customers from a Company by **deleting** the Company, converting them into regular customers (who you can subsequently invite to your store). To get started, set up a new export and specify "**Companies**" as the source "**Sheet**"  Within the exported file, you'll see a column "Command" with an entry of "MERGE" next to each Company record.  Simply update the column "Command" to "DELETE" and re-import the file into Matrixify.  This will then fully delete the Company record from Shopify and all associated customers will then become regular customers. You can then individually invite the customers (see above), or even use Matrixify to bulk activate and invite your customers in one go. ::: *** ## FAQs :::ExpandableHeading **Will SparkLayer break if I enable Shopify's B2B features?** No. SparkLayer operates independently. You can enable Shopify's Companies feature without affecting your SparkLayer setup. ::: :::ExpandableHeading **Can I use both SparkLayer and Shopify's native B2B at the same time?** SparkLayer and Shopify's native B2B checkout cannot run simultaneously for the same customer session - it's one or the other for the ordering experience. However, you can have Shopify Companyrecords set up for admin/reporting purposes while using SparkLayer for the actual B2B ordering. ::: :::ExpandableHeading **Should I allocate tags to customers or set up Shopify Companies?** For SparkLayer to work, you need **customer tags** - this is how SparkLayer identifies B2B buyers. Shopify Company records are optional but recommended for better order attribution and admin organisation. Both can coexist. ::: :::ExpandableHeading **Do I need Shopify Markets to use Shopify Companies?** Companies and Markets are technically separate features, but on non-Plus plans they're closely linked. You can create Company records in Shopify's admin without enabling Markets - they work as structured customer profiles with locations, contacts, and payment terms. However, to assign pricing catalogs to those companies, you need Markets. On Basic, Grow, and Advanced plans, catalogs are assigned through Markets (customer groupings), not directly to companies. So you can have Companies without Markets, but they won't have custom pricing - which limits them to an admin organisational tool. On Shopify Plus, you can bypass Markets entirely and assign catalogs directly to individual company locations. This is the only plan where Companies and catalogs work independently of Markets. SparkLayer doesn't use either system for pricing. Your customer groups, price lists, and payment methods are managed entirely within SparkLayer, regardless of whether you have Markets or Companies enabled in Shopify. ::: :::ExpandableHeading **What about that Shopify warning about apps not attributing B2B orders correctly?** This is already handled. SparkLayer now correctly associates draft orders with the relevant Shopify Company and Location, ensuring accurate B2B order attribution in Shopify's admin. As long as your B2B customers are linked to Company records in Shopify, orders placed through SparkLayer will appear under the correct Company. ::: :::ExpandableHeading **When will company association be available?** It's live now. No additional configuration is needed on the SparkLayer side - just ensure your Shopify customers are linked to the appropriate Company records. ::: [title] WooCommerce FAQs [path] Integrations/WooCommerce/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for WooCommerce?** All SparkLayer plans are compatible with WooCommerce, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via the SparkLayer Dashboard under Acccount > Plan ::: ### WooCommerce setup :::ExpandableHeading **Where do I find the SparkLayer WooCommerce app?** Currently, SparkLayer can only be setup on your WooCommerce store by registering directly via [SparkLayer](http://app.sparklayer.io/register) ::: :::ExpandableHeading **What WooCommerce plan do I need to be on to use SparkLayer?** You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website - WooCommerce: version 9 and above - Wordpress: version 6 and above If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing WooCommerce DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.woocommerce.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **Can you help me install SparkLayer on my WooCommerce website?** By default, the SparkLayer widges will be automatically installed on your store. If you do require assistance, you can [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we will be happy to advise. ::: :::ExpandableHeading **Does SparkLayer work on any WooCommerce theme?** You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website - WooCommerce: version 9 and above - Wordpress: version 6 and above If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). ::: :::ExpandableHeading **How does SparkLayer affect my current WooCommerce theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your WooCommerce store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the WooCommerce checkout. From there, any payment methods you have set up in WooCommerce (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if WooCommerce support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. You could also configure your WooCommerce theme to hide and show products based on tag via custom coding. ::: :::ExpandableHeading **Can I use my WooCommerce prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your WooCommerce prices (e.g. your main WooCommerce retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your WooCommerce prices and we can even make provisions for your tax set up in WooCommerce (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within WooCommerce, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Wix so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Wix, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Wix 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in WooCommerce to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. It's also worth noting that you can manually add customers via the admin by going to **Wordpress/WooCommerce > Users** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. You could think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my WooCommerce website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my WooCommerce website?** This is possible but would require custom coding. We recommend consulting with a WooCommerce expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in WooCommerce?** | Payment Method | Notes | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by Invoice` | The order will be created within **WooCommerce > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Payment on Account` | The order will be created within **WooCommerce > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Upfront Payment (Card payments)` | The order will be created within **WooCommerce > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. | ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within WooCommerce when an order is placed via SparkLayer providing payment hasn't already been processed. From WooCommerce > Oders, navigate to an order. You'll then see the option to **Edit order** allowing you to make changes. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: [title] Shopify Error Codes [path] Integrations/Shopify/ ## Introduction If SparkLayer detects an error on your Shopify store, you may notice one of the following error codes display within the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-). We've detailed the most common errors along with the associated way to resolve them. ## Error codes :::hint{type="danger"} - **SHOPIFY:001 **You've assigned a price list in a specific currency (e.g. AUD) to a B2B customer but this currency has not been enabled in your [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD). In a market that includes multiple countries / regions, there is a setting to "Show prices to customers in their local currency". SparkLayer does not currently support this setting and **it will need to be disabled** for B2B customers in this market to successfully place orders. - **SHOPIFY:002** You've assigned a price list in a specific currency (e.g. AUD) to a B2B customer but the destination shipping country isn't set up in your [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD). - **SHOPIFY:003** There's an issue with your product data such as a missing variant SKU for the product in your order. Try removing the affected product from the order. - **SHOPIFY:005 **The email being used for the order is failing "DNS checks" by Shopify and is being restricted from checking out. Try checking the email address to ensure it is valid. - **SHOPIFY:006 **You're trying to checkout with a shipping address in a country that is not in any of your store's configured Shopify Markets. Please ensure all available shipping countries have an associated Shopify Market set. - **SHOPIFY:007** You're trying to checkout but your customer record is missing either an email address, shipping phone number, or shipping address. These are all required for stores using Managed Markets. - **PRICING:001 **The B2B customer has two price lists assigned to their customer group with different currencies (e.g. GBP and USD). Try changing their customer group settings to ensure only one currency type is assigned. ::: [title] Installing SparkLayer on Wix [path] Integrations/Wix/ ## Introduction SparkLayer enables B2B functionality on your existing Wix store, allowing your B2B customers to login, place orders, manage their account, and much more. :::hint{type="success"} **👋 We're here to help!** Our team can help get everything set up on your Wix store. You can [book a call here](https://connect.sparklayer.io/onboarding-meeting) and we'll walk you through the process! If you'd prefer, you can also use our guide below to try setting things up yourself. :::  *** ## ⚠️ Requirements - important! Before installing SparkLayer on your Wix store, please ensure the following are setup before proceeding: | Item | Details | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Site Member Settings` | You’ll need to make sure that your store is set up to allow "Site members". You can check this within your admin by going to **Settings >** **Site Member Settings > Signup & Login Security**. Under "Who can be a site member", select "Everyone who signs up". | | `Product SKUs` | In order for SparkLayer to save B2B prices for your products, all products must have **SKUs**. Within your admin, go to a product and you'll see the option to set a SKU either on a product or variant level. You can learn more about this below. | | `Contacts` | For your B2B customers to see the SparkLayer, they must have a label of `b2b`. You can set this up by going to **Customers & Leads > Contacts** and editing a customer record. You can learn more about this below. | | `Payments` | Please ensure you have payment methods enabled. You can check this within your admin by going to **Settings > Accept Payments**. | | `Shipping` | In order to place an order, please ensure you have shipping rules set up. Within your admin, go to **Settings > Shipping and Delivery.** | **Areas of Wix Dashboard you'll be using** As part of setting up SparkLayer, you'll primarily be using the following areas: | Area | Details | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Products` | This will be used to setup which products you want to make available to B2B customers. See "Setting up your B2B pricing" below.
*In Wix, go to Catalog > Store Products > Products* | | `Contacts` | This will be used to setup your B2B customers. See "Setting up your B2B customers" below
*I**n Wix, go to Customers & Leads > Contacts* | | `Orders` | This will be used to review and process and orders that are placed by your B2B customers. See "Placing a B2B order" below.
*In Wix, go to Sales > Orders* | :::hint{type="warning"} **Limitations** We recommend familiarising yourself with [current limiitations](docId\:DKZzbjeYVKG6YrJGVKjpW) of SparkLayer for Wix ::: *** ## 🟢 Quick-start guide If you're looking to get setup quickly and just review the key steps, you can use our step by step guide below! :::ExpandableHeading **See step-by-step instructions (click to expand)** **STEP 1 - Install App** Install the [SparkLayer for Wix App](https://www.wix.com/app-market/web-solution/sparklayer-b2b-wholesale) and select the Wix store you’d like to install on (ensuring it is a **Wix Editor** store). *** **STEP 2 - Register with SparkLayer** Install the app and then register an account with SparkLayer**** **⚠️ IMPORTANT: Please ensure you make a note of the email address and password you use**  *** **STEP 3 - App Onboarding Steps** You’ll then be taken to an onboarding page where it guides you through setting SparkLayer up. **⚠️ IMPORTANT: all set up takes place via the **[SparkLayer Dashboard](https://app.sparklayer.io/)** and NOT in Wix**  *** **STEP 4 - Sign into SparkLayer** Log in to the [SparkLayer Dashboard](https://app.sparklayer.io/). This is where you will set up B2B pricing and B2B customer rules primarily. ⚠️**IMPORTANT: you will be prompted to “confirm your SparkLayer plan”, you can ignore this. This will be relevant in due course once the app is live and merchants want to **[select a plan](https://www.sparklayer.io/pricing/)  *** **STEP 5 - Setup B2B Pricing** Go to the [Price Lists section](https://app.sparklayer.io/pricing/lists) and set up an example price list. For example, you could set up an “automatic pricing” which is 50% off your Wix pricing. When you click “Create Price List” you’ll be prompted to assign this to your default B2B customer group (this is optional, you can change it later). Depending on your tax setup in Wix, you can also automatically calculate the correct tax rate to set your automatic pricing.  *** **STEP 6 - Setup B2B Customer Rules** Go to the [Customer Groups section](https://app.sparklayer.io/customers/groups) where you can configure your B2B customer rules. At a minimum, ensure that a “Price List” has been assigned. **⚠️ IMPORTANT: You’ll see a column “WIX LABEL”, this is the label you will need to add to your Wix Contacts (‘Customers”) once ready (see step 9 below)**  *** **STEP 7 - Complete Onboarding Steps** From the main “Home” section, you can check off any steps you take as you go**** **⚠️ IMPORTANT: this step is manual and doesn’t do anything other than mark the step(s) as complete.**  *** **STEP 8 - Product Catalog** In Wix, go Catalog > Store Products > Products to view your product catalogue. These are the products that show on your Wix Online store. **⚠️ IMPORTANT: for SparkLayer to show B2B prices, products *****MUST***** have a *****unique***** SKU added. If no SKU(s) are added, it will not be possible for B2B customers to purchase.**  *** **STEP 9 - Setup a B2B Customer** In Wix, go Customers & Leads. We’re going to create a brand new B2B customer record, click “Create New Contact” and complete the details. **** **⚠️ IMPORTANT: please ensure that a valid address is added. Make a note of the email address you’ve added as you will need to access this to login.**  Under “Label”, assign a label of “b2b” to the contact. If you don’t see this, you can view the Contact record and then add it  **⚠️ IMPORTANT: Please also note:** On a new B2B customer (whether new or existing), when they get labelled b2b for the first time: - SparkLayer will attempt to sync their address only this one time - however, if there are missing required fields (e.g. name, address line, postcode) SparkLayer will not sync the address at all and will not output any sync error logs - Any subsequent address edits from the Wix dashboard on a Wix contact will **not** sync back to SparkLayer - Any address book edits from SparkLayer will not sync back to Wix *** **STEP 10 - Set Contact as Member** In Wix, find the contact record and under Member Info, click **Set Contact as Member** This will then send the contact an email to confirm their account. **⚠️ IMPORTANT: all contacts must be set as “Members” to sign in as a B2B customer**  *** **STEP 11 - Activate Account****** In your emails, you’ll receive an email from Wix to activate your account. Click “Create New Password” and follow the instructions. Customers can also use the “Reset password” feature on the online store to do this.   *** **STEP 12 - Sign in as a B2B Customer** On your Wix store, sign in with the credentials you’ve created in the previous step. Next, navigate to a product page. Providing that the product has a valid SKU, you will then see your SparkLayer B2B pricing rules show and you can begin adding products to your order.  ::: *** ## 🚢 The Onboarding process :::hint{type="info"} **Important** When setting up SparkLayer, some activities take place via the [SparkLayer Dashboard](https://app.sparklayer.io/) alongside Wix. You'll use the SparkLayer Dashboard primarily for setting up your B2B pricing and B2B customer rules. ::: When you create an account on SparkLayer, you'll get access to the [SparkLayer Dashboard](https://app.sparklayer.io/). The Dashboard has a customised onboarding process that gently guides you through all the necessary steps before you're ready to start inviting your B2B customers and taking orders on your website. ::::WorkflowBlock :::WorkflowBlockItem **🔗 Connecting your Wix store** This enables SparkLayer to connect to your Wix store and begin synchronising the information it requires. ➡️ [View in dashboard](https://app.sparklayer.io/integrations/platform) ::: :::WorkflowBlockItem **📓 Setting up your B2B price lists** You'll then set up the B2B price lists that you want your customers to see when they login. These can be automated or you can manually upload specific pricing. ➡️ [View in dashboard](https://app.sparklayer.io/pricing) ::: :::WorkflowBlockItem **👪 Setting up your B2B customer groups** You'll then set the ordering rules for your customers such as minimum order values, available payment methods and price lists they are assigned to. ➡️ [View in dashboard](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem **✅ Testing & launching** You'll then need to run through some final checks (such as placing a test order). Once you're happy, you can then launch SparkLayer and start taking orders! ➡️ [View in dashboard](https://app.sparklayer.io/configuration/onboarding) ::: :::: Let's now dive into each of them! *** ## 🔗 Connecting your Wix store Once you've installed the [SparkLayer for Wix app](https://www.wix.com/app-market/search-result?query=sparklayer) this step of the onboarding process happens automatically. Once SparkLayer is connected to your Wix store, it will **automatically synchronise product and customer data** and then allow you to upload price lists and customise how you want your B2B customer rules to work. :::hint{type="info"} **Installing for the first time?** When installing for the first time, the process works as follows: 1. You'll need to install the SparkLayer app (much like you would any other app). You can do this within your admin by going to **Apps** and clicking **App Market **and then searching for SparkLayer. 2. You'll then be asked to **create an account on SparkLayer**, or sign in if you already have one. 3. Finally, you need to confirm acceptance of our billing plan within Wix to begin your free trial ::: Once the above is complete, you can then return back to the [SparkLayer Dashboard](https://app.sparklayer.io/) to continue with the onboarding process. You can also access the SparkLayer app within your Wix store by going to the **Apps** and clicking **Manage Apps** and clicking the **SparkLayer app** where you'll find a summary of your onboarding process. *** ## 📓 Setting up your B2B pricing :::hint{type="warning"} **Please note** Setting up your B2B pricing happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your Wix admin. ::: Within the [Price Lists](https://app.sparklayer.io/pricing) area of the SparkLayer Dashboard, you can create and manage your B2B pricing rules.  SparkLayer allows you to set the following pricing types: | Type | Details | | ----------- | ---------------------------------------------------------------------------------------- | | `Manual` | You can manually upload a CSV file with specific prices and even enable quantity pricing | | `Automatic` | You can use your Wix prices and apply a discount, e.g. 50% off Wix retail prices | To get started, please following the below steps: ::::WorkflowBlock :::WorkflowBlockItem For any products that you want your B2B customers to be able to buy, these products **must** have unique SKUs assigned. You can check this by going to **Catalogue > Store Products > Products** and editing a product. For regular products, you'll see the option to add a SKU within the **Inventory and shipping** section.  For products that have variants (e.g. colour, size), you'll need to edit a variant and add this within the **Product variants** section and ensure the setting **"Manage pricing and inventory for each product variant"** is turned on.  ::: :::WorkflowBlockItem Next, go to [Price Lists](https://app.sparklayer.io/pricing/lists) within SparkLayer and click "Create Price List" to create your first B2B Price list. You can choose between an automatic or manual price list and configure how this works. ::: :::: :::hint{type="success"} **Ready to set your pricing?** To learn more about pricing, please see our [full guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: *** ## 👪 Setting up your B2B customers :::hint{type="warning"} **Please note** Setting up your B2B customer rules happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your Wix admin. ::: [Customer Groups](https://app.sparklayer.io/customers/groups) let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out.  Much like with Price Lists, you can fully manage this via the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups). To get started, please following the below steps: :::::WorkflowBlock ::::WorkflowBlockItem Within Wix, go to **Customers & Leads** and click **Contacts. **You can either create a new customer or edit an existing one. :::hint{type="warning"} **Please note** Please ensure that a valid address is added and all address fields are populated. Make a note of the email address you’ve added as you will need to access this to login. :::  :::: ::::WorkflowBlockItem To synchronise to SparkLayer, the customer must have a label of `b2b` assigned to them and be a **Site Member**. :::Iframe{iframeHeight="0" code=""} ::: You can set this up by clicking the **Add Label** button when editing a customer.   :::hint{type="warning"} **Please note the following on customer groups** - SparkLayer will only synchronise customers that have a label of `b2b` assigned - If you have created additional [customer groups](https://app.sparklayer.io/customers/groups) within SparkLayer, please ensure that the labels are added to the contact record in Wix exactly as shown. e.g. `b2b` `b2b-additional-group` - Customers must be set up as **Site Members** to be able to sign in to your online store. - When adding a new label in Wix, please ensure that it is not subsequently edited. ::: :::: :::WorkflowBlockItem Once your customers have been set up in Wix (i.e. those with a label of `b2b`), and you've assigned the customer group to **at least** one customer, you can then manage specific rules within the [Customer groups area.](https://app.sparklayer.io/customers/groups)  ::: :::WorkflowBlockItem You'll see a default **Base** customer group that you can use for your B2B customers. If you want to set up additional rules, you can simply click **Create Customer Group** and configure accordingly. For any additional customer groups you create, you'll need to update the labels on the customer record in Wix to match (e.g. `b2b` and `b2b-account`) ::: :::WorkflowBlockItem To simulate logging in as a B2B customer, please see **✅ Testing & launching** below. ::: :::WorkflowBlockItem You can also check if your customer record is syncing by using the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. Within Wix, navigate to a Contact record that has a label of b2b. Within the URL, you'll see a unique ID at the end of the URL. In the example below, the unique ID is `66b4c99a-3431-47d6-995d-309e4e8c5908`  With this unique ID, you can then paste this into the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. If the search results show the customer details, this confirms the customer is synchronosing correctly.  ::: ::::: :::hint{type="success"} **Ready to configure your customer groups?** To learn more about customer groups, please see our [full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: *** ## 🛒 Placing a B2B order Once you've logged into your Wix store as a B2B customer, you can then place an order by going to any product page and adding items to your order. When you add items, they will then appear in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) and you can then proceed to checkout to complete the order. **How payment methods work** When customers reach the payment step, they'll see a variety of available payment methods and can select their preference. | Payment method | Description | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment on Account` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** needing to enter any payment details. | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details. | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). This is sometimes referred to as "Pro-forma payment". | | `Request for quote` | **👪 For the B2B customer:**
The customer can submit their order **without** choosing a payment method. | **How orders arrive into Wix** Depending on which [payment method](docId\:ibIKczvHM085BkeJIfFYv) you've selected, orders will arrive into Wix in the following ways: | Payment Method | Flow | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Pay by Invoice` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay on Account` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay Online by Card` | The order will be created within **Sales > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | | `Request for Quote` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | **"Unpaid" orders and "Paid" orders** By default **all payment methods** other than Upfront Payment will be generated as "Unpaid" orders. **Wix checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the Wix checkout. By default, they will see all Wix payment methods you have set up (e.g. card payment, Paypal, etc). **Additional order details** When an order is placed via SparkLayer, it will also include the following additional data: | Attribute | Notes | | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tag` | A tag of `b2b` is added to any order placed via SparkLayer. This is particularly useful for filtering and segmenting orders, or even adding more advanced automations |  *** ## 🛠️ The frontend widgets When you install SparkLayer on your Wix store, the special SparkLayer widgets are automatically added to **your product detail pages.** There's no coding or configuration to do! Once set up, your approved B2B customers (see above "Setting up your B2B customers") will then see your B2B pricing and can begin placing orders. You can learn more about how this works in [our guide here](docId\:ccZ1vnH0O6D_722w35Xpa).  **Customising the branding (via CSS)** By default, the SparkLayer widgets will show with generic fonts and colours, however it is possible to "overwrite" the styling to better match your store by using special CSS rules. There are a variety of ways to do this via Wix. :::ExpandableHeading **Using Wix Editor 'Custom Code' ** Within your Wix Dashboard, go to **Settings** and then click **Custom Code**. Click** "Add Custom Code"** and add the CSS into the field named **"Paste the code snippet here".** You'll also need to ensure it is set to **"Load code on each new page"**  For example, you could overwrite the colours and fonts by using the following CSS ```css ``` Once saved, you can then make edits at any point.  ::: ::::ExpandableHeading **Using Wix Studio 'Code Mode'** Within your Wix Dashboard, go to **Site & Mobile App** and then click **Edit Site**. :::BlockQuote Within "edit mode", click **Code** in the left navigation. Within the CSS section, you'll see a file global.css that you can use to add our special [CSS variables](docId\:qCt2Zk8wjhYIV2ZbVBJYy) to customise your design. ::: :::Iframe{iframeHeight="0" code=""} ::: For example, you could overwrite the colours and fonts by using the following CSS ```css ``` :::: *** ## ✅ Testing & launching The final step is to run some tests and checks to ensure SparkLayer is fully configured. Within the SparkLayer Dashboard, you'll see a number of [Launch checks](https://app.sparklayer.io/?expand=launch) to perform, from logging in as a B2B customer, through to placing an order. We recommend following the below steps: ::::WorkflowBlock :::WorkflowBlockItem **Set up a customer record** Within your Wix admin, you'll need to ensure you have an example customer record set up (either a new one or an existing). Most importantly, a customer must be associated with a label of `b2b` and be a Site Member. Any customer that has a label of `b2b` will automatically synchronise with SparkLayer.   ::: :::WorkflowBlockItem **Place a test order** Once you've logged in as a B2B customer (i.e. a customer with a label of `b2b`), proceed to add items to your cart and complete the checkout. Please see *"Placing a B2B order"* above for more details on how this works. ::: :::WorkflowBlockItem **Invite your customers** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. One of the easiest ways is to use the built-in Wix messaging system to simply notify your customer to sign in and begin placing orders. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You'll see a tab called **Inbox** that allows you to send direct messages.  You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You can then search and filter your customers and click **Send Email Campaign** to send an email.  We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::: *** ## ⚙️ Advanced configurations In addition to the above setup, there are a number of other configurations that are possible at this time. :::ExpandableHeading **Setting minimum stock levels** It's possible to set minimum stock level for items you may want to sell as pre-orders. This means that your B2B customers can add products to an order and you can limit how many are available. To get started, in your Wix Dashboard, navigate to a product. You'll need to ensure **Track inventory** and **Pre-order** are both turned on. Within **Pre-order limit**, simply enter the stock number, e.g. `50`.  ::: :::ExpandableHeading **Adjusting tax settings** SparkLayer supports tax calculations and simply 'inherits' the rules you've set up in your Wix Dashboard. You can learn more about how tax works [in this Wix guide](https://support.wix.com/en/article/including-tax-in-the-product-price). One key configuration you may want to check is how Tax is calculated during the checkout. From your Wix Dashboard, go to **Settings > Tax** and you can amend accordingly.  ::: :::ExpandableHeading **Enabling SparkLayer JavaScript modifications (e.g. checkout customer fields, language updates)** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Wix store. To get started, go to **Settings > Custom Code** and then click **Add Custom Code**. You can then paste in any JavaScript as required. For example, the below sample enables a special checkout custom field to collect a Delivery Date. ```javascript ``` ::: :::ExpandableHeading **Enabling a URL redirect when signing in ** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Wix store. To get started, go to **Settings > Custom Code** and then click **Add Custom Code**. You can then paste in any JavaScript as required. For example, the below sample enables a special checkout custom field to collect a Delivery Date. ```javascript ``` ::: :::ExpandableHeading **Enabling "Dark mode" for high contract websites** If your Wix store is set up with a darker theme, it's possible to enable a special "Dark Mode" for SparkLayer, ensuring colours and fonts are easily readable.  To get started, go to **Settings > Custom Code** and then click **Add Custom Code**. You can then paste in the code below. ```javascript ``` ::: :::ExpandableHeading **Enabling SparkLayer shipping methods** SparkLayer has a built-in [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) system that lets you customise how shipping works for your B2B customers. By default, your existing shipping methods in your Wix Dashboard will be used, however it's possible to update this to use SparkLayer. To get started, in your Wix Dashboard, go to **Settings > Shipping, Delivery & Fulfillment**. You'll need to make sure you have at least one shipping region set up (e.g. USA, UK). Once you've done that, click the **Manage Your Apps** link below the shipping region. You'll then see the option to enable **SparkLayer Shipping.** Finally, you'll then need to set up your SparkLayer shipping rules via the [SparkLayer Dashboard here](https://app.sparklayer.io/configuration/shipping).  ::: :::ExpandableHeading **Enabling pre-order (or "back orders")** SparkLayer has built-in support for pre-orders (someimtes referred to as "back orders"). To enable this, simply edit a product in Wix and turn on the Pre-order setting as shown below.  Once enabled, this will then show a message to the B2B customer on the product page and allow purchasing.  ::: :::::ExpandableHeading **Enabling Sales Agents** SparkLayer has full support for the [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) feature on Wix, letting your sales team login and place orders on behalf of your B2B customers. You can learn more about how it works in [our guide here](docId\:Uw8mDbMEfwWKqZrVB5CqX). :::hint{type="info"} **Please note** To setup a sales agent, you'll first need to ensure your SparkLayer plan supports this. ::: ::::WorkflowBlock :::WorkflowBlockItem To get started, you'll first need to set up a Contact in Wix and ensure they have a full address added and a label of `b2b` added. Next, you'll need to copy the unique contact ID which you can retreive via the browser URL.  ::: :::WorkflowBlockItem Within the SparkLayer Dashboard, go to the [Sales Agent area](https://app.sparklayer.io/sales-agents) and paste in the contact ID ::: :::WorkflowBlockItem You can then specify which role you'd like to assign to their account. You can learn more about how it works in [our guide here](docId\:Uw8mDbMEfwWKqZrVB5CqX).  ::: :::: ::::: *** ## 📁 Troubleshooting To troubleshoot the most common issues (such as issues with pricing), please see [our guide here](docId\:BlCEkkx3I30nkUcglsfw7). You can also [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to assist. *** ## ℹ️ Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for Wix?** All SparkLayer plans are compatible with Wix, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via your Wix admin and processed monthly or annually if you've selected this option. ::: ### Wix setup :::ExpandableHeading **Where do I find the SparkLayer Wix app?** You can find the official SparkLayer for Wix app in the [Wix App Market](https://www.wix.com/app-market/search-result?query=sparklayer). ::: :::ExpandableHeading **What Wix plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of Wix. All you need is an active Wix store and you're good to go. ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing Wix DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.wix.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **Can you help me install SparkLayer on my Wix website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any Wix theme?** Yes! SparkLayer is compatible with all Wix themes. Once you install the SparkLayer app, our special B2B widgets are automatically added to your Wix store and you're good to go. ::: :::ExpandableHeading **How does SparkLayer affect my current Wix theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Wix store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the Wix checkout. From there, any payment methods you have set up in Wix (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if Wix support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: :::ExpandableHeading **Can I use multiple currencies for my B2B customers?** Currently, Wix [doesn't allow](https://support.wix.com/en/article/wix-stores-request-selling-in-multiple-currencies) a Wix store to accept multiple currencies (e.g. USD, EUR, GBP etc). If you do set up multiple currencies within SparkLayer in the [Price List section](https://app.sparklayer.io/pricing/lists), it's important to note the following: - Customers will see the correct currency when browser your store as a logged in B2B customer. The price they see will be the currency exchange rate at that time - If they proceed to place an order in a different currency to your Wix store's default currency, this will create an order however the pricing will show in your default currency. We've illustrated this below  How the order shows in Wix. Note how the totals are the same but the currency (EUR) has defaulted to the Wix store currency (£ GBP)  ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. Within Wix, you can set pages to have **Permissions** for **Site members**. You create a **Member Role** of `B2B Customers` and then assign this to specific pages on your Wix website. You can see [their full guide here](https://support.wix.com/en/article/wix-stores-creating-restricted-store-pages).  If you wanted to show special B2B-only products, you would need to create these as separate products within Wix (i.e. with unique SKUs, etc) With SparkLayer pricing, if you don't upload a price against a SKU, the B2B customer** won't be able to purchase it.** So this is a way to prevent them from adding items you don't want them to purchase ::: :::ExpandableHeading **How do I hide prices on my regular (B2C) Wix store? ** Within your Wix store, you can easily hide the regular (B2C) retail price from showing. This is a great way to make your Wix store "B2B only" and only show prices once a customer signs in. To view more details on how to do this, please see the [official Wix guide here](https://support.wix.com/en/article/wix-stores-hiding-product-prices). ::: :::ExpandableHeading **Can I use my Wix prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Wix prices (e.g. your main Wix retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Wix prices and we can even make provisions for your tax set up in Wix (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within Wix, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Wix so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Wix, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Wix 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Wix to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. Wix [have a guide here](https://support.wix.com/en/article/wix-forms-an-overview) on ways to do this. It's also worth noting that you can manually add customers via the admin by going to **Customers & Leads > Contacts** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. One of the easiest ways is to use the built-in Wix messaging system to simply notify your customer to sign in and begin placing orders. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You'll see a tab called **Inbox** that allows you to send direct messages.  You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You can then search and filter your customers and click **Send Email Campaign** to send an email.  We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my Wix website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my Wix website?** We recommend consulting with a Wix expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in Wix?** | Payment Method | Notes | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by Invoice` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Payment on Account` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Request for Quote` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Upfront Payment (Card payments)` | The order will be created within **Sales > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. | ::: :::ExpandableHeading **Why do orders show up as "Awaiting Merchant"?** When a B2B customer first places an order, it will show as **Awaiting Merchant** when they view it in their [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP). This status means that the order requires the merchant (the Wix store owner) to view the order and then confirm payment (e.g. such as sending the customer an invoice or arranging payment via other means). Once you then mark the order as paid within Wix, this will then update the order status from **Awaiting Merchan**t to **Processing** and you can then fulfil the order as normal.   ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within Wix when an order is placed via SparkLayer providing payment hasn't already been processed. From your Wix Dashboard, navigate to an order and click the **More Actions** button. You'll then see the option to **Edit order** allowing you to make changes.  ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly but there are some good ways to do this within Wix. When viewing an order within your Wix Dashboard, you'll see the option to **Create Invoice** under **More Actions**. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal.  ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** You can manage notifications and emails that are sent by going to your Wix Dashboard, clicking **Settings** and then **Outgoing Notifications**. ::: :::hint{type="info"} **Need assistance?** We'd be happy to help guide you through this process. Please refer to [our guide here](docId\:NNUw1G9z7eaJ4M78vk7t9) ::: [title] WooCommerce [path] Integrations/ ## Introduction :::hint{type="info"} **Join our Early Access programme** We're launching WooCommerce immentently on SparkLayer. If you'd like to be one of the first to access it, please email *support\@sparklayer.io* and our team will be in touch. ::: SparkLayer is the powerful platform that transforms your existing WooCommerce website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed SparkLayer on your WooCommerce store SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your WooCommerce store. The best part is you can retain your *existing* WooCommerce store design and layout and enable B2B alongside your retail operation (DTC). ## Supported WooCommerce Plans  SparkLayer works with WooCommerce version 9 and above and Wordpress version 6 and above. *** ## WooCommerce Demo Store Want to see SparkLayer & WooCommerce in action? Try it out on our WooCommerce demo store using the details below: | Item | Details | | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Login URL | [demo.woocommerce.sparklayer.io/ ](https://demo.woocommerce.sparklayer.io/my-account/)This is an example DTC + B2B store. To login as a B2B customer, [go to this link](https://demo.woocommerce.sparklayer.io/my-account/) and use the credentials below. | | Username | woocommerce\@sparklayer.io | | Password | I6qxPvpww42#3hsz0hTC%U2b | *** ## Get started ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Installing SparkLayer on WooCommerce](docId:1GjKXB51dfFbw2rbsYxuH) Learn about the steps to install SparkLayer on your WooCommerce store ::: :::LinkArrayItem [WooCommerce Metafields & Data Mapping](docId\:DL0CTVwncNk8ZGJmYihy4) Learn how to use the powerful WooCommerce metafields feature ::: :::LinkArrayItem [WooCommerce FAQs](docId\:laOn_6ALBpQigc7rIvb5v) See some of our most commonly asked questions! ::: :::: [title] Intuitive Shipping [path] Integrations/Customer Experience/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to Intuitive Shipping - Platform: Merchants must be using Shopify or BigCommerce ::: ## Introduction [Intuitive Shipping](https://intuitiveshipping.com/) is a leading shipping solution major eCommerce platforms such as Shopify and BigCommerce, allowing merchants to manage powerful shipping rules for their online store. In the context of SparkLayer, it's possible to integrate Intuitive Shipping seamlessly within the checkout, allowing B2B customers to view shipping rates specific to them. *** ## Configuring on SparkLayer :::hint{type="warning"} **Please note the following before starting** - Your Shopify store must already have the [Intuitive Shipping app](https://apps.shopify.com/intuitive-shipping) installed before enabling this feature. - You must turn on the [SparkLayer shipping system](https://app.sparklayer.io/configuration/shipping) - this will disable showing shipping methods from your eCommerce platform that you do not want to show ::: Once the Intuitive Shipping app has has been installed on your store, you're ready to activate it on SparkLayer! Within the [SparkLayer Dashboard](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard), go to the **Integrations** section and click **Partner Integrations.** Under **Shipping**, click the toggle on the right to activate the Intuitive Shipping integration. You'll then be prompted to enter an **API Key** to complete the setup. You can retrieve this within your Intuitive Shipping Dashboard by going to **Settings**, going to **Partner Integrations** and copying the **API Key**.  This completes the set up process and you can follow the below steps to test the integration. - Log in to your Shopify store as a B2B customer - Go through the checkout process until you reach the "Review & Pay step" - The available shipping methods will correlate with those setup in the Intuitive Shipping Dashboard  *** ## Known limitations Please note the following: - The integration will not factor in any "Shipping dates" configured in Intuitive Shipping - The integration will only work for physical products (i.e. not digital products) - Pricing will always be displayed in net pricing (excluding tax) [title] Installing SparkLayer on Magento [path] Integrations/Magento/ ## Introduction SparkLayer enables B2B functionality on your existing Magento store, allowing your B2B customers to login, place orders, manage their account, and much more.  To familiarise yourself with SparkLayer, we also recommend reviewing the following guides: ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [How SparkLayer Works](docId:_2g8HwCXnN7OFy4o199y1) The fundamentals of what SparkLayer does ::: :::LinkArrayItem [Frontend](docId\:OgKfvQX13dHW2582D57kJ) The special "interfaces" SparkLayer enables ::: :::LinkArrayItem [Features](docId\:SSzdKXuNMlEIDOOITHQcU) The available features and functions. ::: :::: *** ## ⚠️ Requirements - important! Before installing SparkLayer on your Magento store, please ensure the following: | Item | Details | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Magento` | You must be using one of the following Magento versions.
* Magento Open Source - version 2.4.2 or later * Adobe Commerce - version 2.4.2 or later
The Multi-Stock Inventory module should be enabled (this should be the case on most Magento installs by default). | | `Product SKUs` | In order for SparkLayer to save B2B prices for your products, all products must have **SKUs**. | | `Customers` | For your B2B customers to see the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa), they must be assigned an appropriate B2B "Role" within Wordpress > users | | `Payment Processor` | If you’re installing SparkLayer on a test store, please ensure you have an example payment method enabled. You can manage this within **Magento > Sales > Payment Services** | | `Shipping` | In order to place an order via the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), please ensure you have shipping rules set up. You can manage this within Magento under **Stores >Configuration > Delivery Methods** or via SparkLayer's own [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) solution | | `Theme` | You have a technical Magento partner or developer to integrate the SparkLayer Magento module with your theme. Luma and Luma based themes are automatically supported by the SparkLayer module. Other themes will need manual integration work to ensure SparkLayer web components are output instead of normal magento PDP/PLP cards, the SparkLayer script is loaded for B2B customers, and customer authentication is connected to the SparkLayer script. | **Areas of Magento you'll be using** As part of setting up SparkLayer, you'll primarily be using the following areas: | Area | Details | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Catalog` | This will be used to setup which products you want to make available to B2B customers. See "Setting up your B2B pricing" below. | | `Customers` | This will be used to setup your B2B customers. See "Setting up your B2B customers" below | | `Sales` | This will be used to review and process and orders that are placed by your B2B customers. See "Placing a B2B order" below.
*In Magento, go to Orders* | *** ## 🔗 Connecting your Magento store :::hint{type="info"} **Please note** Setting up SparkLayer will require generating API keys within your Magento store. If you're unsure how to do this, our team is happy to assist. To get in touch, please [click here](docId\:NNUw1G9z7eaJ4M78vk7t9). ::: To get started with SparkLayer on your Magento store, there are a number of steps to follow. Once you've completed this step, you can then begin the process of configuring SparkLayer such as pricing and customer rules. ::::WorkflowBlock :::WorkflowBlockItem **Install the SparkLayer Magento module and create an Integration** First, you'll need to install the SparkLayer for Magento module on your store. Please get in touch with your SparkLayer Account Manager for access to the module. Once installed, open the SparkLayer B2B module tab in the Magento admin, and create an integration for the correct Magento store by clicking the "Create and Activate Integration" button:  Then go to Stores > Configuration > SparkLayer > B2B and ensure the "Enabled" option is set to "Yes" for your store:  ::: :::WorkflowBlockItem **Access the Integration API credentials** Next, you'll need to access the SparkLayer Integration API credentials within Magento. From your Magento admin dashboard, you can find this within System > Integrations > SparkLayer B2B for "your store name" > Edit > Integration Details. You will need these credentials to in the following steps to connect and authorise your SparkLayer account to connect to the Magento store.  ::: :::WorkflowBlockItem **Register with SparkLayer** Next, you'll need to create a SparkLayer account by [registering here](http://app.sparklayer.io/register) ::: :::WorkflowBlockItem **Connect your Magento Store** Once registered, go to [Integrations > Platform Connection](https://app.sparklayer.io/integrations/platform) and select Magento. You'll then be prompted to enter your store URL (this should be the URL of the website you are installing SparkLayer on, e.g. `www.mystore.com`) ::: :::WorkflowBlockItem **Enter the API credentials in SparkLayer** From with the SparkLayer Dashboard [Integrations > Platform Connection](https://app.sparklayer.io/integrations/platform) paste the provided credentials from the earlier step. Press save and wait a few seconds whilst SparkLayer connects to the Magento store and performs the SparkLayer plugin initialisation. ::: :::WorkflowBlockItem **Store connected** This completes the process of connecting your Magento store to SparkLayer! ::: :::: *** ## 🚢 The Onboarding process :::hint{type="info"} **Important** When setting up SparkLayer, some activities take place via the [SparkLayer Dashboard](https://app.sparklayer.io/) alongside Magento. You'll use the SparkLayer Dashboard primarily for setting up your B2B pricing and B2B customer rules. ::: When you create an account on SparkLayer, you'll get access to the [SparkLayer Dashboard](https://app.sparklayer.io/). The Dashboard has a customised onboarding process that gently guides you through all the necessary steps before you're ready to start inviting your B2B customers and taking orders on your website. ::::WorkflowBlock :::WorkflowBlockItem **📓 Setting up your B2B price lists** You'll then set up the B2B price lists that you want your customers to see when they login. These can be automated or you can manually upload specific pricing. ➡️ [View in dashboard](https://app.sparklayer.io/pricing) ::: :::WorkflowBlockItem **👪 Setting up your B2B customers** You'll then set the ordering rules for your customers such as minimum order values, available payment methods and price lists they are assigned to. ➡️ [View in dashboard](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem **🛠️ Installing the frontend widgets** You'll need to check the special code snippets ("widgets") are installed on your Magento store in order to show the special SparkLayer B2B interfaces. ➡️ [View in dashboard](https://app.sparklayer.io/integrations/widgets/core) ::: :::WorkflowBlockItem **✅ Testing & launching** You'll then need to run through some final checks (such as placing a test order). Once you're happy, you can then launch SparkLayer and start taking orders! ➡️ [View in dashboard](https://app.sparklayer.io/configuration/onboarding) ::: :::: *** ## 📓 Setting up your B2B pricing :::hint{type="warning"} **Please note** Setting up your B2B pricing happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your Magento admin. ::: Within the [Price Lists](https://app.sparklayer.io/pricing) area of the SparkLayer Dashboard, you can create and manage your B2B pricing rules.  SparkLayer allows you to set the following pricing types: | Type | Details | | ----------- | ------------------------------------------------------------------------------------------------------------------- | | `Manual` | You can manually upload a CSV file with specific prices and even enable quantity pricing | | `Automatic` | You can use your Magento prices and apply a discount. You can choose from your main Magento price or the RRP price. | ::::WorkflowBlock :::WorkflowBlockItem For any products that you want your B2B customers to be able to buy, these products **must** have unique SKUs assigned. In Magento, you can check this by going to **Catalog** and editing a product.  ::: :::WorkflowBlockItem Next, go to [Price Lists](https://app.sparklayer.io/pricing/lists) within SparkLayer and click "Create Price List" to create your first B2B Price list. You can choose between an automatic or manual price list and configure how this works. ::: :::: :::hint{type="success"} **Ready to set your pricing?** To learn more about pricing, please see our [full guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: *** ## 👪 Setting up your B2B customers :::hint{type="warning"} **Please note** Setting up your B2B customer rules happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your Magento admin. ::: [Customer Groups](https://app.sparklayer.io/customers/groups) let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out. Much like with Price Lists, you can fully manage this via the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups). ::::WorkflowBlock :::WorkflowBlockItem Within SparkLayer, create a customer group. You can follow our guide, [Customer Groups](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem SparkLayer will sync any customer groups you create into Magento as a "Group" which can then be assigned to individual customers with Magento. Groups synced from SparkLayer will be automatically prefixed with "B2B".  ::: :::WorkflowBlockItem Once your customers have been set up in Magento (i.e. those with a B2B group assigned), and you've assigned the customer group to **at least** one customer, you can then manage specific rules within the [Customer groups area.](https://app.sparklayer.io/customers/groups)  ::: :::WorkflowBlockItem You'll see a default **Base** customer group that you can use for your B2B customers. If you want to set up additional rules, you can simply click **Create Customer Group** and configure accordingly. For any additional customer groups you create, you'll need to update the role on the customer record in Wordpress/Magento to match. ::: :::WorkflowBlockItem To simulate logging in as a B2B customer, please see **✅ Testing & launching** below. ::: :::WorkflowBlockItem You can also check if your customer record is syncing by using the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. Within Magento, navigate to the Customers section, search for a customer, and note the ID. With this unique ID, you can then paste this into the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. If the search results show the customer details, this confirms the customer is synchronising correctly. ::: :::: :::hint{type="success"} **Ready to configure your customer groups?** To learn more about customer groups, please see our [full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: *** ## 🛠️ Installing the frontend widgets SparkLayer comes with ready-made B2B-optimised "widgets" that we collectively call the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ). The widgets simply overlay sections of your existing Magento store and enable our powerful B2B features.  Once set up, your approved B2B customers (see above "Setting up your B2B customers") will then see your B2B pricing and can begin placing orders. You can learn more about how this works in [our guide here](docId\:ccZ1vnH0O6D_722w35Xpa). **Installing SparkLayer widgets** :::hint{type="warning"} **Please note** Due to the nature of high level of customisation of many Magento stores and themes, you will need a Magento developer to install and integrate the SparkLayer frontend core scripts and widgets. ::: The SparkLayer Magento module provides out-of-the-box setup for the Magento Luma theme (which should work for any luma based themes). Your developers can use this implementation as a reference of how to set this up. To enable the frontend integration on your store for Luma based themes go to Stores > Configuration > SparkLayer > B2B in the Magento Admin dashboard, and enable the Frontend Widgets option which will automatically add the required frontend integration setup:  **Steps required to integrate the SparkLayer frontend widgets:** ::::::WorkflowBlock :::WorkflowBlockItem **Install the **[SparkLayer Core Script ](https://app.sparklayer.io/configuration/frontend/core)Within your main website header you'll need to add the SparkLayer Core Script that activates the SparkLayer functionality when a customer tagged with a SparkLayer B2B group is logged in. ::: :::::WorkflowBlockItem **Install the **[Product Detail Interface](https://app.sparklayer.io/configuration/frontend/pdp) You'll need to update your storefront's product detail page with the SparkLayer Product Purchasing Interface. When a customer logs in and SparkLayer recognises them as being a B2B customer, this will load a special interface with their specific prices and a way to purchase. ::::ExpandableHeading **🛠️ View instructions** ```javascript
This will allow the customer to checkout **without** needing to enter any payment details. | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details. | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). | **How orders arrive into Magento** Depending on which [payment method](docId\:ibIKczvHM085BkeJIfFYv) you've selected, orders will arrive into Magento in the following ways: | Payment Method | Flow | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Pay by Invoice` | The order will be created within ** Magento > Sales** with a payment status of "Pending". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay on Account` | The order will be created within ** Magento > Sales** with a payment status of "Pending". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay Online by Card` | The order will be created within **Magento > Sales** with a payment status of "Processing" providing you have this already configured within Magento. You can then proceed to fulfil the order. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | **"Unpaid" orders and "Paid" orders** By default **all payment methods** other than Upfront Payment will be generated as "Pending" orders. You will need to capture payment either via your Magento Admin or via offline methods (e.g. bank transfer) **Magento checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the Magento checkout. By default, they will see all Magento payment methods you have set up (e.g. card payment, Paypal, etc). **Additional order details** When an order is placed via SparkLayer, it will also include additional data within an order under **SparkLayer Order Information**.  *** ## ✅ Testing & launching The final step is to run some tests and checks to ensure SparkLayer is fully configured. Within the SparkLayer Dashboard, you'll see a number of [Launch checks](https://app.sparklayer.io/?expand=launch) to perform, from logging in as a B2B customer, through to placing an order. We recommend following the below steps: ::::WorkflowBlock :::WorkflowBlockItem **Set up a customer record** Within your Magento admin, you'll need to ensure you have an example customer record set up (either a new one or an existing). Most importantly, a customer must be associated with an appropriate role. *Please see "Setting up your B2B customers" above for more details on how this works.* ::: :::WorkflowBlockItem **Place a test order** Once you've logged in as a B2B customer, proceed to add items to your cart and complete the checkout. Please see *"Placing a B2B order"* above for more details on how this works. ::: :::WorkflowBlockItem **Invite your customers** You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::: *** ## ⚙️ Advanced configurations In addition to the above setup, there are a number of other configurations that are possible at this time. :::ExpandableHeading **Displaying stock (inventory) levels** You can configure SparkLayer to show [stock levels](docId\:Gj_Ao_gQ6oA-jx0D27Hys) in a variety of ways. If you want to show inventory numbers (e.g. 100), you'll need to make sure this is turned on within Magento. Within Magento, go to Stores> Configuration > Inventory and turn on **Manage Stock** ::: :::ExpandableHeading **Adjusting tax settings** SparkLayer supports tax calculations and simply 'inherits' the rules you've set up in your Magento settings. ::: :::ExpandableHeading **Enabling SparkLayer JavaScript modifications (e.g. checkout customer fields, language updates)** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Magento theme store. Within the "Core Script Options" you can add the below code. ```javascript { termsAndConditionsLink: "/policies/terms-of-service", checkoutCustomElements: [ { name: 'shipping-date', translations: { en: { title: 'Preferred Shipping Date', detail: 'Shipping unavailable on weekends.', }, }, attributes: { required: true, type: 'date', }, }, ], } ``` ::: :::ExpandableHeading **Enabling a URL redirect when signing in ** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Wix store. Under **"Core Script Options"** you can add the below code. ```javascript { accountRedirect: { urlRegex: /\/account/g, goTo: "/index", // page to redirect logged in users to }, } ``` ::: :::ExpandableHeading **Enabling "Dark mode" for high contract websites** If your Magento store is set up with a darker theme, it's possible to enable a special "Dark Mode" for SparkLayer, ensuring colours and fonts are easily readable.  Under **"Core Script Options"** you can add the below code. ```javascript { display: { darkTheme: true, }, } ``` ::: :::ExpandableHeading **Enabling SparkLayer shipping methods** SparkLayer has a built-in [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) system that lets you customise how shipping works for your B2B customers. By default, your existing shipping methods in your Magento store will be used, however it's possible to update this to use SparkLayer via the [SparkLayer Dashboard here](https://app.sparklayer.io/configuration/shipping). ::: :::ExpandableHeading **Enabling pre-order (or "back orders")** SparkLayer has built-in support for pre-orders (someimtes referred to as "back orders"). Once enabled, this will then show a message to the B2B customer on the product page and allow purchasing.  ::: *** ## 📁 Troubleshooting To troubleshoot the most common issues (such as issues with pricing), please see [our guide here](docId\:BlCEkkx3I30nkUcglsfw7). You can also [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to assist. *** ## ℹ️ Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for Magento?** Our "Enterprise" plan is required to use the SparkLayer Magento integration. [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via the SparkLayer Dashboard under Acccount > Plan ::: ### Magento setup :::ExpandableHeading **Where do I find the SparkLayer Magento module?** Please get in touch with our support team to get access to the SparkLayer Magento module. ::: :::ExpandableHeading **What Magento plan do I need to be on to use SparkLayer?** SparkLayer supports the following Magento Plans - Magento Open Source (version 2.4.2+) - Adobe Commerce (Cloud, version 2.4.2+) ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing Magento DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.woocommerce.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **How does SparkLayer affect my current Magento theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Magento store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will be taken to our Magento payment methods checkout. From there, any payment methods you have set up in Magento (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if Magento support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. You could also configure your Magento theme to hide and show products based on tag via custom coding. ::: :::ExpandableHeading **Can I use my Magento prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Magento prices (e.g. your main Magento retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Magento prices and we can even make provisions for your tax set up in Magento (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Magento so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Magento, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Magento 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Magento to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. It's also worth noting that you can manually add customers via the admin by going to **Magento > Customers** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. You could think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my Magento website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my Magento website?** This is possible but would require custom coding. We recommend consulting with a Magento expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within Magento when an order is placed via SparkLayer providing payment hasn't already been processed. From Magento > Sales, navigate to an order. You'll then see the option to **Edit order** allowing you to make changes. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: [title] BigCommerce [path] Integrations/ ## Introduction SparkLayer is the powerful platform that transforms your existing BigCommerce website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed the [official SparkLayer for BigCommerce app](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/), SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your BigCommerce store. The best part is you can retain your *existing* BigCommerce store design and layout and enable B2B alongside your retail operation (DTC). ## Supported BigCommerce Plans  SparkLayer requires Customer Groups to work. BigCommerce *Plus* through to BigCommerce *Enterprise *is supported. *** ## BigCommerce Demo Store ::embed[]{url="https://youtu.be/6QCPV7_V_Ps"} Want to see SparkLayer & BigCommerce in action? Try it out on our BigCommerce demo store using the details below: | Item | Details | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Login URL | [](https://demo.bigcommerce.sparklayer.io/login.php)
This is an example DTC + B2B store. To login as a B2B customer, [go to this link](https://demo.bigcommerce.sparklayer.io/login.php) and use the credentials below. | | Username | bigcommerce+user\@sparklayer.io | | Password | Spark123^7\&jj1 | | App store listing | [SparkLayer BigCommerce App](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/) | *** ## Get started ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Installing SparkLayer on BigCommerce](docId\:x6xahBJ_9KYJTHD80_1QH) Learn about the steps to install SparkLayer on your BigCommerce store ::: :::LinkArrayItem [BigCommerce Metafields & Data Mapping](docId\:bkHor8d6QhgZX_yxsdt56) Learn how to use the powerful BigCommerce metafields feature ::: :::LinkArrayItem [BigCommerce FAQs](docId\:KZrw-fFscozjvGMLwPoIB) See some of our most commonly asked questions! ::: :::: [title] Shopify B2B Store Setup [path] Integrations/Shopify/Shopify Customisations/ ## Standalone vs Hybrid  When you're in the process of setting up your Shopify B2B store, there are two ways to go about this: 1. Set up as a **new** standalone Shopify store 2. Enable wholesale functionality on **existing** Shopify store Both have positives and negatives and it's ultimately a business decision as to which is the best route to take. :::hint{type="info" attributes="[object Object]"} **Considerations to bear in mind** A major benefit of SparkLayer is being able to integrate it without needing to duplicate stores. If you're looking to implement SparkLayer in this way, it's important to consider the following: - **Stock and warehouses:** currently, it's not possible to route B2B orders to use specific stock locations in Shopify when using the checkout. This means that, if you're installing SparkLayer on your main Shopify store, B2B orders will need to **share the same stock pool**. This can have knock-on effects on stock allocation and the impact needs to be carefully considered. - **Verify your apps***:* Do you have any apps installed that may interfere with the B2B experience? E.g. apps that send 'leave a review' emails or any post-purchase follow ups. Many will allow you to exclude interactions based on customer tags; remember, all customers that use SparkLayer will have a tag of `b2b` assigned. - **Analytics and reporting**: SparkLayer will show in Shopify as a **Sales Channel** called **SparkLayer B2B & Wholesale** which makes it easy to split out your reports. Within Shopify, you should be able to segment data (e.g. Orders) by this Sales channel - **Affiliate and tracking pixels:** your Shopify site and Shopify checkout may have special tracking code installed to monitor sales; you'll need to make sure this is excluded for B2B customers (e.g. by filtering out any customers that have a tag of `b2b`). This will likely require input from a Shopify developer so consideration will need to be given. [Learn more](https://help.shopify.com/en/manual/orders/status-tracking/customize-order-status#add-additional-scripts) ::: *** ## Creating an additional store It may be necessary to create a **separate** Shopify store to manage your B2B channel. Although this may sound daunting, the good news is it's relatively straightforward to set up and you can automate a lot of the process. The most common reasons why you'd create a secondary Shopify store include: - **Stock levels:** You need to separate out your B2B stock from your DTC - **Products:** You want to create a totally different product catalogue for your B2B customers - **Integrations**: you need to integrate your B2B channel with a different system and keep it separate from your DTC channel - **Website URL**: you need to create a separate website URL to access the store such as `b2b.yourstore.com`. Our recommended approach is as follows: 1. **Set up your main B2B store.** This will mean installing SparkLayer, and then configuring and customising your Shopify store as you require. For example, setting up a storefront theme, customising the homepage and product pages, etc. 2. **Set up your storefront theme**. It's likely you'll want these to use the same design, so the first step is to export your theme from your main B2B store and import it into your additional stores. [This Shopify guide](https://help.shopify.com/en/manual/online-store/themes/managing-themes/downloading-themes) shows you how to do this. 3. **Install SparkLayer on your additional stores**. Just as with your main store, you will need to install SparkLayer on each additional store. We're happy to assist in this process and also discuss a combined pricing rate. 4. **Synchronise your data**. The final step is to set up a mechanism to synchronise data between all your stores. This can include product data, CMS content, even orders. We recommend two highly rated Shopify apps to do this: [Matrixify](https://apps.shopify.com/excel-export-import) and [Syncio](https://apps.shopify.com/syncio). It's likely that you will need someone with Shopify expertise to help in this process and we are happy to advise where possible. [title] Shopify Flow for B2B [path] Integrations/Shopify/Shopify Customisations/ ## Introduction  [Shopify Flow ](https://help.shopify.com/en/manual/shopify-plus/flow)is powerful feature for merchants on the Shopify, Advance, or Shopify Plus plans that allow automations to be configured based on certain actions. We've included some additional ready made **Shopify Flow workflows** that you can [import](https://help.shopify.com/en/manual/shopify-plus/flow/create-workflow/import-export#import-workflows) into your Shopify admin. *** ## Order automations | Trigger | Details | Download | | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `Mark order as paid` | When a B2B customer places an order via manual payment methods, the order will automatically be marked as paid | [Download](https://cdn.shopify.com/s/files/1/0565/7500/0728/files/Mark_B2B_orders_as_paid_0a29877b-9fb6-4d8a-9f10-ca27ba055b66.flow?v=1635839553) | | `Mark Payment on Account order as paid` | When a B2B customer places an order specifically via "Payment on Account", the order will automatically be marked as paid | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Mark_B2B__Payment_on_Account__orders_as_paid.flow?v=1710337044) | | `Archive B2B orders` | Automatically archive B2B orders from your Shopify Orders view; useful if you want to hide them from your standard DTC orders | [Download](https://cdn.shopify.com/s/files/1/0565/7500/0728/files/Archive_B2B_Orders.flow?v=1635838493) | | `Tag pre-orders` | Set up a rule to tag an order when pre-order products are purchased | [Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) | | `Tag order with the net terms applicable to the customer` | Based on the [net terms](docId\:yWm70oQUosyKOoIqb4Z4G) that are set against the customer (via a metafield), this will then automatically tag their orders with a special Net Terms tag. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Tag_order_with_what_net_terms_the_customer_is_on.flow?v=1722499862) | | `Populate order metafield from custom checkout fields` | When using [customer checkout fields](docId\:o3nDhZBCxisWH6M6satDt) (e.g. a date selector), this will pull the data from the draft order and populate metafields on the completed order. | [Download](https://cdn.shopify.com/s/files/1/0631/8453/5705/files/Update_order_Metafield_with_SparkLayer_Custom_Attributes_1.flow?v=1754639426) | | `Control B2B Order Fulfilment Flow` | Automatically route orders from your wholesale customer group to a specific stock location for fulfilment in Shopify. This works with the Shopify Stock Location feature to ensure B2B orders are handled separately from standard (B2C) flows. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_Fulfilment_location_11.flow?v=1760365759) | *** ## Customer automations | Trigger | Details | Download | | ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Switch tag on first order` | When a B2B customer places their first order, replace their existing tag with a new one and send an internal email | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_-_switch_tag_assigned_to_a_B2B_customer_after_their_first_order_acb41199-9408-48f9-8e5e-f1228e836ceb.flow?v=1714641440) | | `Automatically adjust customer tag for customer group depending on spend` | If you have different customer groups (e.g. Gold, Silver, Bronze), you can automatically update the customer's tag based on their order spend. This allows you to automatically change a customer's B2B group. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Automatically_adjust_customer_tag_for_customer_group_depending_on_spend.flow?v=1722499466) | *** ## Product automations | Trigger | Details | Download | | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Remove restock date in metafield when variant back in stock` | If you're using [pre-orders](docId\:Gj_Ao_gQ6oA-jx0D27Hys) and you've set a restock date, this automation removes the restock date when the product comes back in stock. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Remove_restock_date_in_metafield_when_variant_back_in_stock.flow?v=1722499600) | | `Automatically mark new products with B2B ordering & Online store sales channels` | When adding new products to your Shopify store, this will automatically assign the B2B Ordering and Online Store sales channel | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Automatically_mark_new_products_with_B2B_ordering_Online_store_sales_channels.flow?v=1722499725) | | `Add RRP metafield when product status updated` | When a product’s status changes, this automation adds the RRP metafield if it doesn’t already exist. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Add_RRP_when_product_status_updated.flow?v=1772815525) | | `Update RRP metafield when product updated` | When a product is updated, this automation updates the RRP metafield to ensure the value stays in sync. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Update_RRP_Metafield_when_product_updated.flow?v=1772815525) | *** ## Email automations | Trigger | Details | Download | | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Send an email with order details` | Send an email to a specified email address when a B2B customer places an order via a specific B2B payment status; great if you need to notify other members of your team who handle B2B accounts (see below) | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_-_Draft_order-_Send_email_to_verify_the_order.flow?v=1762519098) | | `Send notification based on custom checkout fields (Draft Orders)` | Based on specific [custom checkout fields](docId\:o3nDhZBCxisWH6M6satDt), trigger an action such as an internal email | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_-_Draft_Checkout_Custom_Attributes_-_Send_email_based_on_criteria.flow?v=1717486893) | | `Send notification based on custom checkout fields (Completed Orders)` | Based on specific [custom checkout fields](docId\:o3nDhZBCxisWH6M6satDt), trigger an action such as an internal email | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_-_Completed_Order_Checkout_Custom_Attributes_-_Send_email_based_on_criteria.flow?v=1717486893) | | ` Email sales agent when order placed by customer` | Based on specific rules you set, you can send notifications to sales agents when an order is placed. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Sales_Agents_-_Email_sales_agent_when_order_placed_by_customer.flow?v=1726494991) | Using Shopify Flow, you can modify the contents of the email to include dynamic content. In the example below (*Send an email with order details*), customer details and order details are included and sent to a specific email address.  [title] Katana [path] Integrations/ERPs & Operations/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to the Professional or Enterprise plan - Platform: Merchants must be using Shopify ::: ## Introduction Katana is a manufacturing ERP that gives you a live look at all the moving parts of your business - sales, inventory, and production. You can learn more about Katana [here.](http://brightpearl.com/) *** ## How it works The Katana integration for SparkLayer is available for all Shopify merchants that already use Katana and allows you to bring **B2B pricing** to your Shopify store. The integration works in the following ways: | Item | Details | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customers` | Katana becomes the 'master' of your B2B customer data, and any changes to tagged customer records will automatically be synchronised to Shopify and SparkLayer. | | `Product Pricing` | Price lists and product prices are imported into SparkLayer via pricing rules you set up in Katana | *** ## Configuring on SparkLayer To configure Katana on SparkLayer, you'll need to have an approved account with Katana. Please visit the [Katana website](http://katanamrp.com/) to learn more. To get started using Katana on SparkLayer, you'll first need to enable the integration. Within the [SparkLayer Dashboard](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard), go to the **Integrations** section and click **Partner Integrations**. Under **Multi-channel management**, click the toggle on the right to activate the Katana integration. You'll then be prompted to authorise SparkLayer to access your Katana account. *** ## Configuring Customers Broadly speaking, Katana is your **central location **for managing B2B customer data. When customers are configured in Katana as B2B customers, SparkLayer can automatically retrieve this data and then enable the B2B ordering experience on your Shopify site. You can then create specific rules for this customer group, e.g. minimum orders, price lists, via the [Customer Group](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard/settings#customer-groups) section within SparkLayer. :::ExpandableHeading **Step 1 - Customer mapping** Customers are mapped between the systems based on the **primary email** set within Katana. Once this is mapped, SparkLayer will then synchronise the following data into Shopify. | **Katana** | **Shopify / SparkLayer** | | ------------------- | -------------------------------------------------------------------- | | `Address` | Shows against customer record in Shopify | | `Primary Telephone` | Shows against customer record in Shopify | | `First / Last Name` | Shows against customer record in Shopify | | `Customer Category` | Shows against customer record in Shopify - matches to customer group | | `Company Name` | Shown via metafields in Shopify | | `Discount Rate` | Shown via metafields in Shopify | | `Price List` | Shown via metafields in Shopify | ::: :::ExpandableHeading **Step 2 - Adding new B2B customers** Katana will be the **central source for your customer data**. When creating a new customer in Katana and you want to set them up as a wholesale customer through SparkLayer, you will need to assign them to a Catagory which should match the **Customer group tag** of the group you want to assign them to. For example, if you want to assign them to the below **B2B - Canada** customer group. The Category name in Katana would be `b2b-ca`  In our example, the Category name in the customer in Katana is set to match `b2b-ca` When new customer records are added to Shopify, they will by default be added as **Pending** customer accounts and receive an **automatic email** to enable their account by setting a password.  This uses the **Customer account invite **notification email which can be edited in the Notifications section within Shopify. You can configure whether the email is sent or not from the SparkLayer Katana settings.  ::: *** ## Configuring Product Pricing Once customers are mapped between Katana and SparkLayer, the next step is to configure your B2B pricing. As with customers, Katana is your centralised source for managing your B2B pricing. :::ExpandableHeading **Step 1 - Setting up B2B pricing in Katana** Within Katana, go to **Price Lists**. To add a new price list, click the Add new price list button and complete as necessary.  In the example above, we've created two price lists; B2B and UKVIP. When creating your price list(s) in Katana, you'll be able to add pricing rules for products. In the example below, you can see pricing for the UKVIP price list.  In order for SparkLayer to map this data, price list records are **automatically** imported each time you add a price list in Katana. The mapping works as follows: | **Field name in SparkLayer** | **Field name in Katana** | | ---------------------------- | ------------------------ | | Handle / ID | Price list ID | | Name | Price list name | | Currency | Currency | Price lists will be made using the Katana's base currency. Automatic price lists with currency conversion will be created for customers that are given a different currency in Katana.  ::: *** ## Known limitations Please note the following: - Default addresses in Katana will be mapped to Shipping and Billing address in Shopify as Shopify doesn't support independent addresses. - A customer that is removed from the customer group will also need their allocated 'b2b' tag removed from their customer account in Shopfiy. - Addresses are a 1-way sync currently, from Katana into Shopify. Its recommended to not allow address editing in SparkLayer otherwise new addresses added won't appear in Katana. - Deleted pricing in Katana will not sync back to the Shopify. You will need to manually delete the pricing from the SparkLayer dashboard. *** ## Troubleshooting :::ExpandableHeading **Why isn’t my customer data syncing from Katana to Shopify?** - Confirm the primary email address is set in Katana; it's used for mapping. - Check that the SparkLayer integration has been authorised within Katana under **Configuration > Integrations > Partners**. ::: :::ExpandableHeading **Why are customer addresses not updating in Katana when edited in SparkLayer?** - Address sync is one-way: from Katana to Shopify. Changes made in SparkLayer will not reflect in Katana. - To maintain data consistency, it's recommended to disable address editing in SparkLayer. ::: :::ExpandableHeading **New customers in Katana aren’t appearing in Shopify. What should I check?** - Make sure the Katana integration is active and authorised. - Ensure new customers have all required fields, especially the email. - Check Shopify’s **Customer account invite** email settings to ensure invites are sent or disabled correctly via SparkLayer settings. ::: :::ExpandableHeading **My price list changes in Katana are not visible in SparkLayer. What might be wrong?** - Price lists must be created or updated directly in Katana. - Deleted pricing in Katana does **not** automatically sync — you must manually remove obsolete pricing from the SparkLayer Dashboard. ::: :::ExpandableHeading **Why is the wrong price showing for a B2B customer?** - Double-check that the customer is correctly assigned to the right price list in Katana. - Verify that customer has the correct currency assigned if using a different currency than the base. ::: :::ExpandableHeading **My new price list isn’t appearing in SparkLayer. What should I do?** - Confirm the price list has been properly saved in Katana. - Allow time for SparkLayer to auto-import the price list list. ::: :::ExpandableHeading **Where can I change the invite email that new customers receive?** - Go to Shopify Admin > Settings > Notifications, and edit the Customer account invite email template. - SparkLayer uses this template when enabling new accounts created from Katana. ::: [title] Wix Limitations [path] Integrations/Wix/ ## Introduction Currently, there are a number of limitations to be aware of with the SparkLayer and Wix Integration. | Item | Details | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product cards (Gallery)` | It is not possible to use the [Product Card Interface](docId\:Mrp_Z0QIZQ2QksseuJylv) on a Wix store. This means that if you're showing products on your store (e.g. the homepage or gallery page), **pricing will simply be hidden**. | | `Metafields` | SparkLayer does support [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) however it's not currently possible to set these up in Wix. This means that features such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [MSRP pricing](docId\:S_VTlJBorGmnwjjfSMom9), and others **are not available to use**.
In early 2025, Wix are likely to release functionality to better support this. | | `Customer syncing ` | SparkLayer will sync customer data from your Wix store into our system. It is important to note the following:
* Customer addresses are **only synced once** at the point where the `b2b` label is first added to a Wix Contact. * Any future updates to Wix Contact addresses actioned via the Wix Dashboard centre will not sync back to SparkLayer * It is possible to use the built-in [address book](docId\:lQXaNI7IVDqna09D9soAP) to add and edit addresses via the My Account area | | `Multi-currency` | Currently, Wix [doesn't allow](https://support.wix.com/en/article/wix-stores-request-selling-in-multiple-currencies) a Wix store to accept multiple currencies (e.g. USD, EUR, GBP etc).
If you do set up multiple currencies within SparkLayer in the [Price List section](https://app.sparklayer.io/pricing/lists), it's important to note the following:
* Customers will see the correct currency when browser your store as a logged in B2B customer. The price they see will be the currency exchange rate at that time * If they proceed to place an order in a different currency to your Wix store's default currency, this will create an order however the pricing will show in your default currency. | | `Checkout custom fields` | Currently, it is not possible to use [custom checkout fields with Wix](docId\:o3nDhZBCxisWH6M6satDt) by default. If you access to a developer, it is however possible to use custom fields using the API. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to learn more. | | `Additional fees` | SparkLayer does not currently support the Wix "additional fees" functionality ([learn more here](https://support.wix.com/en/article/wix-functions-adding-additional-fees-at-checkout)) | | `Pickup & local delivery` | SparkLayer does not currently support [Local Delivery](https://support.wix.com/en/article/wix-stores-setting-up-local-delivery) as a shipping option during the checkout. If you do require this as a shipping option, we suggest using the SparkLayer [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) tool and adding this as a 'manual' shipping method. | | `Subscriptions` | SparkLayer does not currently support subscription programmes within Wix | | `Loyalty` | SparkLayer does not currently support loyalty programmes within Wix | | `Digital products` | SparkLayer does not currently digital products within Wix | | `Discounts and coupons` | It is not possible to use the built-in Wix discount system alongside SparkLayer. If you require discounts, please use the SparkLayer [discount engine](docId\:WrejPw9URyjQwiQeKs_Cg). | | `B2B Label` | You must use the "B2B" label for SparkLayer to work, however you are able to rename the B2B label. If you have already used "B2B" and renamed this, if you go to create another "B2B" label it will actually be "B2B+x" | | `Tax Exemptions` | Tax exemptions will only be honoured when the customer checkout out using the Wix checkout (Upfront Payment). If you use manual payment methods Tax will be charged in the checkout | [title] WooCommerce Metafields & Data Mapping [path] Integrations/WooCommerce/ ## Introduction Metafields help you to customise the functionality and appearance of your WooCommerce store by letting you save specialised information that isn't usually captured in the WooCommerce admin. You can use metafields for internal tracking, or to display specialised information on your online store in a variety of ways. In the context of SparkLayer, metafields are used to capture additional B2B data that you can then use in a variety of ways: | Type | Details | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product metafields` | Updating the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) by adding configurations such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [RRP prices](docId\:S_VTlJBorGmnwjjfSMom9), and more | | `Customer attributes` | Updating a customer's information by adding information such as [credit limits](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Order metafields` | Updating an order with [invoicing information](docId\:yWm70oQUosyKOoIqb4Z4G) | *** ## How to add metafields to WooCommerce The easiest way to add metafields is to action this via the SparkLayer Dashboard. Simply go to **Integrations > Platform Connection** and click "Configure" under "Configure metafields". You can then select which of the SparkLayer [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) you'd like to enable. ## Important considerations In order for SparkLayer to work with WooCommerce metafields, please note the following: :::hint{type="warning"} **Product metafields** Metafields are always added at the product variant level, even if the product only comes in a single variant. **JSON data** Some SparkLayer settings require metafields to be set up as JSON strings. These will need to be carefully added, making sure the formatting is set correctly. ::: *** ## Advanced settings To learn about more advanced settings, including customer-level product metafield settings, please see [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) [title] Installing SparkLayer on WooCommerce [path] Integrations/WooCommerce/ ## Introduction SparkLayer enables B2B functionality on your existing WooCommerce store, allowing your B2B customers to login, place orders, manage their account, and much more.  To familiarise yourself with SparkLayer, we also recommend reviewing the following guides: ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [How SparkLayer Works](docId:_2g8HwCXnN7OFy4o199y1) The fundamentals of what SparkLayer does ::: :::LinkArrayItem [Frontend](docId\:OgKfvQX13dHW2582D57kJ) The special "interfaces" SparkLayer enables ::: :::LinkArrayItem [Features](docId\:SSzdKXuNMlEIDOOITHQcU) The available features and functions. ::: :::: *** ## ⚠️ Requirements - important! Before installing SparkLayer on your WooCommerce store, please ensure the following: | Item | Details | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `WooCommerce` | You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website
* WooCommerce: version 9 and above * Wordpress: version 6 and above
If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). | | `Product SKUs` | In order for SparkLayer to save B2B prices for your products, all products must have **SKUs**. | | `Customers` | For your B2B customers to see the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa), they must be assigned an appropriate B2B "Role" within Wordpress > users | | `Payment Processor` | If you’re installing SparkLayer on a test store, please ensure you have an example payment method enabled. You can manage this within WooCommerce > Settings > Payments | | `Shipping` | In order to place an order via the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), please ensure you have shipping rules set up. You can manage this within WooCommerce under Settings > Shipping or via SparkLayer's own [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) solution | **Areas of Wordpress/WooCommerce you'll be using** As part of setting up SparkLayer, you'll primarily be using the following areas: | Area | Details | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Products` | This will be used to setup which products you want to make available to B2B customers. See "Setting up your B2B pricing" below.
*In Wordpress/WooCommerce, go to Products* | | `Users` | This will be used to setup your B2B customers. See "Setting up your B2B customers" below
*I**n* *Wordpress/WooCommerce**, go to Users* | | `Orders` | This will be used to review and process and orders that are placed by your B2B customers. See "Placing a B2B order" below.
*In Wordpress/WooCommerce, go to Orders* | *** ## 🔗 Connecting your WooCommerce store :::hint{type="info"} **Please note** Setting up SparkLayer will require generating API keys within your WooCommerce store. If you're unsure how to do this, our team is happy to assist. To get in touch, please [click here](docId\:NNUw1G9z7eaJ4M78vk7t9). ::: To get started with SparkLayer on your WooCommerce store, there are a number of steps to follow. Once you've completed this step, you can then begin the process of configuring SparkLayer such as pricing and customer rules. ::::WorkflowBlock :::WorkflowBlockItem **Install the SparkLayer plugin** First, you'll need to install the SparkLayer for WooCommerce plugin on your Wordpress store. This works just like any other manually installed plugin and you can see [full details here](https://wordpress.com/support/plugins/install-a-plugin/). ::File{src="https://archbee-doc-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/asHW769jR5kqneAYXGKrK-20251111-132502.zip" label="SparkLayer Plugin for WooCommerce.zip"} ::: :::WorkflowBlockItem **Register with SparkLayer** Next, you'll need to create a SparkLayer account by [registering here](http://app.sparklayer.io/register) ::: :::WorkflowBlockItem **Connect your WooCommerce Store** Once registered, go to [Integrations > Platform Connection](https://app.sparklayer.io/integrations/platform) and select WooCommerce. You'll then be prompted to enter your store URL (this should be the URL of the website you are installing SparkLayer on, e.g. `www.mystore.com`) ::: :::WorkflowBlockItem **Generate API credentials** Next, you'll need to generate REST API credentials within WooCommerce. From your WordPress dashboard, you can find this within WooCommerce > Settings > Advanced > REST API Create the REST API key with a username easily identifiable as linked to SparkLayer, such as **“SparkLayer API”** with Read/Write permissions. ::: :::WorkflowBlockItem **Enter the API credentials in SparkLayer** From with the SparkLayer Dashboard [Integrations > Platform Connection](https://app.sparklayer.io/integrations/platform) paste the provided key and secret into the **“WooCommerce API Key”** and **“WooCommerce API Secret”** fields. Press save and wait a few seconds whilst SparkLayer connects to the WooCommerce store and performs the SparkLayer plugin initialisation. ::: :::WorkflowBlockItem **Store connected** This completes the process of connecting your WooCommerce store to SparkLayer! You can view all associated settings in WooCommerce by going to **WooCommerce > Settings > Integrations > SparkLayer B2B.** ::: :::: *** ## 🚢 The Onboarding process :::hint{type="info"} **Important** When setting up SparkLayer, some activities take place via the [SparkLayer Dashboard](https://app.sparklayer.io/) alongside WooCommerce. You'll use the SparkLayer Dashboard primarily for setting up your B2B pricing and B2B customer rules. ::: When you create an account on SparkLayer, you'll get access to the [SparkLayer Dashboard](https://app.sparklayer.io/). The Dashboard has a customised onboarding process that gently guides you through all the necessary steps before you're ready to start inviting your B2B customers and taking orders on your website. ::::WorkflowBlock :::WorkflowBlockItem **📓 Setting up your B2B price lists** You'll then set up the B2B price lists that you want your customers to see when they login. These can be automated or you can manually upload specific pricing. ➡️ [View in dashboard](https://app.sparklayer.io/pricing) ::: :::WorkflowBlockItem **👪 Setting up your B2B customers** You'll then set the ordering rules for your customers such as minimum order values, available payment methods and price lists they are assigned to. ➡️ [View in dashboard](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem **🛠️ Installing the frontend widgets** You'll need to check the special code snippets ("widgets") are installed on your WooCommerce store in order to show the special SparkLayer B2B interfaces. ➡️ [View in dashboard](https://app.sparklayer.io/integrations/widgets/core) ::: :::WorkflowBlockItem **✅ Testing & launching** You'll then need to run through some final checks (such as placing a test order). Once you're happy, you can then launch SparkLayer and start taking orders! ➡️ [View in dashboard](https://app.sparklayer.io/configuration/onboarding) ::: :::: Let's now dive into each of them! *** ## 📓 Setting up your B2B pricing :::hint{type="warning"} **Please note** Setting up your B2B pricing happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your WooCommerce admin. ::: Within the [Price Lists](https://app.sparklayer.io/pricing) area of the SparkLayer Dashboard, you can create and manage your B2B pricing rules.  SparkLayer allows you to set the following pricing types: | Type | Details | | ----------- | --------------------------------------------------------------------------------------------------------------------------- | | `Manual` | You can manually upload a CSV file with specific prices and even enable quantity pricing | | `Automatic` | You can use your WooCommerce prices and apply a discount. You can choose from your main WooCommerce price or the RRP price. | ::::WorkflowBlock :::WorkflowBlockItem For any products that you want your B2B customers to be able to buy, these products **must** have unique SKUs assigned. In WooCommerce, you can check this by going to **Products** and editing a product. If it's a single variant product, you'll see this under **Product data > Inventory**.  If the product has variants (or "Variations"), you'll see this under **Product data > Variations**.  ::: :::WorkflowBlockItem Next, go to [Price Lists](https://app.sparklayer.io/pricing/lists) within SparkLayer and click "Create Price List" to create your first B2B Price list. You can choose between an automatic or manual price list and configure how this works. ::: :::: :::hint{type="success"} **Ready to set your pricing?** To learn more about pricing, please see our [full guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: *** ## 👪 Setting up your B2B customers :::hint{type="warning"} **Please note** Setting up your B2B customer rules happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your WooCommerce admin. ::: [Customer Groups](https://app.sparklayer.io/customers/groups) let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out. Much like with Price Lists, you can fully manage this via the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups). :::::WorkflowBlock ::::WorkflowBlockItem Within Wordpress/WooCommerce, go to **Users** and click **Add User. **You can either create a new customer or edit an existing one. :::hint{type="warning"} **Please note** Please ensure that a valid address is added and all address fields are populated. Make a note of the email address you’ve added as you will need to access this to login. ::: :::: ::::WorkflowBlockItem To synchronise to SparkLayer, under **SparkLayer Role**, the customer must be assigned to a Role that correlates to a [SparkLayer Group](https://app.sparklayer.io/customers/groups). For example, if you're using the "Base" group in SparkLayer, you'll see a role called **"SparkLayer B2B: Base"**. Once the customer signs in, they'll see the B2B rules you've configured within the [customer group](https://app.sparklayer.io/customers/groups).  :::hint{type="warning"} **Please note the following on customer groups** - SparkLayer will only synchronise customers that have a role assigned that starts with `SparkLayer B2B` ::: :::: :::WorkflowBlockItem Once your customers have been set up in Wordpress/WooCommerce (i.e. those with a role of "SparkLayer B2B" assigned), and you've assigned the customer group to **at least** one customer, you can then manage specific rules within the [Customer groups area.](https://app.sparklayer.io/customers/groups)  ::: :::WorkflowBlockItem You'll see a default **Base** customer group that you can use for your B2B customers. If you want to set up additional rules, you can simply click **Create Customer Group** and configure accordingly. For any additional customer groups you create, you'll need to update the role on the customer record in Wordpress/WooCommerce to match. ::: :::WorkflowBlockItem To simulate logging in as a B2B customer, please see **✅ Testing & launching** below. ::: :::WorkflowBlockItem You can also check if your customer record is syncing by using the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. Within Wordpress/WooCommerce, navigate to a Contact record that has a label of b2b. Within the URL, you'll see a unique ID at the end of the URL, e.g. `?user_id=3` With this unique ID, you can then paste this into the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. If the search results show the customer details, this confirms the customer is synchronising correctly. ::: ::::: :::hint{type="success"} **Ready to configure your customer groups?** To learn more about customer groups, please see our [full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: *** ## 🛠️ Installing the frontend widgets SparkLayer comes with ready-made B2B-optimised "widgets" that we collectively call the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ). The widgets simply overlay sections of your existing WooCommerce store and enable our powerful B2B features.  Once set up, your approved B2B customers (see above "Setting up your B2B customers") will then see your B2B pricing and can begin placing orders. You can learn more about how this works in [our guide here](docId\:ccZ1vnH0O6D_722w35Xpa). :::hint{type="success"} **Auto-installation with "Theme blocks"** If your theme support blocks, when you install SparkLayer, it will by default add the special frontend widgets to your WooCommerce store. Depending on your WooCommerce theme, you may prefer to do this manually and you can follow our steps below. ::: **Installing SparkLayer yourself** If you’re looking to install yourself, there are five steps to follow. ::::::WorkflowBlock :::WorkflowBlockItem **Install the **[SparkLayer Core Script ](https://app.sparklayer.io/configuration/frontend/core)Within your main website header you'll need to add the SparkLayer Core Script that activates the SparkLayer functionality. Providing your stores theme outputs the `wp_head()` functional call in the `` section of the template, then the SparkLayer core script should automatically be injected on your page. ::: :::::WorkflowBlockItem **Install the **[Product Detail Interface](https://app.sparklayer.io/configuration/frontend/pdp) You'll need to update your storefront's product detail page with the SparkLayer Product Purchasing Interface. When a customer logs in and SparkLayer recognises them as being a B2B customer, this will load a special interface with their specific prices and a way to purchase. ::::ExpandableHeading **🛠️ View instructions** ```javascript
This will allow the customer to checkout **without** needing to enter any payment details. | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details. | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). | **How orders arrive into WooCommerce**  Depending on which [payment method](docId\:ibIKczvHM085BkeJIfFYv) you've selected, orders will arrive into WooCommerce in the following ways: | Payment Method | Flow | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Pay by Invoice` | The order will be created within ** WooCommerce > Orders** with a payment status of "Pending Payment". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay on Account` | The order will be created within ** WooCommerce > Orders** with a payment status of "Pending Payment". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay Online by Card` | The order will be created within **WooCommerce > Orders** with a payment status of "Completed" providing you have this already configured within WooCommerce. You can then proceed to fulfil the order. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | **"Unpaid" orders and "Paid" orders** By default **all payment methods** other than Upfront Payment will be generated as "Pending Payment" orders. You will need to capture payment either via your WooCommerce Admin or via offline methods (e.g. bank transfer) **WooCommerce checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the WooCommerce checkout. By default, they will see all WooCommerce payment methods you have set up (e.g. card payment, Paypal, etc). **Additional order details** When an order is placed via SparkLayer, it will also include the following additional data: | Attribute | Notes | | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom Fields` | When viewing an order in WooCommerce, you'll see a section **"SparkLayer Order Information" **which will include the Payment Method used. | *** ## ✅ Testing & launching The final step is to run some tests and checks to ensure SparkLayer is fully configured. Within the SparkLayer Dashboard, you'll see a number of [Launch checks](https://app.sparklayer.io/?expand=launch) to perform, from logging in as a B2B customer, through to placing an order. We recommend following the below steps: ::::WorkflowBlock :::WorkflowBlockItem **Set up a customer record** Within your Wordpress/WooCommerce admin, you'll need to ensure you have an example customer record set up (either a new one or an existing). Most importantly, a customer must be associated with an appropriate role. *Please see "Setting up your B2B customers" above for more details on how this works.* ::: :::WorkflowBlockItem **Place a test order** Once you've logged in as a B2B customer, proceed to add items to your cart and complete the checkout. Please see *"Placing a B2B order"* above for more details on how this works. ::: :::WorkflowBlockItem **Invite your customers** You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::: *** ## ⚙️ Advanced configurations In addition to the above setup, there are a number of other configurations that are possible at this time. :::ExpandableHeading **Displaying stock (inventory) levels** You can configure SparkLayer to show [stock levels](docId\:Gj_Ao_gQ6oA-jx0D27Hys) in a variety of ways. If you want to show inventory numbers (e.g. 100), you'll need to make sure this is turned on within WooCommerce. Within WooCommerce, go to Settings > Products > Inventory and turn on **Manage stock** You can also display this on the SparkLayer widgets (the product cards) by going to WooCommerce > Settings > Integrations > SparkLayer B2B. ::: :::ExpandableHeading **Adjusting tax settings** SparkLayer supports tax calculations and simply 'inherits' the rules you've set up in your WooCommerce settings. You can learn more about how tax works [in this WooCommerce guide](https://woocommerce.com/document/setting-up-taxes-in-woocommerce/). ::: :::ExpandableHeading **Enabling SparkLayer JavaScript modifications (e.g. checkout customer fields, language updates)** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your WooCommerce theme store. You can access this by going to **WooCommerce > Settings > Integrations > SparkLayer B2B.** Under "Core Script Options" you can add the below code. ```javascript { termsAndConditionsLink: "/policies/terms-of-service", checkoutCustomElements: [ { name: 'shipping-date', translations: { en: { title: 'Preferred Shipping Date', detail: 'Shipping unavailable on weekends.', }, }, attributes: { required: true, type: 'date', }, }, ], } ``` ::: :::ExpandableHeading **Enabling a URL redirect when signing in ** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Wix store. You can access this by going to **WooCommerce > Settings > Integrations > SparkLayer B2B.** Under **"Core Script Options"** you can add the below code. ```javascript { accountRedirect: { urlRegex: /\/account/g, goTo: "/index", // page to redirect logged in users to }, } ``` ::: :::ExpandableHeading **Enabling "Dark mode" for high contract websites** If your Wix store is set up with a darker theme, it's possible to enable a special "Dark Mode" for SparkLayer, ensuring colours and fonts are easily readable.  You can access this by going to **WooCommerce > Settings > Integrations > SparkLayer B2B.** Under **"Core Script Options"** you can add the below code. ```javascript { display: { darkTheme: true, }, } ``` ::: :::ExpandableHeading **Enabling SparkLayer shipping methods** SparkLayer has a built-in [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) system that lets you customise how shipping works for your B2B customers. By default, your existing shipping methods in your WooCommerce Dashboard will be used, however it's possible to update this to use SparkLayer via the [SparkLayer Dashboard here](https://app.sparklayer.io/configuration/shipping). ::: :::ExpandableHeading **Enabling pre-order (or "back orders")** SparkLayer has built-in support for pre-orders (someimtes referred to as "back orders"). Once enabled, this will then show a message to the B2B customer on the product page and allow purchasing.  ::: *** ## 📁 Troubleshooting To troubleshoot the most common issues (such as issues with pricing), please see [our guide here](docId\:BlCEkkx3I30nkUcglsfw7). You can also [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to assist. *** ## ℹ️ Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for WooCommerce?** All SparkLayer plans are compatible with WooCommerce, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via the SparkLayer Dashboard under Acccount > Plan ::: ### WooCommerce setup :::ExpandableHeading **Where do I find the SparkLayer WooCommerce app?** Currently, SparkLayer can only be setup on your WooCommerce store by registering directly via [SparkLayer](http://app.sparklayer.io/register) ::: :::ExpandableHeading **What WooCommerce plan do I need to be on to use SparkLayer?** You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website - WooCommerce: version 9 and above - Wordpress: version 6 and above If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing WooCommerce DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.woocommerce.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **Can you help me install SparkLayer on my WooCommerce website?** By default, the SparkLayer widges will be automatically installed on your store. If you do require assistance, you can [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we will be happy to advise. ::: :::ExpandableHeading **Does SparkLayer work on any WooCommerce theme?** You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website - WooCommerce: version 9 and above - Wordpress: version 6 and above If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). ::: :::ExpandableHeading **How does SparkLayer affect my current WooCommerce theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your WooCommerce store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the WooCommerce checkout. From there, any payment methods you have set up in WooCommerce (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if WooCommerce support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. You could also configure your WooCommerce theme to hide and show products based on tag via custom coding. ::: :::ExpandableHeading **Can I use my WooCommerce prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your WooCommerce prices (e.g. your main WooCommerce retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your WooCommerce prices and we can even make provisions for your tax set up in WooCommerce (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within WooCommerce, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Wix so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Wix, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Wix 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in WooCommerce to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. It's also worth noting that you can manually add customers via the admin by going to **Wordpress/WooCommerce > Users** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. You could think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my WooCommerce website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my WooCommerce website?** This is possible but would require custom coding. We recommend consulting with a WooCommerce expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in WooCommerce?** | Payment Method | Notes | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by Invoice` | The order will be created within **WooCommerce > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Payment on Account` | The order will be created within **WooCommerce > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Upfront Payment (Card payments)` | The order will be created within **WooCommerce > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. | ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within WooCommerce when an order is placed via SparkLayer providing payment hasn't already been processed. From WooCommerce > Oders, navigate to an order. You'll then see the option to **Edit order** allowing you to make changes. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: [title] Shopify Email Notifications [path] Integrations/Shopify/Shopify Customisations/ :::hint{type="warning"} **Important to note** If you are looking to customise the behaviour of your Shopify emails and notifications, we strongly recommend engaging a Shopify expert to assist. Whilst we can provide an overview of how to approach making customisations, our team cannot assist in applying any code changes. ::: ## Including B2B-specific content in an email If you need to show B2B-specific content in your Shopify email notifications, it's possible to add special code snippets that give this flexibility. To get started, go to the [Shopify Notifications admin](https://admin.shopify.com/settings/notifications) and load the template you want to edit, e.g. the Order confirmation. Within the code, simply add the following code snippet and adjust as required. ```html {% for tag in customer.tags %} {% if tag == 'b2b' %} Content to show to B2B {% else %} Content to show to DTC {% endif %} {% endfor %} ``` To test your changes, you'll need to trigger the email notification (e.g. by placing a real order) and we advise testing with a customer that has been tagged with `b2b` and one that hasn't. *** ## Including Additional details (order Note attributes) If you want to show additional data within your notifications, you can include the special order note attribute variables. For example, you may want to show a delivery date or a payment method to the customer.  Within the Shopify notification emails, simply add the following code to the following files: - [Order confirmation](https://admin.shopify.com/email_templates/order_confirmation/preview) - [Order invoice](https://admin.shopify.com/email_templates/order_invoice/preview) - [Draft order invoice](https://admin.shopify.com/email_templates/draft_order_invoice/preview) ```html
This is added as an **order note.**
This is primarily for internal use for debugging | | `note` | Order Note: `sparkPaymentType`
This is added as an **order note.**
This contains the name of the payment option used:
* upfrontPayment * paymentOnAccount * paymentByInvoice * quote | | `tag` | A tag of `b2b` is added to any order placed via SparkLayer | On each line item, there is also a `Charged Price` attribute which contains the final line item price. ### Order Mapping | Shopify | Spark Layer | | ------------------------------------------------------ | ---------------------------------------- | | `processsed_at` | `created_at` | | `id` | `external_id` | | `name` | `visible_id` | | `currency` | `currency_code` | | `note` | `customer_reference` | | `customer.id` | `customer_id` | | `billing_address` | `billing_address` | | `shipping_lines[0].title` | `packages[0].shipping_name` | | | `packages[0].shipping_sku` === 'shopify' | | `shipping_address` | `packages[0].shipping_address` | | `shopifyOrder.shipping_lines[X].price (SUM)` | `packages[0].total_shipping_.gross` | | `shopifyOrder.shipping_lines[X].tax_lines.price (SUM)` | `packages[0].total_shipping_.net` | | `line_items[T].name` | `packages[0].items[T].name` | | `line_items[T].quantity` | `packages[0].items[T].quantity` | | `line_items[T].id` | `packages[0].items[T].variant_id` | | `(T)` | `packages[0].items[T].line_total.gross` | | `(T)` | `packages[0].items[T].line_total.net` | ### Order history: importing orders into SparkLayer It's possible to import historic B2B order data into SparkLayer, allowing customers to see their previous order history once they access their account on your store. To do this apply a metafield as shown below: | Item | Details | | ------------------ | --------------------------------------- | | `Custom data type` | Order | | `Metafield type` | This must be set as an `boolean` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `order_import` | | `Value` | This must be set as a boolean of `true` | Any orders that are imported this way must also have a tag of `b2b` assigned to them within Shopify. If you're working with a large data set and would prefer to do this manually, you can instead use order metafields within Shopify to do this. Our recommendation is to use a bulk import tool such as [Matrixify](https://apps.shopify.com/excel-export-import?st_source=autocomplete) to manage this more quickly. When importing using this tool, you can use the format below simply by adding the Shopify order ID in the `ID` column. We also have a [sample CSV template](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/example-historic-order-import.csv?v=1738672207) you can start with. | ID | Metafield: sparklayer.order\_import \[boolean] | Command | | ----------------- | ---------------------------------------------- | -------- | | `[order-id-here]` | `TRUE` | `UPDATE` | :::hint{type="warning" attributes="[object Object]"} **Please note** The note attribute must be added to the order **after** SparkLayer is installed for the order to be synchronised correctly. Orders synced in this way can then be reported upon and will appear in the Orders section of the SparkLayer Dashboard. ::: ### Order ID ("Visible ID") and setting a custom order number It's possible to use a custom order ID instead of the standard order ID generated from Shopify. A typical use-case is customising the Order ID to match order numbers generated from a back-office system (e.g. an ERP), ensuring consistency across systems. When the "Visible ID" is set, this will then take effect when the customer views their orders from the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP).  | Item | Details | | ------------------ | ------------------------------------------ | | `Custom data type` | Order | | `Metafield type` | This must be set as an `single line text ` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `visible_id` | :::hint{type="warning" attributes="[object Object]"} **Please note** If you're using the "Visible ID" configuration, any orders that do not have this populated will fallback to the standard Shopify order number. ::: *** ## Advanced settings To learn about more advanced settings, including customer-level product metafield settings, please see [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) [title] Shopify Payment Methods [path] Integrations/Shopify/Shopify Customisations/ ## Managing "offline" payments SparkLayer supports the ability for customers to use offline payments such as "Pay by Invoice" and "Pay on Account" that allows you to review their orders before processing them. Once enabled for a [customer group](docId:5_lWMNohhjBJJppg9E6Vh), this will show as a payment method within the checkout flow.  When a customer selects "Pay on Account" or "Pay by Invoice", the flow works as follows: **A Draft Order is created** When a customer places an order as a quote, the order will by default enter Shopify in the **Draft order** status. Just as with any order in Shopify, you'll see the customer's details on the top right and you can review and edit their order contents.  **Sending an invoice** To send an invoice, simply click the Send invoice button beneath the order totals.  This will then trigger an email to the customer where they can they review the order and make payment online. :::hint{type="info" attributes="[object Object]"} You can edit this email template by going to **Settings > Notifications** within Shopify and search for the **Draft order invoice** template ::: Once the customer completes their purchase by making payment, the order is then marked as paid and will then display within your **Shopify Orders** area. If you are looking for other ways to manage invoicing, please see [our guide here](docId\:yWm70oQUosyKOoIqb4Z4G). *** ## Hiding payment methods in the checkout By default, when your B2B customers select "Pay Online by Card", they'll be taken to the Shopify checkout and will see all Shopify payment methods you have set up (e.g. card payment, Paypal, etc). You can learn more about [Shopify payment methods here](https://help.shopify.com/en/manual/payments/additional-payment-methods).  It's possible to **conditionally** hide and show payment methods should you require your B2B customers to only see specific payment types when they checkout. - To get started, visit the Shopify App store and search for apps that support "hiding payment methods". One such app is ["ETP Hide and Sort Payment Methods"](https://apps.shopify.com/etp-hide-sort-payments?) - Within the app, you can then configure rules. To detect a B2B customer, simply add a rule that filters on a tag of `b2b` being present. - It's important to note that the payment type "Credit card" can only be hidden if your Shopify store is on the Shopify Plus plan (this is due to limitations with the *Shopify Payment Customization API*) In the example below, the payment types "Paypal" and "Cash on Delivery (COD)" have both been hidden for B2B customers.  [title] Shopify B2B Dawn Theme [path] Integrations/Shopify/  ## Introduction Dawn is the first free [Online Store 2.0](https://themes.shopify.com/themes/dawn/styles/default) theme released by Shopify and is the ideal way to start configuring your Shopify store in a best-practice way. When you create a Shopify store for the first time, your store will by default use this theme and you can also use it for your existing Shopify store. :::hint{type="info"} **Learn more** You can [learn more](https://help.shopify.com/en/manual/online-store/themes/os20/themes-by-shopify/dawn) about the Dawn theme and [see it in action here](https://themes.shopify.com/themes/dawn/styles/default). ::: To make it easy to get up and running with SparkLayer, we've created a **B2B optimised version** of the Dawn theme that you can download, configure, and then customise. The B2B optimised Dawn theme brings the following features: - SparkLayer frontend code snippets fully installed - The ability to restrict access with an optional login screen - The ability to hide prices until a B2B customer signs in - The ability to set B2B-only products that only show when a B2B customer signs in :::hint{type="success" attributes="[object Object]"} **Try the demo** You can try our [Shopify Dawn demo store here](https://standalone.demo.sparklayer.io/) ::: *** ## How it works The SparkLayer B2B optimised version of Dawn works by adapting specific parts of the Dawn theme, activating the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) as well as enabling a special login page. You can see how it works in our video below ::embed[]{url="https://www.youtube.com/watch?v=5bo9nCvSJCM"} The B2B optimisations include: - **A login page** that optionally forces the customer to sign in before accessing the store and allows prospective customers to apply for an account. This content for this page can be customised via the *Shopify Customizer* - [Product Card Interface](docId\:Mrp_Z0QIZQ2QksseuJylv) that display on collection pages, showing the customers B2B pricing and the ability to add to an order - [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT) that show the customers B2B pricing and the ability to add to an order - [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP)** and **[My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) using the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) - A **Quick Buy mode** that lets customers quickly build orders :::hint{type="info"} **Please note** - The Dawn theme is maintained and built by Shopify and may be subject to periodic updates inline with their own releases. ::: *** ## Manually installing To get started, you'll **first** need to install the Dawn theme on your Shopify store and then action a number of specific code changes. There are three ways to go about implementing the code snippets: 1. **Download our code samples** and simply replace the matching files within your Shopify theme: ideal if you've made no changes so far to your Dawn theme. 2. **Download the full repository** via [Github here ](https://github.com/sparklayer-io/dawn/archive/refs/heads/main.zip)and then [uploading as a new theme](https://help.shopify.com/en/manual/online-store/themes/adding-themes#upload-a-theme-file-from-your-computer) in your Shopify store. 3. **Review our code samples** and manually apply them to your theme files: the best option if you've already made customisations to your Dawn theme. Installing the code snippets involves adjusting (or adding) the following files and we've included direct links to Github to see the code. | File Name | Details | Code sample | | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | `layout/theme.liquid` | The code theme file where the SparkLayer core script is installed along with a number of other customisations for CSS and forced login. You'll need to add the [Frontend Integration Guide](docId\:NcgYlSrJkvmtcBoxwVKma) to complete set up | [Click here](https://github.com/sparklayer-io/dawn/blob/main/layout/theme.liquid) | | `templates/page.b2b-login.json` | **A new file** that creates a B2B login page (see guide below) | [Click here](https://github.com/sparklayer-io/dawn/blob/main/templates/page.b2b-login.json) | | `sections/main-b2b-login.liquid` | **A new file** that creates the content for the B2B login page | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-b2b-login.liquid) | | `sections/main-product.liquid` | The product detail page with SparkLayer enabled | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-product.liquid) | | `snippets/card-product.liquid` | The product card with SparkLayer enabled | [Click here](https://github.com/sparklayer-io/dawn/blob/main/snippets/card-product.liquid) | | `templates/customers/register.liquid` | An updated registration page that is required if using the forced login page | [Click here](https://github.com/sparklayer-io/dawn/blob/main/templates/customers/register.liquid) | :::hint{type="success" attributes="[object Object]"} **Using Github?** [Click here](https://github.com/sparklayer-io/dawn) the full Dawn Github repository with changes for SparkLayer ::: *** ## Customisations ### Creating the B2B login page :::hint{type="warning" attributes="[object Object]"} **Important!** If you're wanting to set up a forced login page, please ensure a new page is created in Shopify as detailed below. ::: You can optionally force all customers to login **before** they begin browsing your store and adding products to their B2B order.  **Setting up a new login page** To enable this page, you'll need to create a **Page** within Shopify and then assign this page a special template. ::::WorkflowBlock :::WorkflowBlockItem First, add `sections/main-b2b-login.liquid` ([download here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-b2b-login.liquid)) and the `templates/page.b2b-login.json` ([download here](https://github.com/sparklayer-io/dawn/blob/main/templates/page.b2b-login.json)) files to your theme, ensuring each file goes into the correct directory. ::: :::WorkflowBlockItem Within your Shopify admin, under **Online Store**, click **Pages**, and then click the **Add page** button at the top ::: :::WorkflowBlockItem Give the page a title and then under **Edit website SEO** at the bottom, ensure the **URL and handle** is set to `b2b-login`Under **Online store** and **Theme template**, choose `b2b-login` ::: :::WorkflowBlockItem You can edit how the page looks and functions by going to Online Store > Themes and click the "**Customize**" button. Search for `b2b-login` to begin making changes. You can customise nearly all areas of the page such as colours, form fields, text, and more. To see how the page works, in your browser, visit `www.yourstore.com/pages/b2b-login` and you should see the new login page. ::: :::: :::hint{type="info"} **Learn more** You can learn more about how to customise this page in [our full guide here](docId\:Gfc0UW7mJnMNpnNO6EdRl). ::: ### Enabling the forced login page If you'd rather force customers to login before seeing your store, you can easily adjust this within the `layout/theme.liquid file`. To enable the forced login page, simply change the following code to `true`. ```javascript {% raw %} {% assign showSiteForB2B = true %} {% endif %} {%- if showSiteForB2B == blank -%} {% assign showB2BLogin = true %} {% endif %} {% endraw %} ``` ### Hiding prices by default If you want to **hide prices** until a customer is signed in, you can enable a special setting that will hide prices on product collection and product detail pages.  To enable the hiding of prices, simply set `hidePricesLoggedOut` to `true` in the following files: - `/snippets/card-product.liquid` - `/sections/main-product.liquid` Within the above files, you can also adjust the text and styling that is show to the logged out customer. :::ExpandableHeading **How do I stop my Shopify pricing showing on Google Search?** By default, Google will almost certainly index your Shopify store to show on their search listings. A result of this is your Shopify prices (retail prices) may also show within Google. It's very important to note that this is not related to SparkLayer and is in fact a built-in feature of Shopify. If you do not want your prices to show on Google this is a customisation that would need to be applied via your Shopify store (not via SparkLayer directly). The Shopify support team may be able to best advice here but there are a range of [Shopify community articles](https://community.shopify.com/c/forums/searchpage/tab/message?advanced=false\&allow_punctuation=false\&filter=location\&location=category\:en\&q=hide%20prices%20from%20google) that you can review. Please note, making any changes to your Shopify store in this manner may effect your Google search results and we strongly advise speaking with a Shopify expert before making any changes. ::: *** ## Customising the design Nearly all elements of the login page can be customised via the standard Shopify customisation tools. When you're in the **Customize** mode, navigate to the login page and you'll see all available content that can be modified.  *** ## B2B only products The B2B optimised Dawn theme also has support for B2B only products. This is a great way to **hide specific products** from logged out customers and it's easy to configure within Shopify. The feature works by **automatically hiding** any products that you have tagged with the specific tag `b2b-only` from within the Shopify Products admin.  When you tag a product with `b2b-only`, this product will be invisible to all logged-out customers and won't show on any of your collections pages. If you need to customise this feature, you can edit how it works in the following files: | File Name | Details | Code sample | | -------------------------------------- | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `sections/featured-collection.liquid` | The homepage featured collection | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/featured-collection.liquid) | | `sections/main-collection-grid.liquid` | The main product collection page | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-collection-product-grid.liquid) | | `sections/predictive-search.liquid` | The quick search feature that shows products | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/predictive-search.liquid) | | `sections/main-product.liquid` | The main product detail page | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-product.liquid) | *** ## B2B only navigation The B2B optimised Dawn theme has support for B2B-specific navigation. This is a great way to have a different navigation based on the customer type, e.g. a B2B customer sees one navigation, a logged-out (DTC customer) sees another. To get started, you'll need to create a new menu in your Shopify store from the "Navigation" section of Shopify (you [can access it here](https://admin.shopify.com/menus)). Proceed to set up your menu and for the **Handle**, enter `b2b-menu,` and click **Save menu**.  To activate the new B2B menu, open and edit the following files and set `showB2BNav` to `true` (as shown below) - `snippets/header-mega-menu.liquid` - `snippets/header-dropdown-menu.liquid` - `snippets/header-drawer.liquid` ```html {% assign showB2BNav = true %} ``` To test this, sign in as a B2B customer and you'll see the navigation on your store. *** ## Quick Buy Mode The B2B optimised Dawn theme also has support for 'quick buy mode' that allows you to display product collection pages in a more streamlined view for your B2B customers. Once enabled, your collection pages will be displayed similar to below with pricing, variant options, product rules (e.g. pack sizing) and the ability to quickly add items to an order. :::hint{type="success" attributes="[object Object]"} **Try the demo** Visit our [Demo site](https://demo.sparklayer.io/) and click [Quick Buy](https://demo.sparklayer.io/collections/sample-quick-buy) once logged in :::  To enable 'quick buy mode', within Shopify, go to **Products** and click **Collections** and then edit the collection page you wish to apply this to. From the **Theme template** section, simply choose **quick buy** from the list of options and click save.  It's also possible to apply the 'quick buy mode' to all collection pages if you'd prefer. To enable this, open the file `/templates/collection.json` and adjust the code as shown below. ```json "product-grid": { "type": "main-collection-product-quick-buy", ``` From an implementation point of view, the 'quick buy mode' enables a special template view, managed within the following files: - `/sections/main-collection-product-quick-buy.liquid` [View sample code](https://github.com/sparklayer-io/dawn/blob/main/sections/main-collection-product-quick-buy.liquid) - `/snippets/card-product-quick-buy.liquid` [View sample code](https://github.com/sparklayer-io/dawn/blob/main/snippets/card-product-quick-buy.liquid) It's also possible to adjust the styling of the 'quick buy mode'. Simple open `/sections/main-collection-product-quick-buy.liquid` and edit the CSS displayed at the top. :::hint{type="warning" attributes="[object Object]"} **Important to note** If you apply the new 'quick buy mode' to your collection pages, this will also take effect for logged-out customers also. If you are looking to customise the behaviour of how this works, we recommend engaging a Shopify expert to assist. ::: *** ## Sample products and price lists If you're starting your B2B store on Shopify from scratch, you can even install our sample B2B products to populate your product catalogue and price lists in SparkLayer. You can see these in action on our [demo store.](https://b2b-demo-store-dawn.myshopify.com/) This is a great way to see how SparkLayer works on your Shopify store before then configuring it with your own products. | Item | Notes | Download CSV | | ------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | `Shopify sample products` | Upload CSV via the Products admin in Shopify | [Click here](https://cdn.shopify.com/s/files/1/0608/1642/5195/files/Sample_Shopify_Products.csv?v=1635762514) | | `SparkLayer sample B2B pricing` | Upload CSV via the [Price Lists](docId\:lDePanHogqwEGNf-jHZ6L) admin in the SparkLayer Dashboard | [Click here](https://cdn.shopify.com/s/files/1/0608/1642/5195/files/Sample_SparkLayer_B2B_prices.csv?v=1635762514) | | `SparkLayer sample metafields` | Upload CSV via a third-party app such as [Metafields Guru](https://apps.shopify.com/metafields-editor-2) | Click here | [title] Shopify FAQs [path] Integrations/Shopify/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Shopify setup :::ExpandableHeading **What Shopify plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of Shopify, from Shopify Basic right through to Shopify Plus. All you need is an active Shopify store and you're good to go. ::: :::ExpandableHeading **How does SparkLayer compare to Shopify B2B?** Shopify expanded native B2B features to all plan tiers, including company accounts, up to 3 pricing catalogs, net terms, PO numbers, and easy reorders. For merchants with a handful of wholesale accounts on simple terms, this covers the basics. SparkLayer is designed for merchants who need more. Here are the key differences: **Pricing flexibility** - Shopify's free B2B tier limits you to 3 pricing catalogs assigned to Markets (customer groupings). If you need more than 3 pricing tiers or per-customer pricing, you'd need Shopify Plus at $2,300/month. SparkLayer gives you unlimited price lists on all plans, assigned directly to customer groups. **Sales team ordering** - Shopify offers staff accounts that can create draft orders in the admin. SparkLayer has a dedicated Sales Agent Portal where reps log in, switch between customer accounts, see customer-specific pricing, and place orders on behalf of buyers. It's a fundamentally different workflow. **B2B ordering features** - Several capabilities are only available through SparkLayer and don't exist on any Shopify plan, including Plus: CSV and bulk order upload, AI Intelligent Cart (auto-builds carts from emailed POs), saved shopping lists, advanced discounts, a Quoting Engine for quote-to-order workflows, and self-service invoicing. **Works on any theme** - SparkLayer overlays a B2B experience on top of your existing Shopify theme. Shopify's native B2B works best with their Trade theme. **Transaction fees** - SparkLayer charges no transaction fees on any plan. Shopify charges variable platform fees on B2B orders across all plan tiers. **Shopify Companies compatibility** - SparkLayer works alongside Shopify's Companies feature. Draft orders created through SparkLayer are automatically associated with the correct Shopify Company, Contact, and Location for accurate order attribution and reporting. SparkLayer and Shopify's native B2B can't currently run side by side for the same customer session - it's one or the other for the ordering experience. For a full feature-by-feature breakdown, read our detailed comparison: [SparkLayer vs Shopify B2B - What You Need to Know](https://sparklayer.io/blog/2026/04/03/shopify-b2b-all-plans/) ::: :::ExpandableHeading **Can I use SparkLayer with my development website?** Yes! If you're setting up SparkLayer on a development store (e.g. a test account), we can enable a special developer-mode that lets you use SparkLayer until you're ready to activate a billing plan. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) for more details. ::: :::ExpandableHeading **Can I have DTC and B2B on the same Shopify website?** Yes, It's possible to install SparkLayer onto your existing Shopify DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup' and [we've a guide here](https://www.sparklayer.io/blog/2022/04/04/shopify-hybrid-b2c-b2b/) that explains how works. When your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://b2b-demo-store-usd.myshopify.com/) Sometimes it can be better to separate out your B2B store onto a secondary Shopify store and we've detailed some of the [common reasons](https://www.sparklayer.io/blog/2021/12/15/shopify-b2b-store-setup/). ::: :::ExpandableHeading **Which version of Shopify "Customer Accounts" is SparkLayer compatible with?** When setting up your Shopify store, it's possible to choose from two types of 'Customer Accounts' within Shopify: - **Legacy (Classic) customer accounts:** this is how most Shopify stores are set up and allows compatibility with third-party apps and the ability to customise the look and feel - **New customer accounts**: this uses a 'password-less login' and has a locked down account area that uses Shopify's 'out of the box' functionality (very similar to the checkout) **Compatibility with SparkLayer** SparkLayer works with both versions of accounts. You can learn more in [Shopify Customisations](docId\:ddIv5TDAnCayWTOJ0Vyb7) under "Shopify customer accounts" ::: :::ExpandableHeading **Is there support for Shopify "Companies"?** Yes, please refer to our full guide, [Shopify Companies](docId\:wrzSu8adFvbXOkF50hX5I). ::: :::ExpandableHeading **What is the "SparkLayer B2B & Wholesae" (B2B Ordering) pixel that's added to my Customer Events within Shopify?** When a customer places an order via the Shopify Checkout, SparkLayer needs to know when the order is completed. By adding a special Shopify pixel, this then resets contents of the customer's order and allows them to place additional orders if they wish. **Please note, this step is fully automated when you install SparkLayer and no action is typically required.** To check the SparkLayer pixel has been added to your Shopify store, go to **Settings** and click **Customer events**. You should see a pixel added by SparkLayer and this should be set to the Connected state. When you view the pixel, you will see it called **"B2B Ordering" **which corresponds to the Sales Channel used by SparkLayer.  If you don't see the SparkLayer "B2B Ordering" pixel, you will need to reconnect your Shopify store via the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/integrations/platform). Simply click the "Save" button at the bottom, and this will activate the pixel for you. ::: ### Theme setup :::ExpandableHeading **Can you help me install SparkLayer on my Shopify website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any Shopify theme, include Online Store 2.0?** Yes! SparkLayer is compatible with all Shopify themes, even fully customised. If you need help in the setup, our team can add all the code snippets for you. You can even try our [Shopify B2B Dawn Theme](docId\:LHkU0_G_4GVef1jAmgXmo) ::: :::ExpandableHeading **Can SparkLayer work with my variant "image switcher"** SparkLayer works by updating the product page templates with our special frontend widgets - these automatically pull in your variants, SKUs, and any associated product data that is required for your B2B customers. When they are loaded into your Shopify store, they essentially 'replace' the existing Shopify purchase area that your regular DTC (retail) customers see. Very often, we see Shopify themes that have functionality whereby changing variants will auto-update the main product imagery. This itself is almost always very specific "custom coding" to the theme that is being used - on a technical level, it will be using Shopify theme specific JavaScript coding to do this and will be engineered in a particularly way for the theme. When our SparkLayer widgets are loaded in, they won't have any handling for this specific JavaScript that controls the imagery, so this functionality isn't compatible for logged in B2B customers. As a solution to this, we have released a guide (aimed at Shopify developers) to point them in the right direction to make SparkLayer compatible based on the specific theme they are using. [Learn more](https://docs.sparklayer.io/tech-docs/javascript-sdk#qReb9) ::: :::ExpandableHeading **If I update my Shopify theme, will I need to re-install SparkLayer?** SparkLayer requires adding specific code to your Shopify store and normally involves updating 3 or 4 files within your theme. When you perform a theme update, it's likely that these changes will be removed and the SparkLayer code will need adding back in. We are always happy to perform this re-install for you, please [get in touch](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. ::: :::ExpandableHeading **How does SparkLayer affect my current Shopify theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been tagged with b2b successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Shopify store, you may want to ask the app developer to remove these although this is optional. ::: :::ExpandableHeading **Will SparkLayer slow down my Shopify website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (B2C) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form, we recommend the following options: - **SparkLayer Forms (recommended)** - Our built-in, no-code form builder lets you create and manage B2B registration forms directly within SparkLayer. Get started with the ready-made Customer Registration Form template which includes approval workflows, automatic customer tagging, and email notifications. No third-party apps needed. Learn more about [SparkLayer Forms](docId\:nn5qnfmfGkXlyUmAMpSnq) or get started in the [SparkLayer Dashboard](http://app.sparklayer.io/forms). - **B2B Login and Registration Page** - We offer a free, ready-made template that adds a dedicated B2B login and registration page to your Shopify store (e.g. yourstore.com/pages/b2b-login). It includes a login form for existing wholesale customers, a registration form for new applicants, and is fully customisable via the Shopify Customizer. Our team is happy to install this for you at no charge. Learn more in [Shopify B2B Registration & Login](docId\:Gfc0UW7mJnMNpnNO6EdRl) It's also worth noting that you can manually add customers via the Shopify Customers admin and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I stop my Shopify pricing showing on Google Search?** By default, Google will almost certainly index your Shopify store to show on their search listings. A result of this is your Shopify prices (retail prices) may also show within Google. It's very important to note that this is not related to SparkLayer and is in fact a built-in feature of Shopify. If you do not want your prices to show on Google this is a customisation that would need to be applied via your Shopify store (not via SparkLayer directly). The Shopify support team may be able to best advice here but there are a range of [Shopify community articles](https://community.shopify.com/c/forums/searchpage/tab/message?advanced=false\&allow_punctuation=false\&filter=location\&location=category\:en\&q=hide%20prices%20from%20google) that you can review. Please note, making any changes to your Shopify store in this manner may effect your Google search results and we strongly advise speaking with a Shopify expert before making any changes. ::: ### Discounts :::ExpandableHeading **How do I set up discount promotional codes at checkout?** It's possible to set up discount codes that customers can use during the checkout process. For example, you could set up a discount coupon that gives them 10% off their order. To learn how discounts work, please see [our guide here.](docId\:WrejPw9URyjQwiQeKs_Cg) ::: :::ExpandableHeading **How do I set up discounts to apply across a product range? ** Within the SparkLayer [Discounts](docId\:WrejPw9URyjQwiQeKs_Cg) , using the "Advanced requirements and rewards", you can setup discounts to apply to products with specific tags setup within your store (e.g. in Shopify). For example, you could set the discount to only apply if products within the cart have a tag of `dog-toy` applied, or match a broad term of `dog`. This allows you to setup discounts to apply to collections and product ranges easily. There are also other workarounds without using discounts: - You could create a brand new product in Shopify and set up a range of variants within it (e.g. all the products you want to offer within the discount) - We have a special setting called *minimum product quantity* ([See our guide here](docId\:CmxfrPgjQxfz9vJzTVv0D)) which forces the customer to order at least X of the product (e.g. 3) - Using the [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe), you can then set up your discounted rates (e.g. buy 3 and the price is 10% cheaper) - Within Shopify, you could make these products 'hidden' from standard B2C customers simply by not associating them to a collection ::: :::ExpandableHeading **How do I set up discounts based on an order total?** It's possible to set up discounts that apply based on a certain threshold, e.g. the order total or the number of items in a cart. To learn more about discounts, see [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg) ::: ### Payments :::ExpandableHeading **How do B2B payments work with SparkLayer and Shopify?** SparkLayer supports a range of B2B-specific payment methods that can be tailored on a per-customer basis. Our diagram below illustrates how they work in the context of SparkLayer and Shopify. To learn more, please see our [full guide here](docId\:efevur-A3yCJXUHvrR7t-).  ::: :::ExpandableHeading **Do vaulted credit cards work with SparkLayer?** Yes! Shopify's vaulted credit card feature is fully compatible with SparkLayer. For it to work, the customer placing the order must be assigned to a Shopify company (under Customers > Companies in the Shopify admin). Once a customer within that company location has saved a card - either during checkout or via their customer account - any other customer linked to the same company location can use it. Vaulted cards appear as an option when a customer selects "Pay Online by Card" during the SparkLayer checkout process. They can also be charged against draft orders created by SparkLayer - for example, if a customer places an order using "Pay by Invoice", you can collect payment on the resulting draft order using a vaulted card directly from the Shopify admin. To get started, you need Shopify Payments enabled and your B2B customers linked to company records in Shopify. No additional SparkLayer configuration is required. You can learn more in our [Shopify Companies](docId\:wrzSu8adFvbXOkF50hX5I) guide. ::: :::ExpandableHeading **Can I use my existing payment methods on the checkout?** In terms of payment methods supported by SparkLayer and Shopify. If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the Shopify checkout. From there, any payment methods you have set up in Shopify (e.g. Paypal, Shop Pay, Affirm Pay) will show up, allowing the customers to pay by this method. We've attached a screenshot to illustrate this. In short, if Shopify support this payment method, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: :::ExpandableHeading **Can I additional charges on a B2B order based on the payment type used?** There may be scenarios where you want to add an additional charge on an order based on the payment type used (e.g. if the customer is paying by credit card, you may want to charge an additional 2%). Currently, there is no way to do this directly via SparkLayer. One potential option is to allow the customer to place an order via a manual payment method (e.g. Pay by Invoice), and when the order arrives into Shopify as a draft order, adjust the order totals accordingly. From the draft order within Shopify, you can then use their "Collect payment" functionality to take the card payment.  ::: ### Products ::::ExpandableHeading **How do I hide products or set up B2B-only products?** [B2B Catalogs ](https://apps.shopify.com/sparklayer-b2b-catalogs)is a free SparkLayer app that lets you control which products are visible to different types of customers on your Shopify store. Hide products from B2C customers, restrict items to B2B-only, or show different product ranges to different customer groups - all using simple tags, no code required. [Install B2B Catalogs](https://apps.shopify.com/sparklayer-b2b-catalogs) from the Shopify App Store, then head to our [B2B Catalogs documentation](https://docs.sparklayer.io/b2b-catalogs/) for the full setup guide. :::hint{type="info"} **Hiding variants** Looking to hide variants for specific B2B customer groups? ::: :::: :::ExpandableHeading **Can I use my Shopify prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Shopify prices (e.g. your main Shopify price, Compare-at price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Shopify prices and we can even make provisions for your tax set up in Shopify (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within Shopify, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Shopify so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Shopify, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Shopify's 'Import' or 'Edit products' feature to do this in bulk. ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. SparkLayer has a way to "reserve" stock for your DTC customers, essentially blocking B2B customers from ordering too much inventory for a specific product. [Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Shopify to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store (e.g. you could use an app such as [Locksmith](https://apps.shopify.com/locksmith) to do this) - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. Learn more in [our guide here](docId\:ddIv5TDAnCayWTOJ0Vyb7) ::: ### :::: ### Customers :::ExpandableHeading **How do I set up a customer in Shopify as B2B** To enable a customer as B2B, this works by adding a special tag in Shopify against their customer record. This tag by default is always `b2b` and you can add additional tags based on the rules you've set for the customer in the SparkLayer [Customers](docId:5_lWMNohhjBJJppg9E6Vh) admin. To learn more about setting up customers as B2B, see [our guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** Please refer to [our guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in Shopify?** For non-card payment orders (e.g. Payment by Invoice), the order is saved as a "Draft order". - You can view these in Shopify within **Orders** and then click [Draft Orders](https://admin.shopify.com/draft_orders?selectedView=all) - You can then convert these into approved orders by marking them as paid or marking them with payment terms (please [see this guide](https://help.shopify.com/en/manual/orders/create-orders#accept-payment) for more details). - It's also possible to automatically convert Draft Orders into Completed Orders with [our feature here ](https://app.sparklayer.io/configuration/settings/general)"Auto-complete Shopify Draft orders" - By default Shopify will not send an email for Draft orders but we have a [guide here](docId:7kxW1S6TBM57MlpLJn_Uk) that explains how to do this. When a customer places an order via non-card payment methods, it will show with a status of "**Awaiting Merchant" **until the order ("Draft" order) is converted into a Completed order. ::: :::ExpandableHeading **How do I edit orders?** Firstly, it is possible to edit orders within Shopify when an order is placed via SparkLayer. If you have it configured to create orders as 'Draft orders' you can go into the order and make changes. If you subsequently then manually complete the order (i.e. Mark as paid), you can still edit the order up until the point of fulfilment. The issue arises in one scenario we know about which is a limitation of Shopify. If you have 'Auto-complete Shopify Draft orders' turned on within the [SparkLayer Dashboard > Settings](https://app.sparklayer.io/configuration/settings/general) this will skip the ability to make subsequent orders. This is why, when you try and edit a 'Completed order', you are seeing the "Unable to edit order" message. At this point in time, we don't have a solution to this, other than switching 'off' the SparkLayer setting that automatically completes a draft order. ::: :::ExpandableHeading **Can I stop pricing showing as a discount within a Shopify order?** Yes! By default, prices from SparkLayer into Shopify will show exactly as you've set them up in the SparkLayer [Price Lists](docId\:Zv2wCfqf7CUC5j_pYJ8Pt). If you'd prefer to show the original Shopify price, please contact our team. ::: :::ExpandableHeading **How do I change the wording for "custom discount" on an order** You can change the wording of "Custom discount" by editing the languages within your Shopify store. - Go to Themes and click the 3 dots next to the theme name. Select "Edit default theme content" - Search for "Custom discount" and then edit as required. ::: :::ExpandableHeading **How do I send an invoice?** Please see our guide: [Invoices](docId\:NKh8H14Ffna5DD71SwwNd) ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we do have support for minimum (and maximum) quantities, but you're only able to set these at a product or product-variant level. It's not possible to currently set minimum order-level quantities but it's something we are considering as part of a future update! There is a potential workaround for product-variant requirements and we've included our recommend approach - You could create a brand new product in Shopify and set up a range of variants within it (e.g. all the products you want to offer within the discount) - We have a special setting called [Minimum product quantity](docId\:CmxfrPgjQxfz9vJzTVv0D) which forces the customer to order at least X of the product (e.g. 3) - Using the [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe), you can then set up your discounted rates (e.g. buy 3 and the price is 10% cheaper) ::: :::ExpandableHeading **How do I set up multi-currency using Shopify Markets?** Please refer to [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD) ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** At the moment, Shopify doesn't have a built-in 'notification' for when a draft order is placed so it does require workarounds for now. There are a few options: **Receive notifications as store owner:** - if you are a merchant on the Shopify, Advanced or Shopify Plus plans, you can use Shopify Flow to do this. We've an example you can [download here](docId\:ddIv5TDAnCayWTOJ0Vyb7) - It's also possible to automatically convert Draft Orders into Completed Orders with [our feature here](https://app.sparklayer.io/configuration/settings/general) **Receive notifications as a customer:** - If you want your customers to receive a notification, there are a few ways to do this. As above, you could activate the auto-complete [orders feature above](https://app.sparklayer.io/configuration/settings/general). - We also recommend a really good one called Mechanic that lets you set rules/flows based on criteria. We have some ready-made templates [you can use here](docId:7kxW1S6TBM57MlpLJn_Uk) ::: :::ExpandableHeading **Can I import historic B2B orders into Shopify** Yes, there are methods to do this. Please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: :::ExpandableHeading **Can I change the order number "prefix" in Shopify, e.g. B2B-123** Due to current limitations in Shopify, there is currently no way to differentiate the Shopify Order Number (e.g. #123456) between regular (DTC) and B2B orders. In terms of filtering and segmenting orders between retail and B2B, SparkLayer will by default add a tag to an order `b2b`. Within Shopify, or systems you may have integrated (e.g. shipping, 3PLs), this can then be used as a way to separate out workflows to allow you to differentiate between the customers who are placing orders. ::: [title] Locksmith [path] Integrations/Customer Experience/  ## :::hint{type="success"} **SparkLayer solution** We've launched our FREE [B2B Catalogs](docId\:plxT_QlDSepZu2YqVuicC) that lets you easily hide products for B2B and B2C customers. Learn more in our [full guide here](docId\:vE83XYTnUs59EG2IYKUFZ)  ::: ## Introduction :::hint{type="warning"} **Before you start: **Please note, your Shopify store must already have the [Locksmith app](https://apps.shopify.com/locksmith) installed before following the below guide. Learn more in "Frequently Asked Questions" below. ::: Locksmith lets you control access to products, collections and pages in your Shopify store. It's a great way to offer a different experience to your B2B & wholesale customers, giving you control on the content they can (and can't) see. Locksmith allows powerful ways to restrict content based on conditions such as customer tags (e.g. `b2b`), email addresses, passcodes, secret links, geographic location, purchase history, a schedule, and more. You can see everything that's possible in the official [Locksmith app here](https://apps.shopify.com/locksmith). In this guide, we're going to walk you through some example use-cases of using Locksmith to customise your store for your B2B customers. *** ## Example use-cases :::hint{type="warning"} **Please note the following** When working on a back up theme any lock you create will automatically take effect on your live theme. ::: ### Creating B2B-only products If you have products within your Shopify store that you want to make "B2B-only" and **not** accessible to your regular customers, this is a great way to manage their visibility. **Step one: Creating the Lock** Go into the Locksmith app within your Shopify store. Click in the **"Add new lock"** Field and you'll then see the below screen. When you select a product you are then able to browse your products or you can search by the product name. If you want the lock to take effect straight away you'll need to make sure you have **"Enable Lock" **selected, otherwise it will be set as a draft.  **Step Two: Add a Key** Once you have selected the product you are wanting to hide and you have created the lock, you'll see the ability to **"Add a Key"** to allow specific customers view the product. You'll also need to specify if you want to remove any links to the product and if you want this hidden from your store's native search function along with product listings.  When you add a **Key** you'll see a drop down list of rules you are able to use to allow customers to view the product you are hiding. When using SparkLayer, we advise using **'if the customer is tagged with...'** as you are already using tags for your B2B customers (e.g. `b2b`). [Learn more](docId:5_lWMNohhjBJJppg9E6Vh)  **Step Three: Customise your Key ** When creating a key, you're then able to add numerous conditions your customer has to meet before gaining access to the product. In this example, we're requiring the customer to have a tag of `b2b` before being able to view the product. As you can see below, you're able to redirect your customers who are **not** tagged B2B to a different page (or alternatively they can be given a default message supplied by Locksmith).  **Step Four: Save Lock and Test** Once you have finished setting up your customisations, simply click **Save**. Next, go to your store and check if you can view the product as logged out customer. And vice versa, try accessing it as a logged in B2B customer. If you search for the product directly when **logged out** you should see something like the below.  If you are already logged in **without** a B2B tagged account, you'll see a notification message similar to the below.  ### Creating B2B-only collections This is very similar to the "Creating B2B-only products" detailed above but designed to allow you to customise how your collections work. For example, you may have a collection on your Shopify store that shows your B2B products that you don't want your regular customers to see. **Step one: Creating the lock** Go into the Locksmith app within your Shopify store. Click in the **"Add new lock"** Field and you'll then see the below screen. When you select a Collection you are then able to browse your collections within your store or you can search by the collection name.  If you want the lock to take effect straight away you'll need to make sure you have **"Enable Lock" **selected, along with "**Protect products in this collection".**  **Step Two: Add a Key** Once you have selected the collection you're wanting to hide and you have created the lock, you'll then see the below screen that gives you the ability to **"Add a Key"** to allow specific customers view the collection. You'll need to specify if you want to remove any links to the product and if you want this hidden from your store's native search function along with collection listings.  When you add a **Key**, you'll see a drop down list of rules you are able to use to allow customers to view the collection you are hiding. When using SparkLayer, we advise using **'if the customer is tagged with...'** as you are already using tags for your B2B customers (e.g. `b2b`). [Learn more](docId:5_lWMNohhjBJJppg9E6Vh)  **Step Three: Customise your Key ** When creating a key, you're able to add numerous conditions your customer has to meet before gaining access to the product. For this example, the customer must be tagged with `b2b` to access the collection. You're also able to redirect your customers who are **not** tagged B2B to a different page or display a message to them.  **Step Four: Save Lock and Test** Once you have finished setting up your customisations, simply click **Save**. Next, go to your store and check if you can view the collection as logged out customer. And vice versa, try accessing it as a logged in B2B customer. If you search for the collection directly when **logged out** you should see something like the below.  If you are already logged in **without** a B2B tagged account, you'll see a notification message similar to the below.  ### Creating a B2B-only page In some scenarios, you may want to create B2B-specific pages on your store that cannot be accessed by your regular customers. This is a great way to customise the B2B experience on your store. **Step one: Creating the lock** Go into the Locksmith app within your Shopify store. Click in the **"Add new lock"** Field and you'll then see the below screen. When you select a page you are then able to browse your your pages within your store or you are able to search by the page name.  If you want the lock to take effect straight away you'll need to make sure you have **"Enable Lock" **selected.  **Step Two: Add a Key** Once you've selected the page you are wanting to hide and you have created the lock, you'll then see the ability to **"Add a Key"** to allow specific customers view the product. You'll also need to specify if you want to remove any links to the page and if you want this hidden from your store's native search function.  When you add a **Key** you'll see a drop down list of rules you are able to use to allow customers to view the page you are hiding. When using SparkLayer, we advise using **'if the customer is tagged with...'** as you are already using tags for your B2B customers (e.g. `b2b`). [Learn more](docId:5_lWMNohhjBJJppg9E6Vh)  **Step Three: Customise your Key ** When creating a key, you're able to add numerous conditions your customer has to meet before gaining access to the page. For this example, the customer must be tagged with `b2b` to access the page. You're also able to redirect your customers who are **not** tagged B2B to a different page or display a message to them.  **Step Four: Save Lock and Test** Once you have finished setting up your customisations, simply click **Save**. Next, go to your store and check if you can view the page as logged out customer. And vice versa, try accessing it as a logged in B2B customer. If you search for the page directly when **logged out** you should see something like the below.  If you are already logged in **without** a B2B tagged account, you'll see a notification message similar to the below.  *** ## Frequently Asked Questions :::ExpandableHeading **How do I change the default messages for locked content** When a customer tries to access content that is locked (e.g. a product, a collection, or a page), you can customise the messages that shows for them. Within Locksmith, you'll see a Messages section that allows you to customise the content.  ::: :::ExpandableHeading **How do I create multiple locks** You're able to create **multiple locks** that can apply to one customer group. All you need to do is select "Force open other locks" when setting up your customisations.  ::: :::ExpandableHeading **How do I lock my entire store to B2B customers** If you have a collection for a specific B2B customer group, it's possible to lock down your website so they **cannot access** anything other than the collection you have created for them. First, create a lock to your **Enter store**.  When creating the key, use **"if customer is tagged with..."** then enter the appropriate b2b tag (e.g. `b2b`). You'll also need to **"Invert" **the key, meaning that no customers can view this page **unless **they are tagged B2B.  Once you have created this lock, you'll then need to go in and create a second lock giving your B2B customers access to the B2B collection. You would need follow the normal steps mentioned above however when creating the key on this one you need to ensure you tick **"Force open other locks"** otherwise they would not have access to the collection due to the first lock on the entire store.  ::: ::::ExpandableHeading **Locks aren't taking affect on my backup theme, should they?** :::hint{type="warning"} **Please note** When working on a back up theme any lock you create will automatically take effect on your live theme. ::: If you are conducting testing on a back up (duplicate) theme, Locksmith will only take affect on your live theme. To resolve this, once you've created the lock, go to **Help > Unpublished themes**  Find the theme that you are currently testing on, and select install. This would the install the latest version of Locksmith along with all of the adjustments that you have carried out.  :::: [title] Installing SparkLayer on BigCommerce [path] Integrations/BigCommerce/ ## Introduction SparkLayer enables B2B functionality on your existing BigCommerce store, allowing your B2B customers to login, place orders, manage their account, and much more.  To familiarise yourself with SparkLayer, we also recommend reviewing the following guides: ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [How SparkLayer Works](docId:_2g8HwCXnN7OFy4o199y1) The fundamentals of what SparkLayer does ::: :::LinkArrayItem [Frontend](docId\:OgKfvQX13dHW2582D57kJ) The special "interfaces" SparkLayer enables ::: :::LinkArrayItem [Features](docId\:SSzdKXuNMlEIDOOITHQcU) The available features and functions. ::: :::: *** ## Requirements Before installing SparkLayer on your BigCommerce store, please ensure the following: | Item | Details | | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customer Storefront Accounts` | You’ll need to make sure that customer accounts are enabled on your storefront so that customers can sign in. This is turned on by default on BigCommerce, and you can [learn more here](https://support.bigcommerce.com/s/article/Customer-Account-Creation?language=en_US). | | `Product SKUs` | In order for SparkLayer to save B2B prices for your products, all products must have **SKUs**. Please see [this guide](https://support.bigcommerce.com/s/article/Product-Options-v2?language=en_US#skus) to learn more. | | `Customers` | For your B2B customers to see the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa), they must belong to a [customer group ](https://support.bigcommerce.com/s/article/Customer-Groups?language=en_US)within BigCommerce. You can learn more below on how to configure this. | | `Payment Processor` | If you’re installing SparkLayer on a test store, please ensure you have an example [payment method](https://support.bigcommerce.com/s/article/Available-Payment-Gateways?language=en_US) enabled. | | `Shipping` | In order to place an order via the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), please ensure you have shipping rules set up. You can manage this within BigCommerce under *Settings, Setup*. | :::hint{type="success"} Want to see BigCommerce and SparkLayer in action? Try out our [demo store](docId:6zLPH9x8-qEUITCHs2obE) ::: *** ## The Onboarding process When you create an account on SparkLayer, you'll get access to the [SparkLayer Dashboard](https://app.sparklayer.io/). The Dashboard has a customised onboarding process that gently guides you through all the necessary steps before you're ready to start inviting your B2B customers and taking orders on your website.  ::::WorkflowBlock :::WorkflowBlockItem **🔗 Connecting your BigCommerce store** This enables SparkLayer to connect to your BigCommerce store and begin synchronising the information it requires. ➡️ [View in dashboard](https://app.sparklayer.io/configuration/integrations/platform) ::: :::WorkflowBlockItem **📓 Setting up your B2B price lists** You'll then set up the B2B price lists that you want your customers to see when they login. These can be automated or you can manually upload specific pricing. ➡️ [View in dashboard](https://app.sparklayer.io/pricing) ::: :::WorkflowBlockItem **👪 Setting up your B2B customer groups** You'll then set the ordering rules for your customers such as minimum order values, available payment methods and price lists they are assigned to. ➡️ [View in dashboard](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem **🛠️ Installing the frontend widgets** You'll need to install special code snippets ("widgets") into your BigCommerce theme in order to show the special SparkLayer B2B interfaces. ➡️ [View in dashboard](https://app.sparklayer.io/configuration/frontend/core) ::: :::WorkflowBlockItem **✅ Testing & launching** You'll then need to run through some final checks (such as placing a test order). Once you're happy, you can then launch SparkLayer and start taking orders! ➡️ [View in dashboard](https://app.sparklayer.io/configuration/onboarding) ::: :::: Let's now dive into each of them! *** ## 🔗 Connecting your BigCommerce store Once you've installed the [SparkLayer BigCommerce App ](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/)this step of the onboarding process happens automatically. Once SparkLayer is connected to your BigCommerce store, it will automatically synchronise product and customer data and then allow you to upload price lists and proceed to install the frontend widgets. :::hint{type="info"} **Installing for the first time?** When installing on BigCommerce for the first time, the process works as follows: 1. You'll need to install the [SparkLayer app](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/) (much like you would any other app). You can do this within your BigCommerce admin by going to **Apps** and clicking **Marketplace **and then searching for SparkLayer. 2. You'll then be asked to **create an account on SparkLayer**, or sign in if you already have one. 3. Finally, you need to confirm acceptance of our billing plan within BigCommerce to begin your free trial ::: Once the above is complete, you can then return back to the [SparkLayer Dashboard](https://app.sparklayer.io/) to continue with the onboarding process. You can also access the SparkLayer app within your BigCommerce store by going to the **Apps** and clicking **My Apps** within your BigCommerce admin and you'll find a summary of your onboarding process.  *** ## 📓 Setting up your B2B price lists Within the [Price Lists](https://app.sparklayer.io/pricing) area of the SparkLayer Dashboard, you can create and manage your B2B pricing rules.  SparkLayer allows you to set the following pricing types: | Type | Details | | ----------- | ------------------------------------------------------------------------------------------------ | | `Manual` | You can manually upload a CSV file with specific prices and even enable quantity pricing | | `Automatic` | You can use your BigCommerce prices and apply a discount, e.g. 50% off BigCommerce retail prices | :::hint{type="warning"} **Please note the following on price lists** SparkLayer will **only** use the price lists set up directly within the [SparkLayer Dashboard](https://app.sparklayer.io/pricing) and will not synchronise any price lists you may already have set up in BigCommerce. ::: ### Discounts We also offer discounts on top of the wholesale pricing you’ve already set up. You have the ability to offer a blanket discount, free products or you can get technincal with our "Advanced Discounts and Rewards" where you have the ability to apply discount depending on Brand, Category, Condition UPC or Search Keywords as you are able to see below.  :::hint{type="success"} **Ready to set your pricing?** To learn more about pricing, please see our [full guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: *** ## 👪 Setting up your B2B customer groups [Customer Groups](https://app.sparklayer.io/customers/groups) let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out.  Much like with Price Lists, you can fully manage this via the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups). SparkLayer will **automatically** synchronise customer groups from your BigCommerce store rather than you having to manually set these up in the SparkLayer Dashboard. To get started, please following the below steps: :::::WorkflowBlock :::WorkflowBlockItem Within BigCommerce, go to **Customers** and click **Customer Groups** ::: :::WorkflowBlockItem You can either create a new customer group, or edit an existing one ::: ::::WorkflowBlockItem To synchronise to SparkLayer, the customer **Group Name** must start with `B2B`. In our example below, we've set up `B2B Default`  For any customer groups you want to synchronise, please ensure `B2B` is added in the Group Name. :::hint{type="warning"} **Please note the following on customer groups** - Once you've set up your customer groups in BigCommerce, these must be assigned** to at least one customer record** before SparkLayer will synchronise and show them in the [Customer Groups area](https://app.sparklayer.io/customers/groups) - SparkLayer will only synchronise customer groups that start with **B2B** in the customer group name ::: :::: :::WorkflowBlockItem Once the customer groups have been set up in BigCommerce (i.e. those starting with `B2B`), and you've assigned the customer group to **at least** one customer, you'll then see these appear within the SparkLayer Dashboard, within the [Customer area.](https://app.sparklayer.io/customers/groups)  When the customer groups are imported into Sparklayer, they will always use this format: | Item | Details | | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Name | The exact name set up in BigCommerce, e.g.
`B2B - Default` | | Handle | This will use a sequential format, e.g.
`bigcommerce-group-1`
`bigcommerce-group-2`
Note: you will only need to use the handle for more advanced integrations. | ::: ::::: :::hint{type="success"} **Ready to configure your customer groups?** To learn more about customer groups, please see our [full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: *** ## 🛠️ Installing the frontend widgets SparkLayer comes with ready-made B2B-optimised "widgets" that we collectively call the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ). The widgets simply overlay sections of your existing BigCommerce store and enable our powerful B2B features We offer two ways to get started with SparkLayer on your BigCommerce theme: ::::WorkflowBlock :::WorkflowBlockItem **Installing our frontend widgets yourself** If you're experienced in working with BigCommerce and the [stencil templating language](https://developer.bigcommerce.com/stencil-docs/overview), you should find our onboarding process a breeze (see below). ::: :::WorkflowBlockItem **Request us to install for you** Our expert team can help set up the special SparkLayer frontend widgets on your BigCommerce store and some example B2B pricing. Once we're done, we can then arrange an onboarding call to walk you through it. [Contact our team](docId\:NNUw1G9z7eaJ4M78vk7t9) ::: :::: **Installing SparkLayer yourself** :::hint{type="info"} **Backing up your BigCommerce theme** If you'd prefer not to make these changes on your live BigCommerce theme, you can create a "Duplicate" and make the changes there before publishing. To make a duplicate, go to **Channels** and click **Themes** from within your BigCommerce admin.  ::: If you’re looking to install yourself, there are five steps to follow. ::::::WorkflowBlock :::::WorkflowBlockItem **Install the **[SparkLayer Core Script ](https://app.sparklayer.io/configuration/frontend/core)Within `/templates/layout/base.html` you'll need to add the SparkLayer Core Script that activates the SparkLayer functionality. ::::ExpandableHeading **🛠️ View instructions** :::hint{type="info"} To get started, head over to the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/frontend/core) and you'll see your customised SparkLayer Core Script within the Frontend Configurations.  The script simply needs to be included within the main header of your website's source code within the` ...` tags in your `/templates/base.html` file. If you are making edits to your website via the BigCommerce admin, you can access the template files via this URL: `yourstore.mybigcommerce.com/manage/channel/1/my-themes` ::: :::: ::::: :::::WorkflowBlockItem **Install the **[Product Detail Interface](https://app.sparklayer.io/configuration/frontend/pdp) You'll need to update your storefront's product detail page with the SparkLayer Product Purchasing Interface. When a customer logs in and SparkLayer recognises them as being a B2B customer, this will load a special interface with their specific prices and a way to purchase. ::::ExpandableHeading **🛠️ View instructions** ```javascript
This will send the customer an email order confirmation | | `Payment on Account` | The order will be created with the `Awaiting Payment` status in BigCommerce.
This will send the customer an email order confirmation | | `Request for Quote` | The order will be created with the `Incomplete` status in BigCommerce.
This will **not** send the customer an email order confirmation | | `Upfront Payment` | The order will be create with the `Awaiting Fulfiment` status in BigCommerce
This will send the customer an email order confirmation | :::Iframe{iframeHeight="0" code=""} ::: :::: :::WorkflowBlockItem **Invite your customers** Please refer to [our guide here](docId:5_lWMNohhjBJJppg9E6Vh) on our recommended way to do this  ::: ::::: *** ## Troubleshooting To troubleshoot the most common issues (such as issues with pricing), please see [our guide here](docId\:BlCEkkx3I30nkUcglsfw7). You can also [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to assist. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for BigCommerce?** All SparkLayer plans are compatible with BigCommerce, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, our team will contact you to discuss the most appropriate plan for your needs. Billing is managed via a monthly billing cycle with the option to pay annually. ::: :::ExpandableHeading **How do I select and change plan (upgrade or downgrade)** You can sign up to SparkLayer on BigCommerce without initially selecting a plan. Once you've installed SparkLayer, our team will contact you to discuss the next steps. Once you've activated a plan, we are happy to work with you to upgrade or downgrade based on your changing requirements. ::: ### BigCommerce setup :::ExpandableHeading **Where do I find the SparkLayer BigCommerce app?** You can find the official SparkLayer for BigCommerce app in the [BigCommerce App Store](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/). ::: :::ExpandableHeading **What BigCommerce plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of BigCommerce, from BigCommerce Essentials right through to BigCommerce Enterprise. All you need is an active BigCommerce store and you're good to go. ::: :::ExpandableHeading **Can I use SparkLayer with my development website?** Yes! If you're setting up SparkLayer on a development store (e.g. a test account), we can enable a special developer-mode that lets you use SparkLayer until you're ready to activate a billing plan. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) for more details. ::: :::ExpandableHeading **Can I have DTC and B2B on the same BigCommerce website?** Yes, it's possible to install SparkLayer onto your existing BigCommerce DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://b2b-demo-store-usd.myshopify.com/) ::: ### Theme setup :::ExpandableHeading **Can you help me install SparkLayer on my BigCommerce website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any BigCommerce theme?** Yes! SparkLayer is compatible with all BigCommerce themes, even fully customised. If you need help in the setup, our team can add all the code snippets for you. ::: :::ExpandableHeading **How does SparkLayer affect my current BigCommerce theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a b2b customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your BigCommerce store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** In terms of payment methods supported by SparkLayer and BigCommerce. If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the BigCommerce checkout. From there, any payment methods you have set up in BigCommerce (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. We've attached a screenshot to illustrate this. In short, if BigCommerce support this payment method, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** BigCommerce does have the ability to hide collections from Customer Groups which could be one way to achieve this.  There are a few things we recommend to make the experience better: - You could **create a B2B-only collection** and redirect customers to this once they login. If you wanted to show special B2B-only products, you would need to create these as separate products within BigCommerce (i.e. with unique SKUs, etc) - With SparkLayer pricing, if you don't upload a price against a SKU, the B2B customer** won't be able to purchase it.** So this is a way to prevent them from adding items you don't want them to purchase - It is possible to adapt the BigCommerce themes to hide/show products using custom coding ::: :::ExpandableHeading **Can I use my BigCommerce prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your BigCommerce prices (e.g. your main BigCommerce retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your BigCommerce prices and we can even make provisions for your tax set up in BigCommerce (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within BigCommerce, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within BigCommerce so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in BigCommerce, it's relatively quick to do. You can either edit individual products and add them manually, or you can use BigCommerce's 'Import' or 'Edit products' feature to do this in bulk. ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. SparkLayer has a way to "reserve" stock for your DTC customers, essentially blocking B2B customers from ordering too much inventory for a specific product. [Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in BigCommerce to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: :::ExpandableHeading **Can I sell products on both store fronts?** Yes, it is possible to have product purchaseable on both store fronts if you are using both for wholesale. When you are in the product within your admin, please ensure that you have both store fronts selected as sales channles that you want to offer the products on. ::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some custom coding - You could use a [recommended form builder app](https://support.bigcommerce.com/s/article/Creating-a-Contact-Form?language=en_US#form-builders) to achieve this It's also worth noting that you can manually add customers via the **BigCommerce Customers** admin and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** Please refer to [our guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: :::ExpandableHeading **Will SparkLayer slow down my BigCommerce website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my BigCommerce website?** We recommend consulting with a BigCommerce expert developer before making changes to your website. For their reference, you may find the following Stencil code can be used as a mechanism to hide and show content based on a B2B customer being logged in. ```html {{#contains (toLowerCase customer_group_name) "b2b"}} {{/contains}} ``` ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in BigCommerce?** **Manual payments** For manual (non-card) payment orders (e.g. Payment by Invoice), the order is saved as a "Draft order". - You can view these in your BigCommerce admin within **Orders** and then click **Draft Orders** - You can then convert these into approved orders by marking them as paid or marking them with payment terms It's important to note that once an order has been approved, it will **only** then show in the customers My Account section and the [SparkLayer Dashboard](https://app.sparklayer.io/orders). **Card payments** You can view these in your BigCommerce admin within **Orders** ::: :::ExpandableHeading **How do I see the 'shipped' order status when viewing an order on SparkLayer?** SparkLayer will automatically show a B2B order as "Shipped" providing it meets the following conditions: 1. The order is marked as 'Shipped' within BigCommerce 2. The order has a shipment assigned to it within BigCommerce Without the both being applied to an order, the B2B order will remain in a "Processing" state until actioned. ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within BigCommerce when an order is placed via SparkLayer. If you have it configured to create orders as 'Draft orders' you can go into the order and make changes. If you subsequently then manually complete the order (i.e. Mark as paid), you can still edit the order up until the point of fulfilment. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly but there are some good ways to do this within BigCommerce using a recommended invoicing app or by sending invoices manually to your customers via your existing back-office financial system. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we do have support for minimum (and maximum) quantities, but you're only able to set these at a product or product-variant level. It's not currently possible to set minimum order-level quantities but it's something we are considering as part of a future update! ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** You can manage notifications from BigCommerce by going to **Settings** and clicking **Order Notifications** ::: :::hint{type="info"} **Need assistance?** We'd be happy to help guide you through this process. Please refer to [our guide here](docId\:NNUw1G9z7eaJ4M78vk7t9). ::: [title] QuickBooks Online [path] Integrations/Accountancy/  :::hint{type="info"} **Requirements** **QuickBooks: **Available to **QuickBooks Online** users only **Plan:** Merchants must be signed up to the Professional or Enterprise plan **Platform:** Merchants must be using Shopify ::: ## Introduction [QuickBooks Online](https://quickbooks.intuit.com/) provides online accounting tools for managing finances, invoices, inventory and customer records. With the SparkLayer integration, your B2B orders automatically sync to QuickBooks to create invoices and contacts - reducing manual data entry and removing the need for additional apps or systems to keep your platforms in sync. *** ## ⚠️ Pre-Requisites - important! The following areas need to be configured prior to enabling the integration. | Item | Details | | ---------- | ------------------------------------------------------------------------------------------------ | | `Products` | All B2B products need to be created in QuickBooks with the applicable tax rates applied | | `Shipping` | In order for shipping to be applied at invoice-level, shipping needs to be enabled in QuickBooks | *** ## Getting started To get started, login to your SparkLayer dashboard and navigate to **Integrations -> Partner Integrations -> Accountancy -> QuickBooks** and enable the integration. You will then be redirected to QuickBooks to complete authentication. You will also be notified about which data we require access to at this stage. :::hint{type="info"} **Please note** If your QuickBooks account is associated to multiple companies then you will be requested to select which company you want to connect with SparkLayer. Only one company can be connected per SparkLayer team. ::: Once you are connected, you can navigate back to the **Partner Integrations **page and modify the integrations configuration. You'll need to follow the steps below ("Configuration") to complete the setup. *** ## Configuration The following configuration options exists for the QuickBooks integration; | Setting | Description | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Automatic Contact Creation` | **This is not set on install, and must be configured before using the integration**
Controls whether SparkLayer should create customers in QuickBooks during the invoice synchronisation process.
When creating invoices, each invoice must be associated with a customer in QuickBooks. We first attempt to match an existing contact (as outlined in the Contact Matching section). If no match is found, this setting determines what happens next:
* **Enabled - **SparkLayer will automatically create a new contact in QuickBooks using the customer data held in SparkLayer. You can read more about contact creation [here](https://docs.sparklayer.io/xero#ZR11G). * **Disabled -** SparkLayer will not create new contacts in QuickBooks. This assumes that contacts are either: - Being created by another system, or - Being managed manually within QuickBooks. * In this case, if no matching contact is found, no invoice will be created. | | `Payment on account - Invoice creation trigger` | **Default: On order**
Controls when an invoice should be created for orders using the payment on account payment method.
* **On order **will create an invoice for the whole order once it reaches the `processing` status. * **On shipment **will create an invoice per shipment, once any fulfilments on the order have been created.
You can read more about payment on account orders below. | | `Enable Sales Receipts` | Enable this to generate sales receipts in QuickBooks for upfront payment orders | | `Shipping Tax Code` | Name of the tax code that should be applied to invoice lines for tax exempt users. This must be set in order for invoice synchronisation to succeed. | | `Tax Exemption Tax Code` | Name of the tax code that should be applied to tax exempt invoice lines. | | `Income Account` | Name of the account that should be used as the income account on new products - this will be used when creating the SparkLayer custom product | ### Custom Items On installation, a "SparkLayer Custom Product" product is created within QuickBooks that will be used when a custom item is added to an order within SparkLayer. To ensure an invoice can be successfully created, the applicable tax rate on this product needs to be set before use. You can set this in the same way as other products within QuickBooks. *** ## Invoice Creation SparkLayer automatically creates invoices in QuickBooks for eligible orders as soon as the order is received from your platform. :::hint{type="info"} **Please note** This process runs in the background to keep the checkout experience fast and uninterrupted, which means there may occasionally be a short delay before the invoice appears in QuickBooks. ::: ### Orders eligible for invoicing Whether an invoice is created depends on several conditions, including your integration settings and the specific details of the order. | Item | Details | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Fulfilment status` | We only create invoices for orders that are in either the *processing* or *shipped* fulfilment status. | | `Payment method` | Invoices are generated only for orders using either the **Payment by Invoice** or **Payment on Account** payment methods.
* **Payment by Invoice** For Payment by Invoice orders, the invoice is created as soon as the order reaches the `processing` status. * **Payment on Account** For Payment on Account orders, invoices are created depending on the integrations configuration. You can read more about payment on account orders below.
You can learn more about configuring these methods [our guide here](docId\:ibIKczvHM085BkeJIfFYv) | ### Payment on account orders & split shipments The integration configuration allows you to decide when invoices are created for orders that use the payment on account payment method. Invoices can be created either **on order ** or **on shipment.** If you have configured your integration for **on order **then an invoice will be created when the SparkLayer order reaches the `processing` state. If the integration is configured for **on shipment **then an invoice will be created at the time an fulfillment has been fulfilled on the order. This handling caters for **split fulfillments **as will we will create an invoice per fulfillment, containing only the line items fulfilled. Customers will be able to download all invoices associated with an order from their my account section. Note: If the integration is configured to create orders **on shipment **and changed to **on order** and partially fulfilled orders will not have invoices created for the remaining shipments. Please ensure any partially fulfilled orders are completed before changing this configuration. :::hint{type="info"} **Shipping** In the case of split shipments, the shipping method associated with the order will always be attached to the invoice created for the **first **shipment on the order. ::: ### How invoices are created Invoices are generated using the QuickBooks API. Each invoice is created using a combination of: - Data from the SparkLayer order - Your integration configuration - Relevant settings within QuickBooks The specific fields and logic used are outlined below. | Item | Details | | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Contact` | We attempt to match the invoice to an existing QuickBooks contact using the customer details from the SparkLayer order. If a match is found, the invoice is associated with that contact. You can read more about how contact matching and syncing works in detail here. | | `Billing Address` | The billing address shown on the invoice is taken from the order billing address. | | `Due Date` | The due date calculated for an invoice is dependant on three factors:
* The order date * The payment type * The customers payment terms | | `Due Date for Payment by Invoice orders` | For orders using the **payment by invoice **payment method, the due date is set to the order date. | | `Due Date for Payment on Account orders` | For orders using the **payment on account** type, the due date is calculated in the following hierarchical order:
1) If the customer has **net terms** configured in SparkLayer, these are applied to the order date. You can read more about configuring net terms [here](docId\:yWm70oQUosyKOoIqb4Z4G). 2) If not, any **payment terms** configured for the contact in QuickBooks are applied. 3) If neither of the above are set, any **global payment terms** configured in QuickBooks are applied. 4) If none of these are set, the due date defaults to the order date. | | `Line Item` |
* **Description** The line item’s SKU is used as its description. * **Quantity** The quantity matches the value recorded on the order in SparkLayer. * **Unit Amount & Line Amount** The unit and line amount are calculated by SparkLayer and passed directly to QuickBooks. * **Tax Amount** Tax values are calculated by QuickBooks using the tax rates specified in QuickBooks | | `Shipping` | If shipping enabled in QuickBooks, the shipping amount will be set on the invoice, with the shipping method reflecting the name of the service chosen and the price visile in the totals.
If shipping is disabled in QuickBooks it will be added as a line item to the invoice.
The shipping line will use the Shipping Tax Code specified in the configuration | *** ## Viewing Invoices Once an invoice has been created in QuickBooks, customers can access it directly from the **My Account** section of your store. When the invoice is ready, a **View & Download Invoice** button will appear on the relevant order.  Selecting this button will take the customer to the publicly accessible invoice URL generated by QuickBooks. If this button is not visible, please review our troubleshooting steps below. *** ## Contact matching & creation When creating an invoice, we first attempt to associate it with the correct QuickBooks customer using the customer details from the SparkLayer order. ### How contact matching works Contacts are matched in the following order: 1. **Account number match (Recommended) **- we check for an existing QuickBooks contact with an ID that matches the accounting ID [metafield](https://docs.sparklayer.io/account-and-addresses#advanced-account-settings) configured against the customer in SparkLayer 2. **Email match **- If no account number match is found, we attempt to match using the customer’s email address. If a match is found for either of these conditions, the invoice is associated with the matching contact. ### Multiple contacts for a single email :::hint{type="danger"} **Please note** If your organisation uses multiple contacts with the same email address, we recommend configuring unique account numbers for each contact to ensure reliable matching. ::: In SparkLayer, email addresses are unique - only one customer account can exist per email address. In QuickBooks, email addresses are not unique, meaning multiple contacts can share the same email. If multiple active QuickBooks contacts exist for the customer’s email address, and the currency of the invoice matches the customer, the invoice will be created against the oldest found customer. ### Automatic contact creation If no existing contact can be matched using the methods above, SparkLayer will automatically create a new contact in QuickBooks using the customer data from the order. This behaviour is controlled by the **Automatic Contact Creation** setting in your integration configuration. ### Data synced on contact creation When a contact is created in QuickBooks, the following information is synced once and is not automatically updated if changes occur later in SparkLayer: - First name & last name - Email address - Billing & shipping address (based on the order being invoiced at the time of matching) - Currency will be set to the currency of the invoice being created *** ## Disabling the integration To disable the integration, log in to your SparkLayer Dashboard and navigate to **Integrations → Partner Integrations → Accountancy → QuickBooks**, then toggle the integration off. :::hint{type="warning"} **Please note** If the integration is disabled, all related features will stop working. - No invoices will be created for orders placed while the integration is disabled. - Customers will no longer be able to access their QuickBooks invoices previously generated via SparkLayer using the link in their **My Account** section. ::: *** ## FAQ's :::ExpandableHeading **How do I disconnect from QuickBooks?** To disconnect from your QuickBooks organisation from SparkLayer you will need to login to your SparkLayer Dashboard and navigate to **Integrations -> Partner Integrations -> Accountancy -> QuickBooks **then disable the integration. This will remove the connection from your QuickBooks organisation. Please read further information here on what happens when the integration is disabled [here](https://docs.sparklayer.io/xero#OjTtC). ::: :::ExpandableHeading **Does the integration work for D2C orders?** No. The integration only supports B2B orders that are created through your platforms connection with SparkLayer. Direct-to-consumer (D2C) orders are not included in the sync and will not be pushed to QuickBooks as invoices. ::: :::ExpandableHeading **What level of access does the integration require in QuickBooks?** When connecting SparkLayer to your QuickBooks organisation, you’ll see a list of the exact permissions requested. We follow QuickBooks best-practice and only ask for the minimum access needed for the integration to function. Currently, this includes: - **View & manage contacts** - To match invoices to existing contacts and create new contacts for SparkLayer customers if your integration configuration allows. - **View & manage business transactions** - To create invoices in QuickBooks for SparkLayer B2B orders and in the future, view payments made on invoices. - **View organisation settings** - To read configuration details such as global payment terms when calculating invoice due dates. ::: *** ## Troubleshooting Below are some common issues and steps to help resolve them. If your issue isn’t listed, or the problem persists after following these steps, please contact our support team. :::ExpandableHeading **Customers cannot access their invoice from the My Account section** If links to invoices are not showing in a particular customers My Account section, it could be due to a number of reasons. - Ensure the integration is enabled in the SparkLayer Dashboard by navigating to **Integrations -> Partner Integrations -> Accountancy -> QuickBooks**. - Ensure the order is in a `processing` or `shipped` fulfilment status. We **do not **create invoices for orders which are in the `awaiting merchant` status. - Ensure an invoice exists in QuickBooks for the given order. In some cases it may take a little time for orders to sync across. If there appears to be a large delay, or an invoice has not been created, please contact support, providing the customer and order id. If you are still experiencing issues after checking the above, or invoice urls are not showing for **all **of your customers, please contact support. ::: *** ## Known limitations Please note the following: - Products must be setup in QuickBooks, with a SKU that matches Shopify and the correct tax rate applied. - Invoice creation in QuickBooks is one-way. Any changes made to invoices in QuickBooks, such as modifications to line items or customer details will **not **be reflected back in SparkLayer or your platform. - Apportioned tax rate for shipping line is not currently supported - Multi-currency is not currently supported where a customer has an existing invoice for another currency. [title] Accountancy [path] Integrations/ ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/SgPkgyz2M87ioKZl5xGrS-20251202-152201.jpg"} [Xero](docId\:WGhH4d8L-ys8zjOQmEoVx) ⚙️ Integrates Directly Create invoices and import payments ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/wBbAtWJv_p1-if-cpch7e-20260203-050948.png"} [QuickBooks Online](docId\:fDAlz0ggia651N47ICR2z) ⚙️ Integrates Directly Create invoices and import payments ::: :::: [title] BigCommerce Limitations [path] Integrations/BigCommerce/ ## Introduction Currently, there are a small number of limitations to be aware of with the SparkLayer and BigCommerce Integration. | Limitation | Notes | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Product SKUs` | Within BigCommerce, the product must have a SKU and this must be unique per product. | | `Product Inventory/Stock` | SparkLayer works on variant level stock. Product level stock support is limited and should be avoided where possible.
If the inventory is set to be tracked on product level where a product has multiple variants, SparkLayer would display that each of the variants has the set level rather than the product in its entirety across all variants.
In this situation, if a customer tried to add multiple variants to the cart with total quantity that exceeded the product stock level, a "Something went wrong" error would be shown to the customer and they would not be able to proceed. | | `Negative stock and pre-ordering` | BigCommerce does not support stock levels going below zero. As a result, SparkLayer cannot support pre-ordering functionality when stock is not yet available.
This limitation also applies to Quotes. A quote cannot be placed if there is currently insufficient stock available to fulfill the request. | | `Product Modifier Options` | If you are using BigCommerce Modifier Options (under the Customizations section of the BigCommerce edit product page), these will not show within the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). SparkLayer will only show the variants set up within BigCommerce variations section (e.g. options such as size, colour). | | `Custom Line Items` | SparkLayer custom line items feature is not supported on BigCommerce. | | `Multi-storefront` | Currently SparkLayer does not officially support BigCommerce's [multi-storefront functionality.](https://support.bigcommerce.com/s/article/Multi-Storefront?language=en_US)
However, in most cases multi-storefront setup will work out of the box with the following limitations:
1. Only one customer with the same email address can exist across all storefronts/channels used with SparkLayer.
2. All storefront/channel products, customers, and orders will share the same SparkLayer site.
3. A customer will share a single SparkLayer site across all channels/store-fronts, meaning that either the customers should only be assigned to a single channel at a time, or they will need to complete their checkout on one channel before adding any products on another to not end up creating invalid BigCommerce carts.
4. An extra SparkLayer Core Script Options field must be set with a unique `igniteCheckoutContext.channel_id` numeric value for each channel's storefront. | | `Price lists` | Currently price lists can only be managed though SparkLayer. Any price list modifications actioned via the BigCommerce admin will not apply to SparkLayer. | | `Promotions` | SparkLayer does not currently support the use of BigCommerce discounts (e.g. order-level discounts or promotional codes). This is an area that is being actively reviewed as part of a future update. | | `Multi-zone tax` | SparkLayer does support multi-zone tax configured in BigCommerce, however *at least one* of the following must be true for multi-zone tax to work:
1) The Tax "Prices entered with tax" setting is set to "No, I will enter prices exclusive of tax" 2) The Tax "When calculating the taxes on sales made outside this storefronts default tax zone" setting must be set to "Update product prices to reflect applicable tax rates". | | `Sales Agents` | [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) lets your sales team place orders on behalf of customers. During the checkout process, sales agents won't be able to select "Pay Online by Card" for a customer, payments must be "offline" methods (e.g. net terms, pay by invoice) | | `Company Users` | If you're using [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) and a customer is inviting a team member, the team member will not receive a 'confirmation email' asking them to approve access. They will need to be manually informed of their login email address and to use the "Forgot password" feature on the BigCommerce store to create a password for their account. | | `Tax price display setting updates` | The setting called "How are prices displayed on your storefront" influences how shipping costs appear in your shopping cart. When you install the SparkLayer app or modify the overarching "Prices entered with tax" setting, this setting is automatically updated. But if you adjust this particular setting on its own, SparkLayer won't automatically update, causing the shipping cost to display incorrectly.
If you need to change this setting, reach out to SparkLayer for proper synchronisation. | | `Shipping and checkout` | At this time, it's not possible to use the [SparkLayer Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) feature in parallel with B2B orders that require going through the BigCommerce checkout to pay online by card ("Upfront payment").
Due to BigCommerce shipping configurations, any SparkLayer shipping methods are overwritten by BigCommerce, reverting to the default shipping rules you've set up on your store.
SparkLayer shipping can be only used with BigCommerce if the Upfront Payment method is **disabled**. | | `Shipping method cost display` | When the tax zone price display setting is set to "Tax Inclusive", the shipping method option cost shown in the SparkLayer cart will be calculated using the overall cart tax rate rather than any shipping specific tax bands.
Please note that this is just the cost display amount shown in the shipping method options select UI rather than the actual shipping cost shown in the cart summary which is provided by BigCommerce and is not affected by this limitation. | [title] Magento [path] Integrations/ ## Introduction SparkLayer is the powerful platform that transforms your existing Magento website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed SparkLayer on your Magento store SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your Magento store. The best part is you can retain your *existing* Magento store design and layout and enable B2B alongside your retail operation (DTC). ## Supported Magento Plans  SparkLayer works with Magento Open Source versions 2.4.2 or later (formerly "Community Edition") and Adobe Commerce (Cloud) versions 2.4.2 or later. *** ## Magento Demo Store Want to see SparkLayer & Magento in action? Try it out on our Magento demo store using the details below: | Item | Details | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Login URL | [demo.magento.sparklayer.io/ ](https://demo.magento.sparklayer.io/)This is an example DTC + B2B store. To login as a B2B customer, [go to this link](https://demo.woocommerce.sparklayer.io/my-account/) and use the credentials below. | | Login details | **Sales Agent / Regular B2B Customer**
`contact@sparklayer.io`
`Testtest!` | *** ## Get started ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Installing SparkLayer on Magento](docId\:tlR1CAK6UzBa7R4JItqXq) Learn about the steps to install SparkLayer on your WooCommerce store ::: :::LinkArrayItem [Magento Metafields & Data Mapping](docId\:eBCDHtikvf78kB7v6axEh) Learn how to use the powerful WooCommerce metafields feature ::: :::LinkArrayItem [Magento FAQs](docId\:iN3pgYKCvUVn9R76lza2h) See some of our most commonly asked questions! ::: :::: [title] Linnworks [path] Integrations/ERPs & Operations/Untitled/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to the Professional or Enterprise plan - Platform: works with all eCommerce platforms ::: ## Introduction Linnworks is a multi-channel platform that lets you connect, manage, and automate your eCommerce operations. From inventory and stock, order management, right through to fulfilment. You can learn more about Linnworks [here](https://www.linnworks.com/). *** ## How it works The Linnworks integration for SparkLayer is available for all [Shopify merchants](https://docs.sparklayer.io/integrations/shopify-introduction#introduction) that already use Linnworks and allows you to bring B2B pricing and B2B ordering to your Shopify store.The integration works in two ways: | **Item** | **Details** | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Product Pricing** | Flow: Linnworks into SparkLayer
Product pricing is synchronised from Linnworks into SparkLayer using the 'Extended properties' feature available for all inventory items. | | **Orders** | Flow: SparkLayer to Shopify to Linnworks
Orders placed via SparkLayer are synchronised from Shopify into Linnworks using your **existing** Linnworks integration. Prices that show on orders will be the special B2B pricing | Please note, all customer data is managed via Shopify via the normal methods. *** ## Configuring on SparkLayer **Before you start - **to configure Linnworks on SparkLayer, you'll need to have an approved account with Linnworks. Please visit the [Linnworks website](https://www.linnworks.com/) to learn more. To get started, you'll sign into your Linnworks account and install the SparkLayer app. Once signed in, [click here](https://apps.linnworks.net/Authorization/Authorize/d4d9f57c-ea0e-4ecf-8c6d-eaa5632d4581) to start the process and you'll then be given an **authorisation token.** Within the SparkLayer Dashboard, go to the **Integrations** section and click **Partner Integrations.** Under **Multi-channel management**, click the toggle on the right to activate the Linnworks integration.  You'll then be prompted to enter the **authorisation token** and save your changes.  *** ## Configuring pricing **Creating price lists in SparkLayer** Price Lists determine what prices specific customers see when they log into your website and are central to how SparkLayer works. SparkLayer retrieves pricing from a backend system and ensures the backend system, such as Linnworks, remains as the 'source of truth' for pricing data. The Linnworks integration for SparkLayer works by first creating price lists within SparkLayer directly, and then using the '**extended properties**' feature in Linnworks to map pricing.To get started, go to **Data Feeds **within the SparkLayer Dashboard, and click **Price Lists**  Click **Create Price List **and enter in a unique **Handle** and a **Name** for the price list. You can repeat this process for as many price lists as you need. **Creating B2B pricing in Linnwork** To create B2B product pricing in Linnworks to synchronise with SparkLayer (and subsequently then show on your Shopify store), you need to use the **extended properties **feature in Linnworks. You can learn more about how this works in Linnworks [here](https://assets.linnworks.com/support/inventory/my-inventory/edit-inventory-item/extended-properties/).To get started, navigate to a product in Linnworks and click the **Extended properties** tab  Click 'Add New' and then follow the below steps: - **Name**: this must match the Handle used for the price list in SparkLayer and also start with b2b- For example, if the price list Handle in SparkLayer was was base-list the name in Linnworks would be b2b-base-list. - **Value**: this is is a list of prices in comma separated format and there is also support for tiered pricing. It works as follows: the first price entered is the price for 1 item. If you want to add tiered pricing, prefix the price with the quantity and a plus symbol. For example, let's say you have a product that costs £7.00 for 1 item ordered, but £5.00 for 10+ items ordered. This would be entered as 7.00,10+5.00. - **Unit of Measure: **You may also configure Unit of Measure by formatting the each pricing tier with a Unit of Measure key. For example, if a quantity of 10 items equates to 1 box priced at 5.00 per unit and a quantity of 100 items equates to 1 crate priced at 4.00 per unit. This would be entered as 7.00,10+5.00+box,100+4.00+crate. You can read more about our unit of measure pricing [here](https://docs.sparklayer.io/quantity-pricing#H9IT8). - **Type**: this must be entered as Other  **Bulk updating pricing** We recommend using bulk importing tools in Linnworks to more easily update B2B pricing. You can learn how this works [here](https://assets.linnworks.com/support/settings/import-and-export-data/). Once you've add the B2B product pricing in Linnworks, this will then be synchronised **every hour **into SparkLayer. You can check the pricing that's being received in SparkLayer at any point by using the [Product Data Look up tool](https://docs.sparklayer.io/partners/linnworks). *** ## Configuring customers The final step is to ensure that customers who sign into your Shopify store see the correct pricing. To do this, you'll need to configure Customer Groups. Please read our [full guide here](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard/settings#customer-groups) to complete this step. Once this is completed, you can login as a customer on your Shopify store, navigate to a product, and you'll see the pricing as set up in Linnworks. [title] Magento FAQs [path] Integrations/Magento/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for Magento?** Our "Enterprise" plan is required to use the SparkLayer Magento integration. [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via the SparkLayer Dashboard under Acccount > Plan ::: ### Magento setup :::ExpandableHeading **Where do I find the SparkLayer Magento module?** Please get in touch with our support team to get access to the SparkLayer Magento module. ::: :::ExpandableHeading **What Magento plan do I need to be on to use SparkLayer?** SparkLayer supports the following Magento Plans - Magento Open Source (version 2.4.2+) - Adobe Commerce (Cloud, version 2.4.2+) ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing Magento DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.woocommerce.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **How does SparkLayer affect my current Magento theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Magento store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will be taken to our Magento payment methods checkout. From there, any payment methods you have set up in Magento (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if Magento support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. You could also configure your Magento theme to hide and show products based on tag via custom coding. ::: :::ExpandableHeading **Can I use my Magento prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Magento prices (e.g. your main Magento retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Magento prices and we can even make provisions for your tax set up in Magento (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Magento so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Magento, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Magento 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Magento to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. It's also worth noting that you can manually add customers via the admin by going to **Magento > Customers** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. You could think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my Magento website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my Magento website?** This is possible but would require custom coding. We recommend consulting with a Magento expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within Magento when an order is placed via SparkLayer providing payment hasn't already been processed. From Magento > Sales, navigate to an order. You'll then see the option to **Edit order** allowing you to make changes. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: [title] Wix FAQs [path] Integrations/Wix/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for Wix?** All SparkLayer plans are compatible with Wix, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via your Wix admin and processed monthly or annually if you've selected this option. ::: ### Wix setup :::ExpandableHeading **Where do I find the SparkLayer Wix app?** You can find the official SparkLayer for Wix app in the [Wix App Market](https://www.wix.com/app-market/search-result?query=sparklayer). ::: :::ExpandableHeading **What Wix plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of Wix. All you need is an active Wix store and you're good to go. ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing Wix DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.wix.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **Can you help me install SparkLayer on my Wix website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any Wix theme?** Yes! SparkLayer is compatible with all Wix themes. Once you install the SparkLayer app, our special B2B widgets are automatically added to your Wix store and you're good to go. ::: :::ExpandableHeading **How does SparkLayer affect my current Wix theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Wix store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the Wix checkout. From there, any payment methods you have set up in Wix (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if Wix support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: :::ExpandableHeading **Can I use multiple currencies for my B2B customers?** Currently, Wix [doesn't allow](https://support.wix.com/en/article/wix-stores-request-selling-in-multiple-currencies) a Wix store to accept multiple currencies (e.g. USD, EUR, GBP etc). If you do set up multiple currencies within SparkLayer in the [Price List section](https://app.sparklayer.io/pricing/lists), it's important to note the following: - Customers will see the correct currency when browser your store as a logged in B2B customer. The price they see will be the currency exchange rate at that time - If they proceed to place an order in a different currency to your Wix store's default currency, this will create an order however the pricing will show in your default currency. We've illustrated this below  How the order shows in Wix. Note how the totals are the same but the currency (EUR) has defaulted to the Wix store currency (£ GBP)  ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. Within Wix, you can set pages to have **Permissions** for **Site members**. You create a **Member Role** of `B2B Customers` and then assign this to specific pages on your Wix website. You can see [their full guide here](https://support.wix.com/en/article/wix-stores-creating-restricted-store-pages).  If you wanted to show special B2B-only products, you would need to create these as separate products within Wix (i.e. with unique SKUs, etc) With SparkLayer pricing, if you don't upload a price against a SKU, the B2B customer** won't be able to purchase it.** So this is a way to prevent them from adding items you don't want them to purchase ::: :::ExpandableHeading **How do I hide prices on my regular (B2C) Wix store? ** Within your Wix store, you can easily hide the regular (B2C) retail price from showing. This is a great way to make your Wix store "B2B only" and only show prices once a customer signs in. To view more details on how to do this, please see the [official Wix guide here](https://support.wix.com/en/article/wix-stores-hiding-product-prices). ::: :::ExpandableHeading **Can I use my Wix prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Wix prices (e.g. your main Wix retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Wix prices and we can even make provisions for your tax set up in Wix (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within Wix, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Wix so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Wix, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Wix 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Wix to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. Wix [have a guide here](https://support.wix.com/en/article/wix-forms-an-overview) on ways to do this. It's also worth noting that you can manually add customers via the admin by going to **Customers & Leads > Contacts** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. One of the easiest ways is to use the built-in Wix messaging system to simply notify your customer to sign in and begin placing orders. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You'll see a tab called **Inbox** that allows you to send direct messages.  You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You can then search and filter your customers and click **Send Email Campaign** to send an email.  We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my Wix website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my Wix website?** We recommend consulting with a Wix expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in Wix?** | Payment Method | Notes | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by Invoice` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Payment on Account` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Request for Quote` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Upfront Payment (Card payments)` | The order will be created within **Sales > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. | ::: :::ExpandableHeading **Why do orders show up as "Awaiting Merchant"?** When a B2B customer first places an order, it will show as **Awaiting Merchant** when they view it in their [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP). This status means that the order requires the merchant (the Wix store owner) to view the order and then confirm payment (e.g. such as sending the customer an invoice or arranging payment via other means). Once you then mark the order as paid within Wix, this will then update the order status from **Awaiting Merchan**t to **Processing** and you can then fulfil the order as normal.   ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within Wix when an order is placed via SparkLayer providing payment hasn't already been processed. From your Wix Dashboard, navigate to an order and click the **More Actions** button. You'll then see the option to **Edit order** allowing you to make changes.  ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly but there are some good ways to do this within Wix. When viewing an order within your Wix Dashboard, you'll see the option to **Create Invoice** under **More Actions**. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal.  ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** You can manage notifications and emails that are sent by going to your Wix Dashboard, clicking **Settings** and then **Outgoing Notifications**. ::: [title] Uninstalling & Transferring accounts [path] Integrations/Wix/ ## Uninstalling SparkLayer SparkLayer works just like any other app in Wix and you can uninstall it very easily.  Please follow the below steps: ::::WorkflowBlock :::WorkflowBlockItem From your Wix admin, click **Apps**, and then click **Manage Apps.** ::: :::WorkflowBlockItem For the SparkLayer, click the three dots on the right and then click **Delete**. This will then remove SparkLayer from your store. ::: :::: Once you've removed the app, this will then **cancel** the SparkLayer recurring billing charges with immediate effect. :::hint{type="info"} **More information** You can learn more about removing apps in this [Wix guide](https://support.wix.com/en/article/deleting-apps). ::: :::hint{type="warning"} **Please note** - When you follow the uninstall process, this will disable customers, product and order updates to SparkLayer but will **not** delete the data until you [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to remove your account. - Please note, depending on when your billing cycle to SparkLayer began, you may see charges you're not expecting. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) if you would like us to investigate. ::: *** ## Transferring to another Wix store At this time, it's not possible to transfer your SparkLayer account to a new Wix store. We recommend creating a brand new SparkLayer account on the new store and following our setup guide. [title] Wix [path] Integrations/ ## Introduction SparkLayer is the powerful platform that transforms your existing Wix website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed the [official SparkLayer for Wix app](https://www.wix.com/app-market/web-solution/sparklayer-b2b-wholesale), SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your Wix store. The best part is you can retain your *existing* Wix store design and layout and enable B2B alongside your retail operation (DTC). ## Supported Wix Plans  SparkLayer works with all versions of Wix including Wix Editor and Wix Studio. *** ## Wix Demo Store ::embed[]{url="https://www.youtube.com/embed/Bww33sF7sLk"} Want to see SparkLayer & Wix in action? Try it out on our Wix demo store using the details below: | Item | Details | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Login URL | [[[https://demo.wix.sparklayer.io/](https://demo.wix.sparklayer.io/) ](https://demo.bigcommerce.sparklayer.io/)](https://demo.bigcommerce.sparklayer.io/login.php)To login as a B2B click the "Try Demo" link in the main navigation. | *** ## Get started ::::LinkArray :::LinkArrayItem [Installing SparkLayer on Wix](docId\:JcMpSOZdCrFjgWO6M49rS) Learn about the steps to install SparkLayer on your Wix store ::: :::LinkArrayItem [Wix FAQs](docId\:FTSB7UVso1qIpgXNPwYcI) See some of our most commonly asked questions! ::: :::: [title] Shopify Limitations [path] Integrations/Shopify/ ## Introduction Currently, there are a small number of limitations to be aware of with the SparkLayer and Shopify Integration. | Limitation | Notes | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Discounts` | Currently, it's not possible to use Shopify discounts in parallel to SparkLayer. Instead, SparkLayer has its' own discount system that allows powerful discounts and promotions to be set up. [Learn more](docId\:WrejPw9URyjQwiQeKs_Cg) | | `Product SKUs` | Within Shopify, the product **must** have a SKU and this must be unique per product. | | `Product Customisations` | If you're using an app that adds customisations to a product (e.g. a text-entry field), these will not show within the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). SparkLayer will only show the variants set up within Shopify's own catalogue (e.g. size, colour). It is possible to add customisations using the [JavaScript SDK](docId:315uNbM85_FWnh6FU9KkK) however please be aware that this will require custom development. | | `Cart Line Items` | A set a restriction of a **350 line items**. By request to support, this can be increased to 500, please note this is not by default due to the performance of the Shopify APIs. | | `Product Tax rates` | If you're using line-item tax exemption rules within your product catalogue, SparkLayer will not have appropriate tax handling if a customer's order combines both tax-included and tax-exempt products.
For stores which "Include taxes in pricing", we'll be unable to calculate the gross pricing correctly, and we recommend setting up another store specifically for B2B with this setting off where we can provide net pricing. | | `Duties` | Due to Shopify's API not including Duties, we'll be unable to calculate duties as a 'separate' addition to the cart when completing an order. It's recommended that, if you're using duties in your store, to [disable this option](https://admin.shopify.com/settings/taxes/duties/management) in your Shopify admin settings or create a separate B2B store if required. We will add support for this as soon as is available with Shopify. | | `Companies` | Currently, SparkLayer is not compatible with Shopify B2B companies. Please refer to our [Shopify FAQs](docId\:P-7titr2d20hXBeixvKBZ) for recommended options on how to migrate from Shopify Companies to Shopify (regular) Customers. | [title] Shopify B2B Landing Page [path] Integrations/Shopify/Shopify Customisations/ ## Introduction  When your B2B customers sign in, you may want to take them to a dedicated page that provides a more tailored experience - whether it's to highlight specific products, show important information, or act as a central hub for your B2B store. SparkLayer gives you the ability to control *where* B2B customers land when they log in, and you can customise this to suit your needs. In this guide, we’ll cover a few ideas and approaches you can take. :::hint{type="info"} I**mportant to note** Customising the landing experience for B2B customers is a Shopify-specific change and will require making updates to your theme or using a page builder app. While SparkLayer enables the redirect behaviour, we’re unable to assist with Shopify design or layout customisation. If you’re unsure how to make the changes in Shopify, we recommend working with a Shopify expert ::: *** ## Redirect to a B2B product collection One simple approach is to create a B2B-specific **collection** in Shopify that contains the products you want your B2B customers to see first. For example: :::BlockQuote /collections/b2b-products ::: You can manage collections in Shopify by going to **Products** > **Collections** in your [Shopify admin](https://admin.shopify.com/collections?selectedView=all). Once created, you can configure SparkLayer to redirect logged-in customers to this URL instead of the standard homepage (see "*How to redirect B2B customers to a custom URL*" below) This is ideal if you want your customers to immediately browse and order from your wholesale catalogue. *** ## Create a custom landing page in Shopify Another option is to create a standard **page** in Shopify (e.g. named "*B2B Landing Page"*) and build it out with relevant content. For example, the URL could be: :::BlockQuote /pages/b2b-landing-page ::: This page could include: - Rich text or welcome messaging - Featured product links or categories - Helpful content or banners - Links to customer account tools (e.g. invoices, quick order) You can manage and edit pages directly from the Shopify admin, under **Online Store > Pages** and also within **Online Store** > **Customize** on your live theme. Once created, you can configure SparkLayer to redirect logged-in customers to this URL instead of the standard homepage (see *"How to redirect B2B customers to a custom UR*L" below) :::hint{type="info"} **Please note** The level of functionality may depend on which theme you are using and you may need to consult your theme developer on how best to approach this. ::: *** ## Use a third-party page builder app If you want more control over the design, you can use a **Shopify page builder app** and redirect your B2B customers to a specially designed page. There are many options within the Shopify app store such as: - [PageFly](https://apps.shopify.com/pagefly?st_source=autocomplete\&surface_detail=autocomplete_apps) - [Shogun](https://apps.shopify.com/shogun?st_source=autocomplete\&surface_detail=autocomplete_apps) - [Instant](https://apps.shopify.com/instant-builder?st_source=autocomplete\&surface_detail=autocomplete_apps) - [and many others](https://apps.shopify.com/categories/store-design-storefronts-page-builder/) These apps give you drag-and-drop interfaces to create visually rich landing pages, without needing to write code. This can be a great solution if you want a highly polished, branded B2B dashboard or homepage. As with other pages in your Shopify store, page builder apps will also generate a unique URL that you can direct your B2B customers to. For example, the URL could be: :::BlockQuote /pages/b2b-customer-landing-page ::: Once created, you can configure SparkLayer to redirect logged-in customers to this URL instead of the standard homepage (see *"How to redirect B2B customers to a custom UR*L" below) *** ## Other ideas Every B2B setup is different, and your landing page might be shaped by what matters most to your customers. You could also consider including: - A quick links section to access quotes, past orders, or special promotions - Displaying B2B-only content using Shopify Liquid (read our guide to showing B2B-only content) - Embedding a video or help resources to guide new customers *** ## How to redirect B2B customers to a custom URL When a logged in customer accesses your website's existing my account area (e.g. `/account`), it will redirect them to the SparkLayer My Account interface instead. If you'd prefer, you can change the default handling and set a custom URL to redirect B2B customers to once they log in. You can do this by updating the SparkLayer Core Script on your website. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ accountRedirect: { urlRegex: /\/account/g, goTo: "/index", // page to redirect logged in users to }, /* End of code */ ``` ::::Tabs :::Tab{title="🛍️ Using Shopify"} **Using Shopify Customer Accounts (New Accounts)** If you're using Shopify Customer Accounts, you can configure which URL to send a customer to directly via your Shopify admin. In your Shopify admin, go to Settings, Checkout, and within [Configurations](https://admin.shopify.com/settings/checkout#checkoutprofiles), click "Customize".  From the top, navigate to the "Orders" page, click "Apps" on the left, and then enable the "B2B Account Redirect" extension. You can include: - Some optional placeholder text that shows before the customer is redirected should you wish to inform them that they are being redirected. - A specific destination URL to take the customer to once they are redirected. For example, you may want to take them to a specific collection page or a landing page. **Setting up redirect URLs based on a customer tag** If you're using *Legacy* Shopify accounts (Classic Accounts), you can also add handling to vary the destination redirect URL based on a customer group. E.g. customer group ABC goes to` /collections/wholesale-page` whereas customer group XYZ goes to `/collections/wholesale-vip` Within your SparkLayer Core Script, you can replace the above code sample with the following Liquid code logic (and adapt accordingly): ```javascript accountRedirect: { urlRegex: /\/account/g, {% assign goTo = "/index" %} {% for tag in customer.tags %} {% if tag == "b2b-group-1" %} {% assign goTo = "/collections/wholesale-page" %} {% elsif tag == "b2b-group-2" %} {% assign goTo = "/collections/another-wholesale-page" %} {% endif %} {% endfor %} goTo: {{ goTo | json}}, }, ``` ::: :::Tab{title="🌐 Other platforms"} No configurations available. ::: :::: *** ## Show custom content on your B2B landing page You can also use Shopify’s Liquid templating to tailor the content on your landing page depending on whether a customer is a B2B user. Here’s a simple example: ```html {% if customer.tags contains 'b2b' %}
**Please note:** this must match exactly what is in Unleashed and be seperated by a **comma** with **no** space (e.g. `GROUP1,GROUP2)`. For the purposes of testing, we recommend creating a new group and testing with a dummy customer first before using an existing group. | | `Price Lists` | This is the Unleashed price list you want to set as highest priority for all customer groups. For example if you assign a price list here this would take priority over all other price lists assigned to the customer account.
**Please note: **if you are adding multiple price lists, these must be seperated by a **comma** with **no** spaces. | *** ## Configuring Customers Broadly speaking, Unleashed is your **central location **for managing B2B customer data. When customers are configured in Unleashed as B2B customers, SparkLayer can **automatically** retrieve this data and then enable the B2B ordering experience on your Shopify site. ::::ExpandableHeading **Step 1 - setting up Customer Types** When you have set up the [integration with SparkLayer](https://app.sparklayer.io/configuration/integrations/partners) within your Unleashed Dashbaord, go to **Settings** and then **System**. Within the options you will see **Customer Type**. Within this field, you'll then need to create the different customer groups that you are going to be offering different prices to.  Next, navigate to your **SparkLayer Dashboard** and [Customer Groups](https://app.sparklayer.io/customers/groups). Here you'll need to create the customer groups with the names **matching** the title of the **Customer Types** you have created in Unleashed. In our example below, we have `Base` and `Gold`.  Next, go to the [Partner Integrations](https://app.sparklayer.io/configuration/integrations/partners) section of SparkLayer and click **Modify** within the Unleashed integration. Finally, add the **Customer Types** you have created in Unleashed that you want to sync across to SparkLayer. In our example, we've added them for `Base` and `Gold`. :::hint{type="warning"} **Please note** Customer Types**must** be seperated by a comma with **no** spacing to sync correctly e.g. `Base,Gold` :::  :::: ::::ExpandableHeading **Step 2 - syncing your customers** To sync your customers, you'll need to create your customers in your Unleashed Dashboard if you haven't already. When doing this you are able to allocate them a **Customer Type. **This will assign them into the specific [customer group](https://app.sparklayer.io/customers/groups) within SparkLayer when they are synced across. **Please note: **The customer will be tagged with this customer group as the normal SparkLayer process.  When setting up your customers in Unleashed, please ensure you set up: - A full address - Assign any specific tax settings - Assign a valid email address. This must be set up in order to sync to SparkLayer and Shopify. **Syncing across to SparkLayer and Shopify** First, you'll need to update the customer type to match that entered in the **Customer Type** field (as noted above). SparkLayer is then configured to synchronise **once per night**, and any new and updated records will automatically be synchronised with Shopify. Customers are mapped between the systems based on the **primary contact email** set within Unleashed. Once this is mapped, SparkLayer will then synchronise the following data into Shopify and you'll be able to see within the customer record within Shopify. | **Unleashed** | **Shopify / Spark Layer** | | ------------------- | ------------------------------------------------------------------ | | `Address` | Shows against customer record in Shopify | | `Phone` | Shows against customer record in Shopify | | `First / Last Name` | Shows against customer record in Shopify | | `Company Name` | Shown via metafields in Shopify | | `Stop Credit` | Shown via metafields in Shopify (used to allow payment on account) | | `Taxable` | Shows against customer record in Shopify | :::hint{type="warning"} **Please note** All customer data is managed via Unleashed and any amends made directly in Shopify will **not** synchronise back to Unleashed. ::: :::: :::ExpandableHeading **Step 3 - giving access & notifying new customers** Since Unleashed is the central source for customer data, any new customers created in Unleashed will **automatically** be added to Shopify. When new customer records are added to Shopify, they will by default be added as **Pending** customer accounts and receive an **automatic email** to enable their account by setting a password.  This uses the **Customer account invite** notification email which can be edited in the [Notifications section within Shopify](https://admin.shopify.com/settings/notifications/customer). If you prefer **not** to send the customer account invite automatically, you can easily check if this option has been activated. Simply go to your SparkLayer Dashboard, navigate to [Partner Integrations](https://app.sparklayer.io/sparklayerunleashedtest/live/configuration/integrations/partners). When modifying your Unleashed integration, you can enable or disable this via the setting at the bottom.  ::: *** ## Configuring Pricing In Unleashed, you can utilise **up to 10 price lists**, allowing you to create multiple pricing tiers tailored to your various customer levels. On top of this limit, you have the flexibility to set customer-specific and product-specific discounts, providing even more granular control over your pricing strategy. ::::ExpandableHeading **Step 1 - price list setup** In Unleashed, navigate to **Settings **> **System **> **Sell Price Tiers**. Here, you can customise the names of your price tiers, which are initially labelled as "Sell Price Tier 1" through to "Sell Price Tier 10". :::hint{type="warning"} **Please note** SparkLayer **does not** support the custom names meaning they will show in SparkLayer as "Sell Price Tier X" ::: **Promotion price list** If you want to offer a promotion to customers you are able to do this by creating a promotional price list. You are able to do this by adjusting the product prices within a specific price list mentioned above. You are then able to sync this to all of your customers and make it a "priority price list". You'll need to add this to the [Partner Integration](https://app.sparklayer.io/configuration/integrations/partners) within the SparkLayer Dashboard by clicking **Modify** on the Unleashed option. Within the Price Lists section, enter the price lists you want add. As with Customer Types, if you're adding multple price lists, they must be separated with a **comma** with **no spacing**. E.g. `PriceList1,PriceList1`  :::: ::::ExpandableHeading **Step 2 - viewing price lists** When you view a product within your Unleashed Dashboard, under the **Sale** tab you’ll see the available price tiers listed. For products offered to your wholesale customers, you can specify the exact price for each tier, depending on which pricing list is assigned to the customer.  If you are offering multiple currencies then you are able to use the Sell Price Tiers wihtin Unelashed to achieve this. For instance, if you offer pricing in USD, GBP and EUR then you can assign each currency to a Sell Price Tier in Unleashed (e.g "Sell Price Tier 1" is your GBP price. "Sell Price Tier 2" is EUR). You are able to set this up SparkLayer by going to Settings > Integrations > Partner Integrations, when modifying the Unleashed Integration and you will see the below :::hint{type="warning"} **Please note** If you only sell in the base currency of the store then you will not need to specify the currency as above. :::  :::: ::::ExpandableHeading **Step 3 - assigning a price list** Within your Unleashed Dashboard, navigate back to the customer account that you are working on. You are then able to assign them a price list directly to the customer account within **Sell Price Tier**. This means when they login they will see the product pricing you've assigned to them.  :::hint{type="warning"} **Please note** These price lists will be asigned directly to the customer account through the SparkLayer price list metafield which is set up differently to standard price lists. You can learn more in [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) ::: :::: ::::ExpandableHeading **Setting up product specific discounts** Within the Unleashed Dashboard, navigate to a customer record and click Customer Pricing. Here you are able to set product specific pricing for this customer account. You are able to search for a product, specify a fixed price or discount on the product. When doing this, it will create a new price list within the [SparkLayer Price Lists](https://app.sparklayer.io/pricing/lists) section.  :::hint{type="warning"} **Please note** If you choose to offer a discount this will be from the **Default Sell Price** under **Discount From**. You can see more below under our Known Limitations. ::: :::: :::ExpandableHeading **Setting up additional customer discounts** Within the Unleashed Dashboard, navigate to a customer account and under the **Details** tab, you can provide customers with an additional discount on top of their assigned price list. You’ll see a **Discount (%)** box, where you can enter the desired discount percentage. When doing this, it will create a new price list within the [SparkLayer Price Lists](https://app.sparklayer.io/pricing/lists) section.  ::: :::ExpandableHeading **Assiging prices to the Shopify Customer account** Once you have finished configuring your customers pricing and a sync has taken place, you can then check the customer account in Shopify to ensure they have been assigned the correct pricing. The price list will be assigned directly to the customer account in a **Price List metafield** (this gets added automatically when you first set up the SparkLayer integration). It will also create the price list within your SparkLayer Dashboard > Price lists as an "Integration" Price List. With this metafield it will **always** work in a hierarchy order, which means when a customer searches a SKU it will check the first price list and will cascade through the price lists untill it finds a price. In the example below you are able to see a number of price lists. 1. Any** customer product specific discounts** you have created within the customer in Unleashed. 2. Any** customer specific percentage discounts **that you have given on top of the price list assigned to the customer. 3. The **normal price list **that you have assigned to the customer 4. You will alway see a fallback of the **Default Sell Price**.  ::: *** ## Data mapping We've detailed how data is mapped between SparkLayer and Unleashed. | Item | Details | | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Creating Price Lists` | SparkLayer generates several types of price lists based on the product prices available in Unleashed. | | `Default Price List` | All product prices set in Unleashed under the **Product/Sale** tab go into a standard Default Price List. This acts as the baseline price for all products. | | `Sell Price Tiers` | If Unleashed has specific Sell Price Tiers set up (e.g., "Sell Price Tier 1", "Sell Price Tier 2", etc.), SparkLayer creates separate price lists for these tiers. Unleashed supports up to 10 Sell Price Tiers that you can assign to different groups of customers. | | `Customer-Specific Prices` | If any customer has unique prices specified under the Customer/Product Pricing tab in Unleashed, SparkLayer creates a Customer-Specific Price List for that customer. This ensures that individual customer agreements or special pricing arrangements are captured. | | `Handling Different Currencies` | If a customer uses a currency other than the base currency, SparkLayer will automatically create Alternative Currency Price Lists based on the existing price lists. | | `Applying Discounts` | If a customer has a specific discount percentage assigned (e.g., 10% off all products), SparkLayer will generate a Discounted Price List to reflect the adjusted prices. | | `Assigning Price Lists to Customers` | When assigning prices to customers, SparkLayer follows this order of priority:
* First, the Customer-Specific Price List (if available). * Then, a Sell Price Tier (if assigned in Unleashed). * Finally, the Default Price List.
If a customer has multiple currencies or discounts, they will get additional price lists accordingly. | | `Why Prefixed Price Lists?` | SparkLayer may apply generic "prefixed" price lists to every customer. This is to ensure that a basic Sell Price Tier is always in place, even if the customer’s Unleashed configuration doesn’t explicitly assign one. | *** ## Known limitations **Setting a Discount % as a Price Type** In Unleashed, you can assign the customer’s ‘Sell Price Tier’ from the ‘Details’ tab of the customer record.  Additionally, you can set up specific discounts from the ‘Customer Pricing’ tab. However, there is a specific configuration of this that we do not support due to a limitation with the Unleashed API. If you choose ‘Discount %’ as the Price Type, it will only affect their ‘Sell Price Tier’ (as referred to above), and not the ‘Default Sell Price’ or the ‘Customer Price Tier’.  The following limitations also apply: - Internally SparkLayer will use the internal SellPriceTier naming for simplicity between mapping, not the custom naming that can be setup via the Unleashed Settings - Customers set as obsolete will not be synced. When converting an account to obsolete in Unleashed, the customer will be needed to be disabled manually in Shopify. - Changing the customers email address, will create an additional customer in Shopify. The old account will need to be disabled manually. - Primary Customer Contacts will only be synced. If a new primary contact is selected, the existing Shopify customer on the store should be manually disabled. - Order Import Options in Unleashed Order Configuration must not use import orders to a single customer. To get around this, using a second store for B2B can be the solution. - Customer Synchronization must be disabled in the Unleashed Shopify integration. *** ## Troubleshooting :::ExpandableHeading **Why are some of my customers not syncing correctly from Unleashed to Shopify?** Ensure that the Customer Type field in Unleashed matches exactly what you have set up in SparkLayer. Remember, the Customer Type names should be separated by a comma with no spaces (e.g., Base,Gold). Also, check that the email address is correctly set in Unleashed, as this is used to map the customer records. ::: :::ExpandableHeading **Why am I not seeing the B2B pricing updates in my Shopify store?** This could be due to the pricing rules in Unleashed not being set up correctly. Make sure that the Price Lists in Unleashed are correctly assigned to the customers. Check that these lists match the Price Lists configured in SparkLayer and that they are separated by commas without spaces. ::: :::ExpandableHeading **Why do changes I make in Shopify not reflect in Unleashed?** Shopify is not the master data source for customers in this integration. Unleashed is the single source of truth, meaning any updates made directly in Shopify will not synchronise back to Unleashed. Make changes in Unleashed, and the integration will push these updates to Shopify. ::: :::ExpandableHeading **What should I do if orders placed in Shopify are not appearing in Unleashed?** Verify that the integration settings are configured correctly in the Unleashed Dashboard. Check that the correct API Key and Customer Type fields are being used. If these are set correctly, review the order logs in SparkLayer for any errors during the sync process. ::: :::ExpandableHeading **Why are my custom price lists not displaying properly in SparkLayer?** SparkLayer currently supports Unleashed’s default Sell Price Tiers (e.g., "Sell Price Tier 1"). If you’ve created custom-named tiers, they will not appear in SparkLayer. You need to use the default naming convention for Sell Price Tiers to ensure they display correctly. ::: :::ExpandableHeading **Why am I getting duplicate customers in Shopify after updating emails in Unleashed?** When you change a customer’s email address in Unleashed, it is treated as a new customer by Shopify. To avoid duplication, manually disable the old account in Shopify after making the change in Unleashed. ::: :::ExpandableHeading **Why are my customer-specific discounts not being applied correctly?** Check that the Discount % has been set correctly in Unleashed. Keep in mind that using the "Discount %" option affects only the Sell Price Tier and not the Default Sell Price. For accurate discounts, make sure to apply them to the relevant Price Tiers or use Customer Pricing options within Unleashed. ::: [title] BigCommerce FAQs [path] Integrations/BigCommerce/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for BigCommerce?** All SparkLayer plans are compatible with BigCommerce, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, our team will contact you to discuss the most appropriate plan for your needs. Billing is managed via a monthly billing cycle with the option to pay annually. ::: :::ExpandableHeading **How do I select and change plan (upgrade or downgrade)** You can sign up to SparkLayer on BigCommerce without initially selecting a plan. Once you've installed SparkLayer, our team will contact you to discuss the next steps. Once you've activated a plan, we are happy to work with you to upgrade or downgrade based on your changing requirements. ::: ### BigCommerce setup :::ExpandableHeading **Where do I find the SparkLayer BigCommerce app?** You can find the official SparkLayer for BigCommerce app in the [BigCommerce App Store](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/). ::: :::ExpandableHeading **What BigCommerce plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of BigCommerce, from BigCommerce Essentials right through to BigCommerce Enterprise. All you need is an active BigCommerce store and you're good to go. ::: :::ExpandableHeading **Can I use SparkLayer with my development website?** Yes! If you're setting up SparkLayer on a development store (e.g. a test account), we can enable a special developer-mode that lets you use SparkLayer until you're ready to activate a billing plan. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) for more details. ::: :::ExpandableHeading **Can I have DTC and B2B on the same BigCommerce website?** Yes, it's possible to install SparkLayer onto your existing BigCommerce DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://b2b-demo-store-usd.myshopify.com/) ::: ### Theme setup :::ExpandableHeading **Can you help me install SparkLayer on my BigCommerce website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any BigCommerce theme?** Yes! SparkLayer is compatible with all BigCommerce themes, even fully customised. If you need help in the setup, our team can add all the code snippets for you. ::: :::ExpandableHeading **How does SparkLayer affect my current BigCommerce theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a b2b customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your BigCommerce store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** In terms of payment methods supported by SparkLayer and BigCommerce. If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the BigCommerce checkout. From there, any payment methods you have set up in BigCommerce (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. We've attached a screenshot to illustrate this. In short, if BigCommerce support this payment method, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** BigCommerce does have the ability to hide collections from Customer Groups which could be one way to achieve this.  There are a few things we recommend to make the experience better: - You could **create a B2B-only collection** and redirect customers to this once they login. If you wanted to show special B2B-only products, you would need to create these as separate products within BigCommerce (i.e. with unique SKUs, etc) - With SparkLayer pricing, if you don't upload a price against a SKU, the B2B customer** won't be able to purchase it.** So this is a way to prevent them from adding items you don't want them to purchase - It is possible to adapt the BigCommerce themes to hide/show products using custom coding ::: :::ExpandableHeading **Can I use my BigCommerce prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your BigCommerce prices (e.g. your main BigCommerce retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your BigCommerce prices and we can even make provisions for your tax set up in BigCommerce (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within BigCommerce, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within BigCommerce so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in BigCommerce, it's relatively quick to do. You can either edit individual products and add them manually, or you can use BigCommerce's 'Import' or 'Edit products' feature to do this in bulk. ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. SparkLayer has a way to "reserve" stock for your DTC customers, essentially blocking B2B customers from ordering too much inventory for a specific product. [Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in BigCommerce to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: :::ExpandableHeading **Can I sell products on both store fronts?** Yes, it is possible to have product purchaseable on both store fronts if you are using both for wholesale. When you are in the product within your admin, please ensure that you have both store fronts selected as sales channles that you want to offer the products on. ::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some custom coding - You could use a [recommended form builder app](https://support.bigcommerce.com/s/article/Creating-a-Contact-Form?language=en_US#form-builders) to achieve this It's also worth noting that you can manually add customers via the **BigCommerce Customers** admin and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** Please refer to [our guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: :::ExpandableHeading **Will SparkLayer slow down my BigCommerce website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my BigCommerce website?** We recommend consulting with a BigCommerce expert developer before making changes to your website. For their reference, you may find the following Stencil code can be used as a mechanism to hide and show content based on a B2B customer being logged in. ```html {{#contains (toLowerCase customer_group_name) "b2b"}} {{/contains}} ``` ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in BigCommerce?** **Manual payments** For manual (non-card) payment orders (e.g. Payment by Invoice), the order is saved as a "Draft order". - You can view these in your BigCommerce admin within **Orders** and then click **Draft Orders** - You can then convert these into approved orders by marking them as paid or marking them with payment terms It's important to note that once an order has been approved, it will **only** then show in the customers My Account section and the [SparkLayer Dashboard](https://app.sparklayer.io/orders). **Card payments** You can view these in your BigCommerce admin within **Orders** ::: :::ExpandableHeading **How do I see the 'shipped' order status when viewing an order on SparkLayer?** SparkLayer will automatically show a B2B order as "Shipped" providing it meets the following conditions: 1. The order is marked as 'Shipped' within BigCommerce 2. The order has a shipment assigned to it within BigCommerce Without the both being applied to an order, the B2B order will remain in a "Processing" state until actioned. ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within BigCommerce when an order is placed via SparkLayer. If you have it configured to create orders as 'Draft orders' you can go into the order and make changes. If you subsequently then manually complete the order (i.e. Mark as paid), you can still edit the order up until the point of fulfilment. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly but there are some good ways to do this within BigCommerce using a recommended invoicing app or by sending invoices manually to your customers via your existing back-office financial system. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we do have support for minimum (and maximum) quantities, but you're only able to set these at a product or product-variant level. It's not currently possible to set minimum order-level quantities but it's something we are considering as part of a future update! ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** You can manage notifications from BigCommerce by going to **Settings** and clicking **Order Notifications** ::: [space] SparkLayer B2B Catalogs (/b2b-catalogs) [title] Configuring Access Denied View [path] Setup/ When a product has been hidden for a customer, if the customer attempts to access the the product's PDP page - they will be shown an "access denied" view. If you would like to customize the content of this page, you can do so by modify the liquid `snippets/sparklayer-b2b-catalogs-access-denied.liquid` file that is automatically added when you installed the B2B Catalogs app. :::hint{type="warning"} **Please note** If you disable B2B Catalogs on a theme where you have modified this file, your modifications will be removed. ::: [title] Enabling Catalogs [path] Setup/ :::hint{type="success"} Enabling B2B catalogs is as simple as selecting a theme you would like to display your catalogs, and clicking the `enable` button. :::  Once you've enabled B2B Catalogs on a theme, you will see a list of all other themes which you can / have already enabled B2B Catalogs on. There is no limit to the amount of themes you can have Catalogs enabled on.  [title] Limitations [path] / ### Advanced Catalogs Variant Count Due to the way Shopify provides access to product variants within a theme - we can only guarantee the desired hide/show behaviour on products with `<= 250` variants. ### Hidden product Add to cart caveats If a customer already has a product in their cart before said product is configured such that it should be hidden - the product will remain in the customers cart and they will be able to check out. Similarly customers will still be able to add a product to their cart via add to cart permalinks even if the product is hidden from them. ### Third party app compatibility The Shopify app eco-system is vast, as such we cannot guarantee compatibility with all other third party apps ### Invalid liquid syntax We're unable to modify theme files that contain invalid liquid syntax. If you encounter an error stating `invalid liquid syntax in file` while attempting to enable/disable catalogs on a theme, please fix the
[title] Introduction
[path] /
[B2B Catalogs](https://apps.shopify.com/sparklayer-b2b-catalogs) is a free SparkLayer app that gives you control over which products are visible to different types of customers on your Shopify store. Whether you want to hide specific products from B2C customers, restrict certain items to B2B customers only, or show different product ranges to different customer groups - B2B Catalogs makes it easy to manage from your Shopify admin
The app works by making modifications to your theme files, and you can enable or disable it across your store themes via the app interface.
B2B Catalogs is a [standalone Shopify app](https://apps.shopify.com/sparklayer-b2b-catalogs) available for free.
***
## Getting started
To get started, install the [B2B Catalogs app for Shopify](https://apps.shopify.com/sparklayer-b2b-catalogs) and you'll then be guided through the setup process.
::::LinkArray{contentSource="CUSTOM"}
:::LinkArrayItem{headerType="COLOR" headerColor="#2166AE"}
[Setup](docId\:aKcu9vZHZ16uDGPc_kkWX)
:::
:::LinkArrayItem{headerType="COLOR" headerColor="#14B8A6"}
[Support](docId\:d28pJzUn0Qp2b3XgxFQxP)
:::
:::LinkArrayItem{headerType="COLOR" headerColor="#A855F7"}
[Removing B2B Catalogs](docId\:M87qgqzLKYfKtimRI13AW)
:::
::::
[title] Removing B2B Catalogs
[path] /
:::hint{type="warning"}
If you have enabled B2B Catalogs on any of your themes and want to uninstall the App from your store, you **must** first **disable **B2B Catalogs from any themes it is currently enabled on.
:::
To **disable** B2B Catalogs for a theme, open the App within the Shopify admin and click the "disable" button on any currently enabled themes.
Once all themes have been disabled, you can uninstall the B2B catalogs app.
:::hint{type="warning"}
**Already uninstalled the app?**
You will need to re-install the app temporarily and follow the instructions above.
:::
[title] Support
[path] /
## Ways to contact us
We're here to help! If you need technical support, such as assistance in configuring the B2B Catalogs app on your store, you can either:
- Email [support@sparklayer.io](mailto\:support@sparklayer.io) or
- Click the message icon within the B2B Catalogs app or on the bottom right of this page.
So that we can best help, please ensure you provide key details including:
- What your query is about
- Any screenshots that may help us resolve your query as quickly as possible.
We aim to respond to all queries **within 24 hours**, but please allow up to two working days for a response.
:::hint{type="warning"}
**Messaging via our chat system**
Please note, we operate with a small team and as such, our support is not always available on an immediate 'live chat' basis so we can't always provide a real-time response to your queries. Our support team is normally very responsive and we do tend to reply to queries with a resolution very quickly.
:::
[title] Setup
[path] /
***
## Summary
| What you want to do | How to do it |
| ---------------------------------------------------- | -------------------------------------------------------------------------- |
| Show a product only to B2B customers | Add the `b2b-only` tag to the product |
| Show a product only to B2C customers | Add the `b2c-only` tag to the product |
| Hide a product from a specific B2B customer group | Add a `sparklayer.settings` metafield with the group set to display: false |
| Show a product only to a specific B2B customer group | Set base to `display: false` and the target group to `display: true` |
[title] FAQs
[path] /
## Introduction
Below you'll find answers to the most common questions about SparkLayer B2B Catalogs. If you can't find what you're looking for, get in touch with our support team and we'll be happy to help.
### Where exactly are hidden products hidden?
When you hide a product using B2B Catalogs, it is hidden across your entire store - including product pages, collection pages, and store search results. If a customer tries to access a hidden product's URL directly, they will see a customisable "access denied" page.
### Is B2B Catalogs free?
Yes. B2B Catalogs is a free standalone Shopify app included with every SparkLayer plan - including the free plan. You can install it from the [Shopify App Store](https://apps.shopify.com/sparklayer-b2b-catalogs).
### Do I need a developer to set it up?
No. B2B Catalogs is designed so your merchandising team can manage everything end-to-end. Tag a product, toggle a group, save - and changes go live instantly. No manual theme edits, no custom coding, and no waiting on a release cycle. You can follow our setup guide to get started in minutes.
### Will hidden products still appear in my sitemap or affect SEO?
Products tagged as b2b-only will still appear in the sitemap that Shopify generates automatically. However, the product pages themselves will not be visible to search engines, so they won't show up in external search results. If you need to fully remove these products from your sitemap, you'll need to follow[ Shopify's guidance on hiding products from search engines](https://help.shopify.com/en/manual/promoting-marketing/seo/hide-a-page-from-search-engines#custom-metafield) . Keep in mind that doing so may also prevent those products from appearing in your store's own search results.
### Can I show different products to different B2B customer groups?
In combination with the [SparkLayer B2B & Wholesale Shopify App ](https://docs.sparklayer.io/) it's possible to gain more granular control via the `sparklayer.settings`variant metafield, showing or hiding products between customer groups. For example, you could hide a product from all B2B customers except your 'VIP' group, or hide a specific range from one group while keeping it visible to everyone else. See our setup guide for full details on how customer group rules work.
For more detailed instructions, see[Configuring Advanced Catalogs](docId\:y8pm3bILZW6g6wryevinZ)
### Can I control visibility at the variant level?
In combination with the [SparkLayer B2B & Wholesale Shopify App,](https://docs.sparklayer.io/) B2B Catalogs supports variant-level visibility rules. You can show a 750ml bottle to your B2C shoppers while restricting the 12-pack case to wholesale customers. Same product, different visibility, no duplicate listings needed.
For more detailed instructions, see [Configuring Advanced Catalogs](docId\:y8pm3bILZW6g6wryevinZ)
### What happens if I disable B2B Catalogs on a theme?
Disabling B2B Catalogs on a theme will remove the visibility rules from that theme. If you've customised the `snippets/sparklayer-b2b-catalogs-access-denied.liquid` file, your modifications will also be removed. We recommend keeping a backup of any customisations before disabling.
### How do I uninstall B2B Catalogs?
Before uninstalling the app, you must first disable it on all themes where it is currently enabled. Open the app in your Shopify admin and click "Disable" on each active theme. Once all themes are disabled, you can safely uninstall the app. If you've already uninstalled without disabling first, you'll need to reinstall the app temporarily, disable it on your themes, and then uninstall again.
For full instructions, see [Removing B2B Catalogs](docId\:M87qgqzLKYfKtimRI13AW).
[title] Configuring Your Catalogs
[path] Setup/
B2B Catalogs uses a combination of customer tags, product tags, and variant metafields to control product visibility across your store.
### Configuring your Customers
To identify a customer as a B2B customer, add the `b2b` tag to their customer record in Shopify Admin.
| **Tag** | **Description** |
| ------- | -------------------------------------- |
| `b2b` | Marks the customer as a B2B customer. |
### Configuring your Products
You can control basic product visibility using the following product tags in Shopify Admin:
| **Tag** | **Description** |
| ---------- | --------------------------------------------------------------------------------------------- |
| `b2b-only` | Hides the product from standard B2C customers. Only customers with the `b2b` tag will see it. |
| `b2c-only` | Hides the product from B2B customers. Only standard B2C customers will see it. |
### Configuring Advanced Catalogs
:::hint{type="warning"}
The Advanced Catalogs feature is only available to merchants with the [SparkLayer B2B & Wholesale Shopify App ](https://docs.sparklayer.io/)
:::
| **Metafield** | **Description** |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `sparklayer.settings` | While using[ Sparklayer's variant level selling rules](https://docs.sparklayer.io/product-settings#available-product-settings), if *all *variants have the `display` rule set to `false` for the active customer's customer group, the product will also be hidden. |
For more information see [Configuring Advanced Catalogs](docId\:y8pm3bILZW6g6wryevinZ)
[title] Configuring Advanced Catalogs
[path] Setup/
:::hint{type="warning"}
The Advanced Catalogs feature is only available to merchants with the [SparkLayer B2B & Wholesale Shopify App ](https://docs.sparklayer.io/)
:::
Advanced catalogs allow you to show or hide products at a variant level to your different B2B customer groups.
***
## Configuring Variant Visibility
[Setup Variant level metafields](docId\:OTLHhi8sQ6oS4PAt23-8H)
After following the guide linked above, use the created `sparklayer.settings` variant metafield to show or hide products for specific customer groups.
This is useful if you want certain products to only be visible to particular segments of your B2B customers.
### How the rules work
The `sparklayer.settings` metafield accepts a list of rules, where each rule specifies a [customer group](docId\:y8pm3bILZW6g6wryevinZ) and whether the product should be displayed for that group:
:::BlockQuote
\[
\{
"customer\_group": "group-name",
"display": true / false
}
]
:::
By default, all customer groups can see each variant. Setting display to `false` will hide it for that group.
See more about the [sparklayer.settings metafield](https://docs.sparklayer.io/product-settings#available-product-settings)
If all variants are hidden for a given customer, the product will also be hidden.
:::hint{type="warning"}
Products using customer group metafield rules must still be tagged `b2b-only` for visibility behaviour to apply.
:::
### Understanding customer groups
In Shopify, customers are assigned to Sparklayer customer groups via tags using the format `b2b-[group]` where `[group]` is the group name.
The group name you use in the metafield corresponds to these SparkLayer customer groups.
*For Example:*
| **Customer tag in Shopify** | **Group name in metafield** |
| --------------------------- | --------------------------- |
| `b2b-vip` | vip |
| `b2b-wholesale` | wholesale |
| `b2b-trade` | trade |
The `b2b-` prefix is used on the Shopify customer tag, but when referencing the group in the metafield, you only use the group name (e.g. `vip`, not `b2b-vip`).
You can learn more about how customer groups work in our [Customer Groups](docId:5_lWMNohhjBJJppg9E6Vh) guide.
### Using the "base" group
The special customer group `base` controls the default visibility for all B2B customers. This is useful when you want to hide a product from everyone and then selectively show it to specific groups.
For example, setting the base group to `false` will hide the product for all B2B customer groups, even if the product is tagged `b2b-only`.
***
## Examples
**Hide a product from all B2B customers except a specific group**
In this example, the variant is hidden for all B2B customers except those in the `vip` customer group (i.e. customers with the `b2b-vip` tag):
```json
[
{
"customer_group": "base",
"display": false
},
{
"customer_group": "vip",
"display": true
}
]
```
**Hide a product from a specific customer group**
In this example, the variant remains visible to all B2B customers except those in the `vip` customer group:
```json
[
{
"customer_group": "vip",
"display": false
}
]
```
[space] SparkLayer Ignite API (/ignite)
[title] Platform Connection
[path] /
## Introduction
*Platform connection* is the term used for when a platform is connected to SparkLayer. There are **two endpoints** that are used to inform of a new connection or once it's removed. It is also important to understand and support the two different flows for a new platform connection, depending on how the platform is connected to SparkLayer.
## Platform Connection Flows
There are two different flows for a new platform connection, depending on how the platform is connected to SparkLayer:
### Initialized through the eCommerce platform
This is when the platform connection is initialised though the relevant app store (or similar) on the eCommerce platform. For example, this is when a merchant installs the SparkLayer app on BigCommerce or Shopify.
**Please note:** this flow is only applicable if the Ignite integration is being built for a platform that supports 3rd party apps.
**Dashboard API:** The SparkLayer Dashboard API is used to register the user with SparkLayer, create a platform connection between a 3rd party platform and a SparkLayer site, and to obtain the site onboarding progress data. The documentation for this API is not available publicly, but can be provided on request.
The flow is as follows:
1. The eCommerce platform SparkLayer app is installed on the store
2. Store credentials and other relevant data required by the integration should be stored in the integration for later use. This usually includes the store identifier and eCommerce platform API access token or credentials.
3. The user is shown a SparkLayer registration page within the now installed platform SparkLayer app. To regsiter the user with SparkLayer, the internal SparkLayer Dashboard API user registration endpoint should be called.
4. Once the registration is successful, SparkLayer will return the relevant site environment and ID values which should then be used to call the SparkLayer site platform connection endpoint telling SparkLayer that we want to link the eCommerce platform to the newly registered SparkLayer site.
5. SparkLayer will then call the Ignite integration New Platform Connection endpoint with the SparkLayer site id and credentials data, and the Ignite integration should store this and perform the complete platform connection actions such as full data sync.
6. At this stage, the platform connection is complete and the user on the eCommerce platform store app (if applicable) should be shown the SparkLayer onboarding steps as well as links to the SparkLayer Dashboard and end-user documentation (the onboarding progress data can be obtained though the SparkLayer Dashboard API's GET onboarding steps endpoint).
### Initialised though the SparkLayer dashboard
This is when the platform connection is initialised though the SparkLayer Dashboard `Configuration -> Integrations -> eCommerce Platform` page of an existing SparkLayer site. In this scenario the flow is as follows:
1. SparkLayer will call the Ignite integration's new platform connection endpoint with the SparkLayer site and credentials data.
2. The integration should store this data and return a redirect url to which the merchant user should be redirected to install the SparkLayer app on the eCommerce platform.
3. Once the app is installed, the eCommerce store credentials and other relevant data should be stored in the integration.
4. As at this point both the SparkLayer and the eCommerce platform data is known by the integration, the platform connection is complete, and actions such as a full data sync can be initialised.
5. The user can be shown the SparkLayer onboarding steps and progress (the onboarding progress data can be obtained though the SparkLayer Dashboard API's GET onboarding steps endpoint).
**Dashboard API:** The SparkLayer Dashboard API is used to register the user with SparkLayer, create a platform connection between a 3rd party platform and a SparkLayer site, and to obtain the site onboarding progress data. The documentation for this API is not available publicly, but can be provided on request.
## Platform Connection Endpoints
These endpoints are used by SparkLayer to inform the integration of a new platform connection or when it's removed.
### New Platform Connection
The integration should record the new platform connection and perform the inital actions if connection is complete.
If the endpoint is called by the SparkLayer Dashboard platform connect flow, this endpoint should return a `redirect_url` parameter which will be used by the SparkLayer dashboard to redirect the user to the platform SparkLayer app installation page.
Finally, once the platform connection is complete (both SparkLayer and platform config and credentials are known and the integration is able to start syncing data), the following actions should be performed:
- Register any data change webhooks with the platform if available.
- Sync the store settings from the platform to the Spark API.
- Start a full synchronisation of customers and product data.
**Important considerations:**
- Please note that the completion of the platform connection may not coincide with the call to the Add Platform Connection endpoint. This is true when the connection is initiated through the SparkLayer Dashboard and is pending completion on the external platform. In such cases, the endpoint should return a `redirect_url` for redirecting the user to the platform's SparkLayer installation page where the merchant can complete the process linking their store to the pending platform connection.
- The endpoint should be idempotent - if the platform connection is already established the endpoint should re-triger the connection completion actions in a safe idempotent way.
### Remove Platform Connection
This endpoint performs the following actions:
- Stop any processing of any syncing
- Delete store sync logs
- Delete any connection data locally
:::hint{type="info"}
Our API uses OAuth access tokens and therefore shortlived access tokens are required to be created. These should be stored locally alongside the connection data and refreshed when required.
:::
[title] Authentication
[path] /
When a customer signs into their account on the eCommerce platform it's necessary for SparkLayer to authenticate the customer. To avoid making customers sign in twice (to the platform and to SparkLayer), some platforms provide a mechanism to allow third parties (such as SparkLayer) to authenticate the customer. These mechanisms differ between platforms so Ignite specifies a generic endpoint which can be provided authentication data to be verified.
This diagram shows the how the authentication data moves from the front end to the Ignite API.
::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/8xQXNkIXBJbpnf7pmZhGm_authentication.png" signedSrc="https://archbee-doc-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/8xQXNkIXBJbpnf7pmZhGm_authentication.png" size="50" isUploading="false"}
## BigCommerce example
A real example will help illustrate how this works in practice.
When a B2B customer has signed in to a BigCommerce store, SparkLayer's Javascript code running in the customer's browser makes a request to BigCommerce's [current customer endpoint](https://developer.bigcommerce.com/docs/storefront-auth/current-customer#get-current-customer). This endpoint returns a JSON Web Token which is passed to SparkLayer's API.
::::hint{type="info"}
The SparkLayer API delegates the responsibility of verifying this JWT to the Ignite service for BigCommerce so that platform-specific code is kept separate from SparkLayer's core API.
:::hint
SparkLayer passes the JWT to the `/v1/{env}/{siteId}/authentication/verify` Ignite endpoint. The Ignite implementation must verify the token and return the platform's unique identifier for the customer.
The SparkLayer API then uses the customer ID returned by Ignite to generate an access token for that customer and return it to the customer's browser. This access token is used for all subsequent requests to the SparkLayer API.
:::
::::
[title] Ignite openapi.yaml
[path] /
[title] Calculate tax and shipping
[path] Endpoints Reference/Checkout/
### Code examples
```curl
curl --location --globoff '/v1/{siteEnv}/{siteId}/checkout/calculate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{"customer":{},"billing_address":{},"shipping_address":{},"shipping_line":{},"shop":{},"ignite_state":{}}}'
```
[title] Data Sync
[path] Endpoints Reference/
[title] Customer
[path] Endpoints Reference/
[title] Checkout
[path] Endpoints Reference/
[title] Authentication
[path] Endpoints Reference/
[title] /v1/{siteEnv}/{siteId}/metafield-configuration
[path] Endpoints Reference/Metafield Configuration/
### Code examples
```curl
curl --location --globoff '/v1/{siteEnv}/{siteId}/metafield-configuration' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
[title] Metafield Configuration
[path] Endpoints Reference/
[title] Customer Sub-Accounts
[path] Endpoints Reference/
[title] Trigger a Data Sync
[path] Endpoints Reference/Data Sync/
### Code examples
```curl
curl --location --globoff --request POST '/v1/{siteEnv}/{siteId}/status/{syncDataType}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
[title] Update a customer address
[path] Endpoints Reference/Customer Address/
### Code examples
```curl
curl --location --globoff --request PUT '/v1/{siteEnv}/{siteId}/customers/{customer_external_id}/addresses/{customer_address_external_id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
[title] Remove a Customer Address
[path] Endpoints Reference/Customer Address/
### Code examples
```curl
curl --location --globoff --request DELETE '/v1/{siteEnv}/{siteId}/customers/{customer_external_id}/addresses/{customer_address_external_id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
[title] Data Sync
[path] /
A key part of an Ignite integration is the data syncronization tooling. It brings data from the chosen platform (e.g. eCommerce platform) to SparkLayer. This data can then be viewed by the merchant users within the [SparkLayer Dashboard](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard). Also, the data will be used in the [SparkLayer Frontend](https://docs.sparklayer.io/sparklayer-frontend/overview-of-features) to power the wholesale ordering experience, including which customers should SparkLayer be enabled to, what pricing should be shown, as well as the customer's order history.
## When data sync happens
A full data sync is to be triggered in these scenarios:
- On install of the application
- If any inconsistencies exist and data needs to be refreshed. This will be actioned via the integration's `Trigger a Data Sync` endpoint which is called by the SparkLayer Dashboard ( when the merchant clicks the manual syncronization buttons for products and customers).
Beyond this, data will be synced via partial data updates (based on webhooks or other event mechanisms from the eCommece platform).
### Important considerations
| Area | Notes |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Queueing and retry | To ensure the stability and reliability of the platform, partial sync events should be retried in case of issues. |
| Performance | This service should not be affected by heavy users of our API and should be designed to make as little updates as possible i.e. for a product update, fetch the product and stock levels and only run updates where required. |
| Reporting | To ensure visibility of the last updated date and the last full sync. This should be logged via the sync-log API detailed further down this page. |
| Issue logging | Any issues encountered during the process should be handled and logged via the sync-log API to be displayed to our merchants in the Spark Dashboard. An example of this could be a SKU not set on a product variant or a customer address missing data such as "line 1 is empty". |
## Types of data
The data to be synced includes products, customers, orders and store settings.
### Products
Below are the key elements of data to be synced from the platform (see the API [here](https://docs.sparklayer.io/tech-docs/create-a-product)):
- `title`
- `slug`
- `external_id` -> Platform Product ID
- `variants`
- `external_id` -> Platform Variant ID
- `sku`
- `weight_in_grams`
- `position`
- `cart_image_url`
- `options`
- `status` Status should be set to live when the product is live and set to discontinued when the product is deleted.
Stock levels must be set synced from inventory\_level to our stock API (see the API [here)](https://docs.sparklayer.io/tech-docs/update-product-stock)
:::hint{type="info"}
**Extending the product object with \*\*\***B2B attributes\*\*\*
The below data would be useful if this is synced across from fields on the platform where the data could be stored, such as attributes (If possible, against the variant record)
- `rrp`
- `settings`
- `restock_date` Against the stock record but can be taken from variant
:::
### Pricing
Product pricing can be synced into the [SparkLayer Pricing API](https://docs.sparklayer.io/tech-docs/pricing-api).
We suggest that the Ignite implementation create at least one price list containing the default price for every product in the underlying platform. The price list should be named after the platform, eg. "BigCommerce Price". The price list should be created when the platform is connected and pricing should be updated whenever a product sync happens.
### Customers
Customer data to be synced (see the API [here](https://docs.sparklayer.io/tech-docs/create-a-customer)) and associated customer addresses (see the API [here](https://docs.sparklayer.io/tech-docs/create-a-customer-address)).
- `external_id` -> Platform ID
- `email`
- `first_name`
- `last_name`
- `company_name`
- `send_invite`
- `addresses`
:::hint{type="info"}
**Extending the customer object with \*\*\***B2B attributes\*\*\*
The below data would be useful if this is synced across from fields on the platform where the data could be stored, such as attributes. Group can be fed via other means i.e. if there's another field which makes sense to sync via such as if there's a group on the underlying platform.
- `group`
- `accounting_id`
- `sales_agent_groups`
- `price_lists`
- `discount_percentage`
- `payment_on_account`
- `parent_customer_id`
:::
### Orders
Order data to be synced (see the Purchasing API [here](https://docs.sparklayer.io/tech-docs/createupdate-purchase)); this needs to include order creation, amends and shipments.
For SparkLayer orders, always use the `sparklayer` purchase identifier when upserting purchases. This is important, as other parts of the SparkLayer platform might have already created a purchase for the order in question but might not have known the other identifiers such as the platform order ID. Trying to update a purchase for the same SparkLayer purchase while using another identifier that was not added during the initial purchase creation will result in an `409 Conflict` error.
:::hint{type="info"}
**Please note:** It is also useful to support syncing of historical orders that were not placed through SparkLayer but already exist on the eCommerce platform. When doing this, it's OK to PUT the purchase using the `platform` identifier as we would not have a SparkLayer one, and there would not be a conflicting order already in the system. A historical order import can be triggered by the merchant setting a special historic order import metafield.
Please see the docs for historic orders here: [Importing Historical Orders](https://docs.sparklayer.io/shopify-metafields#6jvT_)
:::
### Store Settings
On platform connection, as well as when the relevant store settings are updated on the eCommerce platform, the following store settings should be synced across:
- Base currency (this should be syned to SparkLayer using the Settings API [here](https://docs.sparklayer.io/tech-docs/update-global-setting) and a setting key of `baseCurrency`).
## Logging Sync Issues
For optimal visibility of the data syncronization process, any customer and product sync timestamps and errors should be reported through the sync-log API. This ensures that our merchants can view this information on the Sparklayer Dashboard and take the necessary actions. Documentation pertaining to the sync-log API endpoints is accessible [here](https://docs.sparklayer.io/tech-docs/core-api).
### Full Data Synchronization (Including Initial Synchronization):
During a full data synchronization a full sync log should be recorded using the PUT endpoint.
Please be advised:
- Upon a full data sync log, errors from the preceding sync log are cleared.
- It's crucial that the external\_id associated with each error remains unique. This precaution prevents errors from being mistakenly overwritten or incorrectly resolved.
- As full data sync might take a while and is often done asyncronously, it will not usually be possible to record all the errors in the inital sync log PUT request. Instead, the initial sync log PUT request can be used to record the start of the sync and the errors (as well as their potential resolutions) can be recorded in subsequent partial sync PATCH requests. Also, the sync log API needs to be notified when the full sync is complete. This can be done by sending a partial sync PATCH request with the `last_full_sync` property once the Ignite integration has finished syncing all the data.
- In the case of a full sync where items are synced in separate application instances (i.e. though a use of a queue) it's important to ensure that the sync log `last_full_sync` property is only updated once all items have been synced. For this you might need to keep track of the items synced and remaining in the integration as the sync log API does not handle this.
### Partial Synchronization:
A partial synchronization log should be recorded any time an individual item is synced. For instance, this would happen if a product or customer is updated on the store and the update is synced to SparkLayer. This can be done using the sync log API PATCH endpoint.
Please be advised:
- The PATCH endpoint retains pre-existing errors.
- Incorporates any new errors.
- Additionally, errors can be resolved using an array of successfully synchronized platform IDs.
### Protocol for Sync Log Deletion:
The sync log API is responsible for sync log upkeep. Given that previous errors are cleared during a full data synchronization, there's typically no need to delete sync logs. However, if a store decides to uninstall SparkLayer, it's essential to delete the store's synchronization logs using the designated delete endpoint.
[title] Endpoints Overview
[path] /
## Introduction
This section covers the endpoints that must be implemented by the Ignite integration. Please consult the [Endpoints Reference](https://docs.sparklayer.io/ignite/endpoints-reference) documentation for the implementation details of each endpoint, as well as the relevant overview pages for each area.
The rest of this document provides an overview of the endpoints that must be implemented by the Ignite integration for various areas:
## Platform Connection
**Add a platform connection:** the endpoint is called when a platform is connected to SparkLayer. This is done either when a connection is initialized though the SparkLayer Dashboard or when a connection is initialized externally (e.g. though the eCommerce platform SparkLayer app) and is now complete. The data provided will contain the SparkLayer site environment, ID as well as the API credentials.
**Remove a platform connection:** the endpoint is called when a platform is disconnected from SparkLayer. The integration should ensure any data syncs are cancelled and the connection data is cleaned up from the integration.
You can view the in-depth Platform Connection requirements [here](https://docs.sparklayer.io/ignite/x-67-platform-connection).
## Data Sync
Allow the triggering of the sync process from the [SparkLayer Dashboard](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard). This is only available to internal staff and used when data needs manual refreshing.
You can view the detailed requirements [here](https://docs.sparklayer.io/ignite/data-sync).
## Customer sub-account
Customer sub-accounts require customer accounts on the eCommerce platform providing a layer of authentication for SparkLayer to use similar to other accounts. These endpoints allow creation and deletion of customers for sub-accounts which can be actioned via the frontend widgets.
## Customer addresses
These endpoints allow creation, updates and deletion of customers addresses which can be done via the frontend widgets.
## Checkout
These endpoints are for calculating checkout tax, collecting available shipping methods and allowing a checkout to be created and completed (an order to be created on the platform). The checkout for upfront payment can use the standard platform checkout and does not need to include discounts and giftcards.
**Important considerations:**
- If the platform may at any point require the checkout prices to be supplied with the tax included, this needs to be handled by adding this tax to the prices that come from SparkLayer in the checkout endpoints. This is because SparkLayer prices are always tax exclusive.
- Similar to the point above, if the calculated shipping prices that come back from the platform contain tax this should also be accounted for, keeping in mind SparkLayer operates on tax-exclusive pricing.
- Carts, checkouts and orders created or updated by SparkLayer Ignite integration should be tagged that they originated from SparkLayer. For example an `external_id` or `source` parameters might need to be set, or a metafield might need to be added. This should then be used by the Order Sync logic to know which orders should be syned to SparkLayer.
- All data supplied by SparkLayer to the Ignite integration's checkout endpoints should be stored on the relevant platform cart, checkout or order objects. Where possible this data should be mapped to the native fields (e.g. customer id, order additional info etc) however in many cases metafields and attributes will need to be utilised to store some of the data that does not have a native field match.
[title] Overview
[path] /
::Image[]{src="https://www.sparklayer.io/assets/images/docs/banner-ignite.png?v=2445" signedSrc="https://www.sparklayer.io/assets/images/docs/banner-ignite.png?v=2445" size="50" alt isUploading="false"}
## 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:
::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/hzx1ykSmjuTS__j84gVES_igniteintegrationdiagram.png" signedSrc="https://archbee-doc-uploads.s3.us-east-1.amazonaws.com/kxppJrvFK15E9wXbMKaTP/hzx1ykSmjuTS__j84gVES_igniteintegrationdiagram.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAYQNQCIXNIQWBC56C%2F20240227%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240227T115438Z&X-Amz-Expires=86400&X-Amz-Signature=13f2b771a9f559493ed2e2f2b4eb23b93b5b426717790b1ba96d80c77f081d70&X-Amz-SignedHeaders=host&x-id=GetObject" size="50" isUploading="false"}
### 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:
1. One to inform of **new connection**
2. 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.
[title] Platform Connection
[path] Endpoints Reference/
[title] Create/update a customer
[path] Endpoints Reference/Customer/
### Code examples
```curl
curl --location --globoff --request PUT '/v1/{siteEnv}/{siteId}/customers' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{"email":"string","first_name":"string","last_name":"string","payment_on_account":{}}}'
```
[title] Remove a Customer sub-account
[path] Endpoints Reference/Customer Sub-Accounts/
### Code examples
```curl
curl --location --globoff --request DELETE '/v1/{siteEnv}/{siteId}/sub-accounts/{customer_external_id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
[title] New Platform Connection
[path] Endpoints Reference/Platform Connection/
### Code examples
```curl
curl --location --globoff '/v1/{siteEnv}/{siteId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{"store_id":"string","spark_api_client_id":"string","spark_api_client_secret":"string"}}'
```
[title] Remove Platform Connection
[path] Endpoints Reference/Platform Connection/
### Code examples
```curl
curl --location --globoff --request DELETE '/v1/{siteEnv}/{siteId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
[title] Customer Address
[path] Endpoints Reference/
[title] Verify authentication data provided by the platform
[path] Endpoints Reference/Authentication/
### Code examples
```curl
curl --location --globoff '/v1/{siteEnv}/{siteId}/authentication/verify' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{"data":"string"}}'
```
[title] Create a new Customer sub-account
[path] Endpoints Reference/Customer Sub-Accounts/
### Code examples
```curl
curl --location --globoff '/v1/{siteEnv}/{siteId}/sub-accounts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{"email":"string","first_name":"string","last_name":"string","parent_customer_external_id":"string"}}'
```
[title] Create a new customer address
[path] Endpoints Reference/Customer Address/
### Code examples
```curl
curl --location --globoff --request POST '/v1/{siteEnv}/{siteId}/customers/{customer_external_id}/addresses' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
[title] Complete Checkout
[path] Endpoints Reference/Checkout/
### Code examples
```curl
curl --location --globoff '/v1/{siteEnv}/{siteId}/checkout/complete' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{"customer":{},"billing_address":{},"shipping_address":{},"shipping_line":{},"shop":{},"ignite_state":{}}}'
```
[title] Update an existing Customer sub-account
[path] Endpoints Reference/Customer Sub-Accounts/
### Code examples
```curl
curl --location --globoff --request PATCH '/v1/{siteEnv}/{siteId}/sub-accounts/{customer_external_id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
[title] /v1/{siteEnv}/{siteId}/metafield-configuration/enable
[path] Endpoints Reference/Metafield Configuration/
### Code examples
```curl
curl --location --globoff '/v1/{siteEnv}/{siteId}/metafield-configuration/enable' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{"key":"string","name":"string"}}'
```
[space] SparkLayer Technical Docs (/tech-docs)
[title] Calculate Cart
[path] Untitled/Core API Docs/Orders/
{
"id": "vrBHzbgFzV7vHJqx0oPqj",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://app.sparklayer.io/api/v1/carts/{id}/calculate",
"servers": [
{
"url": "https://app.sparklayer.io/api/v1/carts/{id}/calculate",
"description": "Live"
},
{
"url": "https://test.app.sparklayer.io/api/v1/carts/{id}/calculate",
"description": "Test"
}
],
"name": "Calculate Cart",
"description": "",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "id",
"type": "string",
"description": "Either the Internal or External ID"
}
],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "Site-Id",
"type": "string",
"example": "jones-climbing",
"description": "Spark Layer Site ID"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "optional",
"name": "body",
"type": "object",
"description": "",
"schema": [
{
"name": "shipping_rate_handle",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Omitting this will set the carts shipping handle to the first available"
}
],
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Successful response",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "totals",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/CartTotals",
"customType": "CartTotals",
"schema": [
{
"name": "total",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Totals",
"customType": "Totals",
"schema": [
{
"name": "pre_discount",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "discount",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "charge",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
},
{
"name": "shipping",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Totals",
"customType": "Totals",
"schema": [
{
"name": "pre_discount",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "discount",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "charge",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
},
{
"name": "sub_total",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Totals",
"customType": "Totals",
"schema": [
{
"name": "pre_discount",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "discount",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "charge",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
}
]
},
{
"name": "discounts",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "shipping_methods",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "title",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "price_v2",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/PriceDeprecated",
"customType": "PriceDeprecated",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "gross",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "tax_rate",
"kind": "optional",
"type": "number",
"nullable": true,
"description": "",
"format": "float"
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "tax_inclusive_display",
"kind": "optional",
"type": "boolean",
"description": "",
"description": "",
"format": "float"
},
{
"name": "gross",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "tax_rate",
"kind": "optional",
"type": "number",
"nullable": true,
"description": "",
"format": "float"
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "tax_inclusive_display",
"kind": "optional",
"type": "boolean",
"description": "",
"description": "",
"enum": [
"AVAILABLE",
"DISABLED"
]
},
{
"name": "payment_on_account",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"AVAILABLE",
"DISABLED",
"UNAVAILABLE_DUE_TO_CREDIT",
"AVAILABLE_CREDIT_LIMIT_HIT"
]
},
{
"name": "upfront_payment",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"AVAILABLE",
"DISABLED"
]
},
{
"name": "quote",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"AVAILABLE",
"DISABLED"
]
}
]
},
{
"name": "selected_shipping_rate_handle",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "selected_payment_method",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
}
],
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "Cart not found",
"jsonExample": "",
"isExpanded": true
},
{
"statusCode": "422",
"description": "Unprocessable Entity",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [],
"complexItems": [
{
"name": "object",
"schema": [],
"modelRef": "#/components/schemas/responses-CartErrorResponse",
"customType": "responses-CartErrorResponse"
},
{
"name": "object",
"schema": [],
"modelRef": "#/components/schemas/Default",
"customType": "Default"
}
],
"complexType": "oneOf",
"isExpanded": true
}
]
},
{
"statusCode": "default",
"description": "Error Response",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false
},
"children": [
{
"text": ""
}
]
}
[title] Update Cart
[path] Untitled/Core API Docs/Orders/
{
"id": "aqlEdfWuWjSwl2CQRHBd_",
"type": "api-oas-v2",
"data": {
"method": "PATCH",
"url": "https://app.sparklayer.io/api/v1/carts/{id}",
"servers": [
{
"url": "https://app.sparklayer.io/api/v1/carts/{id}",
"description": "Live"
},
{
"url": "https://test.app.sparklayer.io/api/v1/carts/{id}",
"description": "Test"
}
],
"name": "Update Cart",
"description": "",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "id",
"type": "string",
"description": "Either the Internal or External ID"
}
],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "Site-Id",
"type": "string",
"example": "jones-climbing",
"description": "Spark Layer Site ID"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "optional",
"name": "body",
"type": "object",
"description": "",
"schema": [
{
"name": "line_items",
"kind": "optional",
"type": "array",
"description": "",
"description": "",
"format": "uuid"
},
{
"name": "intent",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"ORDER",
"QUOTE"
]
},
{
"name": "customer_id",
"kind": "optional",
"type": "string",
"description": "",
"format": "uuid"
},
{
"name": "shipping_address_id",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"format": "uuid"
},
{
"name": "billing_address_id",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"format": "uuid"
},
{
"name": "items",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "sku",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "line_total",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Price",
"customType": "Price",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "gross",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "tax_rate",
"kind": "optional",
"type": "number",
"nullable": true,
"description": "",
"format": "float"
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "tax_inclusive_display",
"kind": "optional",
"type": "boolean",
"description": "",
"nullable": true,
"description": "",
"format": "float"
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "tax_inclusive_display",
"kind": "optional",
"type": "boolean",
"description": "",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "discount",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "charge",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
},
{
"name": "shipping",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Totals",
"customType": "Totals",
"schema": [
{
"name": "pre_discount",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "discount",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "charge",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
},
{
"name": "sub_total",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Totals",
"customType": "Totals",
"schema": [
{
"name": "pre_discount",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "discount",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "charge",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "net",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "gross",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "tax",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "apportioned_tax_rate",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
}
]
},
{
"name": "customer_addresses",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "uuid",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "first_name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "last_name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "company",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "address_line_1",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "address_line_2",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "city",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "postal_code",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "country_code",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "region_code",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "phone",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "external_id",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
}
]
},
{
"name": "shipping_rate_handle",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "payment_method",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "validation_errors",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/CartValidationErrors",
"customType": "CartValidationErrors",
"schema": []
},
{
"name": "customer_reference",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "po_number",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "shipping_requested_date",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "custom_fields",
"kind": "optional",
"type": "array",
"description": "The cart's current custom fields.",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "value",
"kind": "required",
"type": "string",
"description": ""
}
]
}
]
},
{
"name": "item_update_results",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "sku",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "name",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "requested_quantity",
"kind": "optional",
"type": "number",
"description": ""
},
{
"name": "resultant_quantity",
"kind": "optional",
"type": "number",
"description": ""
},
{
"name": "messages",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"cannot-adjust-overridden-qty",
"excessive-lines",
"not-found",
"pack-size",
"product-settings-overridden",
"qty-excessive",
"qty-insufficient",
"qty-unavailable",
"qty-unavailable-no-clamp"
]
}
]
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "Cart not found",
"jsonExample": "",
"isExpanded": true
},
{
"statusCode": "422",
"description": "Unprocessable Entity",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [],
"complexItems": [
{
"name": "object",
"schema": [],
"modelRef": "#/components/schemas/responses-CartErrorResponse",
"customType": "responses-CartErrorResponse"
},
{
"name": "object",
"schema": [],
"modelRef": "#/components/schemas/Default",
"customType": "Default"
}
],
"complexType": "oneOf",
"isExpanded": true
}
]
},
{
"statusCode": "default",
"description": "Error Response",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false
},
"children": [
{
"text": ""
}
]
}
[title] Get a Shipping Method
[path] Untitled/Core API Docs/Shipping/
{
"id": "MfdejJNSy5Hi51h0icgTA",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://app.sparklayer.io/api/v1/shipping-methods/{id}",
"servers": [
{
"url": "https://app.sparklayer.io/api/v1/shipping-methods/{id}",
"description": "Live"
},
{
"url": "https://test.app.sparklayer.io/api/v1/shipping-methods/{id}",
"description": "Test"
}
],
"name": "Get a Shipping Method",
"description": "",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "id",
"type": "string",
"description": "Either the Internal or External ID"
}
],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "Site-Id",
"type": "string",
"example": "jones-climbing",
"description": "Spark Layer Site ID"
}
],
"queryParameters": [],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Successful response",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ShippingMethod",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"readOnly": true,
"description": "Created At",
"format": "date-time"
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "Updated At",
"format": "date-time"
},
{
"name": "sku",
"kind": "optional",
"type": "string",
"description": "Shipping SKU",
"example": "SKU001",
"maxLength": 50
},
{
"name": "title",
"kind": "optional",
"type": "string",
"description": "Shiping Method Name shown at checkout",
"example": "Standard Shipping",
"maxLength": 50
},
{
"name": "priority",
"kind": "optional",
"type": "number",
"description": "",
"schema": []
},
{
"name": "groups",
"kind": "optional",
"type": "array",
"description": "",
"description": "",
"enum": [
"weight"
]
},
{
"name": "min",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.GrossTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.GrossTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"gross_total"
]
},
{
"name": "min_total",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max_total",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.NetTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.NetTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"net_total"
]
},
{
"name": "min",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.None",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.None",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"none"
]
}
]
}
],
"schema": []
},
{
"name": "cost",
"kind": "optional",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"free": "#/components/schemas/ShippingMethod.Cost.Free",
"fixed_price": "#/components/schemas/ShippingMethod.Cost.FixedCost",
"percent_net_total": "#/components/schemas/ShippingMethod.Cost.PercentNetTotal",
"custom": "#/components/schemas/ShippingMethod.Cost.Custom"
}
},
"description": "",
"complexType": "oneOf",
"complexItems": [
{
"name": "ShippingMethod.Cost.Free",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.Free",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"free"
]
}
]
},
{
"name": "ShippingMethod.Cost.FixedCost",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.FixedCost",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"fixed_price"
]
},
{
"name": "price",
"kind": "optional",
"type": "number",
"description": ""
}
]
},
{
"name": "ShippingMethod.Cost.PercentNetTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.PercentNetTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"percent_net_total"
]
},
{
"name": "percentage_charge",
"kind": "optional",
"type": "number",
"description": "",
"format": "float",
"minimum": 0,
"maximum": 100
}
]
},
{
"name": "ShippingMethod.Cost.Custom",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.Custom",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"custom"
]
},
{
"name": "cost_language_string",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
],
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/ShippingMethod",
"isExpanded": true
}
]
},
{
"statusCode": "default",
"description": "Error Response",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false
},
"children": [
{
"text": ""
}
]
}
[title] List of Shipping Methods
[path] Untitled/Core API Docs/Shipping/
{
"id": "C6Rj8JCkph76NBZG5JiGO",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://app.sparklayer.io/api/v1/shipping-methods",
"servers": [
{
"url": "https://app.sparklayer.io/api/v1/shipping-methods",
"description": "Live"
},
{
"url": "https://test.app.sparklayer.io/api/v1/shipping-methods",
"description": "Test"
}
],
"name": "List of Shipping Methods",
"description": "",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "Site-Id",
"type": "string",
"example": "jones-climbing",
"description": "Spark Layer Site ID"
}
],
"queryParameters": [],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Successful response",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "array",
"description": "",
"customType": "ShippingMethod[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"readOnly": true,
"description": "Created At",
"format": "date-time"
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "Updated At",
"format": "date-time"
},
{
"name": "sku",
"kind": "optional",
"type": "string",
"description": "Shipping SKU",
"example": "SKU001",
"maxLength": 50
},
{
"name": "title",
"kind": "optional",
"type": "string",
"description": "Shiping Method Name shown at checkout",
"example": "Standard Shipping",
"maxLength": 50
},
{
"name": "priority",
"kind": "optional",
"type": "number",
"description": "",
"schema": []
},
{
"name": "groups",
"kind": "optional",
"type": "array",
"description": "",
"description": "",
"enum": [
"weight"
]
},
{
"name": "min",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.GrossTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.GrossTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"gross_total"
]
},
{
"name": "min_total",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max_total",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.NetTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.NetTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"net_total"
]
},
{
"name": "min",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.None",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.None",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"none"
]
}
]
}
],
"schema": []
},
{
"name": "cost",
"kind": "optional",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"free": "#/components/schemas/ShippingMethod.Cost.Free",
"fixed_price": "#/components/schemas/ShippingMethod.Cost.FixedCost",
"percent_net_total": "#/components/schemas/ShippingMethod.Cost.PercentNetTotal",
"custom": "#/components/schemas/ShippingMethod.Cost.Custom"
}
},
"description": "",
"complexType": "oneOf",
"complexItems": [
{
"name": "ShippingMethod.Cost.Free",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.Free",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"free"
]
}
]
},
{
"name": "ShippingMethod.Cost.FixedCost",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.FixedCost",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"fixed_price"
]
},
{
"name": "price",
"kind": "optional",
"type": "number",
"description": ""
}
]
},
{
"name": "ShippingMethod.Cost.PercentNetTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.PercentNetTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"percent_net_total"
]
},
{
"name": "percentage_charge",
"kind": "optional",
"type": "number",
"description": "",
"format": "float",
"minimum": 0,
"maximum": 100
}
]
},
{
"name": "ShippingMethod.Cost.Custom",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.Custom",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"custom"
]
},
{
"name": "cost_language_string",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
],
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/ShippingMethod",
"isExpanded": true
}
]
},
{
"statusCode": "default",
"description": "Error Response",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false
},
"children": [
{
"text": ""
}
]
}
[title] Update Pricing by Price List
[path] Untitled/Pricing API Docs/Pricing/
{
"id": "GSE89Ac-xgZs-Usp2W7av",
"type": "api-oas-v2",
"data": {
"method": "PATCH",
"url": "/api/v1/price-lists/{slug}/pricing",
"servers": [],
"name": "Update Pricing by Price List",
"description": "",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "slug",
"type": "string",
"description": "Price List Slug"
}
],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "Site-Id",
"type": "string",
"example": "jones-climbing",
"description": "Spark Layer Site ID"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "optional",
"name": "body",
"type": "array",
"description": "",
"description": "",
"example": 10.49,
"format": "float"
},
{
"name": "unit_of_measure",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "' -H 'header 1' -H 'header 2' ''
```
This endpoint will also return an ID for the file, which can be used for the other endpoints.
You can update the file by using the `PATCH` endpoint `/api/v1/files/{id}`, using the ID returned when creating the file.
### Downloading a File
To download a file, use the `GET` endpoint `/api/v1/files/{id}`. When the file upload has successfully completed, this will return a download URL, along with some file metadata. As with the upload endpoint, it will return a list of headers you must include.
You can then download the file from the provided URL.
### Failed Uploads
If the mime type of the file you upload does not match the file extension, the file will be deleted, and the `GET` endpoint `/api/v1/files/{id}` will return a 410 GONE status code.
### Downloading Order File Attachments
If you would like to download any files attached to one of your B2B orders, you can use the `GET` endpoint `/api/v1/files/{id}`. We store the IDs of attached files in the note attributes of the order, under the name you provide in your `checkoutCustomElements` in your theme (by default this is `file-upload`). They are stored as a JSON array like the following:
```json
[
"gid://sparklayer/File/fdc70d92-fcdf-4719-af2b-9d319a5035d2",
"gid://sparklayer/File/a7a3ee08-c6d0-49ee-89b4-bcdaf780d553",
"gid://sparklayer/File/15be5381-0b50-459f-9643-af236b9f29f7"
]
```
You must extract the UUIDs from these GID strings, removing the `gid://sparklayer/File` prefix. This is what the UUID should look like: `fdc70d92-fcdf-4719-af2b-9d319a5035d2`
[title] Get Price Lists
[path] Untitled/Pricing API Docs/Price Lists/
{
"id": "-VGyk35s3QEst6zHalYD3",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "/api/v2/price-lists",
"servers": [],
"name": "Get Price Lists",
"description": "",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "Site-Id",
"type": "string",
"example": "jones-climbing",
"description": "Spark Layer Site ID"
}
],
"queryParameters": [
{
"kind": "optional",
"name": "page",
"type": "integer",
"description": "The page of results to fetch",
"default": 1,
"minimum": 1
},
{
"kind": "optional",
"name": "page_size",
"type": "integer",
"description": "Number of records per page",
"default": 100,
"minimum": 1,
"maximum": 250
},
{
"kind": "optional",
"name": "order_by",
"type": "string",
"description": "Field to order the search results by",
"default": "name:asc",
"pattern": "^(name|created_at|updated_at):(asc|desc)$"
},
{
"kind": "optional",
"name": "source",
"type": "array",
"description": "",
"default": [
"custom",
"integration",
"platform"
],
"schema": [],
"itemType": "string",
"customType": "string[]"
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Successful response",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/PriceList",
"customType": "PriceList",
"schema": [
{
"name": "slug",
"kind": "optional",
"type": "string",
"description": "Slug",
"example": "base-list",
"minLength": 1,
"maxLength": 64
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "Name",
"example": "Base Price List",
"modelRef": "#/components/schemas/PriceListNameParam",
"customType": "PriceListNameParam",
"schema": []
},
{
"name": "currency_code",
"kind": "optional",
"type": "string",
"description": "ISO 4217 currency code",
"example": "GBP",
"modelRef": "#/components/schemas/PriceListCurrency",
"customType": "PriceListCurrency",
"schema": []
},
{
"name": "source",
"kind": "optional",
"type": "string",
"description": "",
"description": "",
"readOnly": true,
"description": "",
"readOnly": true,
"description": "",
"description": "",
"example": 10.49,
"format": "float"
},
{
"name": "unit_of_measure",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"schema": []
},
{
"name": "groups",
"kind": "optional",
"type": "array",
"description": "",
"description": "",
"enum": [
"weight"
]
},
{
"name": "min",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.GrossTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.GrossTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"gross_total"
]
},
{
"name": "min_total",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max_total",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.NetTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.NetTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"net_total"
]
},
{
"name": "min",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.None",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.None",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"none"
]
}
]
}
],
"schema": []
},
{
"name": "cost",
"kind": "optional",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"free": "#/components/schemas/ShippingMethod.Cost.Free",
"fixed_price": "#/components/schemas/ShippingMethod.Cost.FixedCost",
"percent_net_total": "#/components/schemas/ShippingMethod.Cost.PercentNetTotal",
"custom": "#/components/schemas/ShippingMethod.Cost.Custom"
}
},
"description": "",
"complexType": "oneOf",
"complexItems": [
{
"name": "ShippingMethod.Cost.Free",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.Free",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"free"
]
}
]
},
{
"name": "ShippingMethod.Cost.FixedCost",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.FixedCost",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"fixed_price"
]
},
{
"name": "price",
"kind": "optional",
"type": "number",
"description": ""
}
]
},
{
"name": "ShippingMethod.Cost.PercentNetTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.PercentNetTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"percent_net_total"
]
},
{
"name": "percentage_charge",
"kind": "optional",
"type": "number",
"description": "",
"format": "float",
"minimum": 0,
"maximum": 100
}
]
},
{
"name": "ShippingMethod.Cost.Custom",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.Custom",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"custom"
]
},
{
"name": "cost_language_string",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
],
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/ShippingMethod",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Successful response",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ShippingMethod",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"readOnly": true,
"description": "Created At",
"format": "date-time"
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "Updated At",
"format": "date-time"
},
{
"name": "sku",
"kind": "optional",
"type": "string",
"description": "Shipping SKU",
"example": "SKU001",
"maxLength": 50
},
{
"name": "title",
"kind": "optional",
"type": "string",
"description": "Shiping Method Name shown at checkout",
"example": "Standard Shipping",
"maxLength": 50
},
{
"name": "priority",
"kind": "optional",
"type": "number",
"description": "",
"schema": []
},
{
"name": "groups",
"kind": "optional",
"type": "array",
"description": "",
"description": "",
"enum": [
"weight"
]
},
{
"name": "min",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.GrossTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.GrossTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"gross_total"
]
},
{
"name": "min_total",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max_total",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.NetTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.NetTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"net_total"
]
},
{
"name": "min",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
},
{
"name": "max",
"kind": "optional",
"type": "number",
"nullable": true,
"description": ""
}
]
},
{
"name": "ShippingMethod.Requirement.None",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Requirement.None",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"none"
]
}
]
}
],
"schema": []
},
{
"name": "cost",
"kind": "optional",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"free": "#/components/schemas/ShippingMethod.Cost.Free",
"fixed_price": "#/components/schemas/ShippingMethod.Cost.FixedCost",
"percent_net_total": "#/components/schemas/ShippingMethod.Cost.PercentNetTotal",
"custom": "#/components/schemas/ShippingMethod.Cost.Custom"
}
},
"description": "",
"complexType": "oneOf",
"complexItems": [
{
"name": "ShippingMethod.Cost.Free",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.Free",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"free"
]
}
]
},
{
"name": "ShippingMethod.Cost.FixedCost",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.FixedCost",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"fixed_price"
]
},
{
"name": "price",
"kind": "optional",
"type": "number",
"description": ""
}
]
},
{
"name": "ShippingMethod.Cost.PercentNetTotal",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.PercentNetTotal",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"percent_net_total"
]
},
{
"name": "percentage_charge",
"kind": "optional",
"type": "number",
"description": "",
"format": "float",
"minimum": 0,
"maximum": 100
}
]
},
{
"name": "ShippingMethod.Cost.Custom",
"description": "",
"modelRef": "#/components/schemas/ShippingMethod.Cost.Custom",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"custom"
]
},
{
"name": "cost_language_string",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
],
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/ShippingMethod",
"isExpanded": true
}
]
},
{
"statusCode": "default",
"description": "Error Response",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false
},
"children": [
{
"text": ""
}
]
}
[title] List of Discounts
[path] Untitled/Core API Docs/Discounts/
{
"id": "teYUYxeln-UtjqjtjY82K",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://app.sparklayer.io/api/v1/discounts",
"servers": [
{
"url": "https://app.sparklayer.io/api/v1/discounts",
"description": "Live"
},
{
"url": "https://test.app.sparklayer.io/api/v1/discounts",
"description": "Test"
}
],
"name": "List of Discounts",
"description": "",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "Site-Id",
"type": "string",
"example": "jones-climbing",
"description": "Spark Layer Site ID"
}
],
"queryParameters": [],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Successful response",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "array",
"description": "",
"customType": "Discount[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"readOnly": true,
"description": "",
"format": "date-time"
},
{
"name": "deleted_at",
"kind": "optional",
"type": "string",
"readOnly": true,
"nullable": true,
"description": "",
"format": "date-time"
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"format": "date-time"
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "A user friendly name for the discount",
"maxLength": 256
},
{
"name": "internal_name",
"kind": "required",
"type": "string",
"description": "",
"maxLength": 45
},
{
"name": "internal_slug",
"kind": "required",
"type": "string",
"description": "",
"maxLength": 45
},
{
"name": "template",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"description": "Products which must be in the cart must match all or any one of the combo groups",
"enum": [
"any",
"all"
]
},
{
"name": "reward_selection_type",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"all",
"cheapest",
"expensive"
]
},
{
"name": "currency_code",
"kind": "required",
"type": "string",
"nullable": true,
"description": "",
"example": "gbp",
"minLength": 3,
"maxLength": 3
},
{
"name": "start_date",
"kind": "required",
"type": "string",
"nullable": true,
"description": "Start Date",
"format": "date-time"
},
{
"name": "end_date",
"kind": "required",
"type": "string",
"nullable": true,
"description": "End Date",
"format": "date-time"
},
{
"name": "active",
"kind": "required",
"type": "boolean",
"description": ""
},
{
"name": "requirements",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/Discount.Requirement",
"customType": "Discount.Requirement[]",
"schema": [
{
"name": "items",
"kind": "required",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "restrictions",
"kind": "required",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "type",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"productSKU",
"excludeProductSKU",
"productSKUContains",
"excludeProductSKUContains",
"productMetadata",
"excludeProductMetadata"
]
},
{
"name": "ref",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "metadata_namespace",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "erp",
"maxLength": 256
},
{
"name": "metadata_key",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "vendor",
"maxLength": 128
}
]
},
{
"name": "points_type",
"kind": "required",
"type": "string",
"description": "",
"description": "",
"description": "",
"enum": [
"net"
]
},
{
"name": "selection_type",
"kind": "required",
"type": "string",
"description": "",
"description": "",
"enum": [
"requirements|all",
"requirements|cheapest",
"cart|productSKU",
"cart|cheapestProductSKU",
"cart|productMetadata",
"cart|cheapestProductMetadata",
"product",
"shipping",
"order"
]
},
{
"name": "amount_type",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"percent",
"percentPreDiscount",
"priceAllGross",
"priceAllNet",
"priceLineGross",
"priceLineNet",
"fixedAllGross",
"fixedAllNet",
"fixedLineGross",
"fixedLineNet",
"none"
]
},
{
"name": "restriction_type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"equals",
"notEquals",
"contains",
"notContains"
]
},
{
"name": "item_id",
"kind": "required",
"type": "string",
"description": "",
"maxLength": 100
},
{
"name": "metadata_namespace",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "erp",
"maxLength": 256
},
{
"name": "metadata_key",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "vendor",
"maxLength": 128
},
{
"name": "amount",
"kind": "required",
"type": "number",
"description": "",
"maximum": 1000000000
}
]
},
{
"name": "other_requirements",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/Discount.OtherRequirements.MaxUsesPerCustomer",
"customType": "Discount.OtherRequirements.MaxUsesPerCustomer[]",
"schema": [
{
"name": "requirement_type",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"maxUsesPerCustomer"
]
},
{
"name": "number",
"kind": "optional",
"type": "number",
"description": ""
}
]
}
],
"modelRef": "#/components/schemas/Discount",
"isExpanded": true
}
]
},
{
"statusCode": "default",
"description": "Error Response",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false
},
"children": [
{
"text": ""
}
]
}
[title] Core-api-files.yaml
[path] Untitled/
[title] Get Purchases
[path] Untitled/Purchasing API Docs/Purchasing/
{
"id": "cPdwDB_4eYoWcqo0gjmpS",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "/api/v1/purchases",
"servers": [],
"name": "Get Purchases",
"description": "This endpoint is designed to list any purchase with the ability to easily filter",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "Site-Id",
"type": "string",
"example": "jones-climbing",
"description": "Spark Layer Site ID",
"minLength": 1
}
],
"queryParameters": [
{
"kind": "optional",
"name": "limit",
"type": "integer",
"description": "Limit the number of results returned",
"minimum": 1,
"maximum": 500
},
{
"kind": "optional",
"name": "order_by",
"type": "string",
"description": "Order by",
"enum": [
"created_at",
"updated_at",
"placed_at",
"calculated_submitted_at",
"shipping_requested_date"
]
},
{
"kind": "optional",
"name": "customer_identifiers[sparklayer]",
"type": "string",
"description": "",
"nullable": true,
"description": "The identifier SparkLayer uses for the purchase. You will need to generate this if the purchase does not exist",
"example": "63428136-658f-48a6-beb7-7f333dfd9686",
"format": "uuid",
"minLength": 1
},
{
"name": "platform",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"nullable": true,
"description": "The ID of the company the purchase was placed for.",
"example": "4217ba4f-7618-4e3b-b1af-9055639b18d1",
"format": "uuid"
},
{
"name": "section_id",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "The ID of the company section the purchase was placed for.",
"example": "4217ba4f-7618-4e3b-b1af-9055639b18d1",
"format": "uuid"
},
{
"name": "section_name",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "
* max * maxlength * min * minlength * name * pattern * placeholder * required (default is "false") * disabled (default is "false") * step * type (default is "text") | | `title` | It's also possible to customise the text that is shown to the customer using translations. Text shown in bold above the input **(required)** | | `detail` | Small 'helper' text shown beneath the input. Useful for explaining what the field is for and acceptable values. | :::hint{type="info" attributes="[object Object]"} **Supported element attributes** Some attributes only apply to certain input types and you can find more detailed documentation [can be found here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attributes). ::: ### Example custom checkout fields To get started, we've included some of our most popular customer checkout field types. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: :::ExpandableHeading **Date picker, e.g. 'Shipping date'** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { name: "shipping-date", translations: { en: { title: "Shipping Date", detail: "Please select your preferred shipping date" } }, attributes: { required: true, type: "date" } }, ], /* End of code */ ``` ::: :::ExpandableHeading **Custom text, e.g. 'Tax ID Reference'** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Tax ID Reference", detail: "Please enter your Tax ID reference" } }, name: "tax-id", attributes: { required: false, type: "text", placeholder: "Enter Tax ID reference", minlength: 4, maxlength: 600 } }, ], /* End of code */ ``` ::: ::::ExpandableHeading **Drop-down menu ("select" menu), e.g. 'Seasonal information'** :::Iframe{iframeHeight="0" code=""} ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Option Title", detail: "Select Option Detail" } }, name: "select-option-test", attributes: { required: true, type: "select", }, options: [ { translations: { en: {groupName: "Group A"}, }, items: [ {value: "Option 1", translations: { en: { label: "Option 1" } } }, {value: "Option 2", translations: { en: { label: "Option 2" } } } ], }, { translations: { en: { groupName: "Group B" } }, items: [ {value: "Option 3", translations: { en: { label: "Option 3" } } }, {value: "Option 4", translations: { en: { label: "Option 4" } } } ], } ] } ], /* End of code */ ``` :::: :::ExpandableHeading **Custom text, e.g. 'Shipping instructions'** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Shipping instructions field", detail: "Please confirm any shipping instructions for us" } }, name: "shipping-instructions", attributes: { required: true, type: "text", placeholder: "Shipping instructions field", minlength: 4, maxlength: 600 } }, ], /* End of code */ ``` ::: :::ExpandableHeading **Number, e.g. 'Contact phone number'** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Contact phone number", detail: "Please supply a phone number to allow us to contact you" } }, name: "number-field", attributes: { type: "number", min: 10, max: 25, } }, ], /* End of code */ ``` ::: :::ExpandableHeading **File attachments (e.g. Purchase Order file upload) ** If you're looking to add file uploads to the checkout process, you can manage this via custom checkout fields. Please refer to our full guide below ::: :::ExpandableHeading **Date picker that requires date at least 1 day in future ** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { name: "delivery-date", translations: { en: { title: "Delivery Date", detail: "Delivery date must be at least one day in future." } }, attributes: { required: true, type: "date", min: ((d) => { d.setDate(d.getDate() + 1); return d.toISOString().slice(0,10); })(new Date()) } }, ], ``` ::: :::ExpandableHeading **Date picker that restricts by weekends and specific dates ** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "Delivery Date", detail: "Delivery unavailable on weekends.", 'select-mon-fri': "Date must be Monday-Friday", 'select-date-in-future': "Select a date in the future", 'select-non-bank-holiday': "Select another date which is not a UK bank holiday", }, }, name: "delivery-date-requested", attributes: { required: true, type: "date" }, onChange(val, el) { const [year, month, date] = val.split('-'); const selectedDate = new Date( Number(year), Number(month)-1, Number(date), 0, 0, 0, 0 ); const now = new Date() const ukTime = now.toLocaleString( 'en-GB', { hour: '2-digit', hour12: false, timeZone: 'Europe/London' } ); const earliestDeliveryDate = new Date( now.getFullYear(), now.getMonth(), now.getDate() + (Number(ukTime) >= 12 ? 1 : 0) ) const ukBankHolidays = [ '07/04/2023', '10/04/2023', '01/05/2023', '08/05/2023', '29/05/2023', '28/08/2023', '25/12/2023', '26/12/2023', ]; const selectedDateStr = new Intl.DateTimeFormat('en-GB', { dateStyle: 'short' }) .format(selectedDate); let messageTranslationKey switch (true) { // Date is in the past case selectedDate < earliestDeliveryDate: messageTranslationKey = 'select-date-in-future' break; // Day is weekend case [0, 6].includes(selectedDate.getDay()): messageTranslationKey = 'select-mon-fri' break; // Is bank holiday case ukBankHolidays.includes(selectedDateStr): messageTranslationKey = 'select-non-bank-holiday' break; } return { valid: messageTranslationKey === undefined, messageTranslationKey } } } ], /* End of code */ ``` ::: :::ExpandableHeading **Checkbox to require customer confirmation** ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "I agree to the terms and conditions", detail: "Please confirm you've read and agree to the terms and conditions", }, }, name: "confirmation", attributes: { required: true, type: "checkbox" }, }, ], /* End of code */ ``` ::: ### Supported form field types Custom checkout fields currently support the following field types: | Field Type | Notes | | ---------------- | -------------------------- | | `text` | Freeform text entry | | `select` | Drop down menu | | `number` | Number entry | | `date` | Date, DD/MM/YYYY | | `time` | Specific time, 00:00 | | `week` | Week (4) | | `month` | Month of year (12) | | `datetime-local` | DD/MM/YYY 00:00 | | `checkbox` | Allows multiple selections | | `tel` | Number entry for phone | | `email` | Email entry | | `url` | Website URL entry | | `file` | File attachment | *** ## Standard checkout fields Alongside the freeform custom checkout fields above (which use a name), SparkLayer supports a set of standard checkout fields. These use a known `id` instead of a `name`, so SparkLayer recognises them and integrates them more deeply with your store. Because they're recognised fields, each one is mapped to a structured location in your orders (rather than a generic order note), is available in your theme and template editor, and can be searched and filtered. This makes them a better choice than a freeform field when you're capturing a customer reference, purchase order number, or requested shipping date. The following standard fields are available: | Field | Field ID | | ----------------------- | ------------------------- | | Customer Reference | `customer-reference` | | PO Number | `po-number` | | Requested Shipping Date | `shipping-requested-date` | :::hint{type="info"} **Please note** The **id** must match exactly for SparkLayer to recognise the field and apply the integration described below. ::: ### Adding standard checkout fields  To get started, you can enable the standard checkout fields via [Storefront Options](docId\:TlYOdygHE8taYqbi81JJa) within the SparkLayer Dashboard. For a more advanced setup, you can also add the standard fields to your core script using their id. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { id: "customer-reference" }, { id: "shipping-requested-date" }, { id: "po-number" }, ], /* End of code */ ``` Standard fields support the same attributes and onChange keys as custom checkout fields, so you can apply validation such as `required: true`, along with more advanced configurations (see **Customer checkout fields** above for the full list of supported attributes). ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { id: "customer-reference", attributes: { required: true, }, }, ], /* End of code */ ``` ### Where standard fields appear in your orders Unlike freeform custom fields, which are stored as generic order notes, each standard field is mapped to a structured location on the order: | Field | Where it appears | | ------------------------- | ---------------------------------------------------------------------------- | | `PO Number` | The native Shopify PO Number field on the order. | | `Requested Shipping Date` | A dedicated custom field on the order (shown as sparkShippingRequestedDate). | | `Customer Reference` | The Shopify order notes field. |  Because these fields map to structured data, they're also available in your theme and template editor, so you can display them on documents such as invoices.  ### Searching and filtering by standard fields Mapping each field to structured data also means you can find orders by the information customers enter. From the order and activity views you can: - Search by Customer Reference - Search by PO Number - Filter by Requested Shipping Date (using a date range) ****  ### Migrating to standard fields If you're already capturing any of these fields using the older approach, you can move over to the standard fields to gain the deeper integration. :::ExpandableHeading **Customer Reference** If you previously used the additional information field (via the customerReferenceHidden and customerReferenceRequired display settings), switch to the standard field: ```javascript /* Add the below code into the display object within the SparkLayer core script */ display: { customerReferenceHidden: false, customerReferenceRequired: true, }, /* End of code */ ``` New code to add: ```javascript /* Add the below code into the SparkLayer core script */ checkoutCustomElements: [ { id: "customer-reference", attributes: { required: true, }, }, ], /* End of code */ ``` ::: :::ExpandableHeading **Requested Shipping Date** If you previously added a shipping date as a freeform field using a `name`, switch it to the standard `id`: Old code: ```javascript /* Add the below code into the SparkLayer core script */ checkoutCustomElements: [ { name: "my-shipping-requested-date" }, ], /* End of code */ ``` New code to add: ```javascript /* Add the below code into the SparkLayer core script */ checkoutCustomElements: [ { id: "shipping-requested-date" }, ], /* End of code */ ``` The `id` must be `shipping-requested-date`. Previously the name could be anything you chose - switching to the standard id is what enables the structured storage, searching, and filtering. ::: *** ## File Upload (file attachments) :::hint{type="warning"} **Please note ** The file upload feature is **only** available on the SparkLayer *Growth, 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. ::: SparkLayer supports the ability for B2B customers to upload files during the checkout process. This is a great way to capture additional details from the customer such as a "Purchase Order", details specific to the order, or any other file that is relevant to their account. ::embed[]{url="https://www.youtube.com/embed/UgmP800AdKw"} SparkLayer also supports customers to upload details per line item (such as logos or name customisations) and you can learn more below. ### File upload at checkout **The file upload at checkout flow works as follows:** The B2B customer will see a special field during the checkout process where they can upload relevant files.  When the order is completed, any files uploaded to an order will then display in their [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) area against the order they have just placed. The customer can then easily download any files associated against the order.  **Enabling file uploads** The file upload feature works by adding special code to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) that lets you customise how you accept files from your customers. To get started, you can use our sample code below. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ checkoutCustomElements: [ { translations: { en: { title: "File Upload", detail: "Files must not be larger than 10MB. You can upload between 1 and 4 files" }, }, name: "file-upload", attributes: { type: "file", required: false, // Optional. Default: false minlength: 1, // Optional. Default: 1 maxlength: 4, // Optional. Default: 20 maxsize: '10MB', // Optional. Default: 20MB, Must be a number followed by `B`, `KB` or `MB` fileextensions: [ // Optional. Default: ['txt', 'csv', 'pdf', 'json', 'png', 'jpeg', 'gif', 'webp', 'svg', 'psd', 'xls', 'xlsx', 'ods', 'fods', 'ppt', 'pptx', 'odp', 'fodp', 'doc', 'docx', 'odt', 'fodt'] 'png', 'txt', 'pdf', 'xls' ] } } ], /* End of code */ ``` To customise how you accept files from your B2B customers, you can adjust the special settings: | Setting | Description | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `required` | Setting as `true` will force the customer to have to upload a file | | `minlength` | This sets the **minimum** number of files the customer must upload (e.g. entering `1` would force them to upload 1 file) | | `maxlength` | This sets the **maximum** number of files the customer must upload (e.g. entering `4` would prevent them from uploading more than 4 files) | | `maxsize` | By default, SparkLayer sets a maximum file size of 20MB and this **limit cannot be increased**. If you'd prefer to limit file size, you can adjust this. For example entering `10MB` would set a maximum file size limit of 10MB | | `fileextensions` | If you'd prefer to limit the file types your customers can upload, you can specify file extensions. By default, SparkLayer will support all the following file extensions.
`['txt', 'csv', 'pdf', 'json', 'png', 'jpeg', 'gif', 'webp', 'svg', 'psd', 'xls', 'xlsx', 'ods', 'fods', 'ppt', 'pptx', 'odp', 'fodp', 'doc', 'docx', 'odt', 'fodt']` | | `translations` | You can edit the default text that shows for customers by editing the default language string (see example above). | **Retrieving file uploads** Due to how files are stored within SparkLayer, there are some very specific methods in which to download any files that have been uploaded. When a B2B customer uploads a file against an order, there are **3 ways** to retrieve the files that have been uploaded. | Method | Details | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customer` | The customer themselves can login to their account and download the attachments from their order | | `Sales Agent` | As a user with access to the [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) tool, they can login on behalf of the customer, navigate to their account and download any attachments. | | `API` | Via the *SparkLayer Files API*, file uploads will be associated with order data and this can then be routed into a back-office (e.g. an ERP). For more details on how this works, please speak to our [support team](docId\:NNUw1G9z7eaJ4M78vk7t9). | **How file upload are referenced ** :::::Tabs ::::Tab{title="🛍️ Using Shopify"} When a customer uploads a file and the order arrives into Shopify, files will be referenced within the `file-upload` section on the top right of an order detail. If you'd prefer to use a different naming convention to `file-upload`, you can modify this within the checkout code sample above `name: "file-upload"` :::hint{type="warning"} **Please note** This will include a 'raw link' to the file and it's important to note that this **cannot** be accessed via Shopify. Please refer to our steps above on the methods to retrieve files that have been uploaded. :::  :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: ### File upload per line item :::hint{type="warning"} **Please note** This is an advanced configuration of SparkLayer and will require a developer to implement on a store that requires this feature. Please refer to our [JavaScript SDK](docId\:KqOyqBdWzsiRlt7j-S6CU) for full details. ::: The file upload per "line item" feature allows for item-level customisation control, enabling B2B customers to clearly outline their order requirements and streamline the order process. Once enabled, the B2B customer will see a special field on the product page where they can upload relevant files. The design and layout of this field can be configured as detailed in [JavaScript SDK](docId\:KqOyqBdWzsiRlt7j-S6CU)  In some instances, there may be a need for more than one file upload section. When the files are uploaded to the product page, they will appear above the **"Choose file"** button.  The files uploaded by the customer will then show in the cart as separate line items.  After "line item" file uploads have been added there is still the option to enable the "checkout-level" file upload feature too (see "*File upload at checkout"* above). Whilst the line item file upload option may be ample customisation for some customers, enabling checkout-level file uploads will allow for any order-level attachments to be added such as a "Purchase Order". When the order is completed, all files uploaded to an order (at line item *and* checkout level) will then display in their [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) area against the order they have just placed. The customer can then easily download any files associated against the order.  :::hint{type="info"} **Enabling file uploads for line items** To implement this line item file upload feature, please refer to [our technical guide here.](docId:315uNbM85_FWnh6FU9KkK) ::: *** ## Discounts & promotions SparkLayer supports the ability to have discounts and promotions applied during the checkout and these can either be redeemed via discount codes, or applied "automatically" to the customer's order. :::Iframe{iframeHeight="0" code=""} ::: The SparkLayer Discount Engine unlocks a range of discount rules including: - **Order-level discounts:** eg, spend $1,000 and get 10% off, spend $2,000 and get 15% off - **Percentage and fixed discounts: **eg, 20% off an order total, $100 off an order total - **Coupon codes:** eg, enter code NEWCUSTOMER and get 5% off - **Scheduled discounts:** eg, start discount today and end it on a specific date and time - **Customer-specific discounts:** eg, only allow customer group ‘b2b-vip’ to qualify for the discount - And more :::hint{type="info"} **Learn more about discounts** You can see a full overview of what’s possible with discounts in [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg). ::: *** ## The "Additional Information" field (PO Number) The Additional Information field is useful if you want to capture additional details from a customer whilst their placing an order.  Typical use-cases include capturing a Purchase Order number (sometimes referred to as PO number), delivery instructions, or instructions. ::::Tabs :::Tab{title="🛍️ Using Shopify"} When completed by a customer, the data will then show within the Shopify order under the **Notes** section (this can also be sent to a backend system using the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT)).  ::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: :::: :::hint{type="info"} **Please note** The additional information is a separate field to the 'custom checkout fields' detailed above. The Additional Information field is also limited to 512 characters in total ::: **Make "Additional information" mandatory** You can force customers to complete the 'Additional information' field before proceeding to place their order.  :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the display object within the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { customerReferenceRequired: true, }, /* End of code */ ``` :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.notes.label": "Additional Information", "cart.checkout.notes.placeholder": "Order notes e.g. PO Number", "cart.checkout.notes.helper-text": "Please note, this is required before placing your order", /* Only shown if the field is set to required */ "cart.checkout.notes.default-helper-text": "", /* Add a helper message below the form field */ } }, /* End of code */ ``` **Limiting characters of the "Additional information" field** It's possible to set a character limit for the additional information field should you have requirements to restrict what can be added. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the display object within the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { customerReferenceMaxLength: 512, /* update 512 as required */ }, /* End of code */ ``` **Hiding the "Additional information" field** Alternatively, if you'd prefer to hide the additional information field from showing, you can update this via the SparkLayer Core Script. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the display object within the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { customerReferenceHidden: true, }, /* End of code */ ``` *** ## Custom payment messages On the final step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), Review & Pay, it's possible to display a "custom payment messages" that let you add additional details about a payment method. For example, if a customer is paying by "Pay by Invoice", you could add some additional text to inform them on how this process works.  The "custom payment message" works by adding a special code snippet to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) that lets you define the text you want to show. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.payment-providers.paymentByInvoice.message": "This is a message for Payment by Invoice", "cart.checkout.payment-providers.upfrontPayment.message": "This is a message for Pay Online by Card", "cart.checkout.payment-providers.paymentOnAccount.message": "This is a message for Pay on Account", "cart.checkout.payment-providers.quote.message": "This is a message for Request for Quote", } }, /* End of code */ ``` :::hint{type="warning"} **Please note** It's important to note that this text will show to **all customers **during the checkout process and it's not possible to vary it based on who the customer is. ::: *** ## Custom checkout message On the final step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), Review & Pay, it's possible to display a "custom checkout message" that lets you inform customers of any special notes or information they need to be aware of. It's a great way to highlight information about shipping, payment, or anything else!  The "custom checkout message" works by adding a special code snippet to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) that lets you define the text you want to show. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.review-step.custom-message": "Add your custom checkout message here", } }, /* End of code */ ``` :::hint{type="warning"} **Please note** It's important to note that this text will show to **all customers **during the checkout process and it's not possible to vary it based on who the customer is. ::: ### Styling the message  If you'd like to customise how the message looks, you can do this by adding special [CSS](docId\:qCt2Zk8wjhYIV2ZbVBJYy) to your website. Simply add the below CSS to your website's CSS file and you can then set styling such as colours and spacing. ```css ``` *** ## Search SparkLayer has a built-in tool allowing customers to quickly add items to an order, directly from the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-). You can learn more in [our guide here](docId\:efevur-A3yCJXUHvrR7t-).  *** ## Terms and conditions When customers checkout via the SparkLayer [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), they'll be asked to confirm the store's terms and conditions before completing their order.  By default, the terms and conditions link will point to a URL of `policies/terms-of-service` but it's possible to change this via the SparkLayer Core Script. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ termsAndConditionsLink: "/policies/terms-of-service", /* End of code */ ``` ::::Tabs :::Tab{title="🛍️ Using Shopify"} You can customise the link based on a customer's tag by using code within your Shopify store. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ {% if customer.tags contains 'b2b' %} termsAndConditionsLink: '/policies/b2b-terms', {% elsif customer.tags contains 'b2b-2' %} termsAndConditionsLink: '/policies/b2b-2-terms', {% elsif shop.locale == "fr" %} termsAndConditionsLink: '/policies/fr-terms-and-conditions', {% else %} termsAndConditionsLink: '/policies/terms-and-conditions', {% endif %} /* End of code */ ``` If your store is set up with multiple languages, you can also configure the code to show a different link based on the customer's location ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ {%- if shop.locale == "fr" -%} termsAndConditionsLink: '/policies/fr-terms-and-conditions', {%- else -%} termsAndConditionsLink: '/policies/terms-and-conditions', {%- endif -%} /* End of code */ ``` ::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: :::: :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.terms.start": "I agree to the ", "cart.checkout.terms.link": "terms and conditions", "cart.checkout.terms.end": " ", } }, /* End of code */ ``` *** ## Payment methods Please refer to the [Payment Methods](docId\:ibIKczvHM085BkeJIfFYv) guide for more information. *** ## Tax & shipping messaging :::hint{type="info"} **Tax & shipping** To learn more about how SparkLayer handles tax and shipping, see [our guide here](docId\:ZSsXG6FjRLCod_GxoluTN). ::: When a customer proceeds through the checkout, they'll be notified about tax and shipping with messaging beneath the main call to action.   If you'd like to modify what is shown here, you can do so by updating the default language within your store. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.tax-shipping-note": "Tax and shipping costs calculated during checkout", "cart.tax-shipping-message": "Tax and shipping costs shown on next step", } }, /* End of code */ ``` *** ## Tax ID Requirements Some countries require you to collect your customer’s Tax ID or equivalent during checkout. This helps ensure orders comply with local tax laws and avoids delays or fines at customs. [Learn mroe](docId\:ZSsXG6FjRLCod_GxoluTN) *** ## The order complete screen You can modify the confirmation screen that shows to the customer by adding the below to the language overwrites within the SparkLayer Core Script.  :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.thanks.payment.main": "Thank you for your order!", "cart.thanks.payment.blurb": "Your order has now been placed and you will shortly receive email confirmation to {email}. You can check the status of your order at any time by going to 'My Account'.", "cart.thanks.quote.main": "Thank you for requesting a quote!", "cart.thanks.quote.blurb": "We can confirm that your request for a quote has been received and we'll be in touch once our team has reviewed it.", } }, /* End of code */ ``` *** ## Order limits (minimum and maximum order values) It's possible to set minimum and maximum order values that a customer has to meet before being able to place an order. Please refer to [our full guide here](docId:5_lWMNohhjBJJppg9E6Vh). *** ## Showing custom content (using "slots") Custom Slots (or "Targets") allow you to enhance the SparkLayer [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) by adding your own custom code in predefined areas.   You can learn more in our [custom slots guide here](docId\:l_2ooHJiY-rAx2chBMgP2). *** ## Pricing Display If you have [RRP pricing (MSRP)](docId\:S_VTlJBorGmnwjjfSMom9) set up, by default the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) will display this below the main selling price.  If you'd prefer to hide this, you can add the below CSS to your [CSS overwrites](docId\:qCt2Zk8wjhYIV2ZbVBJYy). ```css --spark-cart-rrp-display: none; ``` *** ## Cart Image It's possible to change how the product image is rendered in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) by using special CSS overwrites. This is especially useful if your product images aren't square in ratio and you want to prevent the image being cropped.  Simply add one of the below options to your [CSS overwrites](docId\:qCt2Zk8wjhYIV2ZbVBJYy). ```css --spark-cart-background-size: cover /* Set image to fill the space*/ --spark-cart-background-size: contain /* Set image to be fully visible*/ ``` [title] Account & Addresses [path] Features/Configurations/ ## Custom My Account fields Within the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP), the customer can see a summary of their details such as email address, company name, and financial details from the "My Details" section. It's possible to set up additional "custom fields" within the My Details area, allowing you to include other information that may be relevant to your B2B customers.  Setting custom fields for the My Details area works in a very similar way to the [custom checkout fields feature](docId\:o3nDhZBCxisWH6M6satDt), by adding special code to your website within the SparkLayer Core Script. You can use our sample below to get started. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ customAccountDetails: [ { title: "Website", value: "{{ customer.metafields.global.company_website }}", type: "website", displayText: "Visit Website", }, { title: "Phone", value: "01234567890", type: "phone", }, { title: "Email", value: "contact@sparklayer.io", type: "email", displayText: "Click to email", }, { title: "Some normal text", value: "This is a normal value with no formatting", }, ], /* End of code */ ``` **Custom element configuration options** | Key | Details | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `title` | The label name to show to the customer, e.g. "Website" | | `value` | The value, this can either be set manually or dynamically generated, e.g. via a metafield or setting | | `type` | The field type, with the following options
* `email` This will set a link in the following format: `displayText` * `phone` This will set a link in the following format: `displayText` * `website` This will set a link in the following format: `displayText` | | `displayText` | By default, the value will be shown to your customers. If you'd prefer to show custom text, you can use the `displayText` field. For example, for a link, you could use
`displayText: "Click here"` | :::hint{type="warning"} **Please note** If you are using our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) functionality, there is an important limitation to be aware of that applies to custom fields that are based on a customer metafield. When a sales agent signs in as a B2B customer, they will not see the value inputted in the metafield on the customer's account - rather they will see the value inputted in the agent's account itself. ::: *** ## Order statuses SparkLayer supports a range of orders statuses (e.g Processing, Shipped) and you can learn more about how this works in [our guide here](docId\:lQXaNI7IVDqna09D9soAP).  If you'd like to change the naming conventions for the order statuses shown, you can update these using special language string settings. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "account.order-status.incoming": "Incoming", "account.order-status.returned": "Returned", "account.order-status.cancelled": "Cancelled", "account.order-status.shipped": "Shipped", "account.order-status.part_shipped": "Part-shipped", "account.order-status.part_returned": "Part-returned", "account.order-status.varied": "Varied", "account.order-status.processing": "Processing", "account.order-status.awaiting_approval": "Requires approval", "account.order-status.awaiting_merchant": "Awaiting merchant", "account.order-status.archived": "Archived", } }, /* End of code */ ``` *** ## Payment status Alongside shipping status, you can give your customers a real-time view of their Payment status (e.g. Paid, Unpaid). Learn more in [Payments Visibility](docId\:ibIKczvHM085BkeJIfFYv).  *** ## Show shipping address summary If you want to give customers an easy way to show their shipping address for an order, you can optionally display this from their My Account overview.  :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the display object within the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ orderListShowShippingAddress: true, /* End of code */ ``` *** ## Allow address editing SparkLayer supports full address editing and adding, allowing customers to manage their online address book. With the My Account interface, customers can simply click the icons next to each address to edit or delete an entry or add a new one. Learn how to configure this in [our guide here](docId:5_lWMNohhjBJJppg9E6Vh).  :::hint{type="info"} **Please note** Address management is enabled by default. If you'd prefer customers to not be able to edit or add addresses, you can turn that off via the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general). There is also an option to prevent addition and modification of the default billing address. This still allows for addition and modification of other addresses. ::: *** ## Order tracking (shipping) details SparkLayer has support to show order tracking information against an order, allowing customers to view shipping tracking details. This also works for part-shipments for an order, giving the customer great visibility of their order details. ::::Tabs :::Tab{title="🛍️ Using Shopify"} Within Shopify, go to an order and go through the fulfilment process. Under "Tracking information (optional)" enter the tracking number and shipping carrier (this can be automated via a third-party app)  Once added, this will then show in the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) for the customer when viewing an order detail page.  ::: :::Tab{title="🌐 Other platforms"} For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: :::: *** ## Account credit and credit balances Please refer to [Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G) *** ## Timeline & Communications The Timeline & Communications feature provides a streamlined way to track communication and activity across all order types within SparkLayer, including [Quotes](docId:8A4OpNIndUyfs3Pup-tuo) (if enabled).  It displays messages, internal notes, and order events, and related email notifications in one centralised area. Learn more in [Timeline & Communications](docId\:Kf-Gd3nHSXlrn2zZvla1Y) . *** ## Account redirect When a logged in customer accesses your website's existing my account area (e.g. `/account`), it will redirect them to the SparkLayer My Account interface instead. If you'd prefer, you can change the default handling and set a custom URL to redirect B2B customers to once they log in. You can do this by updating the SparkLayer Core Script on your website. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ accountRedirect: { urlRegex: /\/account/g, goTo: "/index", // page to redirect logged in users to }, /* End of code */ ``` ::::Tabs :::Tab{title="🛍️ Using Shopify"} **Using Shopify Customer Accounts (New Accounts)** If you're using Shopify Customer Accounts, you can configure which URL to send a customer to directly via your Shopify admin. In your Shopify admin, go to Settings, Checkout, and within [Configurations](https://admin.shopify.com/settings/checkout#checkoutprofiles), click "Customize".  From the top, navigate to the "Orders" page, click "Apps" on the left, and then enable the "B2B Account Redirect" extension. You can include: - Some optional placeholder text that shows before the customer is redirected should you wish to inform them that they are being redirected. - A specific destination URL to take the customer to once they are redirected. For example, you may want to take them to a specific collection page or a landing page. **Setting up redirect URLs based on a customer tag** If you're using *Legacy* Shopify accounts (Classic Accounts), you can also add handling to vary the destination redirect URL based on a customer group. E.g. customer group ABC goes to` /collections/wholesale-page` whereas customer group XYZ goes to `/collections/wholesale-vip` Within your SparkLayer Core Script, you can replace the above code sample with the following Liquid code logic (and adapt accordingly): ```javascript accountRedirect: { urlRegex: /\/account/g, {% assign goTo = "/index" %} {% for tag in customer.tags %} {% if tag == "b2b-group-1" %} {% assign goTo = "/collections/wholesale-page" %} {% elsif tag == "b2b-group-2" %} {% assign goTo = "/collections/another-wholesale-page" %} {% endif %} {% endfor %} goTo: {{ goTo | json}}, }, ``` ::: :::Tab{title="🌐 Other platforms"} No configurations available. ::: :::: *** ## Quick links to view orders SparkLayer has built-in functionality that can optionally 'auto-redirect' a customer directly to their order or quote details, simply by clicking a link. To learn how this works, please see [our guide here](docId\:lQXaNI7IVDqna09D9soAP). *** ## Order invoices It's possible to attach invoices (e.g. a PDF) to a B2B customer's order. Please refer to [our guide here](docId\:yWm70oQUosyKOoIqb4Z4G) to learn more. *** ## Showing a custom Order ID ("Visible ID") It's possible to overwrite the standard order ID that is shown when a customer views their orders, allowing you to have consistent order IDs across systems  ::::Tabs :::Tab{title="🛍️ Using Shopify"} To learn how this works, see [our full guide here](docId\:BxWnGB6b1n7QFfhTnu7pk). ::: :::Tab{title="🌐 Other platforms"} Not applicable ::: :::: *** ## Showing custom content (using "slots") Custom Slots (or "Targets") allow you to enhance the SparkLayer My Account interface by adding your own custom code in predefined areas.  You can learn more in our [custom slots guide here](docId\:l_2ooHJiY-rAx2chBMgP2). *** ## Advanced account settings It's possible to extend how you manage the account information for your B2B customers by using special metafields. For example, if you're using a backend system (e.g. an ERP) that requires very specific address and customer data, these advanced address settings offer more granular flexibility in how data is stored. You can explore our available metafields below. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: :::ExpandableHeading **Accounting ID ** | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `accounting_id` | | `Use-case` | This can be used to specify a unique accounting ID for a customer. For example, if you're using an ERP or accounts package, you can associate a unique account ID against a customer record.
When an Accounting ID is set, this will be added to the eCommerce platform orders metadata. | ::: :::ExpandableHeading **Title** | Item | Details | | ------------------ | ------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `title` | | `Use-case` | This can be used to specify a "title" for the customer. | ::: :::ExpandableHeading **Company Name** | Item | Details | | ------------------ | ------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `company_name` | | `Use-case` | This can be used to specify a "Company Name" for the customer. | ::: :::ExpandableHeading **Shipping Address ID** | Item | Details | | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `shipping_address_id` | | `Use-case` | This can be used to specify a unique shipping address ID for the customer.
When specified, this will be set as the default address for the customer. | ::: :::ExpandableHeading **Billing Address ID ** | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `billing_address_id` | | `Use-case` | This can be used to specify a unique billing address ID for the customer.
When specified, this will be set as the default address for the customer. | ::: :::ExpandableHeading **Available Shipping Addresses by ID ** | Item | Details | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as `JSON` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `available_shipping_address_ids` | | `Example Value` | `[9840404758756,9840404758756]` | | `Use-case` | This can be used to specify the available shipping addresses for the for the customer (by Shopify ID). You can provide multiple address IDs in a comma separated list. | ::: :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `rrp` | | `Value` | This must be set up in the following format
`[{"value":15.99,"currency_code":"usd"}]`
Where `value` is the retail price and `currency_code` is the currency code (e.g. usd, gbp, eur).
You can define prices for additional currencies by using this example format
`[{"value":15.99,"currency_code":"usd"},{"value":10.99,"currency_code":"gbp"}]` | For more information, please refer to the [SparkLayer Technical Do](https://docs.sparklayer.io/tech-docs) ::: ::::: [title] Company Users [path] Features/ ## Introduction Company Users is a powerful feature of SparkLayer that allows companies to create "teams" of users that can share specific actions within their account. Sometimes referred to as "company roles" or "sub accounts", this feature is designed to optimise company B2B purchasing and account management.  Once enabled on your store, Company Users allows the following activities to be shared across team members once they log into their account: | Area | Actions | | ---------------- | ------------------------------------------------------------------------------------------------------------ | | `Order history` | Users of the same company can see all orders placed for the entire company, check order status, and re-order | | `Shopping lists` | Users of the same company can view and delete shopping lists that have been created | | `Address book` | Users of the same company can view, edit, and delete all addresses within the company | It's also possible to set "roles" of Company Users that grant users specific permissions during the B2B ordering process (see below). Please note, the following activities **are not shared** across team members. | Area | Actions | | --------------- | -------------------------------------------------------------------------- | | `Shopping Cart` | If a user has items in their order, these will not be shared across users. | *** ## Getting started To get started with Company Users, you'll need to enable a special setting within SparkLayer. Within the SparkLayer Dashboard, go to the [Settings area](https://app.sparklayer.io/configuration/settings/general) and switch on "Enable company users".  When this setting is enabled, this will then activate a special "widget" within the My Account area called "Company Users". *** ## How it works The Company Users functionality works as follows: ::::WorkflowBlock :::WorkflowBlockItem An active B2B customer logs into their account on your website ::: :::WorkflowBlockItem From their My Account area, they then navigate to the **"**Company Users" widget (at the bottom). From here, they can see all other active company users and invite other users ::: :::WorkflowBlockItem Once another user has been invited to the Company, that **specific user** can subsequently login and begin placing B2B orders ::: :::: Once a company user logs in, they'll also have access to a variety of shared actions and activities that all other company users can see. This currently includes: - **Orders** - users will see all orders placed by the company - **Shopping lists** - users will see all shopping lists created by the company - **Address book** - users will see all addresses added by the company *** ## Inviting users ::embed[]{url="https://www.youtube.com/watch?v=fjunRXufeTs"} Essentially, the customer who begins the *inviting* process becomes the **"main user"** (or "admin") and can control which other users have (or do not have) access to the company. To invite users, from the My Account area, the customer clicks the 'Invite new user" link in the "Company Users" widget.  Once the "Invite new user" link is clicked, they are then asked to complete an invite form. This form includes the ability to: - Specify a first and last name and an email address - Specify the "role" of the Company User (see below) :::hint{type="info" attributes="[object Object]"} **Please note** The email address specified here will be the email address used to login :::  When the **"Send invite"** button is clicked, this will then trigger the following actions: | Account status | Actions | | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `If the invitee does not already have an account on the website` | This will send the invitee an email asking them to create a password to activate their account and join the company | | `If the invitee already has an account on the website` | The customer will be able to login with their existing login details to join the company.
If the invitee is already registered as a B2B customer in your store, they will not be able to become a sub-account. In this instance, the invitee will need to be "manually" associated. This can be actioned by using metafields to associate records and you can learn more in [our guide here.](docId\:OTLHhi8sQ6oS4PAt23-8H) | :::::Tabs ::::Tab{title="🛍️ Using Shopify"} For invitees that do not already have an account, they'll receive an email that looks similar to the below. This is an email that is generated via Shopify and can be easily modified. Within Shopify, this uses the "Activate Account" email notification and can be modified within the Settings > Notifications area of your Shopify admin.  :::hint{type="warning" attributes="[object Object]"} **Please note** As part of introducing Company Users to your B2B customer base, we recommend informing them of the process detailed above to ensure they are familiar with the steps involved. ::: :::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: ::::: *** ## Logging in as an invited Company User When an invited Company User logs in, they'll see the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) as normal along with additional messaging confirming they are part of a company.  In addition, they'll also see the company they are connected to within their **My Details** area.  *** ## Placing an order The invited Company User can browse the website and begin adding items to an order. All prices shown will be the prices set up for the "main user" using the [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) of SparkLayer. Once they've added products to an order, they can access the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) at any point and begin the checkout process. Just as with the standard customer experience, they can select an address, shipping method, and see all available payment methods. ::::Tabs :::Tab{title="🛍️ Using Shopify"} To understand the payment flow, the payment methods work as follows: | Payment Method | Flow | Status | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | `Pay by Invoice` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | | `Pay on Account` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | | `Pay Online by Card` | The order is submitted as a **Draft order** within Shopify and the customer will **receive a notification** to make payment (see below) | Order is left in Draft status until the payment is successfully made | | `Request for Quote` | The order is submitted as a **Draft order** within Shopify and then has to be manually acted upon | Order is left in Draft status until the payment is successfully made | ::: :::Tab{title="🌐 Other platforms"} No configurations applicable ::: :::: ### Creating Draft Orders ::::Tabs :::Tab{title="🛍️ Using Shopify"} The payment flow works broadly the same for a Company User as for a standard customer. When the Company User places an order, the orders will by default enter Shopify in the **Draft order** status with the order saved in the account of the "main user". Within the "Notes" section, under "Additional details", you'll find the email address of the company user who placed the order (within the "Company User Email" field). Just as with any order in Shopify, you'll see the customer's details on the top right.  ::: :::Tab{title="🌐 Other platforms"} No configurations applicabMaking a payment against an order ::: :::: ### Making a payment against an order :::::Tabs ::::Tab{title="🛍️ Using Shopify"} Depending on the payment method used by the Company User, if the customer is required to make payment, they'll receive an **automatic email notification** detailing their order and a button to checkout. This uses the 'Send invoice' feature of Shopify Draft orders and you can learn more about [how this works here](https://help.shopify.com/en/manual/orders/create-orders#share-checkout-link-with-customers). Once the customer completes their purchase by making payment, the order is then marked as paid and will then display within your **Shopify Orders** area.  :::hint{type="info" attributes="[object Object]"} You can edit this email template by going to **Settings > Notifications** within Shopify and search for the **Draft order invoice** template ::: If the customer hasn't made payment for any reason or you are processing it manually, within Shopify you can open the order and easily resend or manually mark as paid. Please note, the order will stay as a Draft order until action has been taken.  :::: :::Tab{title="🌐 Other platforms"} No configurations applicabMaking a payment against an order ::: ::::: *** ## Roles "Roles" let you set up specific privileges for Company Users that are invited. To set a role for a Company User, from the main My Account overview click the "**Invite new user**" link to get started. Within the invitation screen, you'll see a section "**User role**".  There are currently two types of roles available: | Role | Details | | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `Standard` | This will allow users to place orders and view all account activity within your shared company account | | `Limited` | Users will be able to add items to an order but not complete orders. All orders will be sent to the company account owner for approval | ### Limited access If the invited Company User is set to "Limited", they will be prompted during the checkout process that their order will need reviewing by a team member before it can be completed.  Orders placed this way are essentially "pending" orders that will be invisible to the merchant. Once the order has been approved, this will then create a full order which can then be reviewed, completed, and fulfilled as normal. ### Reviewing orders When an order is submitted for review, this will show within the main Company User's account under "Recent Activity" with a status of "Requires Approval". The Order ID will be prefaced with a special identifier (e.g. #P-1234), differentiating it from other orders. You can [learn more](docId\:gznStzTqCRffLFZSTAw0N) about how this works.  When clicking through to an order, within the Actions menu, the Company User can then perform the following actions: | Action | Details | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `Complete Order` | This will load the contents of the order into a new "Cart", allowing the Company User to proceed through the checkout and place the order | | `Cancel Order` | This will cancel the order and remove it from the "Requires approval" list. | :::hint{type="info"} **Please note** Previously, submitting an order for review did not trigger email notifications to the main Company User. With the new update, **notifications are now sent automatically**. ::: **Email notifications** are sent to both the "main" and "limited" Company Users at key stages of the order review process, without requiring them to be logged in: - **Main User Notification**: When a limited user submits an order for review, the main Company User will receive an email alert, notifying them of the pending order that requires their attention. - **Limited User Confirmation**: Once the main Company User approves or amends the order, the limited user will receive a confirmation email, updating them on the status of their order. :::ExpandableHeading **Email notifcation examples (click to expand) **  ::: :::hint{type="info"} **Please note** The name displayed at the top of Company User emails, as shown in the dropdown example above, is synchronised directly from your eCommerce platform by default. If you’d like to customise this information, you can learn how to modify and overwrite your [default store details](docId\:gznStzTqCRffLFZSTAw0N). ::: *** ## Removing users As with inviting new users, the "main user" can also easily remove users. From the "Company Users" widget, simply click the icon to remove the user's access to the company.  *** ## Manually associating users As well as the "main user" being able to invite users, it's also possible to associate users to a company manually by using special settings against a customer. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `parent_customer_id` | | `Value` | This must be the customer ID of the main user (see below) | The manual association works by simply adding the **main account customer ID** into the `parent_customer_id` metafield.  You can find the **main account customer ID** in the URL when navigating a customer within the admin. For example, the URL in your browser may look something like this: `https://your-shopify-store-url.com/admin/customers/6494756339930` In this example, the main account customer ID would be `6494756339930` In addition, you can manually set the user's role to Standard or Limited using the following metafield: :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://hub.sparklayer.io/tech-docs) ::: ::::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as a `single line text` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `role` | | `Value` | To set the customer's role as Standard: `main`
To set the customer's role as Limited: `limited-customer` | :::hint{type="info"} **Please note** In addition to adding the metafields above, any customers added manually will also require the appropriate b2b tags to be associated to their customer record in Shopify. For example, if the main user has tags `b2b` and `b2b-company-1`, these must also be added to the customers being associated. ::: *** ## Compatibility with Sales Agents Company Users is fully compatible with the [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) allowing sales agents to add users to a company, just as a "main user" would. The inviting users works in the same fashion as detailed above. *** ## Customising text It's possible to adjust the text specific to the Company Users functionality by adding special code to the SparkLayer Core Script. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "account.main.company-users.actions": "Actions", "account.main.company-users.title": "You're signed into a Company User account", "account.main.company-users.child-account-notice": "Any activity will be shared across all users from your company. This applies to orders, shopping lists, and addresses. Please speak to your company account owner if you have any queries.", "account.main.company-users.email": "Email", "account.main.company-users.delete-confirm-message": "Are you sure you want to remove this user from your company?", "account.main.company-users.delete-failed-message": "Failed to delete user.", "account.main.company-users.header": "Company Users", "account.main.company-users.invite-button-text": "Invite new user", "account.main.company-users.invite-user.header": "Invite new user", "account.main.company-users.invite-user.invite-sent": "User invite sent", "account.main.company-users.invite-user.invite-failed": "Sorry, something has gone wrong and we have not been able to invited this user", "account.main.company-users.invite-user.form.first-name": "First Name", "account.main.company-users.invite-user.form.last-name": "Last Name", "account.main.company-users.invite-user.form.email": "Email", "account.main.company-users.invite-user.form.send-invite": "Create Company User", "account.main.company-users.invite-user.form.cancel": "Cancel", "account.main.company-users.invite-user.form.description": "When you invite company users, any activity will be shared across your team including orders, shopping lists, and addresses. If the user you're inviting doesn't already have an account to login to our store, they'll receive an Account Activation email and they'll be asked to set a password to gain access. If they already have an account, they can login with their existing details by visiting the login page. If you're unsure about inviting users, please speak to your contact within our company." } }, /* End of code */ ``` *** ## Limitations Please note the following limitations of Company Users: - **Inviting users**: when a new user is invited, they will receive the "Activate Account" email from Shopify. It is not currently possible to create a custom email notification for this - **Restricting access**: when Company Users is activated in the SparkLayer Dashboard, it will apply to all customers that login. It is not possible to manually specify which customers have access to Company Users. [title] How SparkLayer Works [path] Introduction/ ## Introduction SparkLayer is an eCommerce platform that enables brands to rapidly scale and grow their B2B operation. It works alongside your existing online store, enabling a powerful self-service portal for your B2B customers to place orders, manage their account, and much more. ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once SparkLayer is set up, your B2B customers can simply login via your website and they'll then see all the B2B pricing and other B2B rules you've set up (e.g. payment methods, minimum spend shipping rules, and more). Under the hood is a technical feature-set that allows you to connect your mission-critical systems (such as an ERP or CRM) allowing automation of your processes. SparkLayer enables this in one complete solution, helping you achieve your ambitious B2B goals! SparkLayer works out-of-the-box with major eCommerce platforms, including: ::::LinkArray :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/PIEXshl0tG1QL9mwDUrSZ_shopify.png"} [Shopify](docId:7TmhkOEHbgEGGFdd6EMr1) Works with all versions ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/MfTGR03MBhkc_usK1Rlo3_bigcommerce.png"} [BigCommerce](docId:6zLPH9x8-qEUITCHs2obE) Works with all versions ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-AHbuSveltgWw9xRDwxWOk-20250210-144900.png"} [Wix](docId\:vEqgPapEA8X0X60U6ZWZe) Works with all versions ::: :::: *** ## The key elements to SparkLayer To better understand how SparkLayer works, there are a number of key elements: ::::WorkflowBlock :::WorkflowBlockItem **🔗 Connecting to your website** Firstly, SparkLayer connects to your existing eCommerce website (e.g. [Shopify](docId:7TmhkOEHbgEGGFdd6EMr1)). Once connected, it then synchronises specific data such as product and customer information. ::: :::WorkflowBlockItem **📋 B2B data configuration** Secondly, it allows B2B data and rules to be configured, such as [Pricing](docId\:s8XcbZGxQpgdeIGWtXseT) and settings for your [Customers](docId:5_lWMNohhjBJJppg9E6Vh) (e.g. what payment methods they can use). You can manage this manually via the SparkLayer [Dashboard](docId\:nzsx6U_DAWtzVzSehf4oR) or you can even automate this by connecting SparkLayer to your backend system (e.g. ERP or CRM) via the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT) ::: :::WorkflowBlockItem **😊 B2B frontend experience** Thirdly, it enables a beautiful [Frontend](docId\:OgKfvQX13dHW2582D57kJ) "self-service" experience for your B2B customers, allowing them to place orders, manage their account, re-order, and much more. This all happens on your existing website by enabling special "widgets" within your code. ::: :::WorkflowBlockItem **👪 Sales teams support** If you have a sales team within your business, our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) tool empowers them to manage B2B customer accounts. They can also manage the full "quote to order" process using our powerful [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo). ::: :::WorkflowBlockItem **🔄 B2B order processing** Once everything is set up, any orders placed by B2B customers will arrive into your website's admin (e.g. [Shopify](docId:7TmhkOEHbgEGGFdd6EMr1)) where you can then review them, make edits, or simply process them for shipment. This all uses your existing process and workflows that you've already got set up! ::: :::: *** ## Next steps Visit our [Getting Started](docId:-5djX1YCIgzAI6MRkq0u6) guide on how to get up and running with SparkLayer or [try our demo](docId:87ILO_vHmG3XUXKecOLXv) to see it in action! [title] Technical Information [path] Frontend/ ## Introduction SparkLayer is designed to be as lightweight as possible and uses modern JavaScript technology to power the frontend. *** ## How SparkLayer is loaded All elements of SparkLayer are fully-hosted using a best-of-breed server infrastructure, meaning there's no code for you to self-manage, host, or maintain going forward. For performance, SparkLayer Frontend **only** loads when a customer successfully logs into a website; all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. *** ## Browser Support We currently support the latest two versions of the following major browsers: - Google Chrome - Mozilla Firefox - Apple Safari - Microsoft Edge - Apple Safari for iOS - Google Chrome for Android and iOS Please note, SparkLayer may not work fully with beta or pre-release versions of these browsers *** ## Mobile support The [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) work across all devices (e.g.desktop, tablet, mobile), ensuring customers can easily browse your website no matter which device they are using.  *** ## Building custom interfaces It's possible to extend the frontend of SparkLayer to create more custom layouts. Please refer to [JavaScript SDK & Headless](docId\:B-blQYlOC3QNKrit7XLgw) *** ## Event tracking for analytics (Google Analytics, GA4) :::hint{type="warning"} **Please note** This integration requires some technical setup, so please ensure a developer is available to assist. For full instructions, consult our [our technical docs here.](docId\:nRnplHclcT3sLJt_C_9pF) ::: **Integrating Google Analytics with SparkLayer** If you're looking to track key events in Google Analytics (GA4) or Google Tag Manager (GTM) through SparkLayer, you can set this up directly in your integration. This will help you capture valuable B2B events like "add to cart" "checkout," and "purchase" actions. **Key details to note:** - Supports GA4, GTM, and custom analytics. - Configuration is done using `sparkOptions`. Detailed code examples and setup steps are available in [our technical docs here.](docId\:nRnplHclcT3sLJt_C_9pF) :::ExpandableHeading **Available Events (expand to see)** | Event Name | Description | | -------------------- | -------------------------------------------------------- | | `addToCart` | Triggered when a product is added to the cart. | | `cartUpdate` | Fired when the cart is updated (e.g., quantity changes). | | `shoppingListSave` | Occurs when a shopping list is saved. | | `shoppingListLoad` | Occurs when a shopping list is loaded. | | `shoppingListDelete` | Occurs when a shopping list is deleted. | | `csvUpload` | Triggered when a CSV file is uploaded. | | `quickAdd` | Fired during quick add actions. | | `finalStageCheckout` | Occurs at the final stage of the checkout process. | | `shippingUpdate` | Fired when shipping details are updated during checkout. | | `beginCheckout` | Triggered when the checkout process begins. | | `purchase` | Occurs upon successful purchase completion. | | `viewCart` | Fired when the cart is viewed. | ::: ::::ExpandableHeading **Sample code to add (expand to see)** :::hint{type="info"} **Updating sparkOptions and text** You can enable this feature by adding some special code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). ::: ```javascript window.sparkOptions = { // ... other SparkLayer options ... analytics: { providers: [ { handler: 'ga', // Use 'ga' for Google Analytics events: { addToCart: true, cartUpdate: true, shoppingListSave: true, shoppingListLoad: true, shoppingListDelete: true, csvUpload: true, quickAdd: true, finalStageCheckout: true, shippingUpdate: true, beginCheckout: true, purchase: true, viewCart: true } }, { handler: 'gtm', // Use 'gtm' for Google Tag Manager events: { addToCart: true, cartUpdate: true, shoppingListSave: true, shoppingListLoad: true, shoppingListDelete: true, csvUpload: true, quickAdd: true, finalStageCheckout: true, shippingUpdate: true, beginCheckout: true, purchase: true, viewCart: true } }, { handler: function(eventName, eventParam) { console.log('Event fired to custom provider:', eventName, eventParam); // Implement your custom analytics logic here }, events: { addToCart: true, cartUpdate: true, shoppingListSave: true, shoppingListLoad: true, shoppingListDelete: true, csvUpload: true, quickAdd: true, finalStageCheckout: true, shippingUpdate: true, beginCheckout: true, purchase: true, viewCart: true } } ] } }; ``` :::: [title] Frontend [path] / ## Introduction SparkLayer comes with ready-made B2B-optimised "widgets" that we collectively call the *SparkLayer Frontend*. The widgets simply overlay sections of your existing eCommerce store and enable our [powerful B2B features](docId\:SSzdKXuNMlEIDOOITHQcU).  The best part? You can do away with having to build and maintain these yourself, it's super lightweight, and works with leading eCommerce platforms. *** ## Explore more ::::LinkArray :::LinkArrayItem [Integration Guide](docId\:QWXsYM9X5_pvIOGUteKcP) Learn how to add SparkLayer to your website with our special frontend widgets ::: :::LinkArrayItem [Features](docId\:SSzdKXuNMlEIDOOITHQcU) Explore the available features and configurations available out of the box ::: :::LinkArrayItem [Customising the Design](docId\:qCt2Zk8wjhYIV2ZbVBJYy) SparkLayer can be tailored to match your website branding via CSS configurations ::: :::LinkArrayItem [JavaScript SDK](docId\:B-blQYlOC3QNKrit7XLgw) Looking to build a more custom interface? Extend SparkLayer with our frontend SDK. ::: :::LinkArrayItem [Technical Information](docId\:qD08Q-eiJ2-8k1MweLqca) Learn about how SparkLayer is loaded, browser support, and more! ::: :::: [title] Product Price Interface [path] Features/Frontend Interfaces/ ## Introduction The Product Price Interface lets you display B2B pricing for a product anywhere on your website. It can be used alongside (or instead of) the other product interfaces and gives you flexibility to customise how you want your pricing to be shown to your customers.  :::hint{type="success"} **SparkLayer Interactive Demo** You can explore how the SparkLayer Product Page Interfaces work in [our interactive demo](https://www.figma.com/proto/5FPCY5hSGl7mlwjsjMZI2t/SparkLayer-Interfaces?page-id=0%3A1\&type=design\&node-id=86-36708\&viewport=554%2C-398%2C0.33\&t=34VlPwbCqpvQOTsh-8\&scaling=min-zoom\&starting-point-node-id=35%3A7920\&hide-ui=1). ::: *** ## How it works The Product Price Interface lets you show B2B pricing anywhere on the product pages on your website. This could include product collection (or "category") pages or product detail pages. There are two configurations available: | Item | Details | | ------------- | --------------------------------------------------------------------------------------------------------------------- | | `B2B pricing` | This shows logged in customers their specific B2B pricing | | `RRP pricing` | This shows logged in customers the RRP pricing you've set for the product. [Learn more](docId\:S_VTlJBorGmnwjjfSMom9) | *** ## Integrating the code To add the Product Price Interface to your website, you just need to add a single line of code to your product detail page template based on which pricing type you'd like to show. You can also combine the pricing types anywhere on your website. ```javascript
`["price-list-handle-one"]`
For two, use commas:
`["price-list-handle-one", "base-list"]` | :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | Customers | | `Metafield type` | This must be set as a `json` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `price_lists` | | `Value` | An example of just one price list:``
`["price-list-handle-one"]`
For two, use commas:
`["price-list-handle-one", "base-list"]` | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: :::hint{type="success"} Learn more about how price lists work [our guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: [title] Data Tables [path] Features/Forms/ # Introduction Data tables let you store reusable structured data for your forms. Think of them as a simple spreadsheet inside the Forms system. They’re useful when you want to: - power select, radio, or multi-select fields from a central list - reuse the same data across multiple forms - look up table rows and values in calculations, conditions, and workflow logic - keep your form logic cleaner by managing data in one place ### How data tables work Each data table contains: - columns, which define the data you want to store - rows, which hold the actual records - views, which let you filter rows and control which columns are shown Data tables currently support these column types: - Text - Number - Date ### Common use cases You can use data tables for things like: - product lists - branch or store locations - pricing bands - sales reps or account managers - internal reference codes - approved option lists for advanced forms ### How to set one up 1. Create a new data table. 2. Add the columns you need. 3. Add rows manually, or import them from CSV. 4. Connect the table to a choice-based field in your form, or reference it inside calculations and workflows. You can also export table data to CSV when needed. ### Example You might create a Products table with columns for: - product name - SKU - category - price You can then use that table to populate a choice field in a form, and use the same table data later in workflow logic or calculations. ### Best practice Use data tables when the same list or lookup data needs to be managed in one place and reused across multiple forms. This makes updates easier and helps keep forms consistent. [title] B2B Catalogs [path] Features/  B2B Catalogs is a free SparkLayer app that lets you control which products are visible to different types of customers on your Shopify store. Hide products from B2C customers, restrict items to B2B-only, or show different product ranges to different customer groups - all using simple tags, no code required. [Install B2B Catalogs](https://apps.shopify.com/sparklayer-b2b-catalogs) from the Shopify App Store, then head to our [B2B Catalogs documentation](https://docs.sparklayer.io/b2b-catalogs/) for the full setup guide. [title] Workflows & Automations [path] Features/Forms/ ## Introduction Workflows let you automate actions when something happens in a SparkLayer Form — for example sending notifications, updating data, or triggering internal processes. Instead of building manual processes around form submissions, workflows allow you to create automated flows using a visual editor. Typical SparkLayer use cases include: - Trade account approvals - Internal notifications - Order request processing - Conditional routing based on customer data :::hint{type="info"} Please note that creating and editing of workflows is only available on the Growth plan and above. ::: *** ## 🧠 What is a workflow? A workflow is an automated sequence that runs when an event occurs. Every workflow follows a simple structure: :::BlockQuote Trigger → Step → Step → Step → End ::: Each workflow contains: | Component | Description | | ------------- | ----------------------------------- | | `Trigger` | The event that starts the workflow | | `Steps` | Actions performed after the trigger | | `Connections` | Paths that link steps together | Workflows are created visually by connecting nodes together on a canvas. :::hint{type="info"} If you chose to receive notifications on new submissions when creating a form, then your form already has a workflow! Click on the Workflows tab to see it. ::: *** ## Available Triggers Triggers define when a workflow starts. | **Trigger** | Use this to | | ----------------------- | ---------------------------------------------------------------------------------- | | Form submitted | Run the workflow when a form is completed and submitted. | | Entry created | Run the workflow when a new entry is created (user starts filling out the form). | | Answer updated | Run the workflow when one or more selected form answers change. | | Internal field updated | Run the workflow when one or more selected internal fields change. | | Page loaded | Run the workflow when a selected form page is loaded. | | Button clicked | Run the workflow when a button field on the form is clicked. | | Internal button clicked | Run the workflow when an internal fields button field is clicked by an admin user. | | API request | Run the workflow when it is triggered by an API request. | Common examples: - Send an internal notification when a form is submitted - Recalculate a value when an answer changes - Start an approval process when an internal button is clicked - Update internal fields when an admin changes review data - Trigger a workflow from another system using an API request ## Available Steps Steps define what the workflow does after the trigger runs. | **Step** | **What it does** | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | Send email | Sends an email to one or more recipients. | | Condition | Branches the workflow based on rules. | | Calculation | Performs calculations using numbers, formulas, and Data References. | | For each loop | Repeats a set of steps for each item in a list, such as line items, repeatable fields, or Data Table rows. | | Update entry or row | Updates a field value on a form entry or Data Table row. | | Clear answer | Clears one or more values from a form entry or Data Table row. Useful when a value should be reset after related data changes. | | Read/Unread entry | Marks an entry as read or unread. | | Create entry or row | Creates a new form entry or Data Table row. | | Delete entry or row | Deletes a form entry or Data Table row. | | API request | Sends an HTTP request to an external system. | | Get customer | Looks up an existing SparkLayer customer by ID, platform ID, or email. | | Create customer | Creates a customer in the eCommerce platform and SparkLayer. | | Update customer | Updates an existing SparkLayer customer. | ## Step Paths Some steps have multiple paths. Paths control what happens next. | **Step** | **Paths** | | ---------------- | ---------------------------------------- | | Condition | True, False | | For each loop | Loop body for each iteration, After loop | | API request | Success, Error | | Get customer | Found, Not found, Error | | Create customer | Success, Error | | Update customer | Success, Error | | Most other steps | Next | Example: an API request can continue on the success path if the request works, or follow the error path if the request fails. ## Choosing the Right Step - Use **Condition** when the workflow needs to make a decision. - Use **Calculation** when you need to calculate totals, scores, discounts, or other numeric values. - Use **Update entry or row** when you want to write a value back into the current entry, an internal field, another form entry, or a Data Table row. - Use **Clear answer** when a previous value is no longer valid and should be removed. This is useful for dependent fields, such as clearing a selected option after the field that controls its available options changes. - Use **For each loop** when you need to process every item in a list, such as repeatable fields, line items, or filtered Data Table rows. - Use **API request** when another system needs to receive form or workflow data. - Use the **SparkLayer** **customer** steps when the workflow needs to find, create, or update customer account data. *** ## 🚀 Creating a workflow To create a workflow: 1. Open your form in SparkLayer 2. Go to the **Workflows** tab 3. Click **Add workflow** 4. The visual editor will open ### Add a trigger Triggers define when the workflow runs. Examples: - Form submitted - Entry answer updated - Internal field updated - Workflow trigger button clicked To add a trigger: 1. Click **Add Trigger** on the canvas 2. Select the trigger type 3. Configure any options Steps can use [Data References](docId\:Bj9Tb3GN_VYbi1-Ehm4Rd) to read and write values to current entry, workflow run data, and other data sources. ### Add steps Steps define what happens after the trigger. To add a step: 1. Click the **Add step** button, or drag the path handle out from an existing step 2. Choose a step type 3. Configure the action 4. Connect to additional steps if needed You can build simple linear workflows or create branches using conditions. *** ## 🧾 Publishing workflows Workflows are part of your form version. This means: - Changes remain in **Draft** until published - The live workflow only updates when the form version is published - Older entries continue using the workflow version they were created with To activate a workflow: 1. Save your changes 2. Publish the form version This keeps automation stable even while you make updates. *** ## 🎛 Understanding the workflow canvas The workflow editor uses a visual canvas where you arrange nodes and connections. ### Navigation | Action | How it works | | -------------- | ---------------------- | | `Pan` | Click and drag | | `Zoom` | Scroll or use controls | | `Select node` | Click the node | | `Multi-select` | Shift + click or drag | ### Nodes Nodes represent triggers and steps: | Node type | Purpose | | --------------- | ---------------------------------- | | `Trigger nodes` | Starting point for workflows | | `Step nodes` | Actions performed during execution | | `Connections` | Paths between nodes | Click a node to: - Edit settings - View input/output data - Delete or reconnect it *** ## 🔗 Connecting steps You connect steps by dragging from one node to another. ### Connection types | Path | Meaning | | -------------- | ------------------------- | | `Next` | Continue to the next step | | `True / False` | Conditional branching | | `Error` | Run when a step fails | | `Loop` | Used in repeat processes | A single step can branch into multiple paths, allowing complex automation flows. *** ## ⚙️ How workflows run Workflows execute **synchronously**, meaning steps run one after another in order. Execution flow: 1. Trigger fires 2. Steps execute sequentially 3. Entry data updates 4. Workflow completes During execution, workflows can access: - Entry data - Form structure - Outputs from previous steps - Data tables or stored values *** ## 📊 Workflow runs & history Every time a workflow runs, SparkLayer records a run log. ### Viewing workflow runs 1. Open an entry 2. Go to **Workflow Runs** 3. Select a run to view details Each run includes: | Data | Description | | ------------------ | ---------------------------- | | `Start & end time` | When execution occurred | | `Duration` | Total runtime | | `Status` | Completed or failed | | `Step logs` | Inputs, outputs, and results | This helps diagnose issues without needing developer access. *** ## 🧪 Debugging workflows When something doesn’t work as expected: 1. Open the workflow run 2. Review each step 3. Check error messages or failed conditions 4. Adjust the workflow or entry data You can see exactly which path was taken through the workflow — including conditional branches. ## 🧩 Example workflow patterns ### 📩 Simple notification :::BlockQuote Trigger: Form submitted ↓ Send internal email ::: ### 🔀 Conditional routing :::BlockQuote Trigger: Form submitted ↓ If category = Sales → Notify sales team Else → Notify support team ::: ### 🧾 Multi-step approval process :::BlockQuote Trigger: Form submitted ↓ Calculate totals ↓ Update entry fields ↓ Send confirmation email ↓ If total > threshold → Request approval ::: ### 🧾 Dependent Field Reset Use this pattern when one field controls the valid options for another field. Example: A customer selects a country. A second field shows regions for that country. If the customer changes the country, the previously selected region may no longer be valid, so the workflow clears it. Pattern: :::BlockQuote Trigger: Answer updated ↓ Answer changed: Country ↓ Clear answer: Region ↓ The user can now select a valid region for the new country ::: Common uses: - Country → Region - Customer group → Available products - Product category → Product - Department → Approval reason - Order type → Required supporting details *** ## 💡 Best practices **Keep workflows focused** - One workflow per process - Avoid combining unrelated automation - Use clear naming **Test before publishing** - Use preview mode - Submit test entries - Check workflow runs for errors **Plan for errors** - Add error paths where needed - Log important outputs - Avoid breaking critical workflows **Optimise performance** - Limit unnecessary API calls - Avoid overly long step chains - Keep automation logic clear and maintainable [title] Forms [path] Features/ ## Introduction SparkLayer Forms provides a **native, no-code form builder** that lets you capture, manage and act on customer data directly within SparkLayer. ::embed[]{url="https://www.youtube.com/embed/_M4QphRF9_k"} Forms can be used across your B2B journey - from **registration**, to **editing sales agent details** - all without relying on third-party apps or custom development. Forms are built and managed in the [SparkLayer Dashboard](https://app.sparklayer.io/forms) and can be embedded into your storefront or used internally by your team. Common use-cases include: - Wholesale / B2B registration forms - Internal contact or enquiry forms - Capturing structured customer data (e.g. VAT IDs, trade references, licences) - Streamlining approval and onboarding workflows - Reducing reliance on third-party form builders *** ## Features At a top-level, [SparkLayer Forms](https://app.sparklayer.io/forms) supports the following range of features and configurations. | Item | Details | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Form Builder` | - Build forms visually using a drag-and-drop builder - Add flexible field types including text, email, phone, dropdowns, checkboxes, dates, addresses and file uploads - Set fields as required or optional - Apply validation rules (e.g. email, phone or tax ID formats) - Show or hide fields using conditional logic - Structure forms into multiple pages with headers, dividers and progress indicators - Save progress and return later | | `Internal Fields` | * Setup a internal fields for entry administration * Internal Fields act as it's own form that will be shown to administrative users when reviewing the form submissions * Internal Fields are not exposed to the end customer at any time * Use these to setup internal workflows: - Changes to internal fields can trigger workflows - Use the Workflow Trigger field to add a button that can trigger a workflow * You can use any features available in the main form for the internal fields setup including field display logic, custom validation, integration with workflows, adding multiple pages, etc. | | `Publishing` | - Preview forms before publishing - Embed forms on your storefront - Create internal-only forms for team use - Customise success or confirmation pages after submission | | `Branding` | * Style forms to match your site using CSS variables * Customise labels, help text and messaging | | `Entries & Management` | - View all submissions in one place - Review individual responses and uploaded files - See and update Internal Fields against a submission entry - Track timestamps and submission status - Export submissions to CSV for reporting or external systems | | `Workflows & Actions` | * Build custom automations that can be triggered by field updates, entry submissions, internal admin field updates, API calls and other triggers * Workflows can perform a series of actions (called Steps) including: - Assign approved users to customer groups - Automatically apply tags based on responses - Map form data into your connected platform (e.g. metafields or customer data) - Perform an API request to your ERP or external system - Send an email * Build custom review and approval workflows that fit your business, or start with a template | *** ## Getting started To begin using SparkLayer Forms, go to **Forms** within the [SparkLayer Dashboard](http://app.sparklayer.io/forms). You'll then be prompted to create a new form or edit an existing form. :::ExpandableHeading **1️⃣ Create your first form** 1. Go to **SparkLayer → Forms** 2. Click **New Form** 3. Enter a form name (e.g. *Trade Account Request*) 4. Click **Create** You’ll be taken to the form builder. ::: :::ExpandableHeading **2️⃣ Add fields to your form** Use fields to collect the information you need from customers. Common field setup | Field Type | Example Use | | ---------- | -------------------------- | | Text | Company name, contact name | | Email | Customer email address | | Textarea | Notes or messages | **To add a field:** - Click **Add field** - Choose the field type - Configure: - Label - Required toggle - Placeholder text - Click **Save** ::: :::ExpandableHeading **3️⃣ Configure form settings** Open the **Settings** tab to control how the form behaves. | Setting | What it does | | ------------------ | ----------------------------------- | | Form title | Public name shown to customers | | Submit button text | Customise CTA wording | | Success message | Confirmation shown after submission | ::: :::ExpandableHeading **4️⃣ Preview your form** When you have added all the fields: 1. Click **Preview** 2. Fill out the form to test it 3. Make any required tweaks ::: :::ExpandableHeading **5️⃣ Publish your form** When your form is ready: 1. Click **Publish** 2. Confirm changes Your form is now live inside SparkLayer. ::: :::ExpandableHeading **6️⃣ Add your form to your storefront** Once published, you can embed the form where needed using one of the options: 1. On Shopify stores, you can use the **SparkLayer Form** block in your themes. - If you can't select your required form from the dropdown, you may need to re-visit the Sparklayer B2B & Wholesale sales channel app, and confirm any new permissions. 2. On all platforms, you can use the embed code directly: - Copy the embed snippet from the **Share** tab - Add it to your theme or page content - Save your changes ::: :::ExpandableHeading **7️⃣ View submissions** When customers complete your form: 1. Open your form in SparkLayer 2. Go to **Entries** 3. Click any submission to view full details ::: *** ## Start with a Template A few common form templates are available to get you started quickly. Forms created from templates can be further customised and extended with custom automations and extra fields. ### Customer Registration Form Use this template to get a fully working customer registration form with the following features: - Common registration form fields already setup - New registration submission email notifications - Internal approval workflow fields setup allowing easy approval or rejection of new applications - On approval, automatic creation of the customer in the eCommerce platform - Extendible with custom automations or extra fields ### Contact Form Use this template for a customisable contact form: - Add any required or optional fields - Receive an email notification for new submissions - Setup automations and administrative workflows ### *** ## Explore more After creating your first form, explore: [Form setup](docId\:ZMxs_yKAM14ynYNEoEMNw) Configure how your form behaves, including settings, publishing, and version control. [Field types](docId\:zJqYfItNqFnZq-kGLD2TS) Choose the right inputs to capture structured data from your customers. [Form Entries](docId\:uSPvWmmpbtmrtHSpcNyOk) View, manage, and update submissions sent through your forms. [Conditional Logic](docId\:JZ1KsJxZIS72g2JNq8lee) Show or hide fields dynamically based on customer responses. [Validation Rules](docId\:IjhTAqJO7CzJCRi98gSxf) Ensure form data meets your requirements before it’s submitted or processed. [Workflows & Automations](docId\:KFk4KgojUGQV3Bolye--b) Automate actions and processes triggered by form activity. [title] Form setup [path] Features/Forms/ [title] Shopify [path] Integrations/ ## Introduction SparkLayer is the powerful platform that transforms your existing Shopify website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed the [official SparkLayer for Shopify app](https://apps.shopify.com/sparklayer), SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your Shopify store. The best part is you can retain your *existing* Shopify store design and layout and enable B2B alongside your retail operation (DTC). ## Supported Shopify Plans  SparkLayer works on all versions of Shopify, from Shopify Basic through to Shopify Plus. No matter which version of Shopify you use, you can easily enable SparkLayer on your Shopify store. :::hint{type="success"} **Try our demo** Want to test SparkLayer on an example Shopify Store? [Try our Demo](docId:87ILO_vHmG3XUXKecOLXv) ::: *** ## Get started ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Installing SparkLayer on Shopify](docId:687ZiSnQ7rsITCGjjKFyb) Learn about the steps to install SparkLayer on your Shopify store ::: :::LinkArrayItem [Shopify Customisations](docId\:ddIv5TDAnCayWTOJ0Vyb7) Explore our tips and tricks on Shopify B2B customisations ::: :::LinkArrayItem [Shopify B2B Dawn Theme](docId\:LHkU0_G_4GVef1jAmgXmo) Get a head start with our ready-made Shopify B2B theme ::: :::LinkArrayItem [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD) Take your B2B international with Shopify Markets ::: :::LinkArrayItem [Shopify Metafields & Data Mapping](docId\:BxWnGB6b1n7QFfhTnu7pk) Learn how to use the powerful Shopify metafields feature ::: :::LinkArrayItem [Shopify FAQs](docId\:P-7titr2d20hXBeixvKBZ) See some of our most commonly asked questions! ::: :::LinkArrayItem [Shopify Companies](docId\:wrzSu8adFvbXOkF50hX5I) How SparkLayer works alongside Shopify Companies. ::: :::: [title] Product Matrix Interface [path] Features/Frontend Interfaces/ ## Introduction The Product Matrix Interface lets your B2B customers rapidly add products to an order in bulk via a special "matrix table" display. If your products come in multiple variant types (e.g. colour and size), it's a great way to allow customers to quickly see all variants available and quickly purchase them.  :::hint{type="success"} **SparkLayer Interactive Demo** You can explore how the Product Matrix Interface works on our [example product here](https://demo.sparklayer.io/collections/b2b-grid-mode/products/example-running-shoes). ::: *** ## How it works :::hint{type="info"} **Please note** We only recommend using the Product Matrix Interface if you have products that have multiple variant option types (e.g. colour and size) with a large number of options. ::: The Product Matrix Interface replaces elements on your website's product detail page with a specially optimised layout that shows all the product options (variants) in **one single view**. ::embed[]{url="https://www.youtube.com/embed/cloM8_DJ7eg"} Once set up, the interface will be presented in a table and show the following information to the customer: | Item | Details | | ------------------ | ---------------------------------------------------------------------------------------------------- | | `Product pricing` | Their specific B2B pricing and, optionally, RRP pricing | | `Variants` | A matrix table of all available variants | | `Quantity` | The ability to select the quantity of a product using [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) | | `Add to order` | The ability to add items to an order | | `Quantity pricing` | Visibility of quantity pricing available (this is shown in an information popup) | | `Stock level` | The stock status of a product (e.g. pre-order) | | `SKU` | The product code (this is shown in an information popup) | The Product Matrix Interface also has handling for more than two variant groups. For each additional variant group, these will be presented within the table matrix for the customer to view. In the example below, the product is set up with Colour, Size, and an option to add a logo.  *** ## Integrating the code To add the Product Matrix Interface to your website, you just need to add a single line of code to your product detail page. ```javascript
It also enables you to add products to your cart in the same way as the SKU/Barcode Lookup option.
*This type gives your customers the more feature-rich user experience.* | | `SKU / Barcode Lookup` | This allows you to search by **SKU / Barcode** and will add items to an order only if an exact match is found.
*This type is useful if your customers use the tool purely for adding exact SKUs or Barcodes.* | ### How to enable Depending on your preference, you can enable these via the configuration area of the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general). :::hint{type="info"} **Hiding the search / lookup** It's also possible to fully hide the search / lookup feature, you can manage this in the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general) by selecting **Hide search** from the **Cart search type**. ::: ### Understanding the types ::::Tabs :::Tab{title="🔍 Search"} The Search tool offers an easy way for your customers to quickly add items, allowing them to search by a range of criteria including product name, product description, product SKU, product variant name, product variant option name and barcode. ::embed[]{url="https://www.youtube.com/embed/61IRiGBcR6Q"} The tool also handles mis-spellings and "partial matching", ensuring results are delivered where possible and allowing for a more user-friendly search. For example, when searching coffee, results will be returned for entries such as `coffe`, `cofee`, `cofe` In the example below, searching `example coffee` returns results of any products that match this term, prioritising those most relevant.  Similar to the main cart, the customer will see the ability to add items to an order using the quantity entry box as well as full visibilty of any quantity discounts, pack size rules, and inventory status. ::: :::Tab{title="➕ SKU / Barcode Lookup"} The SKU / Barcode Lookup adds products to your order simply by typing in the SKU or Barcode (if you're store is set up to use barcodes, you can [read our guide here](docId\:m3DF4f0Eyc2rM-vUaRG9H)). If it finds a match, it will immediately add the item and you can subsequently make edits.  ::: :::: :::hint{type="info"} **Please note** Each type noted above automatically add products to the order **using the rules** you've set. For example, if the product has been configured to use [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D) or minimum or maximum quantities, this will automatically be applied at the point of adding to the order. ::: ### Customising the text It's also possible to adjust the text that shows by default in the search box by adding a special text overwrite as shown below. For example, if you're using barcodes, you may want to inform customers that they can use both a SKU and a barcode to search. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.quick-order.search-placeholder": "Add products by SKU or barcode", } }, /* End of code */ ``` *** ## Intelligent Cart (AI) SparkLayer Intelligent Cart introduces a revolutionary new way for your B2B customers and sales teams to build orders quickly and effortlessly using the power of AI.  The magic lies in its simplicity: files and emails containing order details (such as SKUs, barcodes, and quantities) can be uploaded or emailed directly to SparkLayer, instantly populating a cart. Learn more about how this works in [our full guide here](docId\:rIAcYwzOMfwSomd5KB5p8). *** ## CSV file importing It's possible to quickly bulk upload products by using the "Import CSV file" feature within the 'Options' menu.  SparkLayer supports two ways to upload the contents of a CSV file: | Type | Details | | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `File upload` | Customers can manually upload a CSV file by specifying two columns:
* **If using SKUs:** `sku` and `qty` (you can also customise these names, please see below) * **If using barcodes: **`barcode` and `sku` | | `Pasting` | Customers can paste the contents of a CSV file into the text entry box |  By default, SparkLayer will accept a CSV file that has two columns, `sku` (or `barcode`) and `qty`  It's possible to configure customised titles for these columns, if you have a requirement for them to be more personalised for your customers. In the example below, the columns have been changed to `Item No.` and `Quantity`.  To get started, within your [language string overwrites](docId\:kLrS7wtxn3WnCDy8z5Zvu), simply add the below code and update accordingly. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.import.csv-headers.sku": "Item No.", "cart.import.csv-headers.barcode": "Barcode No.", "cart.import.csv-headers.qty": "Quantity", } }, /* End of code */ ``` :::hint{type="info"} **Please note** Providing the contents of the CSV file includes valid SKUs (or barcodes), all products will be added to the customer's order and **replace** the existing contents. If a product requires specific pack sizes to be specified, the CSV Import will round up to the nearest valid pack size. ::: *** ## Shopping lists Shopping Lists let your customers save the contents of an order for future use, making it quick and easy to reorder the products they buy regularly. ::embed[****]{url="https://www.youtube.com/embed/rhuLyeKaMQY"} Products can be saved to a list straight from any product page, and lists can be fully managed from within the My Account area - including previewing, adding, and editing their contents. Your B2B customers and sales agents can also export any list as a CSV, making it easier to share and reorder across teams. [Learn more](docId\:AQJJjc8wJrskIYivjIZrG) *** ## Checkout process When a customer is ready to place their order, they can then begin the checkout process. This is split into 4 steps: ::::WorkflowBlock :::WorkflowBlockItem **My Cart** This contains the summary of the products they want to order ::: :::WorkflowBlockItem **Shipping** This allows the customer to set their shipping address and complete additional fields (such as PO number) ::: :::WorkflowBlockItem **Review & Pay** The customer can confirm their preferred shipping cost, select payment method and confirm their order ::: :::WorkflowBlockItem **Complete** This is the final step of the checkout and completes the customer's order ::: :::: ### My Cart The My Cart step is essentially a summary of the customer's order and lets them: - View item level costs for products - Change quantities and remove products - Clear and empty the contents of an order - Perform actions such as saving shopping lists or importing CSV files (see above) - See their order sub-total (typically excluding tax and shipping costs)  :::hint{type="info"} **Order limit rules** It's possible to set minimum and maximum order rules (by order total and order quantity) that a customer has to meet before being able to place an order. Please refer to [our full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: ### Shipping The Shipping step allows the customer to select their shipping address and complete any data entry fields you may have enabled.  **Data entry fields** The data entry fields include the following configurations: - **Additional Information: **this is useful if you want to capture additional details from a customer whilst they are placing an order. Typical use-cases include capturing a Purchase Order number (sometimes referred to as PO number), delivery instructions, or instructions. [Learn more](docId\:o3nDhZBCxisWH6M6satDt) - **Custom checkout fields: **Custom checkout fields allow you to capture additional information from customers during the checkout process. It's a great way to allow customers to add data such as preferred shipping date, shipping instructions, and more! [Learn more](docId\:o3nDhZBCxisWH6M6satDt) - **File uploads: **SparkLayer supports the ability for B2B customers to upload files during the checkout process. This is a great way to capture additional details from the customer such as a "Purchase Order", details specific to their order (e.g. customisations they require), or any other file that is relevant to their account. [Learn more](docId\:o3nDhZBCxisWH6M6satDt) **Addresses** By default, any addresses for the customer are automatically taken from their address book information within your website admin. :::Iframe{iframeHeight="0" code=""} ::: Customers can also manually add addresses by clicking the '"Add new address" button or via the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP).  If they're adding an address via the My Cart interface, they can also select from the following: | Item | Details | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `Set as default shipping address` | This will become the default shipping address for future orders | | `Set as default billing address` | This will become the default billing address for future orders | | `Save address to address book` | This will save the address to their address book and this can be edited from the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) | If a customer has more than 4 addresses saved, the interface will also adapt to show all saved addresses within a drop down menu.  :::hint{type="info"} **Please note** It's possible to disable the ability to edit addresses, learn more in our [guide here](docId:-O7CpOLTlCJA2ChYChdoa) ::: ### Review & Pay The Review & Pay step is the final step of the checkout process and lets customers: - Select and confirm their preferred shipping method - Select and confirm their preferred payment method - See a full breakdown of the cost of their order, including tax and shipping - Confirm to your terms and conditions  **Shipping method** The shipping methods work in one of two ways: 1. Shipping is automatically calculated from the rules set up within your website admin 2. Shipping is calculated by the rules set up in the SparkLayer Dashboard You can learn more about how shipping works in [our guide here](docId\:CfZ_ZpGw2umOVAo73Lc5m). **Payment methods** :::hint{type="info"} Please see [payment methods](docId\:efevur-A3yCJXUHvrR7t-) below ::: ### Complete Once the customer has completed their order, this is then sent through to your eCommerce platform just like any regular order. Depending on the payment method selected, this will either arrive into your website admin as a *Draft* order or a *Completed* order.  If you've additionally configured orders to connect to the [SparkLayer API](docId\:LhKqO8T7-A0HaRgVYFgtT) this will then be sent directly to your backend system or via a middleware solution. :::hint{type="info"} **Customising the order complete screen** You can modify the text that shows to a customer, learn more in [our guide here](docId\:o3nDhZBCxisWH6M6satDt). In addition, you can also add custom content using "Slots". [Learn more](docId\:l_2ooHJiY-rAx2chBMgP2) ::: *** ## Payment methods SparkLayer supports a range of B2B-specific payment methods that can be tailored on a per-customer basis.  When customers reach the payment step, they'll see available methods and can select their preference. | Payment method | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment on Account` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** needing to enter any payment details.
**🏦 For merchants:**
It's essentially an 'offline' payment method and you can even set credit limit rules and net payment terms such as `Net 30, Net 60, etc`[Learn more](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details.
**🏦 For merchants:**
Like "Payment on Account", this is essentially an 'offline' payment method. You can then process the order and take payment via offline channels (e.g. by bank transfer) | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). This is sometimes referred to as "Pro-forma payment".
**🏦 For merchants:**
This will come through as a paid (or "completed") order and no further action should be required to collect payment. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | | `Request for quote` | **👪 For the B2B customer:**
The customer can submit their order **without** choosing a payment method.
**🏦 For merchants:**
The order will be marked as a 'Draft' order and can subsequently be edited (e.g. changing the shipping cost, adding additional discounts, adding or removing products from an order).
*Please note: as of June 2025, this has been replaced with the *[SparkLayer Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo)* and can no longer be selected within a Customer Group.* | ::::Tabs :::Tab{title="🛍️ Using Shopify"} The diagram below helps to illustrate how payments working with SparkLayer and Shopify, based on the payment method the B2B customer selects.  **Draft orders** If you're using Shopify, by default **all payment methods** other than Upfront Payment will be generated as [Draft orders](https://help.shopify.com/en/manual/orders/create-orders). If you'd prefer to automatically convert Draft orders into *Completed* orders, you can enable this via the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general). **Shopify checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the Shopify checkout. By default, they will see all Shopify payment methods you have set up (e.g. card payment, Paypal, etc). It's possible to set rules on which payment methods show for your B2B customers and we recommend [exploring available apps here](https://apps.shopify.com/payfy-conditional-payments). Please note that if a customer uses "Pay Online by Card" and doesn't complete their order, this will still show in your Shopify Draft Orders admin for review. ::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://hub.sparklayer.io/tech-docs) ::: :::: :::hint{type="info"} **Customising the B2B payment methods** You can edit the names and priority of payment methods easily. Learn more in [our guide here](docId\:ibIKczvHM085BkeJIfFYv) ::: *** ## Managing Quotes The SparkLayer [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) introduces a unified solution that streamlines the entire "quote-to-order" process directly from your existing online store. It allows you to handle quotes more effectively, converting them into completed orders faster than ever! ::embed[]{url="https://www.youtube.com/embed/Lmjwg4RK0r8"} The SparkLayer Quoting Engine works by allowing your B2B customers to easily submit quotes for review, and for your sales team to then communicate with the customer until they're ready to complete their order. Learn more in [our full guide](docId:8A4OpNIndUyfs3Pup-tuo). *** ## Discounts & promotions SparkLayer supports the ability to have discounts and promotions applied during the checkout and these can either be redeemed via discount codes, or applied "automatically" to the customer's order. :::Iframe{iframeHeight="0" code=""} ::: The SparkLayer Discount Engine unlocks a range of discount rules including: - **Order-level discounts:** eg, spend $1,000 and get 10% off, spend $2,000 and get 15% off - **Percentage and fixed discounts: **eg, 20% off an order total, $100 off an order total - **Coupon codes:** eg, enter code NEWCUSTOMER and get 5% off - **Scheduled discounts:** eg, start discount today and end it on a specific date and time - **Customer-specific discounts:** eg, only allow customer group ‘b2b-vip’ to qualify for the discount - And more :::hint{type="info"} **Learn more about discounts** You can see a full overview of what’s possible with discounts in [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg). ::: *** ## File uploads (file attachments)  SparkLayer supports the ability for B2B customers to upload files during the checkout process. This is a great way to capture additional details from the customer such as a "Purchase Order", details specific to their order (e.g. customisations they require), or any other file that is relevant to their account. [Learn more](docId\:o3nDhZBCxisWH6M6satDt). *** ## Showing custom content (using "slots") Custom Slots (or "Targets") allow you to enhance the SparkLayer My Cart interface by adding your own custom code in predefined areas.  You can learn more in our [custom slots guide here](docId\:l_2ooHJiY-rAx2chBMgP2). *** ## Persistent saved order A great feature of the SparkLayer My Cart Interface is the "persistent saved order". When a customer adds items to their order, the contents are automatically saved to their browsing session for up to 90 days. If the customer then signs out and logs back in, all previous items in their order will be saved. This feature also works across different devices, e.g. a customer could build an order on a desktop computer and then complete it the next day on a mobile device. *** ## Cart "Locking" SparkLayer has built-in handling for concurrent users making changes to an order, termed cart "locking". This is specifically relevant to our [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) tool where sales agents may be building an order on behalf of a customer. If there is an active cart and a customer subsequently accesses it, they'll see a message shown at the to of the page.  By clicking "Take control", this will then allow the customer (or sales agent) to make further edits before completing the order. *** ## Tax :::hint{type="info"} **Understanding tax** Please refer to our [guide here](docId\:ZSsXG6FjRLCod_GxoluTN) for details on how tax works with SparkLayer. ::: *** ## Configurations SparkLayer supports a wide range of configurations you can apply to the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). Please see our [full guide here](docId\:SBEaOaCq_A7FfbTatX8bD) on what's possible! *** ## Using Hardware (e.g. barcode scanners) ::embed[]{url="https://www.youtube.com/embed/BGnL56nZ8Jk"} Did you know SparkLayer can also support hardware such as barcode scanners? SparkLayer automatically synchronises [barcode data](docId\:m3DF4f0Eyc2rM-vUaRG9H) from your store, meaning you could technically use the My Cart Interface to accept barcode-scanned orders! If you have products with barcodes assigned in your admin then the below option will automatically be displayed in the cart for you to simply scan a product and add it to the cart.  The Quick Search tool (see below) allows you to insert both SKUs and Barcodes, meaning you can quickly add items to an order simply by entering codes into this input field. You'll need to configure your hardware to "target" this input field, but it's a great way to bring powerful B2B ordering to your warehouse or in-store experience.  [title] Pricing Display [path] Features/Configurations/ ## Displaying a RRP price (MSRP price) Within the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ), it's possible to show RRP prices (or "MSRP prices") alongside your specific B2B pricing. For example, you may want logged in users to see what non-B2B customers pay for a specific item, allowing them to easily see their pricing savings.  To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `rrp` | | `Value` | This must be set up in the following format
`[{"value":15.99,"currency_code":"usd"}]`
Where `value` is the retail price and `currency_code` is the currency code (e.g. usd, gbp, eur).
You can define prices for additional currencies by using this example format
`[{"value":15.99,"currency_code":"usd"},{"value":10.99,"currency_code":"gbp"}]` | :::hint{type="success"} **Automate the RRP pricing** You can automatically populate the SparkLayer RRP metafield from your live Shopify prices using Shopify Flow. See [our guide](docId\:uvXV1kUg_VsZEPr5Dlb2z) for ready-made templates. ::: You can also watch our video tutorial on how to set this up. ::embed[]{url="https://www.youtube.com/embed/Duue-ZGKp3A"} :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `rrp` | | `Value` | This must be set up in the following format
`[{"value":15.99,"currency_code":"usd"}]`
Where `value` is the retail price and `currency_code` is the currency code (e.g. usd, gbp, eur).
You can define prices for additional currencies by using this example format
`[{"value":15.99,"currency_code":"usd"},{"value":10.99,"currency_code":"gbp"}]` | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.price.rrp": "MSRP: ", "product-card.price.rrp": "MSRP: ", "cart.price.rrp": "MSRP: ", } }, /* End of code */ ``` If you'd like to adjust the appearance of the RRP pricing, you can do so via adding special CSS overwrites to apply formatting.  Simply add the below CSS to your [CSS overwrites](docId\:qCt2Zk8wjhYIV2ZbVBJYy) and adjust accordingly. ```css ``` *** ## Quantity pricing :::hint{type="info"} **Learn more** For our full guide on quantity pricing and available configurations, please see our [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) guide. ::: ### Quantity pricing table If you've set up [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) for your products, SparkLayer will by default show this to your customers within the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT). :::Iframe{iframeHeight="0" code=""} ::: This will also show to customers when they add items to the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-).  It's also possible to display the tiered pricing breaks table anywhere on your product detail page by adding a special code snippet to your website.  Simply add the below in the source code of your product pages to display an additional quantity breaks table. ```html
`roundPriceBreakPercentages: true,` | | `Hiding savings` | You can optionally hide the savings percentage from showing by adding the following setting to your [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) (within the `display` settings).
`showPriceBreakSavings: false,` |  ### Quantity pricing discount percentage based off RRP If you're using [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) in your price lists, this will display additional information to make it clear to the customer how much they are saving based on how many units they purchase. By default, the 'Savings' will be calculated based on the** single unit price **of the particular product (or variant). For example, if the single unit price is $2.00 and if you purchase 5 or more the price reduces to $1.00, the savings will display as `-50%`  If you'd prefer for the savings to instead be** calculated off the RRP** (i.e. retail price) of a product, you can enable this by adding a special setting. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { savingsUseRrp: true, /* Other settings should show below */ } /* End of code */ ``` *** ## Unit of measure pricing Are you looking to set up pricing based on "units of measure" such as boxes, cartons, or pallets? Please refer to our [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) guide to learn more. *** ## Customising the pricing text It's possible to *prefix* the pricing display on a product detail page with custom language such as `'Your price'`.  :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.price.from-prefix": "Your Price:" } }, /* End of code */ ``` In addition to this, you can also adjust any of the default language used for pricing using the below language strings. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.price.from": "From:", "pdp.price.rrp": "RRP:", "pdp.price.pack-size": "Pack ({packSize}): {price}", "product-card.price.from": "From:", "product-card.price.rrp": "RRP:" } }, /* End of code */ ``` *** ## Display a 'unit cost' price If you sell products that comprise 'multiple units', it's possible to display an automatically calculated "Unit Price" on your product pages. For example, you may sell a product that comes in packs of 10, but you want to make it clear to your customers how much a "single unit" costs. Or you may sell products that come in specific weights (e.g. kg) and you want to show a "price per kg".  To enable this, SparkLayer uses special settings (sometimes referred to as *metafields *or* attributes*) that allow additional data to be stored against products. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Setting up metafields on Shopify** To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as an `integer` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `case_size` | | `Value` | This must be set up in the following format
`1, 2, 3, etc` | Once the setting has been set up, you can then use and modify the below code sample to display on your product pages. :::ExpandableHeading **Click here to view code sample** ```javascript {%- if customer.metafields.sparklayer.authentication -%} {% if product.metafields.sparklayer.case_size %} {% endif %} {% endif %} ``` ::: **Combining with Shopify's unit price feature** If you're using Shopify's built-in unit price feature, you can also dynamically display the 'reference unit' e.g. kg, lb, ml.  Within the code sample above, simple change `el.textContent` to the below: ```javascript el.textContent = `Unit price per {{ item.unit_price_measurement.reference_unit }}: ${formatter.format(priceData.fromPrice / Number(caseSize))}`; ``` :::hint{type="warning"} **Important to note** If you are looking to customise the behaviour of how this works, we recommend engaging a Shopify expert to assist. ::: :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | --------------------------------------------------------------- | | `Custom data type` | Variant-level (products) | | `Metafield type` | This must be set as an `integer` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `case_size` | | `Value` | This must be set up in the following format
`1, 2, 3, etc` | For more information, please refer to the [SparkLayer Technical Doc](https://docs.sparklayer.io/tech-docs) ::: ::::: *** ## Adjusting the "Unavailable" message When a product has no B2B pricing set against it, the [Product Card Interface](docId\:Mrp_Z0QIZQ2QksseuJylv) and [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT) will display a message that shows "Unavailable". This indicates to the B2B customer that the product cannot be purchased.  If you'd prefer, you can adjust this to display a different message by updating the language settings on your store. :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "pdp.messaging.un-sellable": "Unavailable", "product-card.messaging.un-sellable": "Unavailable", "product-card.messaging.select-option": "Unavailable, please select another option" } }, /* End of code */ ``` *** ## Discounts & promotions SparkLayer supports the ability to have discounts and promotions applied during the checkout and these can either be redeemed via discount codes, or applied "automatically" to the customer's order. :::Iframe{iframeHeight="0" code=""} ::: The SparkLayer Discount Engine unlocks a range of discount rules including: - **Order-level discounts:** eg, spend $1,000 and get 10% off, spend $2,000 and get 15% off - **Percentage and fixed discounts: **eg, 20% off an order total, $100 off an order total - **Coupon codes:** eg, enter code NEWCUSTOMER and get 5% off - **Scheduled discounts:** eg, start discount today and end it on a specific date and time - **Customer-specific discounts:** eg, only allow customer group ‘b2b-vip’ to qualify for the discount - And more :::hint{type="info"} **Learn more about discounts** You can see a full overview of what’s possible with discounts in [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg). ::: *** ## Show RRP prices only (for in-store shopping) If you manage orders in physical locations with customers (e.g. in store), it's possible to enable a setting that sets the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) to **only** show the RRP (or "MSRP) prices when browsing and adding items to an order. This is especially useful if you need to "obscure" your B2B prices from view and you only want to show the full retail prices. :::Iframe{iframeHeight="0" code=""} ::: Use-cases could include: - In-store customer visits where an order needs to be placed and the customer must only be able to see the retail (RRP) prices - Sales teams who are placing orders on behalf of customers (e.g. on the road) and only the retail (RRP) prices must be seen :::hint{type="info"} **Please note** Behind the scenes, the B2B prices associated with the logged in B2B customer will still be used to create the order. This feature is solely for display purposes. ::: To enable this feature, you'll just need to update the SparkLayer Core Script. This will then apply to all B2B customers that log in. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { showRrpToggle: true, /* Other settings should show below */ } /* End of code */ ``` If you'd prefer to make this display for specific customers, you can configure the code as shown below: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ display: { {% for tag in customer.tags %} {% if tag == "b2b-group-1" %} showRrpToggle: true, {% elsif tag == "b2b-group-2" %} showRrpToggle: true, {% endif %} {% endfor %} /* Other settings should show below */ } /* End of code */ ``` *** ## Tax-Inclusive Price Display Tax-inclusive price display lets you show your B2B prices with tax included, labelled clearly as "inc. tax" so buyers know exactly what they're looking at. It's designed for markets where buyers expect to see gross prices - common in Australia as well as in trade sectors selling to smaller businesses. :::hint{type="info"} **Please note - this changes presentation only.** Your prices are still stored, uploaded, and transacted net, and the tax your buyer actually pays is still calculated by your store's checkout at the point of purchase using any rules or 3rd party integration as set up in the eCommerce platform. Tax-inclusive price display is enabled for your store by the SparkLayer team. If you'd like it turned on, please get in touch with our support team. ::: ### Key features - **Show the price your buyers expect** - display gross prices to buyers who think in tax-inclusive terms, without changing how you upload or transact your pricing. - **Control it per price list** - turn it on for the price lists that need it and leave the rest showing net, so you can serve different markets from one store. - **Set your own rate per product** - supply a display tax rate per SKU, so reduced-rate and zero-rated products show correctly alongside standard-rate ones. - **Clearly labelled** - key pricing areas will add an extra "inc. tax" label, so there's no ambiguity about which basis a buyer is seeing. ### How to enable There are three parts to the setup, and all three need to be in place before buyers see gross prices. 1. **Ask us to enable the feature** Tax-inclusive display is controlled by a store-level switch that **only the SparkLayer team can change**. [Contact support](docId\:NNUw1G9z7eaJ4M78vk7t9) to have it enabled on your account. You'll be able to see it as enabled in your settings once it's on. 2. **Turn it on for a price list** Each price list has its own Tax Inclusive Display setting. Turn it on for the price lists whose customers should see gross prices, and leave it off elsewhere. Price lists with the setting off continue to show net prices exactly as before. 3. **Add a display tax rate to your products** Add a display\_tax\_rate column to your price CSV. This is the percentage used to work out the gross price from your net price, given as a number between 0 and 100. | Column | Value | Required | | ------------------ | -------------------------------- | ----------------------------------------------------------------- | | sku | Your product SKU | Yes | | price | Your net price | Yes | | quantity | Quantity break | No - leave the column out and every price applies from quantity 1 | | display\_tax\_rate | Display tax percentage, 0 to 100 | No | An example with quantity breaks: :::BlockQuote sku,quantity,price,unit\_of\_measure,display\_tax\_rate ABC-123,1,10.00,each,20 ABC-123,10,9.00,each,20 ::: And the same product without them: :::BlockQuote sku,price,display\_tax\_rate ABC-123,10.00,20 ::: :::hint{type="info"} **Please note** **I**f you include the quantity column, every row needs a value in it. An empty cell in a quantity column will fail the import - to price from quantity 1, leave the column out altogether. The rate applies to the whole SKU on that price list, so it must be the same on every row for a given SKU. Rows may leave the column blank, but conflicting rates for the same SKU will cause the import to fail. A product on a tax-inclusive price list with no rate supplied, or a rate of 0, still shows the "inc. tax" label - at 0%. This is deliberate, so a genuinely zero-rated product isn't indistinguishable from one where the rate simply hasn't been uploaded yet. ::: ### How it works Once enabled, gross prices and the "inc. tax" label appear throughout the buying journey. - **Product pages and product cards** The price shown on product detail pages and product cards is the gross price, with the label alongside key pricing info (the label is not repeated for every price in pricing tables for UX purposes). Where a product has several prices, the "from" price follows whichever price wins. - **Cart** Each cart line shows its gross line total, and the cart subtotal and total show gross with the label. The cart's shipping message also changes to make the basis clear, reading "Prices include tax. Shipping costs calculated during checkout" instead of the standard net wording. - **Checkout** The order total on the checkout review step shows gross with the label. Minimum and maximum order value rules are also assessed on the gross figure, so a buyer seeing gross prices is measured against the total they can actually see. - **Order history** In the customer's account area, order line items and the order total display on the same basis, so a buyer looking back at a past order sees it presented the way they bought it. ### Notes and limitations This is the part worth reading closely before you enable it - this feature is only suitable for stores with simple tax configurations where you can consistently provide a tax percentage rate for each SKU in price lists that you want to show tax-inclusive pricing. - **Your store's checkout is the authority on tax charged.** The display tax rate is the figure you upload, used for presentation. The actual tax your buyer pays is calculated by your store's checkout. If the two disagree, your buyer will see one figure in the cart and pay another. It's critical to keep your uploaded rates aligned with your store's tax configuration. - **Tax-exempt customers always see net prices.** If a customer is marked as tax exempt, SparkLayer shows them net prices with no label, regardless of the price list setting. This is intentional, since a gross price would be wrong for them. - **Mixed carts fall back to net totals.** If a cart contains a mixture of tax-inclusive and tax-exclusive products, the cart totals show net and drop the label. Individual lines still show on their own basis. A single gross total spanning both would understate the tax on the exclusive lines, so we show net instead. - **Custom items and unpriced products affect cart totals.** Custom line items added to a cart carry no display tax rate. A cart containing a product with no price but a manually quoted price will show net totals. - **Quoted prices are always net.** When a sales agent edits a quoted unit price, that price is entered and stored net. The editor is labelled "(excluding tax)" when surrounding prices are shown gross, so there's no confusion. - **RRP prices are never tax-adjusted.** RRP values display exactly as you upload them. On a tax-inclusive price list this means a gross B2B price sits next to a net RRP, and any savings percentage calculated from RRP compares the two different bases. We recommend uploading RRP values on the same basis as your display prices if you show both. - **Display mode can vary within a product.** Variants of the same product can resolve to different price lists, so one variant may be tax inclusive while another is not. This is a configuration issue - please ensure customers are only offered either tax inclusive or exclusive prices though careful price list and customer group configuration. ### FAQ :::ExpandableHeading **Does this change the prices I upload or the amount my customer is charged?** No. Prices are stored and transacted net exactly as before, and your checkout calculates tax as it always has. Only the figure displayed on your storefront changes. ::: :::ExpandableHeading **Can I use it for some customers and not others?** Yes. The setting is per price list, so you can show gross prices to the customer groups on one price list and net prices to everyone else. ::: :::ExpandableHeading **What happens if I don't upload a display tax rate?** Products on a tax-inclusive price list with no rate show their net price, still labelled "inc. tax", at an effective 0%. We recommend uploading rates for every product on a tax-inclusive price list so buyers see accurate gross figures. ::: :::ExpandableHeading **Why does my cart total show net when my product prices show gross?** Your cart most likely contains a mixture of tax-inclusive and tax-exclusive products, a custom item, or a product with a quoted price and no uploaded price. In these cases the cart totals fall back to net rather than show a gross figure that would understate the tax due. Please ensure the price list and customer group setup is consistent so a customer would either see only tax inclusive price lists or tax exclusive ones, but not a mixture. ::: :::ExpandableHeading **Will my buyers see gross prices at card checkout?** The SparkLayer cart and checkout review show gross prices with the label. Once a buyer moves into your store platform's own checkout, that platform's tax display rules apply. ::: [title] Product Display [path] Features/Configurations/ ## Product detail interface ### Table-view mode By default, the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT) shows single variant products with the option to change quantity and an "Add to Order" button.  If you'd prefer, you can force all products to render in the special "table-view" mode, even if they only have a single variant.  To enable this, simply add the below code: ```html
`[{"customer_group":"base","display":false}]`
To apply to multiple customer groups, you can use this format:
`[{"customer_group": "base","display": true},{"customer_group": "b2b-group1","display": false}]` | **Set specific variants to "un-sellable"** | Item | Details | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Variants](https://admin.shopify.com/settings/custom_data/productvariant/metafields) | | `Metafield type` | This must be set as `JSON` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `settings` | | `Value` | This must be set in the following format
`[{"customer_group":"base","sell":false}]`
To apply to multiple customer groups, you can use this format:
`[{"customer_group": "base","sell": true},{"customer_group": "b2b-group1","sell": false}]` | :::: :::Tab{title="🌐 Other platforms"} For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: :::hint{type="info"} **Product settings** You can learn more about product settings in [our full guide here](docId\:Cm9B1I6Cz0vOlc67g-fJI). ::: *** ## Add to Favourites Your B2B customers can save products for later using the heart icon, which appears on the product detail interface next to the Add to cart button and on product cards across your collection pages. Saved products are collected in a Favourites section within My Account, where customers can return to them and add them to the cart whenever they're ready.  Favourites are turned on by default. If you'd prefer not to show the heart icon, you can turn Favourites off from **Storefront → Options** in the SparkLayer dashboard, under My Account Settings. Learn more in [our full guide here](docId\:BXlogKI2-m4jlJtwji_gQ). *** ## Quick Buy Mode :::hint{type="warning"} **Important - please note** The customisations detailed in this guide are recommendations only and may vary in complexity, depending on how your store is set up. Whilst the SparkLayer team can advise on how to approach implementing these recommendations, our team may not be equipped to implement them on your Shopify store. We recommend engaging a developer assist should you wish to proceed with any of the recommendations below. ::: It's possible to adapt the SparkLayer interface to display in **"Quick buy mode"** that allows customers to more rapidly build orders from your product collection pages.  To enable this feature, you can adapt the [Product Card Interface](docId\:Mrp_Z0QIZQ2QksseuJylv) with a special setting that adjusts the layout to a "table-view". Simply add the code below to any product collection page. ```html
This must be specified in the following format:`{"credit_limit":1000,"balance":250}` | :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | ------------------------------------------------------------------------------------ | | `Custom data type` | Customers | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `payment_on_account` | | `Value` | This must be specified in the following format:`{"credit_limit":1000,"balance":250}` | For more information, please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: If you're using multiple currencies for your B2B customers (see [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD)), you can specify their exact currency when viewing the credit limit and account balanace. To set this up, simply change the value key against a customer to the below format, changing `usd` to your required currency: | Item | Details | | ------- | --------------------------------------------------------------------------------------------------------------- | | `Value` | This is applied on a specific customer record.
`{"credit_limit":1000,"currency_code":"usd","balance":250}` | :::hint{type="info"} **Real-time "Account Balance"** SparkLayer also has the ability to show a real-time Account Balance with the use of our **Payments Visibility** toggle. You can [find our guid on this here](https://docs.sparklayer.io/payment-methods#payments-account-balance) ::: You can also modify the text that is shown to a customer by updating the SparkLayer language strings.  They'll see special messaging both in their My Account area and during the checkout if they exceed their credit limit.  :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "account.main.my-details.payment-on-account.detail": "Your account balance is {balance} with a credit limit of {creditLimit}.", "account.main.my-details.payment-on-account.detail-without-limit": "Your account balance is {balance}.", "account.main.my-details.payment-on-account.net-terms": "Your payment terms are {type}.", "account.main.my-details.payment-on-account.sub-text": "Payments may take some time to be updated. Please contact us to discuss payments or credit.", "cart.checkout.payment-method.credit-unavailable.title": "Your cart currently exceeds your available credit limit", "cart.checkout.payment-method.credit-unavailable.message": "Please choose an alternative payment method to complete your order. If you'd like to discuss your payment terms, please contact us.", "cart.checkout.payment-method.credit-limit-hit.title": "Your cart currently exceeds your available credit limit", "cart.checkout.payment-method.credit-limit-hit.message": "You can place an order but it may be delayed and subject to approval. If you'd like to discuss your payment terms, please contact us.", } }, /* End of code */ ``` *** ## Setting Net Terms (Payment on Account) It's possible to set specific "Net terms" for a customer (such as Net 30, Net 60) giving the customer visibility on their payment terms. Once it's set up, this will display in the customer's [My Account](docId\:lQXaNI7IVDqna09D9soAP) area under "Financials'.  When the customer then goes through the checkout, they can simply select "Pay on Account" to trigger their net payment terms.  :::::Tabs ::::Tab{title="🛍️ Using Shopify"} First, you'll need to ensure the "Payment on Account" payment method is enabled within the **Customer Groups **area of the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups) for your chosen customer group. Click the **Edit** icon and you'll see a section called **Payment Methods**. From here, simply ensure that "Payment on Account" is ticked.  When an order then arrives into Shopify, it will be created as a **Draft** order. With the payment terms set (as above), this will then update the "Payment due later" setting and populate the "Payment terms" and "Issue date" fields.  You can even automatically convert the **Draft** order into a **Completed** order within Shopify and then manually collect payment at a later date (such as offline via your accounting system). To activate this, from the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/settings/general), turn on "Auto-complete Shopify Draft orders" and ensure "Payment on Account orders - automatically mark as paid" is **turned off**. If you do want to automatically mark the order as paid, you can achieve this via Shopify Flow. [Learn more](docId\:ddIv5TDAnCayWTOJ0Vyb7).  :::hint{type="info"} **Setting up metafields on Shopify** 🤖 Automatically add this to your Shopify store by going to [configure metafields](https://app.sparklayer.io/configuration/integrations/platform). 📖 Learn more about how metafields work in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Customers](https://admin.shopify.com/settings/custom_data/customer/metafields) | | `Metafield type` | This must be set as an `JSON` string | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `payment_on_account` | | `Value` | This is applied on a specific customer record.
This must be specified in the following format:`{"net_terms":"30_days"}`
If you're also the credit feature (see above), this should be populated as follows:`{"credit_limit":1000,"balance":250,"net_terms":"30_days"}` | In terms of configuring the net terms, the following values are supported: | **Net terms** | **Value** | | ------------- | --------- | | `7 days` | 7\_days | | `15 days` | 15\_days | | `30 days` | 30\_days | | `45 days` | 45\_days | | `60 days` | 60\_days | | `90 days` | 90\_days | :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://docs.sparklayer.io/tech-docs) ::: ::::: :::hint{type="info"} **Please note** If you're using the SparkLayer setting to [automatically mark 'Payment on Account' orders as Paid](https://app.sparklayer.io/configuration/settings/general) on your store setup, this will not work in parallel to customers using "Payment on Account" with specific net terms (as detailed above) ::: :::hint{type="success"} **Shopify automations** You can also automate how your net payments work with our ready-made Shopify Flows. You can learn more in [our guide here](docId\:ddIv5TDAnCayWTOJ0Vyb7) ::: *** ## Sending invoices Are you looking to create and send invoices for your B2B customers? SparkLayer offers a variety of ways to allow invoices to be sent, streamlining your B2B operations: | Method | Details | Use-case | | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SparkLayer Invoices` | Customers can view & download invoices directly via SparkLayer. | Your invoicing requirements are relatively simple and you don't want to use additional third-party apps.
[Learn more](docId\:NKh8H14Ffna5DD71SwwNd) | | `Send invoices via your online store` | Depending on which eCommerce platform you're using, it's also possible to send invoices directly from your store administration area. | You have relatively basic requirements and you want to use your existing eCommerce platform to manage the process.
*Learn more in the guide below.* | | `Metafield and attaching invoices` | Add custom invoice details within your store using special metafields that can be associated with an order (manually or automatically). | You have an existing back-office system that is already generating invoices for your store and you can access these as files (e.g. a PDF).
*Learn more in the guide below.* | | `Third-party app` | Tools such as Sufio allow you to automatically integrate their solution into SparkLayer. | You require invoicing beyond B2B (e.g. for your regular cusotmers also) and need more design customisation.
*Learn more in the guide below.* | ### SparkLayer Invoices To learn about SparkLayer's own invoicing solution, please see [our guide here](docId\:NKh8H14Ffna5DD71SwwNd). ### Send invoices via your online store Depending on which eCommerce platform you're using, it's also possible to send invoices directly from your store administration area. Whilst the functionality may be basic, it can act as a good way to start testing your B2B invoicing process before using a more comprehensive invoicing solution. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} **When an order is placed (as a draft order)** When a customer places an order via your website via a [manual payment method](docId\:ibIKczvHM085BkeJIfFYv) (such as *Payment by Invoice*), it's possible to have this order come into Shopify as a 'Draft' order.  Shopify then has the ability to **'Send an invoice' **that allows you to send a customise message and a link to the Shopify checkout to make payment. This uses the 'Send invoice' feature of Shopify Draft orders and you can learn more about [how this works here](https://help.shopify.com/en/manual/orders/create-orders#share-checkout-link-with-customers). Once the customer completes their purchase by making payment, the order is then marked as paid and will then display within your **Shopify Orders** area.  :::hint{type="info" attributes="[object Object]"} You can edit this email template by going to **Settings > Notifications** within Shopify and search for the **Draft order invoice** template ::: If the customer hasn't made payment for any reason or you are processing it manually, within Shopify you can open the order and easily resend or manually mark as paid. Please note, the order will stay as a Draft order until action has been taken.  :::: :::Tab{title="🌐 Other platforms"} Please refer to the [SparkLayer Technical Docs](https://hub.sparklayer.io/tech-docs) ::: ::::: ### Metafield - attaching an invoice to an order When a customer places an order and payment has been completed against it, the order will appear in their [My Account](docId\:lQXaNI7IVDqna09D9soAP) area. When viewing an order, in addition to the order details (such as products ordered, order status, address), it's possible to attach an invoice against an order that the customer can subsequently download. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} To get started, you'll need to add a custom metafield to your Shopify store, using the "Orders" metafields :::hint{type="info"} **Setting up metafields on Shopify** To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | [Orders](https://admin.shopify.com/settings/custom_data/order/metafields) | | `Metafield type` | This must be set as an`URL` or `File`. One value or lists of values are supported. | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `invoice_url` | | `Value` | **NOTE: It's very important the file name or URL is not guessable. We recommend having a **[UUID](https://www.uuidgenerator.net/)** placed within the URL which makes it impossible to guess.** | Once you've set up the metafield, simply navigate to an order in Shopify and you'll see the field appear to specify the invoice URL.  If you don't already have the invoice file(s) hosted, you can use the built-in [Shopify content system](https://admin.shopify.com/content/files?selectedView=all) to do this. Simply upload the file and copy the link to your clipboard. This can then be pasted within the filed detailed above.  Once the B2B customer logs in, they'll then be able to download this from their order history on your website. As this is using the Shopify metafield system, the process of attaching invoices could be actioned in bulk or you could even automate this process from your backend system (e.g. ERP, CRM).  :::: :::Tab{title="🌐 Other platforms"} | Item | Details | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom data type` | Orders | | `Metafield type` | This must be set as a text string.
We strongly recommend the file names are secure and you can even use a [tool such as this to help](https://www.uuidgenerator.net/). | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `invoice_url` | | `Value` | N/A | For more information, please refer to the [SparkLayer Technical Docs](https://hub.sparklayer.io/tech-docs) ::: ::::: ### Using third-party apps for invoices If you're looking for a more feature-rich invoicing solution, you may also want to consider using a third-party app such as [Sufio Invoicing](docId\:qlBasATpzOCOF5eXC99O3) [title] Custom Slots ("Targets") [path] Features/Frontend Interfaces/ :::hint{type="success"} **🚀 Upgrading to the latest SparkLayer version** To benefit from our latest updates, please upgrade your [SparkLayer Core Script](https://app.sparklayer.io/integrations/widgets/core). You can learn about how the Core Script works in [our guide here](docId\:QWXsYM9X5_pvIOGUteKcP). ::: ## Introduction Custom Slots (or "Targets") allow you to enhance a range of the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) by adding your own custom code in predefined areas. ::embed[]{url="https://www.youtube.com/embed/pAfXYvYnY2M"} It's a great way to further enhance your B2B customer experience and use-cases could include any of the following: | Use-Case | Details | | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Promotional content` | Adding promotional content to the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) that customers see as soon as they login (e.g. announcing a new product line) | | `Adding links` | Adding links in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) area that your B2B customers can access (e.g. downloadable CSV templates) | | `Upsell content` | Adding upsells and promotional content when a customer [completes an order](docId\:efevur-A3yCJXUHvrR7t-) (e.g. asking for a rating) | In addition to this, you could also set up more advanced content that varies based on specific rules: | Use-Case | Details | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customer-specific` | Based on who the customer is and which [customer group](docId:5_lWMNohhjBJJppg9E6Vh) they belong to, show different content (e.g. customer group `VIP`, show a promotional message) | | `Order-specific` | Based on the order contents or order total, show a message (e.g. if the order is under $100, encourage them to add more products) | Custom Slots allow a lot of flexibility in how they're used and it's really up to you how creative you can be! *** ## How it works Custom Slots work by adding special **template slots** to your website that are then displayed in specific locations of the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). You can learn how to begin using them under *"Getting Started"* below. ### My Account The "My Account" template slot is displayed at the top of the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) when a B2B customer signs in.  ### My Order The "My Order" template slot is displayed at the top of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) when a B2B customer signs in.  ### Order Complete The "Order Complete" template slot is displayed when a B2B customer customer [completes an order](docId\:efevur-A3yCJXUHvrR7t-).  ### Cart Shipping Step The "Cart Shipping Step" template slot is displayed on the "Shipping" step of the checkout. ### Cart Payment Step The "Cart Payment Step" template slot is displayed on the "Payment" step of the checkout. ### Purchase Summary Header The "Purchase Summary Header" template slot is displayed above the purchase summary when viewing a purchase. ### Purchase Summary Footer The "Purchase Summary Footer" template slot is displayed below the purchase summary when viewing a purchase. ### Cart Line Item The "Cart Line Item" template slot is displayed below a product line item within the My Cart. *** ## Getting Started ### Configuring your store To begin using Custom Slots, you'll need to add some specific code to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP) within the `display` section. :::Iframe{iframeHeight="0" code=""} ::: Based on the locations you intend to add to your website, you can include the below code in your SparkLayer Core Script. ```javascript display: { showSlots: [ 'spark-slot-my-account', 'spark-slot-my-cart', 'spark-slot-order-complete', 'spark-slot-cart-shipping-step', 'spark-slot-cart-payment-step', 'spark-slot-purchase-summary-header', 'spark-slot-purchase-summary-footer', 'spark-slot-my-cart-line-item', ], }, ``` | Name | Details | | ------------------------------------ | ----------------------------------------------- | | `spark-slot-my-account` | This enables the "My Account" slot | | `spark-slot-my-cart` | This enables the "My Order" slot | | `spark-slot-order-complete` | This enables the "Order Complete" slot | | `spark-slot-cart-shipping-step` | This enables the "Cart Shipping Step" slot | | `spark-slot-cart-payment-step` | This enables the "Cart Payment Step" slot | | `spark-slot-purchase-summary-header` | This enables the "Purchase Summary Header" slot | | `spark-slot-purchase-summary-footer` | This enables the "Purchase Summary Footer" slot | | `spark-slot-my-cart-line-item` | This enables the "Cart Line Item" slot | ### Adding & customising the slots Once you've adjusted the SparkLayer Core Script with the above changes, you can then proceed to add custom content for each of the locations. To get started, you simply need to add a **template element** within your website code, referencing the `id` of one of the slot locations above. ```html
Content here will show in the My Account section.
Content here will show in the My Order section.
Content here will show in the Order Complete section.
Content here will show in the Cart Shipping Step section.
Content here will show in the Cart Payment Step section.
Content here will show in the Purchase Summary Header section.
Content here will show in the Purchase Summary Footer section.
```
You could include these template elements within the main template file of your website (e.g. `layout/theme.liquid` for Shopify), or any other appropriate location that is easy for you to access and update.
:::Iframe{iframeHeight="0" code=""}
:::
The template markup can be very simple with some basic text or you could extend this with more extensive HTML, CSS, images, and other elements. It is really up to you!
:::hint{type="info"}
**Please note**
It's important to note the following:
- Any code added within the **template element**s will show within the specific SparkLayer interface (e.g. the `spark-slot-my-cart` template element will show in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-).
- These template elements **will not be shown anywhere else** on your website and will be invisible to logged out customers.
:::
***
## Examples you can use
To help you get started, we've included some examples you could use.
:::ExpandableHeading
**Show a custom HTML message with coloured backgrounds**
```html
```
:::
:::ExpandableHeading
**Show a custom HTML message with gradient coloured backgrounds**
```html
```
:::
:::ExpandableHeading
**Show a message using ready-made SparkLayer components (e.g. "success")**
```html
Here is a message
Here is a message
Here is a message
(defaults to 1) |  The quantity field in the sample CSV file (named `qty`) lets you define the price the customer pays for that **specific** **quantity** of the item. In example below, we've illustrated how the price for SKU `123-abc` changes from a quantity of `1` to a quantity of 5 e. :::hint{type="warning"} **Please note** When setting up quantity pricing, you must specify a unit price for a quantity of `1` even if you don't intend to allow customers to be able to purchase single units (i.e. you intend to set up minimum quantities or pack sizing: see [our guide here](docId\:CmxfrPgjQxfz9vJzTVv0D).) ::: In addition to using the manual CSV upload to configure your pricing, you can also configure quantity pricing manually via [The Price Editor](docId\:fWW4Oh09nSO1-G9TXUTOP) tool, allowing you to make manual adhoc changes if required.  On set up, the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT) will clearly show the quantity pricing to your customers. :::hint{type="info"} **Please note** By default, the quantity pricing will show a 'Savings' amount based off **the single unit price** of the product (or variant). If you'd prefer for the savings amount to be based off the RRP (i.e. retail price), you can set this via [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD) ::: ### Quantity pricing for multi-variant products When setting up quantity pricing for products that have variants (e.g. colour, size), it's possible to configure how the quantity pricing gets applied. | **Type** | **Behaviour** | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Applying across all variants` | `Default behaviour`
The quantity pricing will take affect** across all variants **of the product. For example, if a product comes in Small, Medium, and Large and you've set up quantity pricing to take effect with a quantity of 5, the customer would receive the discounted pricing no matter the combination. e.g.
1 x Small
2 x Medium
3 x Large | | `Applying to a single variant` | `Configuration`
If you'd prefer to restrict quantity pricing to a specific variant, you can do this by *disabling* a special setting within the [Dashboard](docId\:nzsx6U_DAWtzVzSehf4oR). In this example, if a product comes in Small, Medium, and Large, you can set the quantity pricing to **only** apply to the Large size.
To disable this, [please click here](https://app.sparklayer.io/configuration/settings/general). | ### Understanding the unit price calculation When using quantity pricing, the** unit price** for an item will be dependent on the quantity the customer is adding to their order. When calculating the unit price, SparkLayer will take the "requested quantity" and calculate the quantity "tier" the pricing is applicable to. If the customer has any discounts configured, these will then additionally be deducted from the unit price. *** ## Unit of Measure Pricing SparkLayer supports the option to configure your pricing with **units of measure**, allowing you to offer discounted prices based on specific purchasing quantities. :::Iframe{iframeHeight="0" code=""} ::: It's a great way to allow customers to order in pre-defined units such as boxes, pallets, or cases. When setting these up, you can then specify how pricing works for these specific units, as well as handle units that 'fall outside' these. Generally speaking, unit of measure pricing works in a similar way to quantity pricing - customers are essentially buying in quantity and you're giving a discount on the price (per unit). How it differs to quantity pricing is how the "line total" and "unit price" for a product is calculated. Let's use an example: :::hint{type="success"} **Unit of Measure Example** You have a product that can be purchased as **single units**, in **boxes **or in **pallets**. To fill a box you require **7 units**. To fill a pallet you require **150 units**. - The **single unit** price for a product is `$14.99` - For a **box** of a product, the **unit price** to pay is $10.99 - For a **pallet** of a product, the **unit price** to pay is $8.99 If a customer is requesting to purchase **320** units of a product, SparkLayer will distribute the requested quantity across the configured units of measure and then calculate the line total and unit price as so: - 300 units at the **pallet **unit price: $8.99 \* 300 = $2,697.00 *(2 pallets)* - 14 units at the **box **unit price: $10.99 \* 14 = $153.86 *(2 boxes)* - 6 units at the **single unit** price: $14.99 \* 6 = $89.94 - **Line total **= $2940.80 - **Unit price **= Average price across all units = $2940.80 / 320 = $9.19 ::: :::hint{type="warning"} **Please note** The unit price displayed will be the average unit price across the total quantity purchased. ::: ### How it shows to a customer Within the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT), SparkLayer widget we will provide a breakdown detailing how the unit price has been calculated and the applicable units of measure. This will also carry through to the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), ensuring the customer can clearly see how the overall and unit pricing has been calculated.  ### Configuring Unit of Measure To get started, you'll need to use the [manual pricing upload](docId\:NX9Q00eWV_kbjxc3tg1ut) feature within the [SparkLayer Dashboard](https://app.sparklayer.io/pricing). In order for the CSV file to import your quantity pricing successfully, it must have the following columns, with the addition of `unit_of_measure` as shown below.  | **Column** | **Details** | **Required** | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------- | | `sku` | The product SKU as set up in your eCommerce platform or backend system | `Yes` | | `price` | The unit price for the SKU at the quantity set in column 3 (qty) | `Yes` | | `qty` | The quantity of the SKU for the specified price for quantity pricing (see below) | `No`
(defaults to 1) | | `unit_of_measure` | The unit of measure the quantity is associated to. The `unit_of_measure` value may only be alpha numeric and use **hyphens** as a separator.
For example: `box` `pallet` `pallet-box` | `No` | :::hint{type="info"} **Please note** When setting up unit of measure pricing, you must specify a unit price for a quantity of `1` even if you don't intend to allow customers to be able to purchase single units (i.e. you intend to set up minimum quantities or pack sizing: see [our guide here](docId\:CmxfrPgjQxfz9vJzTVv0D).) ::: You can also configure unit of measure pricing manually via [The Price Editor](docId\:fWW4Oh09nSO1-G9TXUTOP) tool simply by adding (or editing) your prices and specifying the unit of measure and the associated unit price. :::Iframe{iframeHeight="0" code=""} ::: ### Unit of Measure Language Strings You may configure language strings for unit of measure. This allows us to pluralise quantities when displaying feedback to the customer. To modify how a unit of measure is translated and pluralised, specify the translation using the key configured for the unit of measure when setting up the price list. For example: ```javascript /* Add the below code into the SparkLayer Core Script */ translations: { en: { "unit-of-measure.unit-type.box": "{uomQuantity, plural, =1 {box} other {boxes}}", "unit-of-measure.unit-type.pallet_box": "{uomQuantity, plural, =1 {pallet box} other {pallet boxs}}" } }, /* End of code */ ``` :::hint{type="info"} **Learn more** You can [read more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about updating language strings that contain dynamic variables. ::: *** ## Display a quantity pricing widget If you've set up [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe) for your products, SparkLayer will by default show this to your customers within the [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT). :::Iframe{iframeHeight="0" code=""} ::: It's also possible to display the tiered pricing breaks table anywhere on your product detail page by adding a special code snippet to your website. Learn more in [Pricing Display](docId\:S_VTlJBorGmnwjjfSMom9)  *** ## Pack sizing SparkLayer has full support for pack sizing (sometimes called *quantity increments*), meaning you can ensure customers to always add items to an order in your predefined packs (e.g. packs of 3, packs of 6). Learn more in [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) *** ## Minimum and Maximum quantities SparkLayer has support for a variety of different quantity product settings including: - Minimum product quantities at a variant level (e.g. products that have colours) - Minimum product quantities at a parent level (allowing you to apply rules to the product as a whole. If it has variants, it can apply across multiple variants) - Maximum product quantities at a variant level - Maximum product quantities at a parent level You can learn more about this in [Quantity Rules](docId\:CmxfrPgjQxfz9vJzTVv0D) [title] Settings [path] Dashboard/ ## 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.  *** ## 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  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).  :::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**.  :::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. ::: :::: [title] Payment Methods [path] Features/Configurations/ ## Enabling payment methods :::hint{type="info"} **Payment methods** Please refer to [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) for full details on what payment methods SparkLayer supports and how they work. ::: *** ## Request for Quote The SparkLayer [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) introduces a unified solution that streamlines the entire "quote-to-order" process directly from your existing online store. It allows you to handle quotes more effectively, converting them into completed orders faster than ever! ::embed[]{url="https://www.youtube.com/embed/Lmjwg4RK0r8"} The SparkLayer [Quoting Engine](docId:8A4OpNIndUyfs3Pup-tuo) works by allowing your B2B customers to easily submit quotes for review, and for your sales team to then communicate with the customer until they're ready to complete their order. Learn more in [our full guide](docId:8A4OpNIndUyfs3Pup-tuo). *** ## Enabling net payment terms :::hint{type="info"} **Looking to enable net payment terms?** Please refer to [our guide here](docId\:yWm70oQUosyKOoIqb4Z4G) for full details on how this works. ::: *** ## Credit & Credit Limits :::hint{type="info"} **Looking to enable credit limits?** Please refer to [our guide here](docId\:yWm70oQUosyKOoIqb4Z4G) for full details on how this works. ::: *** ## Custom payment messages On the final step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), Review & Pay, it's possible to display a "custom payment messages" that let you add additional details about a payment method. For example, if a customer is paying by "Pay by Invoice", you could add some additional text to inform them on how this process works.  Learn more about how to set this up in [our guide here](docId\:o3nDhZBCxisWH6M6satDt). *** ## Updating payment method names By default, SparkLayer will show the payment methods to customers with the names shown below: | Payment method | Name shown to customers | | -------------------- | ----------------------- | | `Payment by invoice` | Pay by Invoice | | `Payment on Account` | Pay on Account | | `Upfront Payment` | Pay Online by Card | | `Request for quote` | Request for Quote | :::hint{type="info"} **Updating language and text** You can update the default text by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:kLrS7wtxn3WnCDy8z5Zvu) about how to update text on SparkLayer. ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ translations: { en: { "cart.checkout.payment-method.full.paymentByInvoice": "Pay by Invoice", "cart.checkout.payment-method.full.paymentOnAccount": "Pay on Account", "cart.checkout.payment-method.full.upfrontPayment": "Pay Online by Card", "cart.checkout.payment-method.full.quote": "Request for Quote", "cart.checkout.payment-providers.quote.message": "Please note: when requesting a quote for your order, our team will review and notify you within 2 working days before processing.", } }, /* End of code */ ``` **Custom payment messages** On the final step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), Review & Pay, it's possible to display a "custom payment messages" that let you add additional details about a payment method.  For example, if a customer is paying by "Pay by Invoice", you could add some additional text to inform them on how this process works. See [our guide here](docId\:o3nDhZBCxisWH6M6satDt) to get started. *** ## Changing the order of payment methods :::hint{type="info"} **Setting up payment methods** If you're looking to adjust which payment methods your B2B customers can see, you can manage this via the [SparkLayer Customer Groups](https://app.sparklayer.io/customers/groups) area. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) ::: When a customer reaches the payment step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), they'll see all available payment methods you've set against their customer group.  If you'd like to configure the order of the payment methods and which payment method shows by default, you can apply a special setting to your website as shown below. :::hint{type="info"} **Updating the display** You can update the default display by adding code to your [Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). [Learn more](docId\:QWXsYM9X5_pvIOGUteKcP) about how to update display settings on SparkLayer ::: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ paymentMethodsOrder: [ "paymentOnAccount", "paymentByInvoice", "upfrontPayment", "quote", ], /* End of code */ ``` *** ## Setting the default payment method :::hint{type="info"} **Setting up payment methods** If you're looking to adjust which payment methods your B2B customers can see, you can manage this via the [SparkLayer Customer Groups](https://app.sparklayer.io/customers/groups) area. [Learn more](docId:5_lWMNohhjBJJppg9E6Vh) ::: If you'd like to change the default payment methods customers see, you can modify the code sample detailed in "Changing the order of payment methods". In the example detailed above, *Payment on account* is listed first, making it the default shown to customers. You can amend the ordering using the naming conventions below. | Payment method | Setting name | | -------------------- | ------------------ | | `Payment by invoice` | `paymentByInvoice` | | `Payment on Account` | `paymentOnAccount` | | `Upfront Payment` | `upfrontPayment` | | `Request for quote` | `quote` | For example, if you wanted "Upfront Payment" to be the default, you would modify the code as shown below: ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ paymentMethodsOrder: [ "upfrontPayment", "paymentOnAccount", "paymentByInvoice", "quote", ], /* End of code */ ``` *** ## Customising "upfront" payment methods SparkLayer supports a payment method called "Pay Online by Card" that B2B customers can select during the payment step of the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-).  Once selected, the customer will then be directed through to your standard checkout process to make payment. Depending on which platform you're using, it's possible to customise which payment methods show. ::::Tabs :::Tab{title="🛍️ Using Shopify"} By default, when your B2B customers select "Pay Online by Card", they'll be taken to the Shopify checkout and will see all Shopify payment methods you have set up (e.g. card payment, Paypal, etc). You can learn more about [Shopify payment methods here](https://help.shopify.com/en/manual/payments/additional-payment-methods).  ::: :::Tab{title="🌐 Other platforms"} No customisations applicable., they'll be directed to the Shopify checkout. ::: :::: It's possible to **conditionally** hide and show payment methods should you require your B2B customers to only see specific payment types when they checkout. - To get started, visit the Shopify App store and search for apps that support "hiding payment methods". One such app is ["ETP Hide and Sort Payment Methods"](https://apps.shopify.com/etp-hide-sort-payments?) - Within the app, you can then configure rules. To detect a B2B customer, simply add a rule that filters on a tag of `b2b` being present. - It's important to note that the payment type "Credit card" can only be hidden if your Shopify store is on the Shopify Plus plan (this is due to limitations with the *Shopify Payment Customization API*) In the example below, the payment types "Paypal" and "Cash on Delivery (COD)" have both been hidden for B2B customers.  *** ## Payments Visibility Give your customers full transparency over their payment statuses directly within the My Account area.  By enabling Payments Visibility, customers can track order payment statuses, view detailed transaction histories, and track outstanding balances without needing to contact your support team. To get started, go to your SparkLayer Dashboard, open **Settings** from the left-hand menu, and select [Configurations](https://app.sparklayer.io/configuration/settings/general). Find the **Enable Payments Visibility** option, switch the toggle to **On**, and save your changes. ::::Tabs :::Tab{title="🛍️ Using Shopify"} When updating the payment status within Shopify, this will simply reflect within the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP) giving the customer an easy way to see the full status of their order.  For any order, the customer can see the Payment status in a new column "Payment".  In addition to the payment status updating, the [Timeline & Communications](docId\:Kf-Gd3nHSXlrn2zZvla1Y) view will also give a log of when the payment was made and the payment total.  ::: :::Tab{title="🌐 Other platforms"} This feature is not currently available for other platforms. ::: :::: *** ## Payments - Account Balance SparkLayer calculates a real-time "Account Balance" for your customers. To get started, go to your SparkLayer Dashboard, open **Settings** from the left-hand menu, and select [Configurations](https://app.sparklayer.io/configuration/settings/general). Find the **Enable Payments Visibility** option, switch the toggle to **On**, and save your changes.  It does this by taking a starting point (the **Opening Balance**) and then automatically tracking all subsequent orders and payments. - **Self-service tracking:** Customers can see exactly which orders are paid or outstanding. - **Reduced admin:** Decreases "balance inquiry" emails and phone calls to your team. - **Multi-platform support:** Compatible with Shopify, Xero, and QuickBooks Online. **Setting an Opening Balance** To show an accurate balance, SparkLayer needs a starting point. This is a "point-in-time" snapshot of what the customer owes your business. You can set this up using **Customer Metafields**. If you haven't enabled these yet, please see our [Credit, Net Terms, & Invoicing guide](https://docs.sparklayer.io/credit-net-terms-and-invoicing). To set the opening balance, update the **Credit Limit and Account Balance** metafield for a specific customer using the format below: | Property | Description | Example | | -------------- | --------------------------------------------------- | --------------------------- | | `balance` | The amount owed at a specific date. | `150.00` | | `balance_date` | The date the balance was recorded (RFC3339 format). | `2025-01-01T18:00:00+08:00` | :::CodeblockTabs Example snippet ```json { "credit_limit": 10000, "balance": 150, "balance_date": "2025-01-01T18:00:00+08:00" } ``` ::: :::hint{type="info"} **Need help formatting the balance\_date? ** You can use a free online [RFC3339 converter](https://time.now/tool/rfc-3339-converter/) to generate the correct string. ::: Whenever you manually update the metafield values, SparkLayer will automatically recalculate the customer's balance based on the new information. **FAQs** :::ExpandableHeading **How often does the customer's balance update?** SparkLayer recalculates the balance automatically whenever a new order is placed or a payment is synced from your store or accounting tool (Xero/QuickBooks). ::: :::ExpandableHeading **Can I update balances in bulk?** Yes, you can use Shopify’s bulk editor or a CSV import tool to update the "Credit Limit and Account Balance" metafield for multiple customers at once. ::: :::ExpandableHeading **Why is the "Payment on Account" metafield not updating?** When using the real-time account balance then the metafield will not update from the time you first set it up. The balance will be calculated and held within SparkLayer ::: [title] Languages & International [path] Features/Configurations/ ## Supported languages SparkLayer supports a range of languages and when a customer signs in, they'll see the appropriate language native to your store. SparkLayer currently supports the following languages: | Variable | Language | | -------- | ---------------------------------------------- | | `en` | English (default) | | `ar` | Arabic (with full RTL support) | | `zh` | Chinese | | `hr` | Croatian | | `cs` | Czech | | `da` | Danish | | `nl` | Dutch | | `fi` | Finnish | | `fr` | French | | `de` | German | | `el` | Greek | | `he` | Hebrew (with full RTL support) | | `hu` | Hungarian | | `is` | Icelandic | | `it` | Italian | | `ja` | Japanese | | `lt` | Lithuanian | | `lv` | Latvian | | `no` | Norwegian | | `pl` | Polish | | `pt` | Portugese | | `ro` | Romanian | | `ru` | Russian | | `sk` | Slovak | | `sl` | Slovenian | | `es` | Spanish | | `sv` | Swedish | | `th` | Thai | By default, SparkLayer **automatically** detects the default language of your store but it is possible to manually overwrite this with the modification of the language variable in the SparkLayer Core Script. ```javascript /* Modify the below code with the language variable above, e.g. fr*/ language: {{ request.locale.iso_code | json }}, /* End of code */ ``` :::hint{type="info"} **Need a language not listed above?** If you require a language that isn't on our list, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we can send details on how to supply translations. ::: ### Product data translations SparkLayer also supports showing product data in the customer's language. :::::Tabs ::::Tab{title="🛍️ Using Shopify"} :::hint{type="info"} **Please note** This is not enabled by default and you'll need to follow the steps below ::: There are a few things to consider if you'd like this enabled on your store: - You'll need to define your translations in Shopify - You'll need to assign languages to Shopify markets - Languages must be published in Shopify - Your SparkLayer Core Script must be at [least version 3.13](https://app.sparklayer.io/configuration/frontend/core) - Within your Shopify theme, inside `theme.liquid` , set the language SparkLayer Core Script option (see below) - You'll need to [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to enable syncing translations into SparkLayer **Setting language in SparkLayer Core Script** ```javascript language: "{{ localization.language.iso_code }}-{{ localization.country.iso_code }}", ``` Once set up, product data displayed by SparkLayer should align with the rest of your site, according to the languages you have set up in Shopify and assigned to markets. :::: :::Tab{title="🌐 Other platforms"} Not currently supported ::: ::::: *** ## Locale configuration SparkLayer provides an intuitive formatting system for dates and currency symbols by utilising the **locale** of the user's browser. This ensures dates and currency symbols are displayed according to the user's regional setting, enhancing the user experience. However, if you prefer to implement a standard formatting across your user base, SparkLayer offers the option to set a specific locale. By adjusting the locale option, you can establish a fixed format for all of your users, irrespective of their individual browser settings. ```javascript /* Modify the below code with the locale required e.g. en-AU*/ locale: 'en-AU', /* End of code */ ``` The locale option requires a string input, comprised of a combination of a language code and a two-letter country code, delineated by a hyphen (-). - For instance, to set the locale for British English, you would use `'en-GB'` - For American English, `'en-US'` - For Australian English, `'en-AU'` - For German `'de-DE'` - etc This format ensures that the chosen locale accurately reflects both the language and the regional conventions for date formatting and currency symbols. For your B2B pricing, any currency prefixes will be removed and instead default to the locale you've set. For example, if you set the locale to `locale: 'en-US',` this would remove the `US` prefix before your pricing.  :::hint{type="info"} The locale option only affects the *formatting* of prices, not the values. ::: *** ## Text and language overwrites SparkLayer uses "language strings" to render the text used in the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) and any string can be modified with custom text (i.e. overwritten). If you're wanting to update specific text elements, it's possible to turn on a special setting within the SparkLayer Core Script that exposes specific code snippets that you can then reference with your overwrites. ```javascript /* Add the below to your SparkLayer Core Script */ showTranslations: true, /* End of code */ ``` When this setting is enabled, the SparkLayer interface will then render the special language code snippets. In our example below, you can see the language code for the Product Page Interface  :::hint{type="info"} **Please note** We recommend enabling this setting temporarily or onto a non-published theme to ensure it isn't seen by your logged in B2B customers. ::: ### Modifying languages ::::Tabs :::Tab{title="🛍️ Using Shopify"} Add the following to your theme's `theme.liquid` file, just before the closing `` tag: For example, to set the language and account redirect URL: ```html ``` ::: :::Tab{title="🌐 Other platforms"} To overwrite the text, you need to add specific code snippets to the [SparkLayer Core Script](docId\:QWXsYM9X5_pvIOGUteKcP). To install the SparkLayer Core Script, it simply needs to be included within the main "header" of your website's source code within the `...` tags. For BigCommerce, this is typically within the file `/templates/layout/base.html`  To get started, head over to the SparkLayer Dashboard and you'll see your customised SparkLayer Core Script within the [Frontend Configurations](https://app.sparklayer.io/configuration/frontend/core). ```html ``` When you first install SparkLayer, you'll automatically use the latest version and you can also manually update this via the "SparkLayer Core Script version" section. To see what's new, please see make sure to bookmark [What's New!](docId\:WDCEwpeMoHPbrR96TaYCL). ### Technical details From a technical point of view, the Core Script provides SparkLayer with key information that controls how it works on your website. ```html ``` This information includes: | Item | Details | | ----------------- | ----------------------------------------------------------------------------------- | | `siteId` | The website's unique identifier ([learn more](docId\:r9NG74uJdtyWlvGbpnB5u)) | | `platform` | The eCommerce platform of the website | | `language` | The language to be used | | `accountRedirect` | The URL to redirect logged in customers to | | `display` | Which display configurations to enable ([learn more](docId\:SBEaOaCq_A7FfbTatX8bD)) | | `auth` | The authentication details of the logged in customer | ::: :::: Some important items to note: - The variable `en` must be replaced with the specific language of your store (see our [supported languages](docId\:kLrS7wtxn3WnCDy8z5Zvu) with their special codes) - The text overwrites must always end the line with a comma ### Updating text that contains dynamic variables For some text content, SparkLayer includes dynamic variables, such as pack sizing or special settings.  Dynamic variables are always wrapped in 'camel case' , for example `{packSize}` and you can find a list of all dynamic text below: ```javascript ``` [title] Magento Limitations [path] Integrations/Magento/ ## Introduction Currently, there are a small number of limitations to be aware of with the SparkLayer and Magento Integration. | Limitation | Notes | | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product SKUs` | Within Magento, the product must have a SKU and this must be unique per product. | | `Price lists` | Currently price lists can only be managed though SparkLayer. | | `Sales Agents` | [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) lets your sales team place orders on behalf of customers. During the checkout process, sales agents won't be able to select "Pay Online by Card" for a customer, payments must be "offline" methods (e.g. net terms, pay by invoice) | | `Company Users` | If you're using [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) and a customer is inviting a team member, the team member will not receive a 'confirmation email' asking them to approve access. They will need to be manually informed of their login email address and to use the "Forgot password" feature on the Magento store to create a password for their account. | | `Multi-stock Inventory module is required` | The magento setup must have the MSI (Multi-Stock Invenetory) module enabled. | [title] Sufio Invoicing [path] Integrations/Customer Experience/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to Sufio - Platform: Merchants must be using Shopify ::: ## Introduction :::hint{type="success"} **Sending invoices via SparkLayer** SparkLayer has it's own built-in invoice solution and you can [learn more here](docId\:NKh8H14Ffna5DD71SwwNd). ::: [Sufio](https://sufio.com/shopify/invoice/?ref=sparklayer-2) is a leading invoicing solution for major eCommerce platforms such as Shopify and BigCommerce, allowing merchants to create and send beautifully designed invoices. With powerful features such as customizable design and support for multiple currencies, Sufio makes it easy for merchants to automate their invoicing and grow their business. Learn more about Sufio in the [Shopify App Store](https://apps.shopify.com/sufio) *** ## How it works The Sufio integration for SparkLayer is available for all Shopify merchants that already use Sufio and allows you to enable **downloadable invoices** for your B2B customers.  Each time a B2B customer places an order on your store, they can view and download their invoice right from within the [SparkLayer My Account](https://docs.sparklayer.io/sparklayer-frontend/overview-of-features/my-account-interface#order-history) area. You can see this in action in our video below\.Within the order detail view, the customer simply clicks the button and they are then taken off to their specially designed, Sufio-powered invoice where they can view details and download as a PDF. :::hint{type="success"} See this in action in our [B2B demo store](https://b2b-demo-store-usd.myshopify.com/pages/b2b-login-register). Simply sign in and view an order from the My Account area. ::: **Emailing customers an invoice** Sufio also allows you to email customers a copy of their invoice as well as set reminders, giving you a simple way to manage your invoicing process. [Learn more here](https://sufio.com/articles/shopify/send-invoices-customers/when-send-invoices/custom/) *** ## Configuring on SparkLayer :::hint{type="warning"} Please note, your Shopify store must already have the [Sufio Shopify App](https://apps.shopify.com/sufio) installed before enabling this feature. ::: Once the Sufio app has has been installed on your Shopify store, you're ready to activate it on SparkLayer! Within the [SparkLayer Dashboard](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard), go to the **Integrations** section and click **Partner Integrations. **Under **Invoicing**, click the toggle on the right to activate the Sufio integration.  This completes the set up process and you can follow the below steps to test the integration. - Log in to your Shopify store as a B2B customer - Place an order using the available payment methods - If the order is via a manual payment method (e.g. Payment by Invoice), within Shopify, mark this as complete to ensure it shows up in the **Orders** area of Shopify - Within your Shopify store, as a B2B customer, click the My Account tab, click the order and you will see the option to **View or Download Invoice**. *** ## Known limitations Please note the following: - If you're installing Sufio for the first time, invoices will only show for **new orders** placed :::hint{type="info"} If you're looking for a more manual way to attach invoices to an order, see [Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G) ::: [title] WooCommerce Limitations [path] Integrations/WooCommerce/ ## Introduction Currently, there are a small number of limitations to be aware of with the SparkLayer and WooCommerce Integration. | Limitation | Notes | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product SKUs` | Within WooCommerce, the product must have a SKU and this must be unique per product. | | `Price lists` | Currently price lists can only be managed though SparkLayer. | | `Sales Agents` | [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) lets your sales team place orders on behalf of customers. During the checkout process, sales agents won't be able to select "Pay Online by Card" for a customer, payments must be "offline" methods (e.g. net terms, pay by invoice) | | `Company Users` | If you're using [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) and a customer is inviting a team member, the team member will not receive a 'confirmation email' asking them to approve access. They will need to be manually informed of their login email address and to use the "Forgot password" feature on the WooCommerce store to create a password for their account. | | `HTTPS Compatibility` | The SparkLayer B2B plugin will only work with WooCommerce stores which have HTTPS **enabled** | | `Permalink Structure` | In order for the SparkLayer B2B plugin to interact with the WordPress & WooCommerce API, the WordPress permalink structure must be configured to a setting other than *"Plain"* | [title] Uninstalling & Transferring accounts [path] Integrations/BigCommerce/ ## Uninstalling SparkLayer SparkLayer works just like any other app in BigCommerce and you can uninstall it very easily.  Please follow the below steps: ::::WorkflowBlock :::WorkflowBlockItem From your BigCommerce admin, click **Apps**, and then click **My Apps.** ::: :::WorkflowBlockItem Click **Uninstall** ::: :::: Once you've removed the sales channel, this will then **cancel** the SparkLayer recurring billing charges with immediate effect. :::hint{type="info"} **More information** You can learn more about removing apps in this [BigCommerce guide](https://support.bigcommerce.com/s/article/How-do-I-access-and-install-the-new-single-click-apps-within-my-Bigcommerce-store-control-panel?language=en_US#uninstalling). ::: :::hint{type="warning"} **Please note** - If you've also added the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) to your BigCommerce store, these will need to be removed manually. - When you follow the uninstall process, this will disable customers, product and order updates to SparkLayer but will **not** delete the data until you [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to remove your account. - Please note, depending on when your billing cycle to SparkLayer began, you may see charges you're not expecting. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) if you would like us to investigate. ::: *** ## Pausing your account If you'd prefer to pause your SparkLayer account and resume your subscription in the near future, we recommend the following steps: - Follow the uninstall process above to remove the **B2B Ordering** sales channel. - Retain any codes changes in your BigCommerce storefront theme (you can always 'Duplicate' the theme to create a backup). - Notify our team and once you're ready to resume your subscription, we can assist where necessary. :::hint{type="info"} **Please note** Any configurations you've set up in the SparkLayer [Dashboard](docId\:nzsx6U_DAWtzVzSehf4oR) will be retained such as price lists and customer group set up. ::: *** ## Transferring to another BigCommerce store When you first sign up to SparkLayer, you'll be asked to associate your account with your BigCommerce store. Once that's done, SparkLayer will be locked to that URL and will begin synchronising products, customers, and enable you to install the Frontend code snippets to test it out. You may be wanting to trial SparkLayer on a **test or development BigCommerce store** just to see how it works before you fully commit to using it. The good news is, it's possible to transfer accounts by following the below steps! - First, sign into your BigCommerce store and uninstall SparkLayer via the steps above. This will disconnect SparkLayer from the BigCommerce store - Next, [sign into SparkLayer](https://app.sparklayer.io/Login) with the original account you created and go to Configuration and click [Integrations](https://app.sparklayer.io/configuration/integrations/platform) - Select **BigCommerce** and re-enter the new BigCommerce URL you wish to connect - You'll then be taken to the BigCommerce admin and asked to reinstall SparkLayer and select a plan. - Once that's completed, you'll then be returned to the SparkLayer Dashboard. SparkLayer will then begin synchronising your products and customers and you can then re-install the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) on the new store :::hint{type="info" attributes="[object Object]"} **Need assistance?** If you require any assistance in transferring your BigCommerce store, please feel free to [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. ::: [title] BigCommerce Metafields & Data Mapping [path] Integrations/BigCommerce/ ## Introduction Metafields help you to customise the functionality and appearance of your BigCommerce store by letting you save specialised information that isn't usually captured in the BigCommerce admin. You can use metafields for internal tracking, or to display specialised information on your online store in a variety of ways. In the context of SparkLayer, metafields are used to capture additional B2B data that you can then use in a variety of ways: | Type | Details | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product metafields` | Updating the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) by adding configurations such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [RRP prices](docId\:S_VTlJBorGmnwjjfSMom9), and more | | `Customer attributes` | Updating a customer's information by adding information such as [credit limits](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Order metafields` | Updating an order with [invoicing information](docId\:yWm70oQUosyKOoIqb4Z4G) | *** ## How to add metafields to BigCommerce BigCommerce has a variety of ways to access and edit metafields and you may already have your preferred way of doing this. You can also refer to our guide below. ### Useful resources | Item | Details | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Approved apps | [Metafields Manager ](https://www.bigcommerce.co.uk/apps/metafields-manager-by-space-48/)This provides a simple way to manage metafield data within BigCommerce with the exception of "Customers" | | Developer docs | We also recommend referring to the [official BigCommerce guide](https://developer.bigcommerce.com/docs/rest-catalog/products/metafields) on accessing metafield data | ### Configuring different types of metafields :::ExpandableHeading **Product metafields** We recommend using an app listed above in "Approved apps". This allows you to access metafield data at both a product parent and product variant-level. ::: :::ExpandableHeading **Order metafields** We recommend using an app listed above in "Approved apps" ::: :::ExpandableHeading **Customer attributes** There are currently no BigCommerce apps that allow customer attribtues to be added to Customer data. We therefore recommend a more technical approach to accessing and updating this data. Currently customer settings can be added though the use of BigCommerce customer attributes. Before these attribute fields are shown on the customer "Create" and 'Edit" screens in BigCommerce, the attribute types** must be manually created f**or each store. This can be done using the shell command below. You will need to replace `YOUR_STORE_HASH` and `YOUR_STORE_API_TOKEN` values. You can find the store hash in the URL of the store admin page:  You will need to create an API token by going to **Settings -> Store-level API accounts,** clicking the **Create API Account **button, entering a descriptive name (e.g. SparkLayer Support), and selecting the **Modify** value of the **Customers** scope:  Click **Save**. You will now see a popup with the credentials, which are also downloaded to your computer. You will need the access token value. Replace the two values in the command below and run it in your terminal (please note that you can remove the attributes that are not needed to only create the required attributes): ```curl curl --request POST \ --url https://api.bigcommerce.com/stores/YOUR_STORE_HASH/v3/customers/attributes \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: YOUR_STORE_API_TOKEN' \ --data '[ { "name": "SparkLayer - Price Lists", "type": "string" }, { "name": "SparkLayer - Payment On Account", "type": "string" }, { "name": "SparkLayer - Accounting ID", "type": "string" }, { "name": "SparkLayer - Discount Percentage", "type": "number" }, { "name": "SparkLayer - Sales Agent Groups", "type": "string" }, { "name": "SparkLayer - Parent Customer ID", "type": "string" } ]' ``` You will now see the attributes and be able to edit them in the customer create and edit pages.  ::: *** ### Order history: importing historical orders into SparkLayer It's possible to import historical B2B order data into SparkLayer, allowing customers to see their previous order history once they access their account on your store. To do this add a metafield to the order as shown below: | Item | Details | | ----------- | -------------------------------------- | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `order_import` | | `Value` | This must be set as a string of `true` | Any orders that are imported this way must also belong to a customer that has a B2B customer group assigned. Even though the order metafield above can be setup manually using one of the many metafield management apps available, for large numer of orders you might want to automate this using the BigCommerce Order Metafields API. :::hint{type="info"} **Please note** The note attribute must be added to the order **after** SparkLayer is installed for the order to be synchronised correctly. Orders synced in this way can then be reported upon and will appear in the Orders section of the SparkLayer Dashboard. ::: :::hint{type="warning"} **Troubleshooting** If your store was installed before the ***14th of November, 2024***, you might need to contact the SparkLayer customer support to re-save your BigCommerce integration in order to register the required order metafield webhooks. These webhooks notify our system of new metafields added to orders. ::: *** ## Order Data ### Order ID ("Visible ID") and setting a custom order number It's possible to use a custom order ID instead of the standard order ID generated from BigCommerce. A typical use-case is customising the Order ID to match order numbers generated from a back-office system (e.g. an ERP), ensuring consistency across systems. When the "Visible ID" is set, this will then take effect when the customer views their orders from the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP).  | Item | Details | | ------------------ | ----------------------------------------- | | `Custom data type` | Order | | `Metafield type` | This must be set as an `single line text` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `visible_id` | :::hint{type="warning" attributes="[object Object]"} **Please note** If you're using the "Visible ID" configuration, any orders that do not have this populated will fallback to the standard BigCommerce order number. ::: *** ## Important considerations In order for SparkLayer to work with BigCommerce metafields, please note the following: :::hint{type="warning"} **Product metafields** Metafields are always added at the product variant level, even if the product only comes in a single variant. **JSON data** Some SparkLayer settings require metafields to be set up as JSON strings. These will need to be carefully added, making sure the formatting is set correctly. ::: *** ## Advanced settings To learn about more advanced settings, including customer-level product metafield settings, please see [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) [title] Cin7 Core [path] Integrations/ERPs & Operations/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to the Professional or Enterprise plan - Platform: Merchants must be using Shopify ::: ## Introduction **Cin7 Core** is a powerful inventory management system designed for retailers, wholesalers, and manufacturers. From inventory and stock control, to order management and fulfilment, Cin7 Core helps automate and streamline your eCommerce operations. You can learn more about Cin7 Core [here](https://www.cin7.com/solutions/core/?utm_term=cin7%20core\&utm_campaign=mm_search_brand_emea\&utm_source=google\&utm_medium=cpc\&hsa_acc=9060130901\&hsa_cam=18133732967\&hsa_grp=149955377884\&hsa_ad=655886024565\&hsa_src=g\&hsa_tgt=kwd-1942910059907\&hsa_kw=cin7%20core\&hsa_mt=e\&hsa_net=adwords\&hsa_ver=3\&gad_source=1\&gbraid=0AAAAABIS0PhOnUtzfradDOQy0k8dbkFvX\&gclid=Cj0KCQjwzrzABhD8ARIsANlSWNMwImmV0ASbE-CkR02KSmpeD1_CXtjX8K6GG-JAFKFXpD2ZucWP8DkaArZFEALw_wcB). *** ## How it works The Cin7 Core integration for SparkLayer is available for all [Shopify merchants](https://docs.sparklayer.io/integrations/shopify-introduction#introduction) that already use Cin7 Core and allows you to bring **B2B pricing and B2B ordering ** into SparkLayer and your Shopify store. The integration works in the following ways: | **Item** | **Details** | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customers` | Cin7 becomes the 'master' of your B2B customer data, and any changes to customer records that have the assigned Customer Type will automatically be synchronised to Shopify and SparkLayer. SparkLayer will maintain a customer on your E-Commerce platform for every contact of each customer it syncs from Cin7. The Customer's Default contact is treated as the Main account with its other contacts treated as [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) under it. | | `Orders` | Orders placed via SparkLayer are synchronised from your E-Commerce platform into Cin7 using your [existing Cin7 integration](https://help.core.cin7.com/hc/en-us/articles/9034589848335-Shopify-Integration). Prices that show on orders will be the special B2B pricing as set up in Cin7. | | `Pricing` | Price lists and product prices are imported into SparkLayer via pricing rules you set up in Cin7 | | `Sync` | The automatic sync is carried out **every hour**. | :::hint{type="info"} **Please note** We recommend also familiarising yourself with the "Known limitations" below ::: *** ## Configuring the integration :::hint{type="info"} **Before you begin** You'll need to have an approved account with Cin7 Core - Please visit the [Cin7 website](https://www.cin7.com/solutions/core/?tm=tt\&ap=gads\&aaid=adaCskrnITi18\&utm_term=cin7%20core\&utm_campaign=mm_search_brand_emea\&utm_source=google\&utm_medium=cpc\&hsa_acc=9060130901\&hsa_cam=18133732967\&hsa_grp=149955377884\&hsa_ad=655886024565\&hsa_src=g\&hsa_tgt=kwd-1942910059907\&hsa_kw=cin7%20core\&hsa_mt=e\&hsa_net=adwords\&hsa_ver=3\&gad_source=1\&gclid=CjwKCAiA9bq6BhAKEiwAH6bqoN9Zbb8pUMLtFpMfCor1fMKdHdEJRPTDznpBDkKQO2T_1xAiwqwu-RoCkIwQAvD_BwEC) to learn more. ::: To get started, the integration needs to be enable within the [SparkLayer Dashboard. ](https://app.sparklayer.io/configuration/integrations/partners)Go to the **Integrations** section and click **Partner Integrations.** Under **Multi-channel management**, click the toggle on the right to activate the Cin7 Core integration.  You'll then be prompted to enter the following details:  | **Item** | **Details** | | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `API ID` | You can find this within your Cin7 Core admin under **Integration, API** | | `API Key` | You can find this within your Cin7 Core admin under **Integration, API** | | `Customer Sync Tags` | Customers that have any of these tags within Cin7 Core will be **synchronised to Shopify** by SparkLayer. The customer tag should match a customer group that exists in SparkLayer.
**Please note:** The tag must match the SparkLayer **customer group name** exactly and be seperated by a **comma** (e.g. `GROUP1, GROUP2)`. For the purposes of testing, we recommend creating a new group and testing with a dummy customer first before using an existing group. | | `Additional Customer Tags` | When a customer is syncronised to Shopify, **if it has any of these tags within Cin7 Core: it will have those tags within Shopify** as well (prefixed with `spark-`). These must be **valid Shopify tags**, and must not **conflict with your SparkLayer customer groups**.
This feature is **currently exclusive to Shopify** If your store uses a different E-Commerce platform this setting will be ignored. | | `Tax-Exempt Codes`
| This is the code that you want to sync across the customer across as tax-exempt. | | `Ignore Non-Default Contacts` | When checked, **only the Default contact** of each customer will by synced through to SparkLayer. | *** ## Configuring Customers Broadly speaking, Cin7 Core is your **central location **for managing B2B customer data. When customers are configured in Cin7 as B2B customers, SparkLayer can **automatically** retrieve this data and then enable the B2B ordering experience on your Shopify site. ::::ExpandableHeading **Step 1 - setting up a customer ** When you have set up the [integration with SparkLayer](https://app.sparklayer.io/configuration/integrations/partners) within your Cin7 Dashboard, go to **Sale** and then **Customer**. In this page you are able to set up the customer account with your required customer details. You **must **have a first and last name set in General and Contacts  Next, navigate to your **SparkLayer Dashboard** and [Customer Groups](https://app.sparklayer.io/customers/groups). Here you'll need to create the customer groups and, once you have done this, you are then able to add the customer group name as tags within your customer in Cin7 under "Tags".  In our example, we have `Base` and `Gold`. Within Cin7, and add the tag `base` and `gold`.  You will also need to select the **Tax Rule. **Once you have done this, take the tax exemption rule and add this into the final stage of the SparkLayer integration. This means any customers that have been set as tax exempt in Cin7 will automatically be tax exempt in Shopify. Next, go to the [Partner Integrations](https://app.sparklayer.io/configuration/integrations/partners) section of SparkLayer and click **Modify** within the Cin7 integration. Finally, add the **Customer Tags** you have created for your customer groups that you want to sync across the customer from Cin7 to SparkLayer/Shopify. In our example, we've added them for `base` and `gold`. :::hint{type="warning"} **Please note** Customer Tags **must** be seperated by a comma with **no** spacing to sync correctly e.g. `base, gold` :::  :::: ::::ExpandableHeading **Step 2 - syncing your customers ** To sync your customers, you'll need to create your customers in your Cin7 Dashboard if you haven't already. When doing this you are able to allocate them add a **Tag. **This will assign them into the specific [customer group](https://app.sparklayer.io/customers/groups) within SparkLayer when they are synced across. The **Tag **that you assign must match a customer group name that you have created in your SparkLayer dashboard already. For example, if you are using the tags in the above screenshots, your customer groups would look like the below:  :::hint{type="info"} **Please note** The customer would not need be tagged with this customer group within Shopify. Instead, the customer group information is synced to Shopify as a metafield. ::: When setting up your customers in Cin7, please ensure you set up: **General:** - Name (first and last) - Currency - Sale Price Tier - Tax Rule - Tags **Addresses** - A full address **Contacts** - Name (first and last) - Assign a valid email address. This must be set up in order to sync to SparkLayer and Shopify. - Tick main contact as "Default" :::hint{type="info"} **Please note** If you have multiple contacts to sync, the primary contact must be marked as **Default** in Cin7 Core. All additional contacts will be synced as child accounts under the Default (parent) contact. ::: **Syncing across to SparkLayer and Shopify** Ensure the correct **Customer Tag** is added in Cin7 Core to match what you've configured in SparkLayer. SparkLayer syncs with Cin7 Core every 4JJ hours. During each sync, any new or updated records are automatically pushed to Shopify. Customers are mapped between the systems based on the ** contact email** set within Cin7 Core. Once this is mapped, SparkLayer will then synchronise the following data into Shopify. | **Cin7 Core** | **Shopify / Spark Layer** | | ---------------------------------------------------- | ---------------------------------------------------------------------------- | | Address | Shows against customer record in Shopify | | Primary Telephone | Shows against customer record in Shopify | | First / Last Name | Shows against customer record in Shopify | | Customer Group | Shown via metafields in Shopify (see above) | | Credit Limit / On hold | Shown via metafields in Shopify | | Tax Codes (using the mapping in config) | Shows against customer record in Shopify | | Cin7 Core Price List Tier / Customer specific prices | Shown via metafields in Shopify to show the correct pricing for the customer | | Tags | Only **Additional Tags** show against customer record in Shopify. | :::hint{type="warning"} **Please note** All customer data is managed via Cin7 and any amends made directly in Shopify will **not** synchronise back to Cin7. ::: :::: :::ExpandableHeading **Step 3 - giving access & notifying new customers** Since Cin7 is the central source for customer data, any new customers created in Cin7 will **automatically** be added to Shopify (following the above steps). When new customer records are added to Shopify, they will by default be added as **Pending** customer accounts and receive an **automatic email** to enable their account by setting a password.  This uses the **Customer account invite** notification email which can be edited in the [Notifications section within Shopify](https://admin.shopify.com/settings/notifications/customer). If you prefer **not** to send the customer account invite automatically, you can easily check if this option has been activated. Simply go to your SparkLayer Dashboard, navigate to [Partner Integrations](https://app.sparklayer.io/sparklayerunleashedtest/live/configuration/integrations/partners). When modifying your Cin7 integration, you can enable or disable this via the setting at the bottom.  ::: *** ## Configuring Pricing In Cin7, you can utilise **up to 10 price lists**, allowing you to create multiple pricing tiers tailored to your various customer levels. On top of this limit, you have the flexibility to set customer-specific and product-specific discounts, providing even more granular control over your pricing strategy. ::::ExpandableHeading **Step 1 - price list setup** In Cin7, navigate to **Settings **> **General Settings** > **Sell Price Tier Names**. Here, you can customise the names of your price tiers, which are initially labelled as "Sell Price Tier 1" through to "Sell Price Tier 10". :::hint{type="warning"} **Please note** SparkLayer **does not** support the custom names meaning they will show in SparkLayer as "Sell Price Tier X" ::: :::: :::ExpandableHeading **Step 2 - viewing price lists** When you view a product within your Cin7 Dashboard, under the **Prices** tab you’ll see the available price tiers listed. For products offered to your wholesale customers, you can specify the exact price for each tier, depending on which pricing list is assigned to the customer.  ::: ::::ExpandableHeading **Step 3 - assigning a price list** Within your Cin7 Dashboard, navigate back to the customer account that you are working on. You are then able to assign them a price list directly to the customer account within **Sell Price Tier**. This means when they login they will see the product pricing you've assigned to them.  :::hint{type="warning"} **Please note** These price lists will be asigned directly to the customer account through the SparkLayer price list metafield which is set up differently to standard price lists. You can learn more in [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) ::: :::: :::ExpandableHeading **Setting up product specific discounts** Within the Cin7 Dashboard, navigate to a customer record and click Product Prices. Here you are able to set product specific pricing for this customer account. You are able to search for a product, specify a fixed price on the product. When doing this, it will create a new price list within the [SparkLayer Price Lists](https://app.sparklayer.io/pricing/lists) section.  ::: :::ExpandableHeading **Assiging prices to the Shopify Customer account** Once you have finished configuring your customers pricing and a sync has taken place, you can then check the customer account in Shopify to ensure they have been assigned the correct pricing. The price list will be assigned directly to the customer account in a **Price List metafield** (this gets added automatically when you first set up the SparkLayer integration). It will also create the price list within your SparkLayer Dashboard > Price lists as an "Integration" Price List. With this metafield it will **always** work in a hierarchy order, which means when a customer searches a SKU it will check the first price list and will cascade through the price lists untill it finds a price. In the example below you are able to see a number of price lists. 1. Any** customer product specific discounts** you have created within the customer in Cin7. 2. The **normal price list **that you have assigned to the customer  ::: *** ## Data mapping We've detailed how data is mapped between SparkLayer and Cin7. :::ExpandableHeading **Customer data mapping** | Item | Details | | --------------------------- | ----------------------------------------------------------------------------------------------------- | | `First and Last name` | Assigned to the customer account in Shopify | | `Email and Phone number` | Assigned to the customer account in Shopify | | `Addresses` | Assigned to the customer account in Shopify | | `Tax Exemptions` | Assigned to the customer account in Shopify | | `SparkLayer Customer Group` | This will be assigned to the customer account through a Shopify Metafield called "Group" | | `Company Name` | This will be assigned to the customer account through a Shopify Metafield called "Company" | | `Discount Percentage` | This will be assigned to the customer account through a Shopify Metafield called "Disount Percentage" | | `Credit limit` | This will be assigned to the customer account through a Shopify Metafield called Payment On Account | ::: :::ExpandableHeading **Pricing data mapping** | Item | Details | | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Creating Price Lists` | SparkLayer generates several types of price lists based on the product prices available in Cin7. | | `Sell Price Tiers` | If Cin7 has specific Sell Price Tiers set up (e.g., "Sell Price Tier 1", "Sell Price Tier 2", etc.), SparkLayer creates separate price lists for these tiers. Cin7 supports up to 10 Sell Price Tiers that you can assign to different groups of customers. | | `Customer-Specific Prices` | If any customer has unique prices specified under the Customer/Product Price tab in Cin7, SparkLayer creates a Customer-Specific Price List for that customer. This ensures that individual customer agreements or special pricing arrangements are captured. | | `Handling Different Currencies` | If a customer uses a currency other than the base currency, SparkLayer will create Alternative Currency Price Lists based on the existing price lists. For example, if your store is GBP you will have "Dear Tier Price 1" set as GBP, if you assign a customer USD then SparkLayer will create a new price list "Dear Tier Price 1 USD"set as USD. This will take the GBP and convert it at the live going rate to USD | | `Assigning Price Lists to Customers` | Price lists will be assigned directly to the customer account through the use of a Customer Metafield. When assigning prices to customers, SparkLayer follows this order of priority:
* First, the Customer-Specific Price List (if available). * Then, a Sell Price Tier (if assigned in Cin7).
If a customer has multiple currencies or discounts, they will get additional price lists accordingly. | | `Why Prefixed Price Lists?` | SparkLayer may apply generic "prefixed" price lists to every customer. This is to ensure that a basic Sell Price Tier is always in place, even if the customer’s Cin7 configuration doesn’t explicitly assign one. | ::: *** ## Known limitations The following limitations apply: - Internally SparkLayer will use the internal SellPriceTier naming for simplicity between mapping, not the custom naming that can be setup via the Cin7 Core Settings - Changing the customer's email address, will create an additional customer in Shopify. The old account will need to be disabled manually. - When you change a customer's default contact in Cin7 Core: you will need to manually disable the account in Shopify that corresponds to the the old default contact. - A customer that is removed by removing the tag will not be disabled within Shopify. - Default addresses in Cin7 Core will be mapped to Shipping and Billing address in Shopify (Shopify doesn't support independent addresses). - Addresses are a 1-way sync from Cin7 Core into Shopify. It's recommended to not allow address editing in SparkLayer otherwise new addresses added won't appear in Cin7 Core and will be replaced on next integration run. *** ## Troubleshooting :::ExpandableHeading **My customers are not appearing in Shopify** - Ensure that customers in Cin7 Core have been assigned the correct tags matching the **SparkLayer Customer Group Names.** - Confirm the tag formatting: tags must be separated by commas without spaces (e.g., base,gold). - Check that the customer has a valid Default Contact with a valid email address. ::: :::ExpandableHeading **Customer account invites are not being sent** - By default, Shopify will send a Customer Account Invite email when a new customer is created. - Check if automatic invitations are disabled in the SparkLayer Partner Integration settings. ::: :::ExpandableHeading **Customer-specific pricing is not displaying** - After updating pricing, allow up to 6 hours for the next sync to complete. - Verify that the correct Price List metafield exists against the Shopify customer record. ::: :::ExpandableHeading **Changes made in Shopify are not reflected in Cin7 Core** - The integration is one-way (Cin7 Core ➔ Shopify). Changes must always be made in Cin7 Core. - If you update customer information directly in Shopify, it will be overwritten by the next sync. ::: :::ExpandableHeading **Product pricing appears incorrect for customers** - Double-check that the customer is assigned to the correct Sell Price Tier or Product-Specific Pricing. - In Cin7 Core, ensure that price tiers have the expected values for your products. - Confirm that no old price lists or tags are incorrectly linked to the customer in SparkLayer. ::: :::ExpandableHeading **Customer duplicates appear in Shopify** - Double-check that the customer is assigned to the correct Sell Price Tier or Product-Specific Pricing. - In Cin7 Core, ensure that price tiers have the expected values for your products. - Confirm that no old price lists or tags are incorrectly linked to the customer in SparkLayer. ::: [title] Shopify B2B-only Content [path] Integrations/Shopify/Shopify Customisations/ :::hint{type="warning"} **Important to note** If you are looking to customise the behaviour of your Shopify store, we strongly recommend engaging a Shopify expert to assist. Whilst we can provide an overview of how to approach making customisations, our team cannot assist in applying any code changes. ::: ## B2B-only products (hiding products)  If you're running both B2B and DTC within the **same Shopify store**, there may be a range of products that you want to only show and be purchasable to logged in B2B customers. Perhaps they can only be purchased in high-volumes or they are exclusive to your B2B customers. [B2B Catalogs ](https://apps.shopify.com/sparklayer-b2b-catalogs)is a free SparkLayer app that lets you control which products are visible to different types of customers on your Shopify store. Hide products from B2C customers, restrict items to B2B-only, or show different product ranges to different customer groups - all using simple tags, no code required. [Install B2B Catalogs](https://apps.shopify.com/sparklayer-b2b-catalogs) from the Shopify App Store, then head to our [B2B Catalogs documentation](https://docs.sparklayer.io/b2b-catalogs/) for the full setup guide. :::hint{type="info"} **Hiding variants** Looking to hide variants for specific B2B customer groups? [Read our guide](docId\:m3DF4f0Eyc2rM-vUaRG9H) ::: *** ## Hiding prices If you have a dedicated B2B Shopify store and want to fully hide prices from your logged out customers, you can do this by adding special code to your storefront theme. Typically you could apply this to: - The product cards that show on your collection pages (e.g. on `/collections/all`). The code for product cards is typically found in the /snippets/ directory, e.g. `/snippets/card-product.liquid` - The product details page. This is typically found in the /sections/ directory, e.g. `/sections/main-product.liquid` To get started, you can adapt our example code below. This code simply shows some HTML code if the customer browsing the site is not a logged in B2B customer. ```html {%- if customer.metafields.sparklayer.authentication -%}
Please
sign in to see pricing
to see pricing
{%- endif -%}
```
::embed[]{url="https://www.youtube.com/embed/cUqWPCS-dOE"}
***
## B2B-only content
Within Shopify, you can very easily adapt your Shopify code to show (or hide) content based on who the customer is. This means, for B2B customers, you could show additional links in the navigation, content on the homepage or product pages, or even hide content from showing.
The code to do this is very simple and we've included a sample below.
```html
{% if customer.tags contains 'b2b' %}
Show this content to logged-in B2B customers
{% else %}
Show this content to logged-out customers
{% endif %}
```
***
## B2B-only metafields
Shopify also has a powerful feature called *metafields *that allows you to extend product data to include additional content specific to a product SKU. In the context of wholesale (B2B) ordering, it can be a great way to enrich your product pages with additional wholesale-specific information such as bar codes, marketing content, and anything else. You can learn more about metafields in [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk).
:::hint{type="info"}
**Setting up metafields on Shopify**
To learn more about how to configure metafields on Shopify for SparkLayer, please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk)
:::
Once you've populated additional content against your products, you can then update your product detail template to render the data. Here's a sample that renders additional product information but **only** if a customer is signed in and has a tag of `b2b` assigned against them. For any other customer, this additional content will be hidden from view.
```html
{% if customer.tags contains 'b2b' %}
{%assign custom_attributes = product.metafields.products %}
{%if custom_attributes.size > 0 %}
{%endif%}
{% endif %}
```
If you're using [metafields](docId\:BxWnGB6b1n7QFfhTnu7pk) on your Shopify store and want to display these to the customer (e.g. on a collection page or product detail page), you can do this by adding special Liquid code to your Shopify theme.
```html
{% if customer.tags contains 'b2b' %}
{% if product.metafields.sparklayer.pack_size %}
Pack size: {{ product.metafields.sparklayer.pack_size }}
{% endif %}
{% endif %}
```
:::hint{type="info"}
**Learn more about metafields**
For learn more about how metafields work on Shopify, please [see this guide](https://help.shopify.com/en/manual/custom-data/metafields).
:::
***
## B2B-only navigation menu
It's possible to create a B2B-only navigation menu for your store that you can show to logged in customers. It works by using Shopify's built-in menu system and then applying some special logic that shows for B2B customers.
::::WorkflowBlock
:::WorkflowBlockItem
First, you'll need to create a new menu in your Shopify store from the "Navigation" section of Shopify (you [can access it here](https://admin.shopify.com/menus)). Proceed to set up your menu, making note of the "Handle".
:::
:::WorkflowBlockItem
Next, you'll need to locate the liquid file where the menu is setup (normally this is within `/sections/header.liquid`) You should see a line of code that looks roughly like this:
`{%- for link in menu.links -%}`
Once you've located this, replace this with the below code, making a note to change `b2b-menu `to the Handle set up above.
```javascript
{%- if customer.metafields.sparklayer.authentication -%}
{% assign menu = linklists.b2b-menu %}
{%- else -%}
{% assign menu = linklists.main-menu %}
{%- endif -%}
{%- for link in menu.links -%}
```
If you're using the [Shopify B2B Dawn Theme](docId\:LHkU0_G_4GVef1jAmgXmo), you can edit the following files:
- `/snippets/header-drawer.liquid`
- `/snippets/header-dropdown-menu.liquid`
- `/snippets/header-mega-menu.liquid`
:::
:::WorkflowBlockItem
You can repeat this process for your website footer if you want that to vary based on a B2B customer being logged in or logged out.
:::
::::
:::hint{type="info"}
**Using the Shopify B2B Dawn Theme?**
This theme comes with a ready-made B2B navigation menu. [Learn more.](docId\:LHkU0_G_4GVef1jAmgXmo)
:::
***
## B2B-only promotional banner
You can enhance the experience for your wholesale partners by displaying a dedicated banner that only appears for logged-in B2B customers. This is an excellent way to confirm they are receiving wholesale pricing or to provide quick links to bulk order forms.
To add this to your store, you will need to edit your theme's liquid files. Most merchants place this code in `layout/theme.liquid` (for a site-wide banner) or within `sections/header.liquid`.
```html
{% if customer and customer.tags contains 'b2b' %}
{%- endif -%}
```
***
## Hiding content for B2B customers (via CSS)
Just as above in "Showing B2B-only content", it's also possible to do the inverse and **hide** content from B2B customers. One of the easiest ways to do this is by using special CSS which allows you to selectively hide elements based on whether a customer is logged in or not. In the example below, this CSS is only loaded when a B2B customer is signed into your store.
```css
{%- if customer.metafields.sparklayer.authentication -%}
{%- endif -%}
```
:::hint{type="info"}
**Please note**
When hiding content via CSS, the content will technically still be loaded on your website and can be access in the source code (such as via search engines). Please bear this in mind when controlling the display of content via CSS.
:::
***
## Conditional content based on customer tag
It's possible to apply logic to render different behaviour within the SparkLayer Core Script code. For example, you may have a [custom checkout field](docId\:o3nDhZBCxisWH6M6satDt) that you only want to show to customers with a specific tag. You can use the example code below as a starting point.
```javascript
{% for tag in customer.tags %}
{% if tag == "b2b-group-1" %}
-- Code in here for group-1 --
{% elsif tag == "b2b-group-2" %}
-- Code in here for group-2--
{% else %}
-- Code in here as fallback --
{% endif %}
{% endfor %}
```
***
## Redirecting URLs based on URL
Within Shopify, it's possible to redirect a logged in B2B customer based on a specific URL. For example, you may want to redirect the B2B customer from the homepage (the `index` URL) to a dedicated B2B collection page (e.g. `collections/b2b`)
To set this up, within the `layout/theme.liquid` file, before the closing ` `tag, simply add the below code, adjusting to your needs.
```javascript
{%- if customer.metafields.sparklayer.authentication -%}
{%- if template contains 'index'
or request.path == '/index'
or request.path == '/pages/your-specific URL'
-%}
{%- endif -%}
{%- endif -%}
```
***
## Redirecting URLs for logged out customers
If you're looking to 'block' specific URLs based on a customer being logged in or logged out, this can be done relatively easily within Shopify. If a customer is signed in or logged out, you can perform a simple redirect using JavaScript. To set this up, within the `layout/theme.liquid` file, before the closing ` `tag, simply add the below code, adjusting to your needs.
```javascript
{%- if customer.metafields.sparklayer.authentication -%}
{%- else -%}
{%- if request.path == '/path-to-page-here' or request.path == 'path-to-another-page-here' -%}
{%- endif -%}
{%- endif -%}
```
##
[title] ERPs & Operations
[path] Integrations/
::::LinkArray
:::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/Vk2mT_ntWt6lPDP5BAjqb_brighpearl.png"}
[Brightpearl](docId\:UdCRf8baae6izSgXo5uPB)
⚙️ Integrates Directly
Multi-channel eCommerce
:::
:::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/7mm9NPLs7kyK4R8IiJWXL_cin7a.png"}
[Cin7 Core](docId\:L2xOOZGjB4uqMK5L2EDp3)
⚙️ Integrates Directly
ERP Software
:::
:::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/xfNiGBSgEn4kQgHpgIuNy_linnworks.png"}
[Linnworks](docId\:ZvLT9mGlh1mVn8xHM4JIQ)
⚙️ Integrates Directly
Multi-channel eCommerce
:::
:::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/sXyIVQX8jqcgyBLnlwuR2_unleashed.png"}
[Unleashed](docId:83JVcRRNGWsKjpUzf-WYm)
⚙️ Integrates Directly
Inventory Management
:::
:::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/ceApPKUYZPfAcAeLjXgt8_katana.png"}
[Katana](docId\:goIlaInwUK3DbAJ0snj6t)
⚙️ Integrates Directly
Inventory Management
:::
:::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/C8m2i3Hp3fLgqCGIVek-i_patchworks.png"}
[Patchworks ](https://www.sparklayer.io/partners-patchworks/)↗
✅ Trusted Partner
iPaaS solution
:::
:::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/YTgjfLnAuv9ufeGE5bRvi_zynk.png"}
[Zynk ](https://www.sparklayer.io/partners-zynk/)↗
✅ Trusted Partner
iPaaS solution
:::
::::
[title] Xero
[path] Integrations/Accountancy/
:::hint{type="info"}
**Requirements**
**Plan:** Merchants must be signed up to the Professional or Enterprise plan
**Platform:** Merchants must be using Shopify
:::
## Introduction
Xero provides online accounting tools for managing finances, invoices, and customer records. With the SparkLayer integration, your B2B orders automatically sync to Xero to create invoices and contacts - reducing manual data entry and removing the need for additional apps or systems to keep your platforms in sync.
***
## Getting started
To get started, login to your SparkLayer dashboard and navigate to **Integrations -> Partner Integrations -> Accountancy -> Xero** and enable the integration. You will then be redirected to Xero to complete authentication. You will also be notified about which data we require access to at this stage.
:::hint{type="info"}
**Please note**
If your Xero account is associated to multiple organisations then you will be requested to select which organisation you want to connect with SparkLayer. Only one organisation can be connected to your SparkLayer dashboard.
:::
Once you are connected, you can navigate back to the **Partner Integrations **page and modify the integrations configuration. You'll need to follow the steps below ("Configuration") to complete the setup.
***
## Configuration
Below details the configuration options available in the integration.
| Setting | Description |
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Automatic Contact Creation` | **Default: Disabled**Controls whether SparkLayer should create contacts in Xero during the invoice synchronisation process.
When creating invoices, each invoice must be associated with a contact in Xero. We first attempt to match an existing contact (as outlined in the Contact Matching section). If no match is found, this setting determines what happens next:
* **Enabled - **SparkLayer will automatically create a new contact in Xero using the customer data held in SparkLayer. You can read more about contact creation [here](https://docs.sparklayer.io/xero#ZR11G). * **Disabled -** SparkLayer will not create new contacts in Xero. This assumes that contacts are either: - Being created by another system, or - Being managed manually within Xero. * In this case, if no matching contact is found, invoice creation may fail. | | `Default Line Item Account Code` | **Default: 200**
Specifies the Xero account code that invoice line items will be associated with. For example, `200`
You can find your account codes within the **Chart of Accounts** section in Xero. | | `Shipping Line Account Code` | **Default: Falls back to what is configured for "Default Line Item Account Code"**
Allows you to specify a Xero account code to use for shipping line items. For example, `260`
If left empty, the account code used will fallback to what is configured for the `Default Line Item Account Code` setting.
You can find your account codes within the **Chart of Accounts** section in Xero. | | `Invoice creation for Payment on account orders` | **Default: On order**
Controls when an invoice should be created for orders using the payment on account payment method.
* **On order **will create an invoice for the whole order one it reaches the `processing` status. * **On shipment **will create an invoice per shipment, once any fulfilments on the order have been created.
You can read more about payment on account orders below. | | `Invoice Line Item Mapping` | `Map Line Items to Item Codes`
**Default: Disabled**
Controls whether or not, during the creation of invoices, we map invoice line items to Xero Items (Products) based on the SKU held for the line item in SparkLayer.
* **Enabled **- When creating an invoice, we will map the line item to an existing item (product) held in Xero based on the SKU. If no item in Xero exists for a given SKU, the invoice will not be created. * **Disabled **- When creating an invoice, we will not attempt to map line items to items (products) held in Xero.
You can read more about **Invoice Line Item Mapping **below. | | `Tracking categories` | **Default: None**
Allows you to specify which tracking category or categories we should map line items to when creating SparkLayer invoices.
Mappings pairs should be formatted as a comma-separated list in the format:
`CategoryName:Option`
**For example;**
`Channel:B2B,Source:SparkLayer`
**In this example:**
* The **Channel** tracking category will be set to **B2B** * The **Source **tracking category will be set to **SparkLayer**
**Note:** Xero supports a maximum of two tracking categories per line item. Any additional mappings beyond this limit will be ignored. | *** ## Invoice Creation SparkLayer automatically creates invoices in Xero for eligible customer orders as soon as the order is received from your platform. :::hint{type="info"} **Please note** This process runs in the background to keep the checkout experience fast and uninterrupted, which means there may occasionally be a short delay before the invoice appears in Xero. ::: ### Orders eligible for invoicing Whether an invoice is created depends on several conditions, including your integration settings and the specific details of the order. | Item | Details | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Fulfilment status` | We only create invoices for orders that are in either the *processing* or *shipped* fulfilment status. | | `Payment method` | Invoices are generated only for orders using either the **Payment by Invoice** or **Payment on Account** payment methods.
* **Payment by Invoice** For Payment by Invoice orders, the invoice is created as soon as the order reaches the `processing` status. * **Payment on Account** For Payment on Account orders, invoices are created depending on the integrations configuration. You can read more about payment on account orders here.
You can learn more about configuring these methods [our guide here](docId\:ibIKczvHM085BkeJIfFYv) | ### Payment on account orders & split shipments The integration configuration allows you to decide when invoices are created for orders that use the payment on account payment method. Invoices can be created either **on order ** or **on shipment.** If you have configured your integration for **on order **then an invoice will be created when the SparkLayer order reaches the `processing` state. If the integration is configured for **on shipment **then an invoice will be created at the time an fulfillment has been fulfilled on the order. This handling caters for **split fulfillments **as will we will create an invoice per fulfillment, containing only the line items fulfilled. Customers will be able to download all invoices associated with an order from their my account section. :::hint{type="info"} **Shipping** In the case of split shipments, the shipping method associated with the order will always be attached to the invoice created for the **first **shipment on the order. ::: :::hint{type="warning"} **Rounding issues** Split shipments are in some cases susceptible to rounding issues. This is due to the differences between how your platform, SparkLayer and Xero calculate tax for line items across shipments. If we detect a rounding issue on an invoice, we will automatically apply a "Rounding adjustment" line item to the affected invoice, assigned to Xeros rounding account code 860. This ensures totals on the Xero invoices match the order in SparkLayer. ::: ### How invoices are created Invoices are generated using the Xero API. You can verify that an invoice was created via the SparkLayer integration by checking the **History & Notes** section in Xero, where an automatic note identifies SparkLayer as the source. Each invoice is created using a combination of: - Data from the SparkLayer order - Your integration configuration - Relevant settings within Xero The specific fields and logic used are outlined below. | Item | Details | | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Invoice Status` | By default, invoices are created in a **Submitted** status in Xero.
In some cases, invoices may be created in a **Draft** status if we are unable to determine a valid due date. | | `Contact` | We attempt to match the invoice to an existing Xero contact using the customer details from the SparkLayer order. If a match is found, the invoice is associated with that contact. You can read more about how contact matching and syncing works in detail [here](https://docs.sparklayer.io/xero#ZR11G). | | `Billing Address` | The billing address shown on the invoice is taken from the billing address associated with the matched Xero Contact. | | `Due Date` | The due date calculated for an invoice is dependant on three factors:
* The order date * The payment type * The customers payment terms | | `Due Date for Payment by Invoice orders` | For orders using the **payment by invoice **payment method, the due date is set to the order date. | | `Due Date for Payment on Account orders` | For orders using the **payment on account** type, the due date is calculated in the following hierarchical order:
1) If the customer has **net terms** configured in SparkLayer, these are applied to the order date. You can read more about configuring net terms [here](docId\:yWm70oQUosyKOoIqb4Z4G). 2) If not, any **payment terms** configured for the contact in Xero are applied. 3) If neither of the above are set, any **global payment terms** configured in Xero are applied. 4) If none of these are set, the due date defaults to the order date. | | `Line Item` | - **Item Code** If you have configured your integration to map line items to item codes in Xero, we'll use the line items SKU as the item code. - **Account Code** Each line item uses the default account code set in your integration settings. - **Description** A combination of the line item’s SKU and parent / child name is used as its description. If the item also has any custom attributes associated with it, these are also appended. - **Quantity** The quantity matches the value recorded on the order in SparkLayer. - **Unit Amount, Line Amount & Tax Amount** All monetary values, unit amount, line amount, and tax amount, are calculated by SparkLayer and passed directly to Xero. | | `Shipping` | We attach shipping details to the invoice as a line item at the bottom of the invoice. We'll use the shipping method name & SKU to form the line item description alongside the relevant monetary values.
The account code used is the same as other line items, using the default account code set in your integration settings. | | `Tracking` | Xero allows you to associate each invoice line item with up to two tracking categories.
If tracking category mappings are configured in the integration settings, **all** line items on generated invoices will automatically be assigned to the specified tracking categories. | :::hint{type="info"} **Please note ** Xero supports only a single billing address per contact. If a SparkLayer customer has multiple addresses, the billing address shown on the invoice may differ from the one stored in SparkLayer. We sync a customer’s billing address only when the contact is first created in Xero. Any changes made afterwards in SparkLayer are not automatically reflected and may require manual updates on the invoice or Xero contact record. ::: ### Mapping Line Items to Xero Items (Products) In the integration configuration section `Invoice Line Item Mapping` you may enable `Map Line Items to Item Codes`. This setting assumes you have already pre-configured items in Xero for all of the products in your platform, using the product SKU as the item code in Xero. When enabled, we'll map each line item to its corrersponding item in Xero based on the SKY held in SparkLayer. :::hint{type="warning"} If a line item is for a SKU which **does not **exist as an item (product) in Xero then we'll fail to create the invoice. Once any missing items are added, the invoice will be created. ::: *** ## Viewing Invoices Once an invoice has been created in Xero, customers can access it directly from the **My Account** section of your store. When the invoice is ready, a **View & Download Invoice** button will appear on the relevant order.  Selecting this button will take the customer to the publicly accessible invoice URL generated by Xero. If this button is not visible, please review our troubleshooting steps below. *** ## Contact matching & creation When creating an invoice, we first attempt to associate it with the correct Xero contact using the customer details from the SparkLayer order. ### How contact matching works Contacts are matched in the following order: 1. **Account number match **- we check for an existing Xero contact with an account number that matches the accounting ID configured against the customer in SparkLayer. [Read more on how to configure accounting IDs](https://docs.sparklayer.io/account-and-addresses#advanced-account-settings) 2. **Email match **- If no account number match is found, we attempt to match using the customer’s email address. If a match is found for either of these conditions, the invoice is associated with the matching contact. ### Multiple contacts for a single email In SparkLayer, email addresses are unique - only one customer account can exist per email address. In Xero, email addresses are not unique, meaning multiple contacts can share the same email. If multiple Xero contacts exist for the customer’s email address, we will create the invoice for the first matching contact returned by Xero. :::hint{type="warning"} **Please note** If your organisation uses multiple contacts with the same email address, we recommend configuring unique account numbers for each contact to ensure reliable matching. ::: ### Automatic contact creation If no existing contact can be matched using the methods above, SparkLayer will automatically create a new contact in Xero using the customer data from the order. This behaviour is controlled by the **Automatic Contact Creation** setting in your integration configuration. ### Data synced on contact creation When a contact is created in Xero, the following information is synced once and is not automatically updated if changes occur later in SparkLayer: - Company name - First name & last name - Email address - Billing & shipping address (based on the order being invoiced at the time of matching) - Payment terms (if configured via the payment terms metafield). Contacts are created using Xero’s *days after bill date* payment term type. ### Unique contacts in Xero Xero requires each contact **name** within an organisation to be unique. To ensure successful contact creation, we use a multi-stage naming strategy when creating new contacts. **Contact creation stages:** - **Stage 1: **If the [SparkLayer Company Name ](https://docs.sparklayer.io/account-and-addresses#advanced-account-settings)metafield is populated, this is used as the contact name. *Example: “The Company”* - **Stage 2: **If a contact with this name already exists in Xero, we append the customer’s first and last name. *Example: “The Company (Jane Doe)”* - **Stage 3: **If the above name is also already in use, we fall back to using only the customer’s first and last name. *Example: “Jane Doe”* If all of the above naming conventions fail to create a unique contact in Xero, to ensure an invoice is created we'll attempt each again but with a timestamp appended to the end. *Example:* "*The Company (20260520093837)*" *** ## Payment Visibility If [payment visibility](https://docs.sparklayer.io/payment-methods#payments-visibility) is enabled in your SparkLayer Dashboard configuration then you will see any payments made against invoices in Xero reflected as transactions on the order in SparkLayer. We track the following Xero payment types as transactions on orders: - Payments / Offline Payments - Credit Notes applied to invoices - Overpayments applied to invoices All payment types will be displayed as transactions on the order and modify the balance due on the order held in SparkLayer. :::hint{type="info"} **Please note** Even if the payment visibility setting is **disabled **we will continue to track Xero payments as transactions on SparkLayer orders in the background. ::: ### Refunds We do not currently track refunds on card payments as refunds are not typically applied directly to an invoice but instead reflected as a credit note on the customer account. We do however track when any of the above payment types are removed from an invoice, and reflect this accordingly on the order in SparkLayer. ### Credit Limits As SparkLayer tracks payments made against invoices, if you have configured credit limits and account balances as outlined in [Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G), any payments made on Xero invoices for **Payment on Account** orders will automatically modify the customers unpaid balance accordingly. :::hint{type="warning"} **Xero Contact Credit Limits** In Xero you ahve the ability to set credit limits for contacts. Unforunately this information is not exposed in the Xero APIs. As a result, we’re unable to automatically sync credit limits configured in Xero with customers in SparkLayer. To apply credit limits to customers, you will need to follow our documentation on[Credit, Net Terms, & Invoicing](docId\:yWm70oQUosyKOoIqb4Z4G) ::: ### Credit Notes Whilst we are able to sync credit that's been applied to invoices as a payment, we are currently unable to reflect any unallocated credit held against the contact record in Xero, against the customer balance in SparkLayer. Currently, in order to keep these in sync we'd recommend manually modifying the balance on the customers metafield to reflect any unallocated credit. Once you have allocated the credit to an invoice, you will then need to modify the balance back accordingly. *** ## Disabling the integration To disable the integration, log in to your SparkLayer Dashboard and navigate to **Integrations → Partner Integrations → Accountancy → Xero**, then toggle the integration off. To disable the integration, log in to your SparkLayer Dashboard and navigate to **Integrations → Partner Integrations → Accountancy → Xero**, then toggle the integration off. :::hint{type="warning"} **Please note** If the integration is disabled, all related features will stop working. - No invoices will be created for orders placed while the integration is disabled. - Customers will no longer be able to access their Xero invoices via the link in their **My Account** section. ::: *** ## FAQ's :::ExpandableHeading **How do I disconnect from Xero?** To disconnect from your Xero organisation from SparkLayer you will need to login to your SparkLayer Dashboard and navigate to **Integrations -> Partner Integrations -> Accountancy -> Xero **then disable the integration. This will remove the connection from your Xero organisation. Please read further information here on what happens when the integration is disabled [here](https://docs.sparklayer.io/xero#OjTtC). ::: :::ExpandableHeading **Does the integration work for D2C orders?** No. The integration only supports B2B orders that are created through your platforms connection with SparkLayer. Direct-to-consumer (D2C) orders are not included in the sync and will not be pushed to Xero as invoices. ::: :::ExpandableHeading **What level of access does the integration require in Xero?** When connecting SparkLayer to your Xero organisation, you’ll see a list of the exact permissions requested. We follow Xero best-practice and only ask for the minimum access needed for the integration to function. Currently, this includes: - **View & manage contacts** - To match invoices to existing contacts and create new contacts for SparkLayer customers if your integration configuration allows. - **View & manage business transactions** - To create invoices in Xero for SparkLayer B2B orders and in the future, view payments made on invoices. - **View organisation settings** - To read configuration details such as global payment terms when calculating invoice due dates. ::: *** ## Troubleshooting Below are some common issues and steps to help resolve them. If your issue isn’t listed, or the problem persists after following these steps, please contact our support team. :::ExpandableHeading **Customers cannot access their invoice from the My Account section** If links to invoices are not showing in a particular customers My Account section, it could be due to a number of reasons. - Ensure the integration is enabled in the SparkLayer Dashboard by navigating to **Integrations -> Partner Integrations -> Accountancy -> Xero**. - Ensure the order is in a `processing` or `shipped` fulfilment status. We **do not **create invoices for orders which are in the `awaiting merchant` status. - Ensure an invoice exists in Xero for the given order. In some cases it may take a little time for orders to sync across. If there appears to be a large delay, or an invoice has not been created, please contact support, providing the customer and order id. - Ensure the invoice is not in a **draft **status. Xero does not provide public urls for invoices which are in a **draft **status. If you are still experiencing issues after checking the above, or invoice urls are not showing for **all **of your customers, please contact support. ::: :::ExpandableHeading **The address on the invoice is different to the address the customer used during checkout** The address(es) used on an invoice in Xero come directly from the related contact record. Whilst in SparkLayer we allow for a customer to have multiple billing & shipping addresses, Xero only offers support for a single billing and shipping address per contact record. We will only use the addresses held in SparkLayer if we create the contact as part of the contact matching and creation flow detailed above. If any of these addresses change after the contact has been created, we will not automatically update them. ::: *** ## Known limitations Please note the following: - Multiple tax rates per line item are not currently supported. - Invoice creation in Xero is one-way. Any changes made to invoices in Xero, such as modifications to line items or customer details will **not **be reflected back in SparkLayer or your platform. [title] Shopify Reporting & Filtering [path] Integrations/Shopify/Shopify Customisations/ ## Introduction Because SparkLayer works as a [Sales Channel](https://help.shopify.com/en/manual/online-sales-channels) within Shopify, it makes filtering and reporting by SparkLayer orders easier. In most areas of the Shopify Admin, it's possible to filter by Sales Channel and, in the case of SparkLayer, you simply need to filter by Sales Channel **B2B Ordering** to apply specific filters.  As well as this, SparkLayer also adds tags and additional data against orders placed by B2B customers and this can also be a used to generate reports within Shopify. | Attribute | Notes | | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tag` | A tag of `b2b` is added to any order placed via SparkLayer. This is particularly useful for filtering and segmenting orders, or even adding more advanced automations | | `note` | Order Note: `sparkCartId`
This is added as an **order note.**
This is primarily for internal use for debugging | | `note` | Order Note: `sparkPaymentType`
This is added as an **order note.**
This contains the name of the payment option used:
* upfrontPayment * paymentOnAccount * paymentByInvoice * quote |  [title] Shopify Companies [path] Integrations/Shopify/ ## Introduction :::hint{type="info"} **Please note** It is not necessary to use Shopify Companies alongside SparkLayer. This guide gives an overview of how SparkLayer works alongside Shopify Companies. Using Shopify Companies may incur additional transaction costs from Shopify and we recommend speaking to Shopify Support to confirm. ::: SparkLayer and Shopify's "Companies" feature are **two different systems for managing B2B customers**. They don't currently share data - but we're actively building compatibility so they can work alongside each other. If you're a SparkLayer merchant, your B2B customer management, pricing, and ordering continues to work exactly as it does today. Shopify's Companies feature doesn't interfere with SparkLayer - but you should understand how the two systems relate. *** ## What Is Shopify Companies? Shopify has expanded its native B2B features to all plan tiers. At the core of this is the **Companies** feature (found at Customers > Companies in your Shopify admin).  A Shopify Company is a structured record that represents a business you sell to. It includes: - **Company profile** - the business name, tax ID, and general information - **Company locations** - physical locations (offices, warehouses, branches) with their own shipping/billing addresses - **Customers** - individual buyers linked to a company location, each with their own login and permissions - **Catalogs** - pricing and product visibility assigned to the company or location - **Payment terms** - net terms, deposit requirements, and checkout rules per company When a B2B customer logs in via Shopify's native B2B, they select their company and location, and Shopify automatically shows them the right pricing, products, and payment options. *** ## How SparkLayer Works SparkLayer uses a **tag-based system** to identify and manage B2B customers. Instead of Shopify's Company → Location → Customer hierarchy, SparkLayer works like this: - **Customer tags** in Shopify identify which customers are B2B buyers - **Customer groups** in SparkLayer define pricing tiers, payment methods, and rules - Customers are assigned to groups, and those groups control their B2B experience - SparkLayer overlays a full B2B frontend on top of your existing Shopify theme This means SparkLayer doesn't use Shopify's Company or Company Location records to determine who sees what pricing. You can learn more [in our guide here](docId:5_lWMNohhjBJJppg9E6Vh). *** ## Do They Conflict? **No.** SparkLayer and Shopify Companies can coexist on the same store without breaking anything. However, they currently operate independently: - SparkLayer reads **customer tags** to identify B2B buyers and assign them to groups - Shopify's native B2B reads **Company records** to determine pricing and catalogs - If a customer is set up in both systems, each system handles them separately The important thing to understand: **SparkLayer does not currently read from or write to Shopify's Company, Company Location, or Catalog records.** Your SparkLayer pricing, groups, and ordering features are managed entirely within SparkLayer. *** ## Draft Order Company Association When SparkLayer creates a draft order on behalf of a B2B customer, it **associates that order with the correct Shopify Company, Contact, and Location IDs**. This means: - B2B orders created through SparkLayer appear correctly under the Company in Shopify's admin - Order attribution is accurate - Shopify's reporting recognises these as B2B orders from a specific company - This addresses the Shopify warning: *"Some apps may not attribute B2B orders correctly on your current plan. Check that B2B orders are assigned to a company, not just an individual customer."* ### How It Works 1. B2B customer places an order via SparkLayer 2. SparkLayer creates a draft order in Shopify 3. The order is linked to both the **customer** AND their **Shopify Company and Location** 4. In Shopify's admin, the order appears correctly under both the customer and the Company  *** ## What You Need to Do **If you're an existing SparkLayer customer:** **Nothing changes with your B2B setup.** SparkLayer continues to manage your customer groups, pricing, and ordering independently of Shopify's Companies feature. The company association feature is now live - if your Shopify customers are linked to Company records, SparkLayer will **automatically** associate draft orders with the correct Company and Location. To take advantage of this: - Ensure your B2B customers in Shopify are linked to the appropriate Company records - Orders placed through SparkLayer will then appear under the Company in Shopify's admin - No additional SparkLayer configuration is needed **If you're setting up SparkLayer for the first time:** You can set up Shopify Companies alongside SparkLayer from day one. The two systems work independently, and SparkLayer's company association ensures orders are attributed correctly from the start. **Do I need to create Shopify Companies?** It depends on your needs: - **If you want Shopify's admin to show B2B orders grouped by company** → Yes, create Company records for your B2B customers. When SparkLayer's company association feature goes live, orders will be linked automatically. - **If you only use SparkLayer for B2B management** → Company records are optional. SparkLayer's customer groups handle everything. - **If you want the best of both worlds** → Create Company records for reporting and admin organisation, and use SparkLayer for the full B2B ordering experience. *** ## Vaulted credit cards Because SparkLayer associates draft orders with the correct Shopify company and location, your B2B customers can take advantage of [Shopify's vaulted credit card](https://help.shopify.com/en/manual/b2b/checkout-and-orders/vaulted-cards) feature - allowing them to securely save a card once and reuse it across future orders without re-entering payment details. ### How it works Shopify's vaulted cards **are tied to a company location. **When a customer saves a card - either at checkout or through their customer account - that card becomes available to any customer linked to the same company location. With SparkLayer, vaulted cards work in two ways: **Pay online by card** When a B2B customer checks out via SparkLayer and selects **"Pay Online by Card"**, any vaulted cards saved against their company location will appear as a payment option. The customer can select a saved card to complete the order without re-entering their details.  **Draft orders and invoices** When a customer places an order using another payment method in SparkLayer (e.g. pay by invoice), the **resulting draft order** in Shopify can have a vaulted card charged against it. This means you can collect payment on invoice orders directly from the Shopify admin using a card already on file.  ### Getting started To use vaulted cards with SparkLayer, you need the following in place: 1. **Shopify Payments must be enabled** - Vaulted cards require Shopify Payments as your payment provider. 2. **Customers must be linked to a Shopify company** - The customer's account in Shopify needs to be assigned to a company record. SparkLayer's company association feature handles the order attribution, but the customer-to-company link must exist in Shopify's admin. 3. **A card must be saved** - A customer within that company location needs to have saved a card during a previous checkout, or added one via their customer account. Once saved, the card is available to all customers at that location. No additional SparkLayer configuration is needed. As long as your customers are linked to Shopify company records and Shopify Payments is active, vaulted cards will work automatically during the SparkLayer checkout process. ### Controlling access If you want to prevent certain team members from using vaulted cards, SparkLayer's [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) feature gives you a simple way to do this. When a company user is assigned the "Limited" role, they can browse products and build an order - but they can't complete the checkout themselves. Their order is sent to the main company user for approval instead. Because limited users never reach the Shopify checkout, they won't have access to any vaulted cards saved against the company location. This makes the limited role an easy way to restrict who can charge a saved card while still allowing them to participate in the ordering process. :::hint{type="info"} **Please note** Vaulted cards are available on all Shopify plan tiers that support the companies feature. We recommend confirming any transaction fee implications with Shopify support, as using Shopify companies may incur additional costs depending on your plan. ::: *** ## Limitations While SparkLayer now supports Shopify Companies for order attribution, there are some scenarios to be aware of: - **Multiple companies or locations:** If a customer is connected to more than one Shopify Company, or to multiple locations within a company, the draft order will not be placed against a company. SparkLayer requires a single, unambiguous company-location match to associate the order correctly. - **Company records must exist first:** SparkLayer doesn't create Shopify Company records - it reads them. If a B2B customer doesn't have a Company record set up in Shopify's admin, the order will be linked to the customer only (as before). - **SparkLayer doesn't read Shopify catalogs or payment terms:** Pricing, product visibility, and payment rules are still managed entirely within SparkLayer's customer groups. Shopify's catalog assignments and payment term settings on Company records are not used by SparkLayer. - **No two-way sync between systems:** Changes made in SparkLayer's customer groups (adding a price list, changing a payment method) are not reflected in Shopify's Company records, and vice versa. The two systems are linked for order attribution but managed independently. - **Customer must be linked in Shopify:** The customer placing the order must be associated with a Company record in Shopify's admin. If the customer exists in SparkLayer's customer groups but isn't linked to a Shopify Company, the association won't happen. *** ## Migrating Companies to Customers If you'd prefer to manage your B2B customers entirely through SparkLayer's tag-based system and don't need Shopify Company records for reporting, you can remove customers from Companies and convert them to regular Shopify customers. This simplifies the setup and avoids any potential conflicts between the two systems." :::ExpandableHeading **How to migrate a customer manually** The easiest way to migrate a customer is to go into a company record within Shopify and, in the right hand side, click the "Remove customers" button. This will then allow you to remove a customer from the company record.  Next, go to the "Customers" area of Shopify and locate the customer. From the top right, click "Send account invite". When you click this button, this will then send the customer an "activation email", allowing them to set a password (not a 6 digit code) and subsequently be able to login to your store.  ::: :::ExpandableHeading **How to migrate a customer in bulk** If you're looking to migrate customers in bulk, our recommended approach is to the Shopify App, [Matrixify](https://apps.shopify.com/excel-export-import?st_source=autocomplete). Built-in to this tool is the ability to bulk 'Un-assign" customers from a Company by **deleting** the Company, converting them into regular customers (who you can subsequently invite to your store). To get started, set up a new export and specify "**Companies**" as the source "**Sheet**"  Within the exported file, you'll see a column "Command" with an entry of "MERGE" next to each Company record.  Simply update the column "Command" to "DELETE" and re-import the file into Matrixify.  This will then fully delete the Company record from Shopify and all associated customers will then become regular customers. You can then individually invite the customers (see above), or even use Matrixify to bulk activate and invite your customers in one go. ::: *** ## FAQs :::ExpandableHeading **Will SparkLayer break if I enable Shopify's B2B features?** No. SparkLayer operates independently. You can enable Shopify's Companies feature without affecting your SparkLayer setup. ::: :::ExpandableHeading **Can I use both SparkLayer and Shopify's native B2B at the same time?** SparkLayer and Shopify's native B2B checkout cannot run simultaneously for the same customer session - it's one or the other for the ordering experience. However, you can have Shopify Companyrecords set up for admin/reporting purposes while using SparkLayer for the actual B2B ordering. ::: :::ExpandableHeading **Should I allocate tags to customers or set up Shopify Companies?** For SparkLayer to work, you need **customer tags** - this is how SparkLayer identifies B2B buyers. Shopify Company records are optional but recommended for better order attribution and admin organisation. Both can coexist. ::: :::ExpandableHeading **Do I need Shopify Markets to use Shopify Companies?** Companies and Markets are technically separate features, but on non-Plus plans they're closely linked. You can create Company records in Shopify's admin without enabling Markets - they work as structured customer profiles with locations, contacts, and payment terms. However, to assign pricing catalogs to those companies, you need Markets. On Basic, Grow, and Advanced plans, catalogs are assigned through Markets (customer groupings), not directly to companies. So you can have Companies without Markets, but they won't have custom pricing - which limits them to an admin organisational tool. On Shopify Plus, you can bypass Markets entirely and assign catalogs directly to individual company locations. This is the only plan where Companies and catalogs work independently of Markets. SparkLayer doesn't use either system for pricing. Your customer groups, price lists, and payment methods are managed entirely within SparkLayer, regardless of whether you have Markets or Companies enabled in Shopify. ::: :::ExpandableHeading **What about that Shopify warning about apps not attributing B2B orders correctly?** This is already handled. SparkLayer now correctly associates draft orders with the relevant Shopify Company and Location, ensuring accurate B2B order attribution in Shopify's admin. As long as your B2B customers are linked to Company records in Shopify, orders placed through SparkLayer will appear under the correct Company. ::: :::ExpandableHeading **When will company association be available?** It's live now. No additional configuration is needed on the SparkLayer side - just ensure your Shopify customers are linked to the appropriate Company records. ::: [title] WooCommerce FAQs [path] Integrations/WooCommerce/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for WooCommerce?** All SparkLayer plans are compatible with WooCommerce, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via the SparkLayer Dashboard under Acccount > Plan ::: ### WooCommerce setup :::ExpandableHeading **Where do I find the SparkLayer WooCommerce app?** Currently, SparkLayer can only be setup on your WooCommerce store by registering directly via [SparkLayer](http://app.sparklayer.io/register) ::: :::ExpandableHeading **What WooCommerce plan do I need to be on to use SparkLayer?** You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website - WooCommerce: version 9 and above - Wordpress: version 6 and above If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing WooCommerce DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.woocommerce.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **Can you help me install SparkLayer on my WooCommerce website?** By default, the SparkLayer widges will be automatically installed on your store. If you do require assistance, you can [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we will be happy to advise. ::: :::ExpandableHeading **Does SparkLayer work on any WooCommerce theme?** You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website - WooCommerce: version 9 and above - Wordpress: version 6 and above If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). ::: :::ExpandableHeading **How does SparkLayer affect my current WooCommerce theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your WooCommerce store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the WooCommerce checkout. From there, any payment methods you have set up in WooCommerce (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if WooCommerce support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. You could also configure your WooCommerce theme to hide and show products based on tag via custom coding. ::: :::ExpandableHeading **Can I use my WooCommerce prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your WooCommerce prices (e.g. your main WooCommerce retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your WooCommerce prices and we can even make provisions for your tax set up in WooCommerce (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within WooCommerce, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Wix so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Wix, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Wix 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in WooCommerce to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. It's also worth noting that you can manually add customers via the admin by going to **Wordpress/WooCommerce > Users** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. You could think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my WooCommerce website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my WooCommerce website?** This is possible but would require custom coding. We recommend consulting with a WooCommerce expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in WooCommerce?** | Payment Method | Notes | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by Invoice` | The order will be created within **WooCommerce > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Payment on Account` | The order will be created within **WooCommerce > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Upfront Payment (Card payments)` | The order will be created within **WooCommerce > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. | ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within WooCommerce when an order is placed via SparkLayer providing payment hasn't already been processed. From WooCommerce > Oders, navigate to an order. You'll then see the option to **Edit order** allowing you to make changes. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: [title] Shopify Error Codes [path] Integrations/Shopify/ ## Introduction If SparkLayer detects an error on your Shopify store, you may notice one of the following error codes display within the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-). We've detailed the most common errors along with the associated way to resolve them. ## Error codes :::hint{type="danger"} - **SHOPIFY:001 **You've assigned a price list in a specific currency (e.g. AUD) to a B2B customer but this currency has not been enabled in your [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD). In a market that includes multiple countries / regions, there is a setting to "Show prices to customers in their local currency". SparkLayer does not currently support this setting and **it will need to be disabled** for B2B customers in this market to successfully place orders. - **SHOPIFY:002** You've assigned a price list in a specific currency (e.g. AUD) to a B2B customer but the destination shipping country isn't set up in your [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD). - **SHOPIFY:003** There's an issue with your product data such as a missing variant SKU for the product in your order. Try removing the affected product from the order. - **SHOPIFY:005 **The email being used for the order is failing "DNS checks" by Shopify and is being restricted from checking out. Try checking the email address to ensure it is valid. - **SHOPIFY:006 **You're trying to checkout with a shipping address in a country that is not in any of your store's configured Shopify Markets. Please ensure all available shipping countries have an associated Shopify Market set. - **SHOPIFY:007** You're trying to checkout but your customer record is missing either an email address, shipping phone number, or shipping address. These are all required for stores using Managed Markets. - **PRICING:001 **The B2B customer has two price lists assigned to their customer group with different currencies (e.g. GBP and USD). Try changing their customer group settings to ensure only one currency type is assigned. ::: [title] Installing SparkLayer on Wix [path] Integrations/Wix/ ## Introduction SparkLayer enables B2B functionality on your existing Wix store, allowing your B2B customers to login, place orders, manage their account, and much more. :::hint{type="success"} **👋 We're here to help!** Our team can help get everything set up on your Wix store. You can [book a call here](https://connect.sparklayer.io/onboarding-meeting) and we'll walk you through the process! If you'd prefer, you can also use our guide below to try setting things up yourself. :::  *** ## ⚠️ Requirements - important! Before installing SparkLayer on your Wix store, please ensure the following are setup before proceeding: | Item | Details | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Site Member Settings` | You’ll need to make sure that your store is set up to allow "Site members". You can check this within your admin by going to **Settings >** **Site Member Settings > Signup & Login Security**. Under "Who can be a site member", select "Everyone who signs up". | | `Product SKUs` | In order for SparkLayer to save B2B prices for your products, all products must have **SKUs**. Within your admin, go to a product and you'll see the option to set a SKU either on a product or variant level. You can learn more about this below. | | `Contacts` | For your B2B customers to see the SparkLayer, they must have a label of `b2b`. You can set this up by going to **Customers & Leads > Contacts** and editing a customer record. You can learn more about this below. | | `Payments` | Please ensure you have payment methods enabled. You can check this within your admin by going to **Settings > Accept Payments**. | | `Shipping` | In order to place an order, please ensure you have shipping rules set up. Within your admin, go to **Settings > Shipping and Delivery.** | **Areas of Wix Dashboard you'll be using** As part of setting up SparkLayer, you'll primarily be using the following areas: | Area | Details | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Products` | This will be used to setup which products you want to make available to B2B customers. See "Setting up your B2B pricing" below.
*In Wix, go to Catalog > Store Products > Products* | | `Contacts` | This will be used to setup your B2B customers. See "Setting up your B2B customers" below
*I**n Wix, go to Customers & Leads > Contacts* | | `Orders` | This will be used to review and process and orders that are placed by your B2B customers. See "Placing a B2B order" below.
*In Wix, go to Sales > Orders* | :::hint{type="warning"} **Limitations** We recommend familiarising yourself with [current limiitations](docId\:DKZzbjeYVKG6YrJGVKjpW) of SparkLayer for Wix ::: *** ## 🟢 Quick-start guide If you're looking to get setup quickly and just review the key steps, you can use our step by step guide below! :::ExpandableHeading **See step-by-step instructions (click to expand)** **STEP 1 - Install App** Install the [SparkLayer for Wix App](https://www.wix.com/app-market/web-solution/sparklayer-b2b-wholesale) and select the Wix store you’d like to install on (ensuring it is a **Wix Editor** store). *** **STEP 2 - Register with SparkLayer** Install the app and then register an account with SparkLayer**** **⚠️ IMPORTANT: Please ensure you make a note of the email address and password you use**  *** **STEP 3 - App Onboarding Steps** You’ll then be taken to an onboarding page where it guides you through setting SparkLayer up. **⚠️ IMPORTANT: all set up takes place via the **[SparkLayer Dashboard](https://app.sparklayer.io/)** and NOT in Wix**  *** **STEP 4 - Sign into SparkLayer** Log in to the [SparkLayer Dashboard](https://app.sparklayer.io/). This is where you will set up B2B pricing and B2B customer rules primarily. ⚠️**IMPORTANT: you will be prompted to “confirm your SparkLayer plan”, you can ignore this. This will be relevant in due course once the app is live and merchants want to **[select a plan](https://www.sparklayer.io/pricing/)  *** **STEP 5 - Setup B2B Pricing** Go to the [Price Lists section](https://app.sparklayer.io/pricing/lists) and set up an example price list. For example, you could set up an “automatic pricing” which is 50% off your Wix pricing. When you click “Create Price List” you’ll be prompted to assign this to your default B2B customer group (this is optional, you can change it later). Depending on your tax setup in Wix, you can also automatically calculate the correct tax rate to set your automatic pricing.  *** **STEP 6 - Setup B2B Customer Rules** Go to the [Customer Groups section](https://app.sparklayer.io/customers/groups) where you can configure your B2B customer rules. At a minimum, ensure that a “Price List” has been assigned. **⚠️ IMPORTANT: You’ll see a column “WIX LABEL”, this is the label you will need to add to your Wix Contacts (‘Customers”) once ready (see step 9 below)**  *** **STEP 7 - Complete Onboarding Steps** From the main “Home” section, you can check off any steps you take as you go**** **⚠️ IMPORTANT: this step is manual and doesn’t do anything other than mark the step(s) as complete.**  *** **STEP 8 - Product Catalog** In Wix, go Catalog > Store Products > Products to view your product catalogue. These are the products that show on your Wix Online store. **⚠️ IMPORTANT: for SparkLayer to show B2B prices, products *****MUST***** have a *****unique***** SKU added. If no SKU(s) are added, it will not be possible for B2B customers to purchase.**  *** **STEP 9 - Setup a B2B Customer** In Wix, go Customers & Leads. We’re going to create a brand new B2B customer record, click “Create New Contact” and complete the details. **** **⚠️ IMPORTANT: please ensure that a valid address is added. Make a note of the email address you’ve added as you will need to access this to login.**  Under “Label”, assign a label of “b2b” to the contact. If you don’t see this, you can view the Contact record and then add it  **⚠️ IMPORTANT: Please also note:** On a new B2B customer (whether new or existing), when they get labelled b2b for the first time: - SparkLayer will attempt to sync their address only this one time - however, if there are missing required fields (e.g. name, address line, postcode) SparkLayer will not sync the address at all and will not output any sync error logs - Any subsequent address edits from the Wix dashboard on a Wix contact will **not** sync back to SparkLayer - Any address book edits from SparkLayer will not sync back to Wix *** **STEP 10 - Set Contact as Member** In Wix, find the contact record and under Member Info, click **Set Contact as Member** This will then send the contact an email to confirm their account. **⚠️ IMPORTANT: all contacts must be set as “Members” to sign in as a B2B customer**  *** **STEP 11 - Activate Account****** In your emails, you’ll receive an email from Wix to activate your account. Click “Create New Password” and follow the instructions. Customers can also use the “Reset password” feature on the online store to do this.   *** **STEP 12 - Sign in as a B2B Customer** On your Wix store, sign in with the credentials you’ve created in the previous step. Next, navigate to a product page. Providing that the product has a valid SKU, you will then see your SparkLayer B2B pricing rules show and you can begin adding products to your order.  ::: *** ## 🚢 The Onboarding process :::hint{type="info"} **Important** When setting up SparkLayer, some activities take place via the [SparkLayer Dashboard](https://app.sparklayer.io/) alongside Wix. You'll use the SparkLayer Dashboard primarily for setting up your B2B pricing and B2B customer rules. ::: When you create an account on SparkLayer, you'll get access to the [SparkLayer Dashboard](https://app.sparklayer.io/). The Dashboard has a customised onboarding process that gently guides you through all the necessary steps before you're ready to start inviting your B2B customers and taking orders on your website. ::::WorkflowBlock :::WorkflowBlockItem **🔗 Connecting your Wix store** This enables SparkLayer to connect to your Wix store and begin synchronising the information it requires. ➡️ [View in dashboard](https://app.sparklayer.io/integrations/platform) ::: :::WorkflowBlockItem **📓 Setting up your B2B price lists** You'll then set up the B2B price lists that you want your customers to see when they login. These can be automated or you can manually upload specific pricing. ➡️ [View in dashboard](https://app.sparklayer.io/pricing) ::: :::WorkflowBlockItem **👪 Setting up your B2B customer groups** You'll then set the ordering rules for your customers such as minimum order values, available payment methods and price lists they are assigned to. ➡️ [View in dashboard](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem **✅ Testing & launching** You'll then need to run through some final checks (such as placing a test order). Once you're happy, you can then launch SparkLayer and start taking orders! ➡️ [View in dashboard](https://app.sparklayer.io/configuration/onboarding) ::: :::: Let's now dive into each of them! *** ## 🔗 Connecting your Wix store Once you've installed the [SparkLayer for Wix app](https://www.wix.com/app-market/search-result?query=sparklayer) this step of the onboarding process happens automatically. Once SparkLayer is connected to your Wix store, it will **automatically synchronise product and customer data** and then allow you to upload price lists and customise how you want your B2B customer rules to work. :::hint{type="info"} **Installing for the first time?** When installing for the first time, the process works as follows: 1. You'll need to install the SparkLayer app (much like you would any other app). You can do this within your admin by going to **Apps** and clicking **App Market **and then searching for SparkLayer. 2. You'll then be asked to **create an account on SparkLayer**, or sign in if you already have one. 3. Finally, you need to confirm acceptance of our billing plan within Wix to begin your free trial ::: Once the above is complete, you can then return back to the [SparkLayer Dashboard](https://app.sparklayer.io/) to continue with the onboarding process. You can also access the SparkLayer app within your Wix store by going to the **Apps** and clicking **Manage Apps** and clicking the **SparkLayer app** where you'll find a summary of your onboarding process. *** ## 📓 Setting up your B2B pricing :::hint{type="warning"} **Please note** Setting up your B2B pricing happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your Wix admin. ::: Within the [Price Lists](https://app.sparklayer.io/pricing) area of the SparkLayer Dashboard, you can create and manage your B2B pricing rules.  SparkLayer allows you to set the following pricing types: | Type | Details | | ----------- | ---------------------------------------------------------------------------------------- | | `Manual` | You can manually upload a CSV file with specific prices and even enable quantity pricing | | `Automatic` | You can use your Wix prices and apply a discount, e.g. 50% off Wix retail prices | To get started, please following the below steps: ::::WorkflowBlock :::WorkflowBlockItem For any products that you want your B2B customers to be able to buy, these products **must** have unique SKUs assigned. You can check this by going to **Catalogue > Store Products > Products** and editing a product. For regular products, you'll see the option to add a SKU within the **Inventory and shipping** section.  For products that have variants (e.g. colour, size), you'll need to edit a variant and add this within the **Product variants** section and ensure the setting **"Manage pricing and inventory for each product variant"** is turned on.  ::: :::WorkflowBlockItem Next, go to [Price Lists](https://app.sparklayer.io/pricing/lists) within SparkLayer and click "Create Price List" to create your first B2B Price list. You can choose between an automatic or manual price list and configure how this works. ::: :::: :::hint{type="success"} **Ready to set your pricing?** To learn more about pricing, please see our [full guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: *** ## 👪 Setting up your B2B customers :::hint{type="warning"} **Please note** Setting up your B2B customer rules happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your Wix admin. ::: [Customer Groups](https://app.sparklayer.io/customers/groups) let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out.  Much like with Price Lists, you can fully manage this via the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups). To get started, please following the below steps: :::::WorkflowBlock ::::WorkflowBlockItem Within Wix, go to **Customers & Leads** and click **Contacts. **You can either create a new customer or edit an existing one. :::hint{type="warning"} **Please note** Please ensure that a valid address is added and all address fields are populated. Make a note of the email address you’ve added as you will need to access this to login. :::  :::: ::::WorkflowBlockItem To synchronise to SparkLayer, the customer must have a label of `b2b` assigned to them and be a **Site Member**. :::Iframe{iframeHeight="0" code=""} ::: You can set this up by clicking the **Add Label** button when editing a customer.   :::hint{type="warning"} **Please note the following on customer groups** - SparkLayer will only synchronise customers that have a label of `b2b` assigned - If you have created additional [customer groups](https://app.sparklayer.io/customers/groups) within SparkLayer, please ensure that the labels are added to the contact record in Wix exactly as shown. e.g. `b2b` `b2b-additional-group` - Customers must be set up as **Site Members** to be able to sign in to your online store. - When adding a new label in Wix, please ensure that it is not subsequently edited. ::: :::: :::WorkflowBlockItem Once your customers have been set up in Wix (i.e. those with a label of `b2b`), and you've assigned the customer group to **at least** one customer, you can then manage specific rules within the [Customer groups area.](https://app.sparklayer.io/customers/groups)  ::: :::WorkflowBlockItem You'll see a default **Base** customer group that you can use for your B2B customers. If you want to set up additional rules, you can simply click **Create Customer Group** and configure accordingly. For any additional customer groups you create, you'll need to update the labels on the customer record in Wix to match (e.g. `b2b` and `b2b-account`) ::: :::WorkflowBlockItem To simulate logging in as a B2B customer, please see **✅ Testing & launching** below. ::: :::WorkflowBlockItem You can also check if your customer record is syncing by using the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. Within Wix, navigate to a Contact record that has a label of b2b. Within the URL, you'll see a unique ID at the end of the URL. In the example below, the unique ID is `66b4c99a-3431-47d6-995d-309e4e8c5908`  With this unique ID, you can then paste this into the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. If the search results show the customer details, this confirms the customer is synchronosing correctly.  ::: ::::: :::hint{type="success"} **Ready to configure your customer groups?** To learn more about customer groups, please see our [full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: *** ## 🛒 Placing a B2B order Once you've logged into your Wix store as a B2B customer, you can then place an order by going to any product page and adding items to your order. When you add items, they will then appear in the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) and you can then proceed to checkout to complete the order. **How payment methods work** When customers reach the payment step, they'll see a variety of available payment methods and can select their preference. | Payment method | Description | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment on Account` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** needing to enter any payment details. | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details. | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). This is sometimes referred to as "Pro-forma payment". | | `Request for quote` | **👪 For the B2B customer:**
The customer can submit their order **without** choosing a payment method. | **How orders arrive into Wix** Depending on which [payment method](docId\:ibIKczvHM085BkeJIfFYv) you've selected, orders will arrive into Wix in the following ways: | Payment Method | Flow | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Pay by Invoice` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay on Account` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay Online by Card` | The order will be created within **Sales > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | | `Request for Quote` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | **"Unpaid" orders and "Paid" orders** By default **all payment methods** other than Upfront Payment will be generated as "Unpaid" orders. **Wix checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the Wix checkout. By default, they will see all Wix payment methods you have set up (e.g. card payment, Paypal, etc). **Additional order details** When an order is placed via SparkLayer, it will also include the following additional data: | Attribute | Notes | | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tag` | A tag of `b2b` is added to any order placed via SparkLayer. This is particularly useful for filtering and segmenting orders, or even adding more advanced automations |  *** ## 🛠️ The frontend widgets When you install SparkLayer on your Wix store, the special SparkLayer widgets are automatically added to **your product detail pages.** There's no coding or configuration to do! Once set up, your approved B2B customers (see above "Setting up your B2B customers") will then see your B2B pricing and can begin placing orders. You can learn more about how this works in [our guide here](docId\:ccZ1vnH0O6D_722w35Xpa).  **Customising the branding (via CSS)** By default, the SparkLayer widgets will show with generic fonts and colours, however it is possible to "overwrite" the styling to better match your store by using special CSS rules. There are a variety of ways to do this via Wix. :::ExpandableHeading **Using Wix Editor 'Custom Code' ** Within your Wix Dashboard, go to **Settings** and then click **Custom Code**. Click** "Add Custom Code"** and add the CSS into the field named **"Paste the code snippet here".** You'll also need to ensure it is set to **"Load code on each new page"**  For example, you could overwrite the colours and fonts by using the following CSS ```css ``` Once saved, you can then make edits at any point.  ::: ::::ExpandableHeading **Using Wix Studio 'Code Mode'** Within your Wix Dashboard, go to **Site & Mobile App** and then click **Edit Site**. :::BlockQuote Within "edit mode", click **Code** in the left navigation. Within the CSS section, you'll see a file global.css that you can use to add our special [CSS variables](docId\:qCt2Zk8wjhYIV2ZbVBJYy) to customise your design. ::: :::Iframe{iframeHeight="0" code=""} ::: For example, you could overwrite the colours and fonts by using the following CSS ```css ``` :::: *** ## ✅ Testing & launching The final step is to run some tests and checks to ensure SparkLayer is fully configured. Within the SparkLayer Dashboard, you'll see a number of [Launch checks](https://app.sparklayer.io/?expand=launch) to perform, from logging in as a B2B customer, through to placing an order. We recommend following the below steps: ::::WorkflowBlock :::WorkflowBlockItem **Set up a customer record** Within your Wix admin, you'll need to ensure you have an example customer record set up (either a new one or an existing). Most importantly, a customer must be associated with a label of `b2b` and be a Site Member. Any customer that has a label of `b2b` will automatically synchronise with SparkLayer.   ::: :::WorkflowBlockItem **Place a test order** Once you've logged in as a B2B customer (i.e. a customer with a label of `b2b`), proceed to add items to your cart and complete the checkout. Please see *"Placing a B2B order"* above for more details on how this works. ::: :::WorkflowBlockItem **Invite your customers** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. One of the easiest ways is to use the built-in Wix messaging system to simply notify your customer to sign in and begin placing orders. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You'll see a tab called **Inbox** that allows you to send direct messages.  You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You can then search and filter your customers and click **Send Email Campaign** to send an email.  We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::: *** ## ⚙️ Advanced configurations In addition to the above setup, there are a number of other configurations that are possible at this time. :::ExpandableHeading **Setting minimum stock levels** It's possible to set minimum stock level for items you may want to sell as pre-orders. This means that your B2B customers can add products to an order and you can limit how many are available. To get started, in your Wix Dashboard, navigate to a product. You'll need to ensure **Track inventory** and **Pre-order** are both turned on. Within **Pre-order limit**, simply enter the stock number, e.g. `50`.  ::: :::ExpandableHeading **Adjusting tax settings** SparkLayer supports tax calculations and simply 'inherits' the rules you've set up in your Wix Dashboard. You can learn more about how tax works [in this Wix guide](https://support.wix.com/en/article/including-tax-in-the-product-price). One key configuration you may want to check is how Tax is calculated during the checkout. From your Wix Dashboard, go to **Settings > Tax** and you can amend accordingly.  ::: :::ExpandableHeading **Enabling SparkLayer JavaScript modifications (e.g. checkout customer fields, language updates)** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Wix store. To get started, go to **Settings > Custom Code** and then click **Add Custom Code**. You can then paste in any JavaScript as required. For example, the below sample enables a special checkout custom field to collect a Delivery Date. ```javascript ``` ::: :::ExpandableHeading **Enabling a URL redirect when signing in ** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Wix store. To get started, go to **Settings > Custom Code** and then click **Add Custom Code**. You can then paste in any JavaScript as required. For example, the below sample enables a special checkout custom field to collect a Delivery Date. ```javascript ``` ::: :::ExpandableHeading **Enabling "Dark mode" for high contract websites** If your Wix store is set up with a darker theme, it's possible to enable a special "Dark Mode" for SparkLayer, ensuring colours and fonts are easily readable.  To get started, go to **Settings > Custom Code** and then click **Add Custom Code**. You can then paste in the code below. ```javascript ``` ::: :::ExpandableHeading **Enabling SparkLayer shipping methods** SparkLayer has a built-in [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) system that lets you customise how shipping works for your B2B customers. By default, your existing shipping methods in your Wix Dashboard will be used, however it's possible to update this to use SparkLayer. To get started, in your Wix Dashboard, go to **Settings > Shipping, Delivery & Fulfillment**. You'll need to make sure you have at least one shipping region set up (e.g. USA, UK). Once you've done that, click the **Manage Your Apps** link below the shipping region. You'll then see the option to enable **SparkLayer Shipping.** Finally, you'll then need to set up your SparkLayer shipping rules via the [SparkLayer Dashboard here](https://app.sparklayer.io/configuration/shipping).  ::: :::ExpandableHeading **Enabling pre-order (or "back orders")** SparkLayer has built-in support for pre-orders (someimtes referred to as "back orders"). To enable this, simply edit a product in Wix and turn on the Pre-order setting as shown below.  Once enabled, this will then show a message to the B2B customer on the product page and allow purchasing.  ::: :::::ExpandableHeading **Enabling Sales Agents** SparkLayer has full support for the [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) feature on Wix, letting your sales team login and place orders on behalf of your B2B customers. You can learn more about how it works in [our guide here](docId\:Uw8mDbMEfwWKqZrVB5CqX). :::hint{type="info"} **Please note** To setup a sales agent, you'll first need to ensure your SparkLayer plan supports this. ::: ::::WorkflowBlock :::WorkflowBlockItem To get started, you'll first need to set up a Contact in Wix and ensure they have a full address added and a label of `b2b` added. Next, you'll need to copy the unique contact ID which you can retreive via the browser URL.  ::: :::WorkflowBlockItem Within the SparkLayer Dashboard, go to the [Sales Agent area](https://app.sparklayer.io/sales-agents) and paste in the contact ID ::: :::WorkflowBlockItem You can then specify which role you'd like to assign to their account. You can learn more about how it works in [our guide here](docId\:Uw8mDbMEfwWKqZrVB5CqX).  ::: :::: ::::: *** ## 📁 Troubleshooting To troubleshoot the most common issues (such as issues with pricing), please see [our guide here](docId\:BlCEkkx3I30nkUcglsfw7). You can also [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to assist. *** ## ℹ️ Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for Wix?** All SparkLayer plans are compatible with Wix, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via your Wix admin and processed monthly or annually if you've selected this option. ::: ### Wix setup :::ExpandableHeading **Where do I find the SparkLayer Wix app?** You can find the official SparkLayer for Wix app in the [Wix App Market](https://www.wix.com/app-market/search-result?query=sparklayer). ::: :::ExpandableHeading **What Wix plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of Wix. All you need is an active Wix store and you're good to go. ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing Wix DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.wix.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **Can you help me install SparkLayer on my Wix website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any Wix theme?** Yes! SparkLayer is compatible with all Wix themes. Once you install the SparkLayer app, our special B2B widgets are automatically added to your Wix store and you're good to go. ::: :::ExpandableHeading **How does SparkLayer affect my current Wix theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Wix store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the Wix checkout. From there, any payment methods you have set up in Wix (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if Wix support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: :::ExpandableHeading **Can I use multiple currencies for my B2B customers?** Currently, Wix [doesn't allow](https://support.wix.com/en/article/wix-stores-request-selling-in-multiple-currencies) a Wix store to accept multiple currencies (e.g. USD, EUR, GBP etc). If you do set up multiple currencies within SparkLayer in the [Price List section](https://app.sparklayer.io/pricing/lists), it's important to note the following: - Customers will see the correct currency when browser your store as a logged in B2B customer. The price they see will be the currency exchange rate at that time - If they proceed to place an order in a different currency to your Wix store's default currency, this will create an order however the pricing will show in your default currency. We've illustrated this below  How the order shows in Wix. Note how the totals are the same but the currency (EUR) has defaulted to the Wix store currency (£ GBP)  ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. Within Wix, you can set pages to have **Permissions** for **Site members**. You create a **Member Role** of `B2B Customers` and then assign this to specific pages on your Wix website. You can see [their full guide here](https://support.wix.com/en/article/wix-stores-creating-restricted-store-pages).  If you wanted to show special B2B-only products, you would need to create these as separate products within Wix (i.e. with unique SKUs, etc) With SparkLayer pricing, if you don't upload a price against a SKU, the B2B customer** won't be able to purchase it.** So this is a way to prevent them from adding items you don't want them to purchase ::: :::ExpandableHeading **How do I hide prices on my regular (B2C) Wix store? ** Within your Wix store, you can easily hide the regular (B2C) retail price from showing. This is a great way to make your Wix store "B2B only" and only show prices once a customer signs in. To view more details on how to do this, please see the [official Wix guide here](https://support.wix.com/en/article/wix-stores-hiding-product-prices). ::: :::ExpandableHeading **Can I use my Wix prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Wix prices (e.g. your main Wix retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Wix prices and we can even make provisions for your tax set up in Wix (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within Wix, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Wix so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Wix, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Wix 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Wix to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. Wix [have a guide here](https://support.wix.com/en/article/wix-forms-an-overview) on ways to do this. It's also worth noting that you can manually add customers via the admin by going to **Customers & Leads > Contacts** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. One of the easiest ways is to use the built-in Wix messaging system to simply notify your customer to sign in and begin placing orders. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You'll see a tab called **Inbox** that allows you to send direct messages.  You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You can then search and filter your customers and click **Send Email Campaign** to send an email.  We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my Wix website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my Wix website?** We recommend consulting with a Wix expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in Wix?** | Payment Method | Notes | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by Invoice` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Payment on Account` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Request for Quote` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Upfront Payment (Card payments)` | The order will be created within **Sales > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. | ::: :::ExpandableHeading **Why do orders show up as "Awaiting Merchant"?** When a B2B customer first places an order, it will show as **Awaiting Merchant** when they view it in their [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP). This status means that the order requires the merchant (the Wix store owner) to view the order and then confirm payment (e.g. such as sending the customer an invoice or arranging payment via other means). Once you then mark the order as paid within Wix, this will then update the order status from **Awaiting Merchan**t to **Processing** and you can then fulfil the order as normal.   ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within Wix when an order is placed via SparkLayer providing payment hasn't already been processed. From your Wix Dashboard, navigate to an order and click the **More Actions** button. You'll then see the option to **Edit order** allowing you to make changes.  ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly but there are some good ways to do this within Wix. When viewing an order within your Wix Dashboard, you'll see the option to **Create Invoice** under **More Actions**. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal.  ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** You can manage notifications and emails that are sent by going to your Wix Dashboard, clicking **Settings** and then **Outgoing Notifications**. ::: :::hint{type="info"} **Need assistance?** We'd be happy to help guide you through this process. Please refer to [our guide here](docId\:NNUw1G9z7eaJ4M78vk7t9) ::: [title] WooCommerce [path] Integrations/ ## Introduction :::hint{type="info"} **Join our Early Access programme** We're launching WooCommerce immentently on SparkLayer. If you'd like to be one of the first to access it, please email *support\@sparklayer.io* and our team will be in touch. ::: SparkLayer is the powerful platform that transforms your existing WooCommerce website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed SparkLayer on your WooCommerce store SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your WooCommerce store. The best part is you can retain your *existing* WooCommerce store design and layout and enable B2B alongside your retail operation (DTC). ## Supported WooCommerce Plans  SparkLayer works with WooCommerce version 9 and above and Wordpress version 6 and above. *** ## WooCommerce Demo Store Want to see SparkLayer & WooCommerce in action? Try it out on our WooCommerce demo store using the details below: | Item | Details | | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Login URL | [demo.woocommerce.sparklayer.io/ ](https://demo.woocommerce.sparklayer.io/my-account/)This is an example DTC + B2B store. To login as a B2B customer, [go to this link](https://demo.woocommerce.sparklayer.io/my-account/) and use the credentials below. | | Username | woocommerce\@sparklayer.io | | Password | I6qxPvpww42#3hsz0hTC%U2b | *** ## Get started ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Installing SparkLayer on WooCommerce](docId:1GjKXB51dfFbw2rbsYxuH) Learn about the steps to install SparkLayer on your WooCommerce store ::: :::LinkArrayItem [WooCommerce Metafields & Data Mapping](docId\:DL0CTVwncNk8ZGJmYihy4) Learn how to use the powerful WooCommerce metafields feature ::: :::LinkArrayItem [WooCommerce FAQs](docId\:laOn_6ALBpQigc7rIvb5v) See some of our most commonly asked questions! ::: :::: [title] Intuitive Shipping [path] Integrations/Customer Experience/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to Intuitive Shipping - Platform: Merchants must be using Shopify or BigCommerce ::: ## Introduction [Intuitive Shipping](https://intuitiveshipping.com/) is a leading shipping solution major eCommerce platforms such as Shopify and BigCommerce, allowing merchants to manage powerful shipping rules for their online store. In the context of SparkLayer, it's possible to integrate Intuitive Shipping seamlessly within the checkout, allowing B2B customers to view shipping rates specific to them. *** ## Configuring on SparkLayer :::hint{type="warning"} **Please note the following before starting** - Your Shopify store must already have the [Intuitive Shipping app](https://apps.shopify.com/intuitive-shipping) installed before enabling this feature. - You must turn on the [SparkLayer shipping system](https://app.sparklayer.io/configuration/shipping) - this will disable showing shipping methods from your eCommerce platform that you do not want to show ::: Once the Intuitive Shipping app has has been installed on your store, you're ready to activate it on SparkLayer! Within the [SparkLayer Dashboard](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard), go to the **Integrations** section and click **Partner Integrations.** Under **Shipping**, click the toggle on the right to activate the Intuitive Shipping integration. You'll then be prompted to enter an **API Key** to complete the setup. You can retrieve this within your Intuitive Shipping Dashboard by going to **Settings**, going to **Partner Integrations** and copying the **API Key**.  This completes the set up process and you can follow the below steps to test the integration. - Log in to your Shopify store as a B2B customer - Go through the checkout process until you reach the "Review & Pay step" - The available shipping methods will correlate with those setup in the Intuitive Shipping Dashboard  *** ## Known limitations Please note the following: - The integration will not factor in any "Shipping dates" configured in Intuitive Shipping - The integration will only work for physical products (i.e. not digital products) - Pricing will always be displayed in net pricing (excluding tax) [title] Installing SparkLayer on Magento [path] Integrations/Magento/ ## Introduction SparkLayer enables B2B functionality on your existing Magento store, allowing your B2B customers to login, place orders, manage their account, and much more.  To familiarise yourself with SparkLayer, we also recommend reviewing the following guides: ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [How SparkLayer Works](docId:_2g8HwCXnN7OFy4o199y1) The fundamentals of what SparkLayer does ::: :::LinkArrayItem [Frontend](docId\:OgKfvQX13dHW2582D57kJ) The special "interfaces" SparkLayer enables ::: :::LinkArrayItem [Features](docId\:SSzdKXuNMlEIDOOITHQcU) The available features and functions. ::: :::: *** ## ⚠️ Requirements - important! Before installing SparkLayer on your Magento store, please ensure the following: | Item | Details | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Magento` | You must be using one of the following Magento versions.
* Magento Open Source - version 2.4.2 or later * Adobe Commerce - version 2.4.2 or later
The Multi-Stock Inventory module should be enabled (this should be the case on most Magento installs by default). | | `Product SKUs` | In order for SparkLayer to save B2B prices for your products, all products must have **SKUs**. | | `Customers` | For your B2B customers to see the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa), they must be assigned an appropriate B2B "Role" within Wordpress > users | | `Payment Processor` | If you’re installing SparkLayer on a test store, please ensure you have an example payment method enabled. You can manage this within **Magento > Sales > Payment Services** | | `Shipping` | In order to place an order via the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), please ensure you have shipping rules set up. You can manage this within Magento under **Stores >Configuration > Delivery Methods** or via SparkLayer's own [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) solution | | `Theme` | You have a technical Magento partner or developer to integrate the SparkLayer Magento module with your theme. Luma and Luma based themes are automatically supported by the SparkLayer module. Other themes will need manual integration work to ensure SparkLayer web components are output instead of normal magento PDP/PLP cards, the SparkLayer script is loaded for B2B customers, and customer authentication is connected to the SparkLayer script. | **Areas of Magento you'll be using** As part of setting up SparkLayer, you'll primarily be using the following areas: | Area | Details | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Catalog` | This will be used to setup which products you want to make available to B2B customers. See "Setting up your B2B pricing" below. | | `Customers` | This will be used to setup your B2B customers. See "Setting up your B2B customers" below | | `Sales` | This will be used to review and process and orders that are placed by your B2B customers. See "Placing a B2B order" below.
*In Magento, go to Orders* | *** ## 🔗 Connecting your Magento store :::hint{type="info"} **Please note** Setting up SparkLayer will require generating API keys within your Magento store. If you're unsure how to do this, our team is happy to assist. To get in touch, please [click here](docId\:NNUw1G9z7eaJ4M78vk7t9). ::: To get started with SparkLayer on your Magento store, there are a number of steps to follow. Once you've completed this step, you can then begin the process of configuring SparkLayer such as pricing and customer rules. ::::WorkflowBlock :::WorkflowBlockItem **Install the SparkLayer Magento module and create an Integration** First, you'll need to install the SparkLayer for Magento module on your store. Please get in touch with your SparkLayer Account Manager for access to the module. Once installed, open the SparkLayer B2B module tab in the Magento admin, and create an integration for the correct Magento store by clicking the "Create and Activate Integration" button:  Then go to Stores > Configuration > SparkLayer > B2B and ensure the "Enabled" option is set to "Yes" for your store:  ::: :::WorkflowBlockItem **Access the Integration API credentials** Next, you'll need to access the SparkLayer Integration API credentials within Magento. From your Magento admin dashboard, you can find this within System > Integrations > SparkLayer B2B for "your store name" > Edit > Integration Details. You will need these credentials to in the following steps to connect and authorise your SparkLayer account to connect to the Magento store.  ::: :::WorkflowBlockItem **Register with SparkLayer** Next, you'll need to create a SparkLayer account by [registering here](http://app.sparklayer.io/register) ::: :::WorkflowBlockItem **Connect your Magento Store** Once registered, go to [Integrations > Platform Connection](https://app.sparklayer.io/integrations/platform) and select Magento. You'll then be prompted to enter your store URL (this should be the URL of the website you are installing SparkLayer on, e.g. `www.mystore.com`) ::: :::WorkflowBlockItem **Enter the API credentials in SparkLayer** From with the SparkLayer Dashboard [Integrations > Platform Connection](https://app.sparklayer.io/integrations/platform) paste the provided credentials from the earlier step. Press save and wait a few seconds whilst SparkLayer connects to the Magento store and performs the SparkLayer plugin initialisation. ::: :::WorkflowBlockItem **Store connected** This completes the process of connecting your Magento store to SparkLayer! ::: :::: *** ## 🚢 The Onboarding process :::hint{type="info"} **Important** When setting up SparkLayer, some activities take place via the [SparkLayer Dashboard](https://app.sparklayer.io/) alongside Magento. You'll use the SparkLayer Dashboard primarily for setting up your B2B pricing and B2B customer rules. ::: When you create an account on SparkLayer, you'll get access to the [SparkLayer Dashboard](https://app.sparklayer.io/). The Dashboard has a customised onboarding process that gently guides you through all the necessary steps before you're ready to start inviting your B2B customers and taking orders on your website. ::::WorkflowBlock :::WorkflowBlockItem **📓 Setting up your B2B price lists** You'll then set up the B2B price lists that you want your customers to see when they login. These can be automated or you can manually upload specific pricing. ➡️ [View in dashboard](https://app.sparklayer.io/pricing) ::: :::WorkflowBlockItem **👪 Setting up your B2B customers** You'll then set the ordering rules for your customers such as minimum order values, available payment methods and price lists they are assigned to. ➡️ [View in dashboard](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem **🛠️ Installing the frontend widgets** You'll need to check the special code snippets ("widgets") are installed on your Magento store in order to show the special SparkLayer B2B interfaces. ➡️ [View in dashboard](https://app.sparklayer.io/integrations/widgets/core) ::: :::WorkflowBlockItem **✅ Testing & launching** You'll then need to run through some final checks (such as placing a test order). Once you're happy, you can then launch SparkLayer and start taking orders! ➡️ [View in dashboard](https://app.sparklayer.io/configuration/onboarding) ::: :::: *** ## 📓 Setting up your B2B pricing :::hint{type="warning"} **Please note** Setting up your B2B pricing happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your Magento admin. ::: Within the [Price Lists](https://app.sparklayer.io/pricing) area of the SparkLayer Dashboard, you can create and manage your B2B pricing rules.  SparkLayer allows you to set the following pricing types: | Type | Details | | ----------- | ------------------------------------------------------------------------------------------------------------------- | | `Manual` | You can manually upload a CSV file with specific prices and even enable quantity pricing | | `Automatic` | You can use your Magento prices and apply a discount. You can choose from your main Magento price or the RRP price. | ::::WorkflowBlock :::WorkflowBlockItem For any products that you want your B2B customers to be able to buy, these products **must** have unique SKUs assigned. In Magento, you can check this by going to **Catalog** and editing a product.  ::: :::WorkflowBlockItem Next, go to [Price Lists](https://app.sparklayer.io/pricing/lists) within SparkLayer and click "Create Price List" to create your first B2B Price list. You can choose between an automatic or manual price list and configure how this works. ::: :::: :::hint{type="success"} **Ready to set your pricing?** To learn more about pricing, please see our [full guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: *** ## 👪 Setting up your B2B customers :::hint{type="warning"} **Please note** Setting up your B2B customer rules happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your Magento admin. ::: [Customer Groups](https://app.sparklayer.io/customers/groups) let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out. Much like with Price Lists, you can fully manage this via the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups). ::::WorkflowBlock :::WorkflowBlockItem Within SparkLayer, create a customer group. You can follow our guide, [Customer Groups](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem SparkLayer will sync any customer groups you create into Magento as a "Group" which can then be assigned to individual customers with Magento. Groups synced from SparkLayer will be automatically prefixed with "B2B".  ::: :::WorkflowBlockItem Once your customers have been set up in Magento (i.e. those with a B2B group assigned), and you've assigned the customer group to **at least** one customer, you can then manage specific rules within the [Customer groups area.](https://app.sparklayer.io/customers/groups)  ::: :::WorkflowBlockItem You'll see a default **Base** customer group that you can use for your B2B customers. If you want to set up additional rules, you can simply click **Create Customer Group** and configure accordingly. For any additional customer groups you create, you'll need to update the role on the customer record in Wordpress/Magento to match. ::: :::WorkflowBlockItem To simulate logging in as a B2B customer, please see **✅ Testing & launching** below. ::: :::WorkflowBlockItem You can also check if your customer record is syncing by using the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. Within Magento, navigate to the Customers section, search for a customer, and note the ID. With this unique ID, you can then paste this into the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. If the search results show the customer details, this confirms the customer is synchronising correctly. ::: :::: :::hint{type="success"} **Ready to configure your customer groups?** To learn more about customer groups, please see our [full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: *** ## 🛠️ Installing the frontend widgets SparkLayer comes with ready-made B2B-optimised "widgets" that we collectively call the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ). The widgets simply overlay sections of your existing Magento store and enable our powerful B2B features.  Once set up, your approved B2B customers (see above "Setting up your B2B customers") will then see your B2B pricing and can begin placing orders. You can learn more about how this works in [our guide here](docId\:ccZ1vnH0O6D_722w35Xpa). **Installing SparkLayer widgets** :::hint{type="warning"} **Please note** Due to the nature of high level of customisation of many Magento stores and themes, you will need a Magento developer to install and integrate the SparkLayer frontend core scripts and widgets. ::: The SparkLayer Magento module provides out-of-the-box setup for the Magento Luma theme (which should work for any luma based themes). Your developers can use this implementation as a reference of how to set this up. To enable the frontend integration on your store for Luma based themes go to Stores > Configuration > SparkLayer > B2B in the Magento Admin dashboard, and enable the Frontend Widgets option which will automatically add the required frontend integration setup:  **Steps required to integrate the SparkLayer frontend widgets:** ::::::WorkflowBlock :::WorkflowBlockItem **Install the **[SparkLayer Core Script ](https://app.sparklayer.io/configuration/frontend/core)Within your main website header you'll need to add the SparkLayer Core Script that activates the SparkLayer functionality when a customer tagged with a SparkLayer B2B group is logged in. ::: :::::WorkflowBlockItem **Install the **[Product Detail Interface](https://app.sparklayer.io/configuration/frontend/pdp) You'll need to update your storefront's product detail page with the SparkLayer Product Purchasing Interface. When a customer logs in and SparkLayer recognises them as being a B2B customer, this will load a special interface with their specific prices and a way to purchase. ::::ExpandableHeading **🛠️ View instructions** ```javascript
This will allow the customer to checkout **without** needing to enter any payment details. | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details. | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). | **How orders arrive into Magento** Depending on which [payment method](docId\:ibIKczvHM085BkeJIfFYv) you've selected, orders will arrive into Magento in the following ways: | Payment Method | Flow | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Pay by Invoice` | The order will be created within ** Magento > Sales** with a payment status of "Pending". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay on Account` | The order will be created within ** Magento > Sales** with a payment status of "Pending". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay Online by Card` | The order will be created within **Magento > Sales** with a payment status of "Processing" providing you have this already configured within Magento. You can then proceed to fulfil the order. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | **"Unpaid" orders and "Paid" orders** By default **all payment methods** other than Upfront Payment will be generated as "Pending" orders. You will need to capture payment either via your Magento Admin or via offline methods (e.g. bank transfer) **Magento checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the Magento checkout. By default, they will see all Magento payment methods you have set up (e.g. card payment, Paypal, etc). **Additional order details** When an order is placed via SparkLayer, it will also include additional data within an order under **SparkLayer Order Information**.  *** ## ✅ Testing & launching The final step is to run some tests and checks to ensure SparkLayer is fully configured. Within the SparkLayer Dashboard, you'll see a number of [Launch checks](https://app.sparklayer.io/?expand=launch) to perform, from logging in as a B2B customer, through to placing an order. We recommend following the below steps: ::::WorkflowBlock :::WorkflowBlockItem **Set up a customer record** Within your Magento admin, you'll need to ensure you have an example customer record set up (either a new one or an existing). Most importantly, a customer must be associated with an appropriate role. *Please see "Setting up your B2B customers" above for more details on how this works.* ::: :::WorkflowBlockItem **Place a test order** Once you've logged in as a B2B customer, proceed to add items to your cart and complete the checkout. Please see *"Placing a B2B order"* above for more details on how this works. ::: :::WorkflowBlockItem **Invite your customers** You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::: *** ## ⚙️ Advanced configurations In addition to the above setup, there are a number of other configurations that are possible at this time. :::ExpandableHeading **Displaying stock (inventory) levels** You can configure SparkLayer to show [stock levels](docId\:Gj_Ao_gQ6oA-jx0D27Hys) in a variety of ways. If you want to show inventory numbers (e.g. 100), you'll need to make sure this is turned on within Magento. Within Magento, go to Stores> Configuration > Inventory and turn on **Manage Stock** ::: :::ExpandableHeading **Adjusting tax settings** SparkLayer supports tax calculations and simply 'inherits' the rules you've set up in your Magento settings. ::: :::ExpandableHeading **Enabling SparkLayer JavaScript modifications (e.g. checkout customer fields, language updates)** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Magento theme store. Within the "Core Script Options" you can add the below code. ```javascript { termsAndConditionsLink: "/policies/terms-of-service", checkoutCustomElements: [ { name: 'shipping-date', translations: { en: { title: 'Preferred Shipping Date', detail: 'Shipping unavailable on weekends.', }, }, attributes: { required: true, type: 'date', }, }, ], } ``` ::: :::ExpandableHeading **Enabling a URL redirect when signing in ** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Wix store. Under **"Core Script Options"** you can add the below code. ```javascript { accountRedirect: { urlRegex: /\/account/g, goTo: "/index", // page to redirect logged in users to }, } ``` ::: :::ExpandableHeading **Enabling "Dark mode" for high contract websites** If your Magento store is set up with a darker theme, it's possible to enable a special "Dark Mode" for SparkLayer, ensuring colours and fonts are easily readable.  Under **"Core Script Options"** you can add the below code. ```javascript { display: { darkTheme: true, }, } ``` ::: :::ExpandableHeading **Enabling SparkLayer shipping methods** SparkLayer has a built-in [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) system that lets you customise how shipping works for your B2B customers. By default, your existing shipping methods in your Magento store will be used, however it's possible to update this to use SparkLayer via the [SparkLayer Dashboard here](https://app.sparklayer.io/configuration/shipping). ::: :::ExpandableHeading **Enabling pre-order (or "back orders")** SparkLayer has built-in support for pre-orders (someimtes referred to as "back orders"). Once enabled, this will then show a message to the B2B customer on the product page and allow purchasing.  ::: *** ## 📁 Troubleshooting To troubleshoot the most common issues (such as issues with pricing), please see [our guide here](docId\:BlCEkkx3I30nkUcglsfw7). You can also [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to assist. *** ## ℹ️ Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for Magento?** Our "Enterprise" plan is required to use the SparkLayer Magento integration. [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via the SparkLayer Dashboard under Acccount > Plan ::: ### Magento setup :::ExpandableHeading **Where do I find the SparkLayer Magento module?** Please get in touch with our support team to get access to the SparkLayer Magento module. ::: :::ExpandableHeading **What Magento plan do I need to be on to use SparkLayer?** SparkLayer supports the following Magento Plans - Magento Open Source (version 2.4.2+) - Adobe Commerce (Cloud, version 2.4.2+) ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing Magento DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.woocommerce.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **How does SparkLayer affect my current Magento theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Magento store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will be taken to our Magento payment methods checkout. From there, any payment methods you have set up in Magento (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if Magento support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. You could also configure your Magento theme to hide and show products based on tag via custom coding. ::: :::ExpandableHeading **Can I use my Magento prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Magento prices (e.g. your main Magento retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Magento prices and we can even make provisions for your tax set up in Magento (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Magento so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Magento, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Magento 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Magento to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. It's also worth noting that you can manually add customers via the admin by going to **Magento > Customers** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. You could think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my Magento website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my Magento website?** This is possible but would require custom coding. We recommend consulting with a Magento expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within Magento when an order is placed via SparkLayer providing payment hasn't already been processed. From Magento > Sales, navigate to an order. You'll then see the option to **Edit order** allowing you to make changes. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: [title] BigCommerce [path] Integrations/ ## Introduction SparkLayer is the powerful platform that transforms your existing BigCommerce website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed the [official SparkLayer for BigCommerce app](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/), SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your BigCommerce store. The best part is you can retain your *existing* BigCommerce store design and layout and enable B2B alongside your retail operation (DTC). ## Supported BigCommerce Plans  SparkLayer requires Customer Groups to work. BigCommerce *Plus* through to BigCommerce *Enterprise *is supported. *** ## BigCommerce Demo Store ::embed[]{url="https://youtu.be/6QCPV7_V_Ps"} Want to see SparkLayer & BigCommerce in action? Try it out on our BigCommerce demo store using the details below: | Item | Details | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Login URL | [](https://demo.bigcommerce.sparklayer.io/login.php)
This is an example DTC + B2B store. To login as a B2B customer, [go to this link](https://demo.bigcommerce.sparklayer.io/login.php) and use the credentials below. | | Username | bigcommerce+user\@sparklayer.io | | Password | Spark123^7\&jj1 | | App store listing | [SparkLayer BigCommerce App](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/) | *** ## Get started ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Installing SparkLayer on BigCommerce](docId\:x6xahBJ_9KYJTHD80_1QH) Learn about the steps to install SparkLayer on your BigCommerce store ::: :::LinkArrayItem [BigCommerce Metafields & Data Mapping](docId\:bkHor8d6QhgZX_yxsdt56) Learn how to use the powerful BigCommerce metafields feature ::: :::LinkArrayItem [BigCommerce FAQs](docId\:KZrw-fFscozjvGMLwPoIB) See some of our most commonly asked questions! ::: :::: [title] Shopify B2B Store Setup [path] Integrations/Shopify/Shopify Customisations/ ## Standalone vs Hybrid  When you're in the process of setting up your Shopify B2B store, there are two ways to go about this: 1. Set up as a **new** standalone Shopify store 2. Enable wholesale functionality on **existing** Shopify store Both have positives and negatives and it's ultimately a business decision as to which is the best route to take. :::hint{type="info" attributes="[object Object]"} **Considerations to bear in mind** A major benefit of SparkLayer is being able to integrate it without needing to duplicate stores. If you're looking to implement SparkLayer in this way, it's important to consider the following: - **Stock and warehouses:** currently, it's not possible to route B2B orders to use specific stock locations in Shopify when using the checkout. This means that, if you're installing SparkLayer on your main Shopify store, B2B orders will need to **share the same stock pool**. This can have knock-on effects on stock allocation and the impact needs to be carefully considered. - **Verify your apps***:* Do you have any apps installed that may interfere with the B2B experience? E.g. apps that send 'leave a review' emails or any post-purchase follow ups. Many will allow you to exclude interactions based on customer tags; remember, all customers that use SparkLayer will have a tag of `b2b` assigned. - **Analytics and reporting**: SparkLayer will show in Shopify as a **Sales Channel** called **SparkLayer B2B & Wholesale** which makes it easy to split out your reports. Within Shopify, you should be able to segment data (e.g. Orders) by this Sales channel - **Affiliate and tracking pixels:** your Shopify site and Shopify checkout may have special tracking code installed to monitor sales; you'll need to make sure this is excluded for B2B customers (e.g. by filtering out any customers that have a tag of `b2b`). This will likely require input from a Shopify developer so consideration will need to be given. [Learn more](https://help.shopify.com/en/manual/orders/status-tracking/customize-order-status#add-additional-scripts) ::: *** ## Creating an additional store It may be necessary to create a **separate** Shopify store to manage your B2B channel. Although this may sound daunting, the good news is it's relatively straightforward to set up and you can automate a lot of the process. The most common reasons why you'd create a secondary Shopify store include: - **Stock levels:** You need to separate out your B2B stock from your DTC - **Products:** You want to create a totally different product catalogue for your B2B customers - **Integrations**: you need to integrate your B2B channel with a different system and keep it separate from your DTC channel - **Website URL**: you need to create a separate website URL to access the store such as `b2b.yourstore.com`. Our recommended approach is as follows: 1. **Set up your main B2B store.** This will mean installing SparkLayer, and then configuring and customising your Shopify store as you require. For example, setting up a storefront theme, customising the homepage and product pages, etc. 2. **Set up your storefront theme**. It's likely you'll want these to use the same design, so the first step is to export your theme from your main B2B store and import it into your additional stores. [This Shopify guide](https://help.shopify.com/en/manual/online-store/themes/managing-themes/downloading-themes) shows you how to do this. 3. **Install SparkLayer on your additional stores**. Just as with your main store, you will need to install SparkLayer on each additional store. We're happy to assist in this process and also discuss a combined pricing rate. 4. **Synchronise your data**. The final step is to set up a mechanism to synchronise data between all your stores. This can include product data, CMS content, even orders. We recommend two highly rated Shopify apps to do this: [Matrixify](https://apps.shopify.com/excel-export-import) and [Syncio](https://apps.shopify.com/syncio). It's likely that you will need someone with Shopify expertise to help in this process and we are happy to advise where possible. [title] Shopify Flow for B2B [path] Integrations/Shopify/Shopify Customisations/ ## Introduction  [Shopify Flow ](https://help.shopify.com/en/manual/shopify-plus/flow)is powerful feature for merchants on the Shopify, Advance, or Shopify Plus plans that allow automations to be configured based on certain actions. We've included some additional ready made **Shopify Flow workflows** that you can [import](https://help.shopify.com/en/manual/shopify-plus/flow/create-workflow/import-export#import-workflows) into your Shopify admin. *** ## Order automations | Trigger | Details | Download | | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `Mark order as paid` | When a B2B customer places an order via manual payment methods, the order will automatically be marked as paid | [Download](https://cdn.shopify.com/s/files/1/0565/7500/0728/files/Mark_B2B_orders_as_paid_0a29877b-9fb6-4d8a-9f10-ca27ba055b66.flow?v=1635839553) | | `Mark Payment on Account order as paid` | When a B2B customer places an order specifically via "Payment on Account", the order will automatically be marked as paid | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Mark_B2B__Payment_on_Account__orders_as_paid.flow?v=1710337044) | | `Archive B2B orders` | Automatically archive B2B orders from your Shopify Orders view; useful if you want to hide them from your standard DTC orders | [Download](https://cdn.shopify.com/s/files/1/0565/7500/0728/files/Archive_B2B_Orders.flow?v=1635838493) | | `Tag pre-orders` | Set up a rule to tag an order when pre-order products are purchased | [Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) | | `Tag order with the net terms applicable to the customer` | Based on the [net terms](docId\:yWm70oQUosyKOoIqb4Z4G) that are set against the customer (via a metafield), this will then automatically tag their orders with a special Net Terms tag. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Tag_order_with_what_net_terms_the_customer_is_on.flow?v=1722499862) | | `Populate order metafield from custom checkout fields` | When using [customer checkout fields](docId\:o3nDhZBCxisWH6M6satDt) (e.g. a date selector), this will pull the data from the draft order and populate metafields on the completed order. | [Download](https://cdn.shopify.com/s/files/1/0631/8453/5705/files/Update_order_Metafield_with_SparkLayer_Custom_Attributes_1.flow?v=1754639426) | | `Control B2B Order Fulfilment Flow` | Automatically route orders from your wholesale customer group to a specific stock location for fulfilment in Shopify. This works with the Shopify Stock Location feature to ensure B2B orders are handled separately from standard (B2C) flows. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_Fulfilment_location_11.flow?v=1760365759) | *** ## Customer automations | Trigger | Details | Download | | ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Switch tag on first order` | When a B2B customer places their first order, replace their existing tag with a new one and send an internal email | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_-_switch_tag_assigned_to_a_B2B_customer_after_their_first_order_acb41199-9408-48f9-8e5e-f1228e836ceb.flow?v=1714641440) | | `Automatically adjust customer tag for customer group depending on spend` | If you have different customer groups (e.g. Gold, Silver, Bronze), you can automatically update the customer's tag based on their order spend. This allows you to automatically change a customer's B2B group. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Automatically_adjust_customer_tag_for_customer_group_depending_on_spend.flow?v=1722499466) | *** ## Product automations | Trigger | Details | Download | | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Remove restock date in metafield when variant back in stock` | If you're using [pre-orders](docId\:Gj_Ao_gQ6oA-jx0D27Hys) and you've set a restock date, this automation removes the restock date when the product comes back in stock. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Remove_restock_date_in_metafield_when_variant_back_in_stock.flow?v=1722499600) | | `Automatically mark new products with B2B ordering & Online store sales channels` | When adding new products to your Shopify store, this will automatically assign the B2B Ordering and Online Store sales channel | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Automatically_mark_new_products_with_B2B_ordering_Online_store_sales_channels.flow?v=1722499725) | | `Add RRP metafield when product status updated` | When a product’s status changes, this automation adds the RRP metafield if it doesn’t already exist. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Add_RRP_when_product_status_updated.flow?v=1772815525) | | `Update RRP metafield when product updated` | When a product is updated, this automation updates the RRP metafield to ensure the value stays in sync. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Update_RRP_Metafield_when_product_updated.flow?v=1772815525) | *** ## Email automations | Trigger | Details | Download | | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Send an email with order details` | Send an email to a specified email address when a B2B customer places an order via a specific B2B payment status; great if you need to notify other members of your team who handle B2B accounts (see below) | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_-_Draft_order-_Send_email_to_verify_the_order.flow?v=1762519098) | | `Send notification based on custom checkout fields (Draft Orders)` | Based on specific [custom checkout fields](docId\:o3nDhZBCxisWH6M6satDt), trigger an action such as an internal email | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_-_Draft_Checkout_Custom_Attributes_-_Send_email_based_on_criteria.flow?v=1717486893) | | `Send notification based on custom checkout fields (Completed Orders)` | Based on specific [custom checkout fields](docId\:o3nDhZBCxisWH6M6satDt), trigger an action such as an internal email | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/B2B_-_Completed_Order_Checkout_Custom_Attributes_-_Send_email_based_on_criteria.flow?v=1717486893) | | ` Email sales agent when order placed by customer` | Based on specific rules you set, you can send notifications to sales agents when an order is placed. | [Download](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/Sales_Agents_-_Email_sales_agent_when_order_placed_by_customer.flow?v=1726494991) | Using Shopify Flow, you can modify the contents of the email to include dynamic content. In the example below (*Send an email with order details*), customer details and order details are included and sent to a specific email address.  [title] Katana [path] Integrations/ERPs & Operations/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to the Professional or Enterprise plan - Platform: Merchants must be using Shopify ::: ## Introduction Katana is a manufacturing ERP that gives you a live look at all the moving parts of your business - sales, inventory, and production. You can learn more about Katana [here.](http://brightpearl.com/) *** ## How it works The Katana integration for SparkLayer is available for all Shopify merchants that already use Katana and allows you to bring **B2B pricing** to your Shopify store. The integration works in the following ways: | Item | Details | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customers` | Katana becomes the 'master' of your B2B customer data, and any changes to tagged customer records will automatically be synchronised to Shopify and SparkLayer. | | `Product Pricing` | Price lists and product prices are imported into SparkLayer via pricing rules you set up in Katana | *** ## Configuring on SparkLayer To configure Katana on SparkLayer, you'll need to have an approved account with Katana. Please visit the [Katana website](http://katanamrp.com/) to learn more. To get started using Katana on SparkLayer, you'll first need to enable the integration. Within the [SparkLayer Dashboard](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard), go to the **Integrations** section and click **Partner Integrations**. Under **Multi-channel management**, click the toggle on the right to activate the Katana integration. You'll then be prompted to authorise SparkLayer to access your Katana account. *** ## Configuring Customers Broadly speaking, Katana is your **central location **for managing B2B customer data. When customers are configured in Katana as B2B customers, SparkLayer can automatically retrieve this data and then enable the B2B ordering experience on your Shopify site. You can then create specific rules for this customer group, e.g. minimum orders, price lists, via the [Customer Group](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard/settings#customer-groups) section within SparkLayer. :::ExpandableHeading **Step 1 - Customer mapping** Customers are mapped between the systems based on the **primary email** set within Katana. Once this is mapped, SparkLayer will then synchronise the following data into Shopify. | **Katana** | **Shopify / SparkLayer** | | ------------------- | -------------------------------------------------------------------- | | `Address` | Shows against customer record in Shopify | | `Primary Telephone` | Shows against customer record in Shopify | | `First / Last Name` | Shows against customer record in Shopify | | `Customer Category` | Shows against customer record in Shopify - matches to customer group | | `Company Name` | Shown via metafields in Shopify | | `Discount Rate` | Shown via metafields in Shopify | | `Price List` | Shown via metafields in Shopify | ::: :::ExpandableHeading **Step 2 - Adding new B2B customers** Katana will be the **central source for your customer data**. When creating a new customer in Katana and you want to set them up as a wholesale customer through SparkLayer, you will need to assign them to a Catagory which should match the **Customer group tag** of the group you want to assign them to. For example, if you want to assign them to the below **B2B - Canada** customer group. The Category name in Katana would be `b2b-ca`  In our example, the Category name in the customer in Katana is set to match `b2b-ca` When new customer records are added to Shopify, they will by default be added as **Pending** customer accounts and receive an **automatic email** to enable their account by setting a password.  This uses the **Customer account invite **notification email which can be edited in the Notifications section within Shopify. You can configure whether the email is sent or not from the SparkLayer Katana settings.  ::: *** ## Configuring Product Pricing Once customers are mapped between Katana and SparkLayer, the next step is to configure your B2B pricing. As with customers, Katana is your centralised source for managing your B2B pricing. :::ExpandableHeading **Step 1 - Setting up B2B pricing in Katana** Within Katana, go to **Price Lists**. To add a new price list, click the Add new price list button and complete as necessary.  In the example above, we've created two price lists; B2B and UKVIP. When creating your price list(s) in Katana, you'll be able to add pricing rules for products. In the example below, you can see pricing for the UKVIP price list.  In order for SparkLayer to map this data, price list records are **automatically** imported each time you add a price list in Katana. The mapping works as follows: | **Field name in SparkLayer** | **Field name in Katana** | | ---------------------------- | ------------------------ | | Handle / ID | Price list ID | | Name | Price list name | | Currency | Currency | Price lists will be made using the Katana's base currency. Automatic price lists with currency conversion will be created for customers that are given a different currency in Katana.  ::: *** ## Known limitations Please note the following: - Default addresses in Katana will be mapped to Shipping and Billing address in Shopify as Shopify doesn't support independent addresses. - A customer that is removed from the customer group will also need their allocated 'b2b' tag removed from their customer account in Shopfiy. - Addresses are a 1-way sync currently, from Katana into Shopify. Its recommended to not allow address editing in SparkLayer otherwise new addresses added won't appear in Katana. - Deleted pricing in Katana will not sync back to the Shopify. You will need to manually delete the pricing from the SparkLayer dashboard. *** ## Troubleshooting :::ExpandableHeading **Why isn’t my customer data syncing from Katana to Shopify?** - Confirm the primary email address is set in Katana; it's used for mapping. - Check that the SparkLayer integration has been authorised within Katana under **Configuration > Integrations > Partners**. ::: :::ExpandableHeading **Why are customer addresses not updating in Katana when edited in SparkLayer?** - Address sync is one-way: from Katana to Shopify. Changes made in SparkLayer will not reflect in Katana. - To maintain data consistency, it's recommended to disable address editing in SparkLayer. ::: :::ExpandableHeading **New customers in Katana aren’t appearing in Shopify. What should I check?** - Make sure the Katana integration is active and authorised. - Ensure new customers have all required fields, especially the email. - Check Shopify’s **Customer account invite** email settings to ensure invites are sent or disabled correctly via SparkLayer settings. ::: :::ExpandableHeading **My price list changes in Katana are not visible in SparkLayer. What might be wrong?** - Price lists must be created or updated directly in Katana. - Deleted pricing in Katana does **not** automatically sync — you must manually remove obsolete pricing from the SparkLayer Dashboard. ::: :::ExpandableHeading **Why is the wrong price showing for a B2B customer?** - Double-check that the customer is correctly assigned to the right price list in Katana. - Verify that customer has the correct currency assigned if using a different currency than the base. ::: :::ExpandableHeading **My new price list isn’t appearing in SparkLayer. What should I do?** - Confirm the price list has been properly saved in Katana. - Allow time for SparkLayer to auto-import the price list list. ::: :::ExpandableHeading **Where can I change the invite email that new customers receive?** - Go to Shopify Admin > Settings > Notifications, and edit the Customer account invite email template. - SparkLayer uses this template when enabling new accounts created from Katana. ::: [title] Wix Limitations [path] Integrations/Wix/ ## Introduction Currently, there are a number of limitations to be aware of with the SparkLayer and Wix Integration. | Item | Details | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product cards (Gallery)` | It is not possible to use the [Product Card Interface](docId\:Mrp_Z0QIZQ2QksseuJylv) on a Wix store. This means that if you're showing products on your store (e.g. the homepage or gallery page), **pricing will simply be hidden**. | | `Metafields` | SparkLayer does support [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) however it's not currently possible to set these up in Wix. This means that features such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [MSRP pricing](docId\:S_VTlJBorGmnwjjfSMom9), and others **are not available to use**.
In early 2025, Wix are likely to release functionality to better support this. | | `Customer syncing ` | SparkLayer will sync customer data from your Wix store into our system. It is important to note the following:
* Customer addresses are **only synced once** at the point where the `b2b` label is first added to a Wix Contact. * Any future updates to Wix Contact addresses actioned via the Wix Dashboard centre will not sync back to SparkLayer * It is possible to use the built-in [address book](docId\:lQXaNI7IVDqna09D9soAP) to add and edit addresses via the My Account area | | `Multi-currency` | Currently, Wix [doesn't allow](https://support.wix.com/en/article/wix-stores-request-selling-in-multiple-currencies) a Wix store to accept multiple currencies (e.g. USD, EUR, GBP etc).
If you do set up multiple currencies within SparkLayer in the [Price List section](https://app.sparklayer.io/pricing/lists), it's important to note the following:
* Customers will see the correct currency when browser your store as a logged in B2B customer. The price they see will be the currency exchange rate at that time * If they proceed to place an order in a different currency to your Wix store's default currency, this will create an order however the pricing will show in your default currency. | | `Checkout custom fields` | Currently, it is not possible to use [custom checkout fields with Wix](docId\:o3nDhZBCxisWH6M6satDt) by default. If you access to a developer, it is however possible to use custom fields using the API. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to learn more. | | `Additional fees` | SparkLayer does not currently support the Wix "additional fees" functionality ([learn more here](https://support.wix.com/en/article/wix-functions-adding-additional-fees-at-checkout)) | | `Pickup & local delivery` | SparkLayer does not currently support [Local Delivery](https://support.wix.com/en/article/wix-stores-setting-up-local-delivery) as a shipping option during the checkout. If you do require this as a shipping option, we suggest using the SparkLayer [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) tool and adding this as a 'manual' shipping method. | | `Subscriptions` | SparkLayer does not currently support subscription programmes within Wix | | `Loyalty` | SparkLayer does not currently support loyalty programmes within Wix | | `Digital products` | SparkLayer does not currently digital products within Wix | | `Discounts and coupons` | It is not possible to use the built-in Wix discount system alongside SparkLayer. If you require discounts, please use the SparkLayer [discount engine](docId\:WrejPw9URyjQwiQeKs_Cg). | | `B2B Label` | You must use the "B2B" label for SparkLayer to work, however you are able to rename the B2B label. If you have already used "B2B" and renamed this, if you go to create another "B2B" label it will actually be "B2B+x" | | `Tax Exemptions` | Tax exemptions will only be honoured when the customer checkout out using the Wix checkout (Upfront Payment). If you use manual payment methods Tax will be charged in the checkout | [title] WooCommerce Metafields & Data Mapping [path] Integrations/WooCommerce/ ## Introduction Metafields help you to customise the functionality and appearance of your WooCommerce store by letting you save specialised information that isn't usually captured in the WooCommerce admin. You can use metafields for internal tracking, or to display specialised information on your online store in a variety of ways. In the context of SparkLayer, metafields are used to capture additional B2B data that you can then use in a variety of ways: | Type | Details | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product metafields` | Updating the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) by adding configurations such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [RRP prices](docId\:S_VTlJBorGmnwjjfSMom9), and more | | `Customer attributes` | Updating a customer's information by adding information such as [credit limits](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Order metafields` | Updating an order with [invoicing information](docId\:yWm70oQUosyKOoIqb4Z4G) | *** ## How to add metafields to WooCommerce The easiest way to add metafields is to action this via the SparkLayer Dashboard. Simply go to **Integrations > Platform Connection** and click "Configure" under "Configure metafields". You can then select which of the SparkLayer [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) you'd like to enable. ## Important considerations In order for SparkLayer to work with WooCommerce metafields, please note the following: :::hint{type="warning"} **Product metafields** Metafields are always added at the product variant level, even if the product only comes in a single variant. **JSON data** Some SparkLayer settings require metafields to be set up as JSON strings. These will need to be carefully added, making sure the formatting is set correctly. ::: *** ## Advanced settings To learn about more advanced settings, including customer-level product metafield settings, please see [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) [title] Installing SparkLayer on WooCommerce [path] Integrations/WooCommerce/ ## Introduction SparkLayer enables B2B functionality on your existing WooCommerce store, allowing your B2B customers to login, place orders, manage their account, and much more.  To familiarise yourself with SparkLayer, we also recommend reviewing the following guides: ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [How SparkLayer Works](docId:_2g8HwCXnN7OFy4o199y1) The fundamentals of what SparkLayer does ::: :::LinkArrayItem [Frontend](docId\:OgKfvQX13dHW2582D57kJ) The special "interfaces" SparkLayer enables ::: :::LinkArrayItem [Features](docId\:SSzdKXuNMlEIDOOITHQcU) The available features and functions. ::: :::: *** ## ⚠️ Requirements - important! Before installing SparkLayer on your WooCommerce store, please ensure the following: | Item | Details | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `WooCommerce` | You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website
* WooCommerce: version 9 and above * Wordpress: version 6 and above
If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). | | `Product SKUs` | In order for SparkLayer to save B2B prices for your products, all products must have **SKUs**. | | `Customers` | For your B2B customers to see the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa), they must be assigned an appropriate B2B "Role" within Wordpress > users | | `Payment Processor` | If you’re installing SparkLayer on a test store, please ensure you have an example payment method enabled. You can manage this within WooCommerce > Settings > Payments | | `Shipping` | In order to place an order via the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), please ensure you have shipping rules set up. You can manage this within WooCommerce under Settings > Shipping or via SparkLayer's own [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) solution | **Areas of Wordpress/WooCommerce you'll be using** As part of setting up SparkLayer, you'll primarily be using the following areas: | Area | Details | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Products` | This will be used to setup which products you want to make available to B2B customers. See "Setting up your B2B pricing" below.
*In Wordpress/WooCommerce, go to Products* | | `Users` | This will be used to setup your B2B customers. See "Setting up your B2B customers" below
*I**n* *Wordpress/WooCommerce**, go to Users* | | `Orders` | This will be used to review and process and orders that are placed by your B2B customers. See "Placing a B2B order" below.
*In Wordpress/WooCommerce, go to Orders* | *** ## 🔗 Connecting your WooCommerce store :::hint{type="info"} **Please note** Setting up SparkLayer will require generating API keys within your WooCommerce store. If you're unsure how to do this, our team is happy to assist. To get in touch, please [click here](docId\:NNUw1G9z7eaJ4M78vk7t9). ::: To get started with SparkLayer on your WooCommerce store, there are a number of steps to follow. Once you've completed this step, you can then begin the process of configuring SparkLayer such as pricing and customer rules. ::::WorkflowBlock :::WorkflowBlockItem **Install the SparkLayer plugin** First, you'll need to install the SparkLayer for WooCommerce plugin on your Wordpress store. This works just like any other manually installed plugin and you can see [full details here](https://wordpress.com/support/plugins/install-a-plugin/). ::File{src="https://archbee-doc-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/asHW769jR5kqneAYXGKrK-20251111-132502.zip" label="SparkLayer Plugin for WooCommerce.zip"} ::: :::WorkflowBlockItem **Register with SparkLayer** Next, you'll need to create a SparkLayer account by [registering here](http://app.sparklayer.io/register) ::: :::WorkflowBlockItem **Connect your WooCommerce Store** Once registered, go to [Integrations > Platform Connection](https://app.sparklayer.io/integrations/platform) and select WooCommerce. You'll then be prompted to enter your store URL (this should be the URL of the website you are installing SparkLayer on, e.g. `www.mystore.com`) ::: :::WorkflowBlockItem **Generate API credentials** Next, you'll need to generate REST API credentials within WooCommerce. From your WordPress dashboard, you can find this within WooCommerce > Settings > Advanced > REST API Create the REST API key with a username easily identifiable as linked to SparkLayer, such as **“SparkLayer API”** with Read/Write permissions. ::: :::WorkflowBlockItem **Enter the API credentials in SparkLayer** From with the SparkLayer Dashboard [Integrations > Platform Connection](https://app.sparklayer.io/integrations/platform) paste the provided key and secret into the **“WooCommerce API Key”** and **“WooCommerce API Secret”** fields. Press save and wait a few seconds whilst SparkLayer connects to the WooCommerce store and performs the SparkLayer plugin initialisation. ::: :::WorkflowBlockItem **Store connected** This completes the process of connecting your WooCommerce store to SparkLayer! You can view all associated settings in WooCommerce by going to **WooCommerce > Settings > Integrations > SparkLayer B2B.** ::: :::: *** ## 🚢 The Onboarding process :::hint{type="info"} **Important** When setting up SparkLayer, some activities take place via the [SparkLayer Dashboard](https://app.sparklayer.io/) alongside WooCommerce. You'll use the SparkLayer Dashboard primarily for setting up your B2B pricing and B2B customer rules. ::: When you create an account on SparkLayer, you'll get access to the [SparkLayer Dashboard](https://app.sparklayer.io/). The Dashboard has a customised onboarding process that gently guides you through all the necessary steps before you're ready to start inviting your B2B customers and taking orders on your website. ::::WorkflowBlock :::WorkflowBlockItem **📓 Setting up your B2B price lists** You'll then set up the B2B price lists that you want your customers to see when they login. These can be automated or you can manually upload specific pricing. ➡️ [View in dashboard](https://app.sparklayer.io/pricing) ::: :::WorkflowBlockItem **👪 Setting up your B2B customers** You'll then set the ordering rules for your customers such as minimum order values, available payment methods and price lists they are assigned to. ➡️ [View in dashboard](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem **🛠️ Installing the frontend widgets** You'll need to check the special code snippets ("widgets") are installed on your WooCommerce store in order to show the special SparkLayer B2B interfaces. ➡️ [View in dashboard](https://app.sparklayer.io/integrations/widgets/core) ::: :::WorkflowBlockItem **✅ Testing & launching** You'll then need to run through some final checks (such as placing a test order). Once you're happy, you can then launch SparkLayer and start taking orders! ➡️ [View in dashboard](https://app.sparklayer.io/configuration/onboarding) ::: :::: Let's now dive into each of them! *** ## 📓 Setting up your B2B pricing :::hint{type="warning"} **Please note** Setting up your B2B pricing happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your WooCommerce admin. ::: Within the [Price Lists](https://app.sparklayer.io/pricing) area of the SparkLayer Dashboard, you can create and manage your B2B pricing rules.  SparkLayer allows you to set the following pricing types: | Type | Details | | ----------- | --------------------------------------------------------------------------------------------------------------------------- | | `Manual` | You can manually upload a CSV file with specific prices and even enable quantity pricing | | `Automatic` | You can use your WooCommerce prices and apply a discount. You can choose from your main WooCommerce price or the RRP price. | ::::WorkflowBlock :::WorkflowBlockItem For any products that you want your B2B customers to be able to buy, these products **must** have unique SKUs assigned. In WooCommerce, you can check this by going to **Products** and editing a product. If it's a single variant product, you'll see this under **Product data > Inventory**.  If the product has variants (or "Variations"), you'll see this under **Product data > Variations**.  ::: :::WorkflowBlockItem Next, go to [Price Lists](https://app.sparklayer.io/pricing/lists) within SparkLayer and click "Create Price List" to create your first B2B Price list. You can choose between an automatic or manual price list and configure how this works. ::: :::: :::hint{type="success"} **Ready to set your pricing?** To learn more about pricing, please see our [full guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: *** ## 👪 Setting up your B2B customers :::hint{type="warning"} **Please note** Setting up your B2B customer rules happens within the [SparkLayer Dashboard](https://app.sparklayer.io/), not via your WooCommerce admin. ::: [Customer Groups](https://app.sparklayer.io/customers/groups) let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out. Much like with Price Lists, you can fully manage this via the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups). :::::WorkflowBlock ::::WorkflowBlockItem Within Wordpress/WooCommerce, go to **Users** and click **Add User. **You can either create a new customer or edit an existing one. :::hint{type="warning"} **Please note** Please ensure that a valid address is added and all address fields are populated. Make a note of the email address you’ve added as you will need to access this to login. ::: :::: ::::WorkflowBlockItem To synchronise to SparkLayer, under **SparkLayer Role**, the customer must be assigned to a Role that correlates to a [SparkLayer Group](https://app.sparklayer.io/customers/groups). For example, if you're using the "Base" group in SparkLayer, you'll see a role called **"SparkLayer B2B: Base"**. Once the customer signs in, they'll see the B2B rules you've configured within the [customer group](https://app.sparklayer.io/customers/groups).  :::hint{type="warning"} **Please note the following on customer groups** - SparkLayer will only synchronise customers that have a role assigned that starts with `SparkLayer B2B` ::: :::: :::WorkflowBlockItem Once your customers have been set up in Wordpress/WooCommerce (i.e. those with a role of "SparkLayer B2B" assigned), and you've assigned the customer group to **at least** one customer, you can then manage specific rules within the [Customer groups area.](https://app.sparklayer.io/customers/groups)  ::: :::WorkflowBlockItem You'll see a default **Base** customer group that you can use for your B2B customers. If you want to set up additional rules, you can simply click **Create Customer Group** and configure accordingly. For any additional customer groups you create, you'll need to update the role on the customer record in Wordpress/WooCommerce to match. ::: :::WorkflowBlockItem To simulate logging in as a B2B customer, please see **✅ Testing & launching** below. ::: :::WorkflowBlockItem You can also check if your customer record is syncing by using the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. Within Wordpress/WooCommerce, navigate to a Contact record that has a label of b2b. Within the URL, you'll see a unique ID at the end of the URL, e.g. `?user_id=3` With this unique ID, you can then paste this into the [Customer Sync](https://app.sparklayer.io/data-sync/customers) area of SparkLayer. If the search results show the customer details, this confirms the customer is synchronising correctly. ::: ::::: :::hint{type="success"} **Ready to configure your customer groups?** To learn more about customer groups, please see our [full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: *** ## 🛠️ Installing the frontend widgets SparkLayer comes with ready-made B2B-optimised "widgets" that we collectively call the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ). The widgets simply overlay sections of your existing WooCommerce store and enable our powerful B2B features.  Once set up, your approved B2B customers (see above "Setting up your B2B customers") will then see your B2B pricing and can begin placing orders. You can learn more about how this works in [our guide here](docId\:ccZ1vnH0O6D_722w35Xpa). :::hint{type="success"} **Auto-installation with "Theme blocks"** If your theme support blocks, when you install SparkLayer, it will by default add the special frontend widgets to your WooCommerce store. Depending on your WooCommerce theme, you may prefer to do this manually and you can follow our steps below. ::: **Installing SparkLayer yourself** If you’re looking to install yourself, there are five steps to follow. ::::::WorkflowBlock :::WorkflowBlockItem **Install the **[SparkLayer Core Script ](https://app.sparklayer.io/configuration/frontend/core)Within your main website header you'll need to add the SparkLayer Core Script that activates the SparkLayer functionality. Providing your stores theme outputs the `wp_head()` functional call in the `` section of the template, then the SparkLayer core script should automatically be injected on your page. ::: :::::WorkflowBlockItem **Install the **[Product Detail Interface](https://app.sparklayer.io/configuration/frontend/pdp) You'll need to update your storefront's product detail page with the SparkLayer Product Purchasing Interface. When a customer logs in and SparkLayer recognises them as being a B2B customer, this will load a special interface with their specific prices and a way to purchase. ::::ExpandableHeading **🛠️ View instructions** ```javascript
This will allow the customer to checkout **without** needing to enter any payment details. | | `Payment by invoice` | **👪 For the B2B customer:**
This will allow the customer to checkout **without** having to enter in payment details. | | `Pay Online by Card` | **👪 For the B2B customer:**
The customer will be directed to your **standard checkout process **and will be required to make payment right away (e.g. by card or via another payment processor). | **How orders arrive into WooCommerce**  Depending on which [payment method](docId\:ibIKczvHM085BkeJIfFYv) you've selected, orders will arrive into WooCommerce in the following ways: | Payment Method | Flow | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Pay by Invoice` | The order will be created within ** WooCommerce > Orders** with a payment status of "Pending Payment". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay on Account` | The order will be created within ** WooCommerce > Orders** with a payment status of "Pending Payment". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Pay Online by Card` | The order will be created within **WooCommerce > Orders** with a payment status of "Completed" providing you have this already configured within WooCommerce. You can then proceed to fulfil the order. Note: this is termed "Upfront Payment" within the [Customers](docId:5_lWMNohhjBJJppg9E6Vh) area of the SparkLayer Dashboard | **"Unpaid" orders and "Paid" orders** By default **all payment methods** other than Upfront Payment will be generated as "Pending Payment" orders. You will need to capture payment either via your WooCommerce Admin or via offline methods (e.g. bank transfer) **WooCommerce checkout payment methods** If a customer selects "Pay Online by Card" (i.e. "Upfront payment"), they'll be directed to the WooCommerce checkout. By default, they will see all WooCommerce payment methods you have set up (e.g. card payment, Paypal, etc). **Additional order details** When an order is placed via SparkLayer, it will also include the following additional data: | Attribute | Notes | | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `Custom Fields` | When viewing an order in WooCommerce, you'll see a section **"SparkLayer Order Information" **which will include the Payment Method used. | *** ## ✅ Testing & launching The final step is to run some tests and checks to ensure SparkLayer is fully configured. Within the SparkLayer Dashboard, you'll see a number of [Launch checks](https://app.sparklayer.io/?expand=launch) to perform, from logging in as a B2B customer, through to placing an order. We recommend following the below steps: ::::WorkflowBlock :::WorkflowBlockItem **Set up a customer record** Within your Wordpress/WooCommerce admin, you'll need to ensure you have an example customer record set up (either a new one or an existing). Most importantly, a customer must be associated with an appropriate role. *Please see "Setting up your B2B customers" above for more details on how this works.* ::: :::WorkflowBlockItem **Place a test order** Once you've logged in as a B2B customer, proceed to add items to your cart and complete the checkout. Please see *"Placing a B2B order"* above for more details on how this works. ::: :::WorkflowBlockItem **Invite your customers** You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::: *** ## ⚙️ Advanced configurations In addition to the above setup, there are a number of other configurations that are possible at this time. :::ExpandableHeading **Displaying stock (inventory) levels** You can configure SparkLayer to show [stock levels](docId\:Gj_Ao_gQ6oA-jx0D27Hys) in a variety of ways. If you want to show inventory numbers (e.g. 100), you'll need to make sure this is turned on within WooCommerce. Within WooCommerce, go to Settings > Products > Inventory and turn on **Manage stock** You can also display this on the SparkLayer widgets (the product cards) by going to WooCommerce > Settings > Integrations > SparkLayer B2B. ::: :::ExpandableHeading **Adjusting tax settings** SparkLayer supports tax calculations and simply 'inherits' the rules you've set up in your WooCommerce settings. You can learn more about how tax works [in this WooCommerce guide](https://woocommerce.com/document/setting-up-taxes-in-woocommerce/). ::: :::ExpandableHeading **Enabling SparkLayer JavaScript modifications (e.g. checkout customer fields, language updates)** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your WooCommerce theme store. You can access this by going to **WooCommerce > Settings > Integrations > SparkLayer B2B.** Under "Core Script Options" you can add the below code. ```javascript { termsAndConditionsLink: "/policies/terms-of-service", checkoutCustomElements: [ { name: 'shipping-date', translations: { en: { title: 'Preferred Shipping Date', detail: 'Shipping unavailable on weekends.', }, }, attributes: { required: true, type: 'date', }, }, ], } ``` ::: :::ExpandableHeading **Enabling a URL redirect when signing in ** SparkLayer supports a range of advanced configurations that rely on updating JavaScript via **"Spark Options"**. Within our [Configurations](docId\:SBEaOaCq_A7FfbTatX8bD), you can apply any of the modifications by updating the code within your Wix store. You can access this by going to **WooCommerce > Settings > Integrations > SparkLayer B2B.** Under **"Core Script Options"** you can add the below code. ```javascript { accountRedirect: { urlRegex: /\/account/g, goTo: "/index", // page to redirect logged in users to }, } ``` ::: :::ExpandableHeading **Enabling "Dark mode" for high contract websites** If your Wix store is set up with a darker theme, it's possible to enable a special "Dark Mode" for SparkLayer, ensuring colours and fonts are easily readable.  You can access this by going to **WooCommerce > Settings > Integrations > SparkLayer B2B.** Under **"Core Script Options"** you can add the below code. ```javascript { display: { darkTheme: true, }, } ``` ::: :::ExpandableHeading **Enabling SparkLayer shipping methods** SparkLayer has a built-in [Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) system that lets you customise how shipping works for your B2B customers. By default, your existing shipping methods in your WooCommerce Dashboard will be used, however it's possible to update this to use SparkLayer via the [SparkLayer Dashboard here](https://app.sparklayer.io/configuration/shipping). ::: :::ExpandableHeading **Enabling pre-order (or "back orders")** SparkLayer has built-in support for pre-orders (someimtes referred to as "back orders"). Once enabled, this will then show a message to the B2B customer on the product page and allow purchasing.  ::: *** ## 📁 Troubleshooting To troubleshoot the most common issues (such as issues with pricing), please see [our guide here](docId\:BlCEkkx3I30nkUcglsfw7). You can also [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to assist. *** ## ℹ️ Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for WooCommerce?** All SparkLayer plans are compatible with WooCommerce, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via the SparkLayer Dashboard under Acccount > Plan ::: ### WooCommerce setup :::ExpandableHeading **Where do I find the SparkLayer WooCommerce app?** Currently, SparkLayer can only be setup on your WooCommerce store by registering directly via [SparkLayer](http://app.sparklayer.io/register) ::: :::ExpandableHeading **What WooCommerce plan do I need to be on to use SparkLayer?** You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website - WooCommerce: version 9 and above - Wordpress: version 6 and above If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing WooCommerce DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.woocommerce.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **Can you help me install SparkLayer on my WooCommerce website?** By default, the SparkLayer widges will be automatically installed on your store. If you do require assistance, you can [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we will be happy to advise. ::: :::ExpandableHeading **Does SparkLayer work on any WooCommerce theme?** You must already have [WooCommerce](https://woocommerce.com/) installed on your Wordpress website - WooCommerce: version 9 and above - Wordpress: version 6 and above If you're using a "Block theme", SparkLayer can be automatically installed (otherwise this is a manual installation process). ::: :::ExpandableHeading **How does SparkLayer affect my current WooCommerce theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your WooCommerce store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the WooCommerce checkout. From there, any payment methods you have set up in WooCommerce (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if WooCommerce support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. You could also configure your WooCommerce theme to hide and show products based on tag via custom coding. ::: :::ExpandableHeading **Can I use my WooCommerce prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your WooCommerce prices (e.g. your main WooCommerce retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your WooCommerce prices and we can even make provisions for your tax set up in WooCommerce (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within WooCommerce, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Wix so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Wix, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Wix 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in WooCommerce to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. It's also worth noting that you can manually add customers via the admin by going to **Wordpress/WooCommerce > Users** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. You could think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my WooCommerce website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my WooCommerce website?** This is possible but would require custom coding. We recommend consulting with a WooCommerce expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in WooCommerce?** | Payment Method | Notes | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by Invoice` | The order will be created within **WooCommerce > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Payment on Account` | The order will be created within **WooCommerce > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Upfront Payment (Card payments)` | The order will be created within **WooCommerce > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. | ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within WooCommerce when an order is placed via SparkLayer providing payment hasn't already been processed. From WooCommerce > Oders, navigate to an order. You'll then see the option to **Edit order** allowing you to make changes. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: [title] Shopify Email Notifications [path] Integrations/Shopify/Shopify Customisations/ :::hint{type="warning"} **Important to note** If you are looking to customise the behaviour of your Shopify emails and notifications, we strongly recommend engaging a Shopify expert to assist. Whilst we can provide an overview of how to approach making customisations, our team cannot assist in applying any code changes. ::: ## Including B2B-specific content in an email If you need to show B2B-specific content in your Shopify email notifications, it's possible to add special code snippets that give this flexibility. To get started, go to the [Shopify Notifications admin](https://admin.shopify.com/settings/notifications) and load the template you want to edit, e.g. the Order confirmation. Within the code, simply add the following code snippet and adjust as required. ```html {% for tag in customer.tags %} {% if tag == 'b2b' %} Content to show to B2B {% else %} Content to show to DTC {% endif %} {% endfor %} ``` To test your changes, you'll need to trigger the email notification (e.g. by placing a real order) and we advise testing with a customer that has been tagged with `b2b` and one that hasn't. *** ## Including Additional details (order Note attributes) If you want to show additional data within your notifications, you can include the special order note attribute variables. For example, you may want to show a delivery date or a payment method to the customer.  Within the Shopify notification emails, simply add the following code to the following files: - [Order confirmation](https://admin.shopify.com/email_templates/order_confirmation/preview) - [Order invoice](https://admin.shopify.com/email_templates/order_invoice/preview) - [Draft order invoice](https://admin.shopify.com/email_templates/draft_order_invoice/preview) ```html
Name of field: {{ attributes.Name of Field }}
Name of field: {{ attributes.Another Name of Field }}
``` For example, if you wanted to show the shipping date and the payment method in our example above, you would add the below. ```html {{ attributes.shipping-date }} {{ attributes.sparkPaymentType }} ``` This code will need to be added in an appropriate location and may need to be adjusted based on how your emails are formatted. You can also show the order note by including the below code: ```html {% if note != '' %} Note: {{ note }} {% endif %} ``` *** ## Hide discount pricing from showing It's also possible to hide the discounting pricing from showing if you would prefer to just show the final price.  Within the Shopify notification emails, simply add the following CSS to the following files: - [Order confirmation](https://admin.shopify.com/email_templates/order_confirmation/preview) - [Order invoice](https://admin.shopify.com/email_templates/order_invoice/preview) - [Draft order invoice](https://admin.shopify.com/email_templates/draft_order_invoice/preview) This code will need to be added before the closing `` tag in each email template. ```css {% for tag in customer.tags %} {% if tag == 'b2b' %} {% else %} {% endif %} {% endfor %} ``` *** ## Customise the payment methods The order notification email will by default show a payment method at the bottom. It's possible to customise what is shown here by adding the below code to the Order confirmation email. ```html {% assign sparkPaymentType = attributes.sparkPaymentType %} {% if sparkPaymentType == 'paymentByInvoice' %} Invoice Payment [change this to the required payment name] {% endif %} ``` *** ## B2B customer account invite email Depending on how you've set up your [Customer Accounts ](https://admin.shopify.com/settings/customer_accounts)in Shopify, you can customise the notifications that are sent to your B2B customers. :::hint{type="info"} **Using Customer accounts ("New customer accounts")** If you're using Shopify "Customer Accounts", you can simply direct your customers to your website's login page (e.g. `yourstore.com/account`) and they can then enter their email to receive a 6-digit access code. At this time, it is not possible to customise the email that is sent to the customer. ::: If you're using "**Legacy accounts**" and you're creating a brand new customer record, you'll need to click "**Send account invite". **  This will then send the customer an "account invite" email with details on how to activate their account by setting a password ([learn more here](https://help.shopify.com/en/manual/customers/customer-accounts#invite-customers-to-create-accounts)).  By default, the email contents are relatively basic and you may want to enhance what is shown to the customer. You can also edit the contents of this email by going to Settings > Notifications within your [Shopify admin here](https://admin.shopify.com/settings/notifications/customer). Under "Accounts and outreach", you'll see all related emails that can be modified. In the case of the "customer account invite", you can edit the contents [of this email here](https://admin.shopify.com/email_templates/customer_account_activate/preview). You could go a step-further and even make the contents specific to your B2B customers by using our guide above "Including B2B-specific content in an email"). Should you require, you can also edit further customer-related emails such as the "account welcome", "password reset" and more.  [title] Shopify Metafields & Data Mapping [path] Integrations/Shopify/ ## Introduction :::hint{type="success"} **See what's possible with metafields** To see all available metafields for SparkLayer, please see our [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) guide. ::: Metafields help you to customise the functionality and appearance of your Shopify store by letting you save specialised information that isn't usually captured in the Shopify admin. You can use metafields for internal tracking, or to display specialised information on your online store in a variety of ways. For full details, please refer to this [official Shopify guide](https://help.shopify.com/en/manual/custom-data/metafields). In the context of SparkLayer, metafields are used to capture additional B2B data that you can then use in a variety of ways: | Type | Details | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product metafields` | Updating the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) by adding configurations such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [RRP prices](docId\:S_VTlJBorGmnwjjfSMom9), and more | | `Customer metafields` | Updating a customer's information by adding information such as [credit limits](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Order metafields` | Updating an order with [invoicing information](docId\:yWm70oQUosyKOoIqb4Z4G) | :::hint{type="warning"} **Important considerations** In order for SparkLayer to work with Shopify metafields, please note the following: - **Product metafields** Metafields are always added at the product variant level, even if the product only comes in a single variant. - **JSON data** Some SparkLayer settings require metafields to be set up as JSON strings. These will need to be carefully added, making sure the formatting is set correctly. ::: *** ## Automatically adding metafields Within the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/integrations/platform), you can speed up the creation of metafields using our built-in tool to automatically configure them. ::::Tabs :::Tab{title="🛍️ Using Shopify"} To get started, go to **Integrations, Platform Connection** 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](https://admin.shopify.com/settings/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](https://admin.shopify.com/settings/custom_data) section within your Shopify store. ::: :::: *** ## Manually adding metafields :::hint{type="info"} **Please note** Shopify has built-in ways to set up metafields and we recommend referring to their [official Shopify guide](https://help.shopify.com/en/manual/custom-data/metafields) on the best ways to do this. ::: Within your Shopify store, navigate to **Settings** and click **Custom Data** and you'll see an interface similar to the below.  In this example, you can see how [RRP (MSRP) pricing](docId\:S_VTlJBorGmnwjjfSMom9) is set up at a variant level and we've also included a video below to see the full steps.  ::embed[]{url="https://www.youtube.com/embed/Duue-ZGKp3A"} ### Setting up product metafields :::hint{type="success"} **See what's possible with product metafields** To see all available metafields for SparkLayer, please see our [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) guide. ::: :::hint{type="warning"} **Metafields at a variant level** Generally speaking, in the context of SparkLayer, all metafields are added at the [variant level](https://admin.shopify.com/settings/custom_data/productvariant/metafields) not the product level. This is very important to remember when configuring any metafields that you're looking to add. ::: :::Iframe{iframeHeight="0" code=""} ::: When setting up metafields in Shopify, you'll be required to specify the following at a minimum: | Item | Details | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `Metafield type` | This sets the data type, e.g. a text field, JSON, a selection of values | | `Namespace` | This defines the category and naming convention of the metafield. In the case of SparkLayer, this must be set as `sparklayer` | | `Key` | This defines the key to use, e.g. `pack_size` | | `Value` | This is then added against a product variant within Shopify (see below) | When you're setting up the Namespace and Key via the Shopify admin, you'll be required to "combine" this in the "Namespace and key" field. In our example below, we've illustrated how this works for [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), entered as `sparklayer.pack_size`. :::Iframe{iframeHeight="0" code=""} ::: ### Setting up customer metafields :::hint{type="success"} **See what's possible with customer metafields** To see all available metafields for SparkLayer, please see our [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) guide. ::: Customer metafields work in just the same way as product metafields (see above) and, once they are setup within Shopify, you can navigate to any customer record and add or edit data as required. In our example below, we've set up [payment terms](docId\:yWm70oQUosyKOoIqb4Z4G), a [sales agent group](docId\:Uw8mDbMEfwWKqZrVB5CqX), and a [customer-specific discount](docId\:v8dVUcJ7Ju0fH7BvINrEw).  ### Populating metafields Once you've set up metafields, you can navigate to a product, customer, or order record within Shopify and add your SparkLayer settings within the fields shown.  *** ## Importing metafields in bulk Currently, Shopify offers no "built-in" way to bulk import metafield data at a variant-level so it's necessary to use third-party apps to get around this. One of the most recommended, is an app called [Matrixify](https://apps.shopify.com/excel-export-import) which allows you to easily "map" metafield data and import in bulk. *** ## Order Data :::hint{type="success"} **See what's possible with order metafields** To see all available metafields for SparkLayer, please see our [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) guide. :::  When an order is passed to Shopify, the following attributes are attached to the order: | Attribute | Notes | | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `note` | Order Note: `sparkCartId`This is added as an **order note.**
This is primarily for internal use for debugging | | `note` | Order Note: `sparkPaymentType`
This is added as an **order note.**
This contains the name of the payment option used:
* upfrontPayment * paymentOnAccount * paymentByInvoice * quote | | `tag` | A tag of `b2b` is added to any order placed via SparkLayer | On each line item, there is also a `Charged Price` attribute which contains the final line item price. ### Order Mapping | Shopify | Spark Layer | | ------------------------------------------------------ | ---------------------------------------- | | `processsed_at` | `created_at` | | `id` | `external_id` | | `name` | `visible_id` | | `currency` | `currency_code` | | `note` | `customer_reference` | | `customer.id` | `customer_id` | | `billing_address` | `billing_address` | | `shipping_lines[0].title` | `packages[0].shipping_name` | | | `packages[0].shipping_sku` === 'shopify' | | `shipping_address` | `packages[0].shipping_address` | | `shopifyOrder.shipping_lines[X].price (SUM)` | `packages[0].total_shipping_.gross` | | `shopifyOrder.shipping_lines[X].tax_lines.price (SUM)` | `packages[0].total_shipping_.net` | | `line_items[T].name` | `packages[0].items[T].name` | | `line_items[T].quantity` | `packages[0].items[T].quantity` | | `line_items[T].id` | `packages[0].items[T].variant_id` | | `(T)` | `packages[0].items[T].line_total.gross` | | `(T)` | `packages[0].items[T].line_total.net` | ### Order history: importing orders into SparkLayer It's possible to import historic B2B order data into SparkLayer, allowing customers to see their previous order history once they access their account on your store. To do this apply a metafield as shown below: | Item | Details | | ------------------ | --------------------------------------- | | `Custom data type` | Order | | `Metafield type` | This must be set as an `boolean` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `order_import` | | `Value` | This must be set as a boolean of `true` | Any orders that are imported this way must also have a tag of `b2b` assigned to them within Shopify. If you're working with a large data set and would prefer to do this manually, you can instead use order metafields within Shopify to do this. Our recommendation is to use a bulk import tool such as [Matrixify](https://apps.shopify.com/excel-export-import?st_source=autocomplete) to manage this more quickly. When importing using this tool, you can use the format below simply by adding the Shopify order ID in the `ID` column. We also have a [sample CSV template](https://cdn.shopify.com/s/files/1/0612/7602/9065/files/example-historic-order-import.csv?v=1738672207) you can start with. | ID | Metafield: sparklayer.order\_import \[boolean] | Command | | ----------------- | ---------------------------------------------- | -------- | | `[order-id-here]` | `TRUE` | `UPDATE` | :::hint{type="warning" attributes="[object Object]"} **Please note** The note attribute must be added to the order **after** SparkLayer is installed for the order to be synchronised correctly. Orders synced in this way can then be reported upon and will appear in the Orders section of the SparkLayer Dashboard. ::: ### Order ID ("Visible ID") and setting a custom order number It's possible to use a custom order ID instead of the standard order ID generated from Shopify. A typical use-case is customising the Order ID to match order numbers generated from a back-office system (e.g. an ERP), ensuring consistency across systems. When the "Visible ID" is set, this will then take effect when the customer views their orders from the [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP).  | Item | Details | | ------------------ | ------------------------------------------ | | `Custom data type` | Order | | `Metafield type` | This must be set as an `single line text ` | | `Namespace` | This must be set as `sparklayer` | | `Key` | This must be set as `visible_id` | :::hint{type="warning" attributes="[object Object]"} **Please note** If you're using the "Visible ID" configuration, any orders that do not have this populated will fallback to the standard Shopify order number. ::: *** ## Advanced settings To learn about more advanced settings, including customer-level product metafield settings, please see [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) [title] Shopify Payment Methods [path] Integrations/Shopify/Shopify Customisations/ ## Managing "offline" payments SparkLayer supports the ability for customers to use offline payments such as "Pay by Invoice" and "Pay on Account" that allows you to review their orders before processing them. Once enabled for a [customer group](docId:5_lWMNohhjBJJppg9E6Vh), this will show as a payment method within the checkout flow.  When a customer selects "Pay on Account" or "Pay by Invoice", the flow works as follows: **A Draft Order is created** When a customer places an order as a quote, the order will by default enter Shopify in the **Draft order** status. Just as with any order in Shopify, you'll see the customer's details on the top right and you can review and edit their order contents.  **Sending an invoice** To send an invoice, simply click the Send invoice button beneath the order totals.  This will then trigger an email to the customer where they can they review the order and make payment online. :::hint{type="info" attributes="[object Object]"} You can edit this email template by going to **Settings > Notifications** within Shopify and search for the **Draft order invoice** template ::: Once the customer completes their purchase by making payment, the order is then marked as paid and will then display within your **Shopify Orders** area. If you are looking for other ways to manage invoicing, please see [our guide here](docId\:yWm70oQUosyKOoIqb4Z4G). *** ## Hiding payment methods in the checkout By default, when your B2B customers select "Pay Online by Card", they'll be taken to the Shopify checkout and will see all Shopify payment methods you have set up (e.g. card payment, Paypal, etc). You can learn more about [Shopify payment methods here](https://help.shopify.com/en/manual/payments/additional-payment-methods).  It's possible to **conditionally** hide and show payment methods should you require your B2B customers to only see specific payment types when they checkout. - To get started, visit the Shopify App store and search for apps that support "hiding payment methods". One such app is ["ETP Hide and Sort Payment Methods"](https://apps.shopify.com/etp-hide-sort-payments?) - Within the app, you can then configure rules. To detect a B2B customer, simply add a rule that filters on a tag of `b2b` being present. - It's important to note that the payment type "Credit card" can only be hidden if your Shopify store is on the Shopify Plus plan (this is due to limitations with the *Shopify Payment Customization API*) In the example below, the payment types "Paypal" and "Cash on Delivery (COD)" have both been hidden for B2B customers.  [title] Shopify B2B Dawn Theme [path] Integrations/Shopify/  ## Introduction Dawn is the first free [Online Store 2.0](https://themes.shopify.com/themes/dawn/styles/default) theme released by Shopify and is the ideal way to start configuring your Shopify store in a best-practice way. When you create a Shopify store for the first time, your store will by default use this theme and you can also use it for your existing Shopify store. :::hint{type="info"} **Learn more** You can [learn more](https://help.shopify.com/en/manual/online-store/themes/os20/themes-by-shopify/dawn) about the Dawn theme and [see it in action here](https://themes.shopify.com/themes/dawn/styles/default). ::: To make it easy to get up and running with SparkLayer, we've created a **B2B optimised version** of the Dawn theme that you can download, configure, and then customise. The B2B optimised Dawn theme brings the following features: - SparkLayer frontend code snippets fully installed - The ability to restrict access with an optional login screen - The ability to hide prices until a B2B customer signs in - The ability to set B2B-only products that only show when a B2B customer signs in :::hint{type="success" attributes="[object Object]"} **Try the demo** You can try our [Shopify Dawn demo store here](https://standalone.demo.sparklayer.io/) ::: *** ## How it works The SparkLayer B2B optimised version of Dawn works by adapting specific parts of the Dawn theme, activating the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) as well as enabling a special login page. You can see how it works in our video below ::embed[]{url="https://www.youtube.com/watch?v=5bo9nCvSJCM"} The B2B optimisations include: - **A login page** that optionally forces the customer to sign in before accessing the store and allows prospective customers to apply for an account. This content for this page can be customised via the *Shopify Customizer* - [Product Card Interface](docId\:Mrp_Z0QIZQ2QksseuJylv) that display on collection pages, showing the customers B2B pricing and the ability to add to an order - [Product Detail Interface](docId\:JkCjbYUAnjzp75I8ul7MT) that show the customers B2B pricing and the ability to add to an order - [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP)** and **[My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-) using the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) - A **Quick Buy mode** that lets customers quickly build orders :::hint{type="info"} **Please note** - The Dawn theme is maintained and built by Shopify and may be subject to periodic updates inline with their own releases. ::: *** ## Manually installing To get started, you'll **first** need to install the Dawn theme on your Shopify store and then action a number of specific code changes. There are three ways to go about implementing the code snippets: 1. **Download our code samples** and simply replace the matching files within your Shopify theme: ideal if you've made no changes so far to your Dawn theme. 2. **Download the full repository** via [Github here ](https://github.com/sparklayer-io/dawn/archive/refs/heads/main.zip)and then [uploading as a new theme](https://help.shopify.com/en/manual/online-store/themes/adding-themes#upload-a-theme-file-from-your-computer) in your Shopify store. 3. **Review our code samples** and manually apply them to your theme files: the best option if you've already made customisations to your Dawn theme. Installing the code snippets involves adjusting (or adding) the following files and we've included direct links to Github to see the code. | File Name | Details | Code sample | | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | `layout/theme.liquid` | The code theme file where the SparkLayer core script is installed along with a number of other customisations for CSS and forced login. You'll need to add the [Frontend Integration Guide](docId\:NcgYlSrJkvmtcBoxwVKma) to complete set up | [Click here](https://github.com/sparklayer-io/dawn/blob/main/layout/theme.liquid) | | `templates/page.b2b-login.json` | **A new file** that creates a B2B login page (see guide below) | [Click here](https://github.com/sparklayer-io/dawn/blob/main/templates/page.b2b-login.json) | | `sections/main-b2b-login.liquid` | **A new file** that creates the content for the B2B login page | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-b2b-login.liquid) | | `sections/main-product.liquid` | The product detail page with SparkLayer enabled | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-product.liquid) | | `snippets/card-product.liquid` | The product card with SparkLayer enabled | [Click here](https://github.com/sparklayer-io/dawn/blob/main/snippets/card-product.liquid) | | `templates/customers/register.liquid` | An updated registration page that is required if using the forced login page | [Click here](https://github.com/sparklayer-io/dawn/blob/main/templates/customers/register.liquid) | :::hint{type="success" attributes="[object Object]"} **Using Github?** [Click here](https://github.com/sparklayer-io/dawn) the full Dawn Github repository with changes for SparkLayer ::: *** ## Customisations ### Creating the B2B login page :::hint{type="warning" attributes="[object Object]"} **Important!** If you're wanting to set up a forced login page, please ensure a new page is created in Shopify as detailed below. ::: You can optionally force all customers to login **before** they begin browsing your store and adding products to their B2B order.  **Setting up a new login page** To enable this page, you'll need to create a **Page** within Shopify and then assign this page a special template. ::::WorkflowBlock :::WorkflowBlockItem First, add `sections/main-b2b-login.liquid` ([download here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-b2b-login.liquid)) and the `templates/page.b2b-login.json` ([download here](https://github.com/sparklayer-io/dawn/blob/main/templates/page.b2b-login.json)) files to your theme, ensuring each file goes into the correct directory. ::: :::WorkflowBlockItem Within your Shopify admin, under **Online Store**, click **Pages**, and then click the **Add page** button at the top ::: :::WorkflowBlockItem Give the page a title and then under **Edit website SEO** at the bottom, ensure the **URL and handle** is set to `b2b-login`Under **Online store** and **Theme template**, choose `b2b-login` ::: :::WorkflowBlockItem You can edit how the page looks and functions by going to Online Store > Themes and click the "**Customize**" button. Search for `b2b-login` to begin making changes. You can customise nearly all areas of the page such as colours, form fields, text, and more. To see how the page works, in your browser, visit `www.yourstore.com/pages/b2b-login` and you should see the new login page. ::: :::: :::hint{type="info"} **Learn more** You can learn more about how to customise this page in [our full guide here](docId\:Gfc0UW7mJnMNpnNO6EdRl). ::: ### Enabling the forced login page If you'd rather force customers to login before seeing your store, you can easily adjust this within the `layout/theme.liquid file`. To enable the forced login page, simply change the following code to `true`. ```javascript {% raw %} {% assign showSiteForB2B = true %} {% endif %} {%- if showSiteForB2B == blank -%} {% assign showB2BLogin = true %} {% endif %} {% endraw %} ``` ### Hiding prices by default If you want to **hide prices** until a customer is signed in, you can enable a special setting that will hide prices on product collection and product detail pages.  To enable the hiding of prices, simply set `hidePricesLoggedOut` to `true` in the following files: - `/snippets/card-product.liquid` - `/sections/main-product.liquid` Within the above files, you can also adjust the text and styling that is show to the logged out customer. :::ExpandableHeading **How do I stop my Shopify pricing showing on Google Search?** By default, Google will almost certainly index your Shopify store to show on their search listings. A result of this is your Shopify prices (retail prices) may also show within Google. It's very important to note that this is not related to SparkLayer and is in fact a built-in feature of Shopify. If you do not want your prices to show on Google this is a customisation that would need to be applied via your Shopify store (not via SparkLayer directly). The Shopify support team may be able to best advice here but there are a range of [Shopify community articles](https://community.shopify.com/c/forums/searchpage/tab/message?advanced=false\&allow_punctuation=false\&filter=location\&location=category\:en\&q=hide%20prices%20from%20google) that you can review. Please note, making any changes to your Shopify store in this manner may effect your Google search results and we strongly advise speaking with a Shopify expert before making any changes. ::: *** ## Customising the design Nearly all elements of the login page can be customised via the standard Shopify customisation tools. When you're in the **Customize** mode, navigate to the login page and you'll see all available content that can be modified.  *** ## B2B only products The B2B optimised Dawn theme also has support for B2B only products. This is a great way to **hide specific products** from logged out customers and it's easy to configure within Shopify. The feature works by **automatically hiding** any products that you have tagged with the specific tag `b2b-only` from within the Shopify Products admin.  When you tag a product with `b2b-only`, this product will be invisible to all logged-out customers and won't show on any of your collections pages. If you need to customise this feature, you can edit how it works in the following files: | File Name | Details | Code sample | | -------------------------------------- | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `sections/featured-collection.liquid` | The homepage featured collection | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/featured-collection.liquid) | | `sections/main-collection-grid.liquid` | The main product collection page | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-collection-product-grid.liquid) | | `sections/predictive-search.liquid` | The quick search feature that shows products | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/predictive-search.liquid) | | `sections/main-product.liquid` | The main product detail page | [Click here](https://github.com/sparklayer-io/dawn/blob/main/sections/main-product.liquid) | *** ## B2B only navigation The B2B optimised Dawn theme has support for B2B-specific navigation. This is a great way to have a different navigation based on the customer type, e.g. a B2B customer sees one navigation, a logged-out (DTC customer) sees another. To get started, you'll need to create a new menu in your Shopify store from the "Navigation" section of Shopify (you [can access it here](https://admin.shopify.com/menus)). Proceed to set up your menu and for the **Handle**, enter `b2b-menu,` and click **Save menu**.  To activate the new B2B menu, open and edit the following files and set `showB2BNav` to `true` (as shown below) - `snippets/header-mega-menu.liquid` - `snippets/header-dropdown-menu.liquid` - `snippets/header-drawer.liquid` ```html {% assign showB2BNav = true %} ``` To test this, sign in as a B2B customer and you'll see the navigation on your store. *** ## Quick Buy Mode The B2B optimised Dawn theme also has support for 'quick buy mode' that allows you to display product collection pages in a more streamlined view for your B2B customers. Once enabled, your collection pages will be displayed similar to below with pricing, variant options, product rules (e.g. pack sizing) and the ability to quickly add items to an order. :::hint{type="success" attributes="[object Object]"} **Try the demo** Visit our [Demo site](https://demo.sparklayer.io/) and click [Quick Buy](https://demo.sparklayer.io/collections/sample-quick-buy) once logged in :::  To enable 'quick buy mode', within Shopify, go to **Products** and click **Collections** and then edit the collection page you wish to apply this to. From the **Theme template** section, simply choose **quick buy** from the list of options and click save.  It's also possible to apply the 'quick buy mode' to all collection pages if you'd prefer. To enable this, open the file `/templates/collection.json` and adjust the code as shown below. ```json "product-grid": { "type": "main-collection-product-quick-buy", ``` From an implementation point of view, the 'quick buy mode' enables a special template view, managed within the following files: - `/sections/main-collection-product-quick-buy.liquid` [View sample code](https://github.com/sparklayer-io/dawn/blob/main/sections/main-collection-product-quick-buy.liquid) - `/snippets/card-product-quick-buy.liquid` [View sample code](https://github.com/sparklayer-io/dawn/blob/main/snippets/card-product-quick-buy.liquid) It's also possible to adjust the styling of the 'quick buy mode'. Simple open `/sections/main-collection-product-quick-buy.liquid` and edit the CSS displayed at the top. :::hint{type="warning" attributes="[object Object]"} **Important to note** If you apply the new 'quick buy mode' to your collection pages, this will also take effect for logged-out customers also. If you are looking to customise the behaviour of how this works, we recommend engaging a Shopify expert to assist. ::: *** ## Sample products and price lists If you're starting your B2B store on Shopify from scratch, you can even install our sample B2B products to populate your product catalogue and price lists in SparkLayer. You can see these in action on our [demo store.](https://b2b-demo-store-dawn.myshopify.com/) This is a great way to see how SparkLayer works on your Shopify store before then configuring it with your own products. | Item | Notes | Download CSV | | ------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | `Shopify sample products` | Upload CSV via the Products admin in Shopify | [Click here](https://cdn.shopify.com/s/files/1/0608/1642/5195/files/Sample_Shopify_Products.csv?v=1635762514) | | `SparkLayer sample B2B pricing` | Upload CSV via the [Price Lists](docId\:lDePanHogqwEGNf-jHZ6L) admin in the SparkLayer Dashboard | [Click here](https://cdn.shopify.com/s/files/1/0608/1642/5195/files/Sample_SparkLayer_B2B_prices.csv?v=1635762514) | | `SparkLayer sample metafields` | Upload CSV via a third-party app such as [Metafields Guru](https://apps.shopify.com/metafields-editor-2) | Click here | [title] Shopify FAQs [path] Integrations/Shopify/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Shopify setup :::ExpandableHeading **What Shopify plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of Shopify, from Shopify Basic right through to Shopify Plus. All you need is an active Shopify store and you're good to go. ::: :::ExpandableHeading **How does SparkLayer compare to Shopify B2B?** Shopify expanded native B2B features to all plan tiers, including company accounts, up to 3 pricing catalogs, net terms, PO numbers, and easy reorders. For merchants with a handful of wholesale accounts on simple terms, this covers the basics. SparkLayer is designed for merchants who need more. Here are the key differences: **Pricing flexibility** - Shopify's free B2B tier limits you to 3 pricing catalogs assigned to Markets (customer groupings). If you need more than 3 pricing tiers or per-customer pricing, you'd need Shopify Plus at $2,300/month. SparkLayer gives you unlimited price lists on all plans, assigned directly to customer groups. **Sales team ordering** - Shopify offers staff accounts that can create draft orders in the admin. SparkLayer has a dedicated Sales Agent Portal where reps log in, switch between customer accounts, see customer-specific pricing, and place orders on behalf of buyers. It's a fundamentally different workflow. **B2B ordering features** - Several capabilities are only available through SparkLayer and don't exist on any Shopify plan, including Plus: CSV and bulk order upload, AI Intelligent Cart (auto-builds carts from emailed POs), saved shopping lists, advanced discounts, a Quoting Engine for quote-to-order workflows, and self-service invoicing. **Works on any theme** - SparkLayer overlays a B2B experience on top of your existing Shopify theme. Shopify's native B2B works best with their Trade theme. **Transaction fees** - SparkLayer charges no transaction fees on any plan. Shopify charges variable platform fees on B2B orders across all plan tiers. **Shopify Companies compatibility** - SparkLayer works alongside Shopify's Companies feature. Draft orders created through SparkLayer are automatically associated with the correct Shopify Company, Contact, and Location for accurate order attribution and reporting. SparkLayer and Shopify's native B2B can't currently run side by side for the same customer session - it's one or the other for the ordering experience. For a full feature-by-feature breakdown, read our detailed comparison: [SparkLayer vs Shopify B2B - What You Need to Know](https://sparklayer.io/blog/2026/04/03/shopify-b2b-all-plans/) ::: :::ExpandableHeading **Can I use SparkLayer with my development website?** Yes! If you're setting up SparkLayer on a development store (e.g. a test account), we can enable a special developer-mode that lets you use SparkLayer until you're ready to activate a billing plan. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) for more details. ::: :::ExpandableHeading **Can I have DTC and B2B on the same Shopify website?** Yes, It's possible to install SparkLayer onto your existing Shopify DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup' and [we've a guide here](https://www.sparklayer.io/blog/2022/04/04/shopify-hybrid-b2c-b2b/) that explains how works. When your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://b2b-demo-store-usd.myshopify.com/) Sometimes it can be better to separate out your B2B store onto a secondary Shopify store and we've detailed some of the [common reasons](https://www.sparklayer.io/blog/2021/12/15/shopify-b2b-store-setup/). ::: :::ExpandableHeading **Which version of Shopify "Customer Accounts" is SparkLayer compatible with?** When setting up your Shopify store, it's possible to choose from two types of 'Customer Accounts' within Shopify: - **Legacy (Classic) customer accounts:** this is how most Shopify stores are set up and allows compatibility with third-party apps and the ability to customise the look and feel - **New customer accounts**: this uses a 'password-less login' and has a locked down account area that uses Shopify's 'out of the box' functionality (very similar to the checkout) **Compatibility with SparkLayer** SparkLayer works with both versions of accounts. You can learn more in [Shopify Customisations](docId\:ddIv5TDAnCayWTOJ0Vyb7) under "Shopify customer accounts" ::: :::ExpandableHeading **Is there support for Shopify "Companies"?** Yes, please refer to our full guide, [Shopify Companies](docId\:wrzSu8adFvbXOkF50hX5I). ::: :::ExpandableHeading **What is the "SparkLayer B2B & Wholesae" (B2B Ordering) pixel that's added to my Customer Events within Shopify?** When a customer places an order via the Shopify Checkout, SparkLayer needs to know when the order is completed. By adding a special Shopify pixel, this then resets contents of the customer's order and allows them to place additional orders if they wish. **Please note, this step is fully automated when you install SparkLayer and no action is typically required.** To check the SparkLayer pixel has been added to your Shopify store, go to **Settings** and click **Customer events**. You should see a pixel added by SparkLayer and this should be set to the Connected state. When you view the pixel, you will see it called **"B2B Ordering" **which corresponds to the Sales Channel used by SparkLayer.  If you don't see the SparkLayer "B2B Ordering" pixel, you will need to reconnect your Shopify store via the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/integrations/platform). Simply click the "Save" button at the bottom, and this will activate the pixel for you. ::: ### Theme setup :::ExpandableHeading **Can you help me install SparkLayer on my Shopify website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any Shopify theme, include Online Store 2.0?** Yes! SparkLayer is compatible with all Shopify themes, even fully customised. If you need help in the setup, our team can add all the code snippets for you. You can even try our [Shopify B2B Dawn Theme](docId\:LHkU0_G_4GVef1jAmgXmo) ::: :::ExpandableHeading **Can SparkLayer work with my variant "image switcher"** SparkLayer works by updating the product page templates with our special frontend widgets - these automatically pull in your variants, SKUs, and any associated product data that is required for your B2B customers. When they are loaded into your Shopify store, they essentially 'replace' the existing Shopify purchase area that your regular DTC (retail) customers see. Very often, we see Shopify themes that have functionality whereby changing variants will auto-update the main product imagery. This itself is almost always very specific "custom coding" to the theme that is being used - on a technical level, it will be using Shopify theme specific JavaScript coding to do this and will be engineered in a particularly way for the theme. When our SparkLayer widgets are loaded in, they won't have any handling for this specific JavaScript that controls the imagery, so this functionality isn't compatible for logged in B2B customers. As a solution to this, we have released a guide (aimed at Shopify developers) to point them in the right direction to make SparkLayer compatible based on the specific theme they are using. [Learn more](https://docs.sparklayer.io/tech-docs/javascript-sdk#qReb9) ::: :::ExpandableHeading **If I update my Shopify theme, will I need to re-install SparkLayer?** SparkLayer requires adding specific code to your Shopify store and normally involves updating 3 or 4 files within your theme. When you perform a theme update, it's likely that these changes will be removed and the SparkLayer code will need adding back in. We are always happy to perform this re-install for you, please [get in touch](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. ::: :::ExpandableHeading **How does SparkLayer affect my current Shopify theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been tagged with b2b successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Shopify store, you may want to ask the app developer to remove these although this is optional. ::: :::ExpandableHeading **Will SparkLayer slow down my Shopify website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (B2C) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form, we recommend the following options: - **SparkLayer Forms (recommended)** - Our built-in, no-code form builder lets you create and manage B2B registration forms directly within SparkLayer. Get started with the ready-made Customer Registration Form template which includes approval workflows, automatic customer tagging, and email notifications. No third-party apps needed. Learn more about [SparkLayer Forms](docId\:nn5qnfmfGkXlyUmAMpSnq) or get started in the [SparkLayer Dashboard](http://app.sparklayer.io/forms). - **B2B Login and Registration Page** - We offer a free, ready-made template that adds a dedicated B2B login and registration page to your Shopify store (e.g. yourstore.com/pages/b2b-login). It includes a login form for existing wholesale customers, a registration form for new applicants, and is fully customisable via the Shopify Customizer. Our team is happy to install this for you at no charge. Learn more in [Shopify B2B Registration & Login](docId\:Gfc0UW7mJnMNpnNO6EdRl) It's also worth noting that you can manually add customers via the Shopify Customers admin and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I stop my Shopify pricing showing on Google Search?** By default, Google will almost certainly index your Shopify store to show on their search listings. A result of this is your Shopify prices (retail prices) may also show within Google. It's very important to note that this is not related to SparkLayer and is in fact a built-in feature of Shopify. If you do not want your prices to show on Google this is a customisation that would need to be applied via your Shopify store (not via SparkLayer directly). The Shopify support team may be able to best advice here but there are a range of [Shopify community articles](https://community.shopify.com/c/forums/searchpage/tab/message?advanced=false\&allow_punctuation=false\&filter=location\&location=category\:en\&q=hide%20prices%20from%20google) that you can review. Please note, making any changes to your Shopify store in this manner may effect your Google search results and we strongly advise speaking with a Shopify expert before making any changes. ::: ### Discounts :::ExpandableHeading **How do I set up discount promotional codes at checkout?** It's possible to set up discount codes that customers can use during the checkout process. For example, you could set up a discount coupon that gives them 10% off their order. To learn how discounts work, please see [our guide here.](docId\:WrejPw9URyjQwiQeKs_Cg) ::: :::ExpandableHeading **How do I set up discounts to apply across a product range? ** Within the SparkLayer [Discounts](docId\:WrejPw9URyjQwiQeKs_Cg) , using the "Advanced requirements and rewards", you can setup discounts to apply to products with specific tags setup within your store (e.g. in Shopify). For example, you could set the discount to only apply if products within the cart have a tag of `dog-toy` applied, or match a broad term of `dog`. This allows you to setup discounts to apply to collections and product ranges easily. There are also other workarounds without using discounts: - You could create a brand new product in Shopify and set up a range of variants within it (e.g. all the products you want to offer within the discount) - We have a special setting called *minimum product quantity* ([See our guide here](docId\:CmxfrPgjQxfz9vJzTVv0D)) which forces the customer to order at least X of the product (e.g. 3) - Using the [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe), you can then set up your discounted rates (e.g. buy 3 and the price is 10% cheaper) - Within Shopify, you could make these products 'hidden' from standard B2C customers simply by not associating them to a collection ::: :::ExpandableHeading **How do I set up discounts based on an order total?** It's possible to set up discounts that apply based on a certain threshold, e.g. the order total or the number of items in a cart. To learn more about discounts, see [our guide here](docId\:WrejPw9URyjQwiQeKs_Cg) ::: ### Payments :::ExpandableHeading **How do B2B payments work with SparkLayer and Shopify?** SparkLayer supports a range of B2B-specific payment methods that can be tailored on a per-customer basis. Our diagram below illustrates how they work in the context of SparkLayer and Shopify. To learn more, please see our [full guide here](docId\:efevur-A3yCJXUHvrR7t-).  ::: :::ExpandableHeading **Do vaulted credit cards work with SparkLayer?** Yes! Shopify's vaulted credit card feature is fully compatible with SparkLayer. For it to work, the customer placing the order must be assigned to a Shopify company (under Customers > Companies in the Shopify admin). Once a customer within that company location has saved a card - either during checkout or via their customer account - any other customer linked to the same company location can use it. Vaulted cards appear as an option when a customer selects "Pay Online by Card" during the SparkLayer checkout process. They can also be charged against draft orders created by SparkLayer - for example, if a customer places an order using "Pay by Invoice", you can collect payment on the resulting draft order using a vaulted card directly from the Shopify admin. To get started, you need Shopify Payments enabled and your B2B customers linked to company records in Shopify. No additional SparkLayer configuration is required. You can learn more in our [Shopify Companies](docId\:wrzSu8adFvbXOkF50hX5I) guide. ::: :::ExpandableHeading **Can I use my existing payment methods on the checkout?** In terms of payment methods supported by SparkLayer and Shopify. If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the Shopify checkout. From there, any payment methods you have set up in Shopify (e.g. Paypal, Shop Pay, Affirm Pay) will show up, allowing the customers to pay by this method. We've attached a screenshot to illustrate this. In short, if Shopify support this payment method, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: :::ExpandableHeading **Can I additional charges on a B2B order based on the payment type used?** There may be scenarios where you want to add an additional charge on an order based on the payment type used (e.g. if the customer is paying by credit card, you may want to charge an additional 2%). Currently, there is no way to do this directly via SparkLayer. One potential option is to allow the customer to place an order via a manual payment method (e.g. Pay by Invoice), and when the order arrives into Shopify as a draft order, adjust the order totals accordingly. From the draft order within Shopify, you can then use their "Collect payment" functionality to take the card payment.  ::: ### Products ::::ExpandableHeading **How do I hide products or set up B2B-only products?** [B2B Catalogs ](https://apps.shopify.com/sparklayer-b2b-catalogs)is a free SparkLayer app that lets you control which products are visible to different types of customers on your Shopify store. Hide products from B2C customers, restrict items to B2B-only, or show different product ranges to different customer groups - all using simple tags, no code required. [Install B2B Catalogs](https://apps.shopify.com/sparklayer-b2b-catalogs) from the Shopify App Store, then head to our [B2B Catalogs documentation](https://docs.sparklayer.io/b2b-catalogs/) for the full setup guide. :::hint{type="info"} **Hiding variants** Looking to hide variants for specific B2B customer groups? ::: :::: :::ExpandableHeading **Can I use my Shopify prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Shopify prices (e.g. your main Shopify price, Compare-at price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Shopify prices and we can even make provisions for your tax set up in Shopify (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within Shopify, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Shopify so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Shopify, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Shopify's 'Import' or 'Edit products' feature to do this in bulk. ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. SparkLayer has a way to "reserve" stock for your DTC customers, essentially blocking B2B customers from ordering too much inventory for a specific product. [Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Shopify to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store (e.g. you could use an app such as [Locksmith](https://apps.shopify.com/locksmith) to do this) - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. Learn more in [our guide here](docId\:ddIv5TDAnCayWTOJ0Vyb7) ::: ### :::: ### Customers :::ExpandableHeading **How do I set up a customer in Shopify as B2B** To enable a customer as B2B, this works by adding a special tag in Shopify against their customer record. This tag by default is always `b2b` and you can add additional tags based on the rules you've set for the customer in the SparkLayer [Customers](docId:5_lWMNohhjBJJppg9E6Vh) admin. To learn more about setting up customers as B2B, see [our guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** Please refer to [our guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in Shopify?** For non-card payment orders (e.g. Payment by Invoice), the order is saved as a "Draft order". - You can view these in Shopify within **Orders** and then click [Draft Orders](https://admin.shopify.com/draft_orders?selectedView=all) - You can then convert these into approved orders by marking them as paid or marking them with payment terms (please [see this guide](https://help.shopify.com/en/manual/orders/create-orders#accept-payment) for more details). - It's also possible to automatically convert Draft Orders into Completed Orders with [our feature here ](https://app.sparklayer.io/configuration/settings/general)"Auto-complete Shopify Draft orders" - By default Shopify will not send an email for Draft orders but we have a [guide here](docId:7kxW1S6TBM57MlpLJn_Uk) that explains how to do this. When a customer places an order via non-card payment methods, it will show with a status of "**Awaiting Merchant" **until the order ("Draft" order) is converted into a Completed order. ::: :::ExpandableHeading **How do I edit orders?** Firstly, it is possible to edit orders within Shopify when an order is placed via SparkLayer. If you have it configured to create orders as 'Draft orders' you can go into the order and make changes. If you subsequently then manually complete the order (i.e. Mark as paid), you can still edit the order up until the point of fulfilment. The issue arises in one scenario we know about which is a limitation of Shopify. If you have 'Auto-complete Shopify Draft orders' turned on within the [SparkLayer Dashboard > Settings](https://app.sparklayer.io/configuration/settings/general) this will skip the ability to make subsequent orders. This is why, when you try and edit a 'Completed order', you are seeing the "Unable to edit order" message. At this point in time, we don't have a solution to this, other than switching 'off' the SparkLayer setting that automatically completes a draft order. ::: :::ExpandableHeading **Can I stop pricing showing as a discount within a Shopify order?** Yes! By default, prices from SparkLayer into Shopify will show exactly as you've set them up in the SparkLayer [Price Lists](docId\:Zv2wCfqf7CUC5j_pYJ8Pt). If you'd prefer to show the original Shopify price, please contact our team. ::: :::ExpandableHeading **How do I change the wording for "custom discount" on an order** You can change the wording of "Custom discount" by editing the languages within your Shopify store. - Go to Themes and click the 3 dots next to the theme name. Select "Edit default theme content" - Search for "Custom discount" and then edit as required. ::: :::ExpandableHeading **How do I send an invoice?** Please see our guide: [Invoices](docId\:NKh8H14Ffna5DD71SwwNd) ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we do have support for minimum (and maximum) quantities, but you're only able to set these at a product or product-variant level. It's not possible to currently set minimum order-level quantities but it's something we are considering as part of a future update! There is a potential workaround for product-variant requirements and we've included our recommend approach - You could create a brand new product in Shopify and set up a range of variants within it (e.g. all the products you want to offer within the discount) - We have a special setting called [Minimum product quantity](docId\:CmxfrPgjQxfz9vJzTVv0D) which forces the customer to order at least X of the product (e.g. 3) - Using the [Quantity Pricing & Settings](docId\:t2cEaOsmeOHmgZStjCnhe), you can then set up your discounted rates (e.g. buy 3 and the price is 10% cheaper) ::: :::ExpandableHeading **How do I set up multi-currency using Shopify Markets?** Please refer to [Shopify Markets & Currencies](docId\:vex5XjFlT6Pvb0AzhlKQD) ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** At the moment, Shopify doesn't have a built-in 'notification' for when a draft order is placed so it does require workarounds for now. There are a few options: **Receive notifications as store owner:** - if you are a merchant on the Shopify, Advanced or Shopify Plus plans, you can use Shopify Flow to do this. We've an example you can [download here](docId\:ddIv5TDAnCayWTOJ0Vyb7) - It's also possible to automatically convert Draft Orders into Completed Orders with [our feature here](https://app.sparklayer.io/configuration/settings/general) **Receive notifications as a customer:** - If you want your customers to receive a notification, there are a few ways to do this. As above, you could activate the auto-complete [orders feature above](https://app.sparklayer.io/configuration/settings/general). - We also recommend a really good one called Mechanic that lets you set rules/flows based on criteria. We have some ready-made templates [you can use here](docId:7kxW1S6TBM57MlpLJn_Uk) ::: :::ExpandableHeading **Can I import historic B2B orders into Shopify** Yes, there are methods to do this. Please refer to [our guide here](docId\:BxWnGB6b1n7QFfhTnu7pk) ::: :::ExpandableHeading **Can I change the order number "prefix" in Shopify, e.g. B2B-123** Due to current limitations in Shopify, there is currently no way to differentiate the Shopify Order Number (e.g. #123456) between regular (DTC) and B2B orders. In terms of filtering and segmenting orders between retail and B2B, SparkLayer will by default add a tag to an order `b2b`. Within Shopify, or systems you may have integrated (e.g. shipping, 3PLs), this can then be used as a way to separate out workflows to allow you to differentiate between the customers who are placing orders. ::: [title] Locksmith [path] Integrations/Customer Experience/  ## :::hint{type="success"} **SparkLayer solution** We've launched our FREE [B2B Catalogs](docId\:plxT_QlDSepZu2YqVuicC) that lets you easily hide products for B2B and B2C customers. Learn more in our [full guide here](docId\:vE83XYTnUs59EG2IYKUFZ)  ::: ## Introduction :::hint{type="warning"} **Before you start: **Please note, your Shopify store must already have the [Locksmith app](https://apps.shopify.com/locksmith) installed before following the below guide. Learn more in "Frequently Asked Questions" below. ::: Locksmith lets you control access to products, collections and pages in your Shopify store. It's a great way to offer a different experience to your B2B & wholesale customers, giving you control on the content they can (and can't) see. Locksmith allows powerful ways to restrict content based on conditions such as customer tags (e.g. `b2b`), email addresses, passcodes, secret links, geographic location, purchase history, a schedule, and more. You can see everything that's possible in the official [Locksmith app here](https://apps.shopify.com/locksmith). In this guide, we're going to walk you through some example use-cases of using Locksmith to customise your store for your B2B customers. *** ## Example use-cases :::hint{type="warning"} **Please note the following** When working on a back up theme any lock you create will automatically take effect on your live theme. ::: ### Creating B2B-only products If you have products within your Shopify store that you want to make "B2B-only" and **not** accessible to your regular customers, this is a great way to manage their visibility. **Step one: Creating the Lock** Go into the Locksmith app within your Shopify store. Click in the **"Add new lock"** Field and you'll then see the below screen. When you select a product you are then able to browse your products or you can search by the product name. If you want the lock to take effect straight away you'll need to make sure you have **"Enable Lock" **selected, otherwise it will be set as a draft.  **Step Two: Add a Key** Once you have selected the product you are wanting to hide and you have created the lock, you'll see the ability to **"Add a Key"** to allow specific customers view the product. You'll also need to specify if you want to remove any links to the product and if you want this hidden from your store's native search function along with product listings.  When you add a **Key** you'll see a drop down list of rules you are able to use to allow customers to view the product you are hiding. When using SparkLayer, we advise using **'if the customer is tagged with...'** as you are already using tags for your B2B customers (e.g. `b2b`). [Learn more](docId:5_lWMNohhjBJJppg9E6Vh)  **Step Three: Customise your Key ** When creating a key, you're then able to add numerous conditions your customer has to meet before gaining access to the product. In this example, we're requiring the customer to have a tag of `b2b` before being able to view the product. As you can see below, you're able to redirect your customers who are **not** tagged B2B to a different page (or alternatively they can be given a default message supplied by Locksmith).  **Step Four: Save Lock and Test** Once you have finished setting up your customisations, simply click **Save**. Next, go to your store and check if you can view the product as logged out customer. And vice versa, try accessing it as a logged in B2B customer. If you search for the product directly when **logged out** you should see something like the below.  If you are already logged in **without** a B2B tagged account, you'll see a notification message similar to the below.  ### Creating B2B-only collections This is very similar to the "Creating B2B-only products" detailed above but designed to allow you to customise how your collections work. For example, you may have a collection on your Shopify store that shows your B2B products that you don't want your regular customers to see. **Step one: Creating the lock** Go into the Locksmith app within your Shopify store. Click in the **"Add new lock"** Field and you'll then see the below screen. When you select a Collection you are then able to browse your collections within your store or you can search by the collection name.  If you want the lock to take effect straight away you'll need to make sure you have **"Enable Lock" **selected, along with "**Protect products in this collection".**  **Step Two: Add a Key** Once you have selected the collection you're wanting to hide and you have created the lock, you'll then see the below screen that gives you the ability to **"Add a Key"** to allow specific customers view the collection. You'll need to specify if you want to remove any links to the product and if you want this hidden from your store's native search function along with collection listings.  When you add a **Key**, you'll see a drop down list of rules you are able to use to allow customers to view the collection you are hiding. When using SparkLayer, we advise using **'if the customer is tagged with...'** as you are already using tags for your B2B customers (e.g. `b2b`). [Learn more](docId:5_lWMNohhjBJJppg9E6Vh)  **Step Three: Customise your Key ** When creating a key, you're able to add numerous conditions your customer has to meet before gaining access to the product. For this example, the customer must be tagged with `b2b` to access the collection. You're also able to redirect your customers who are **not** tagged B2B to a different page or display a message to them.  **Step Four: Save Lock and Test** Once you have finished setting up your customisations, simply click **Save**. Next, go to your store and check if you can view the collection as logged out customer. And vice versa, try accessing it as a logged in B2B customer. If you search for the collection directly when **logged out** you should see something like the below.  If you are already logged in **without** a B2B tagged account, you'll see a notification message similar to the below.  ### Creating a B2B-only page In some scenarios, you may want to create B2B-specific pages on your store that cannot be accessed by your regular customers. This is a great way to customise the B2B experience on your store. **Step one: Creating the lock** Go into the Locksmith app within your Shopify store. Click in the **"Add new lock"** Field and you'll then see the below screen. When you select a page you are then able to browse your your pages within your store or you are able to search by the page name.  If you want the lock to take effect straight away you'll need to make sure you have **"Enable Lock" **selected.  **Step Two: Add a Key** Once you've selected the page you are wanting to hide and you have created the lock, you'll then see the ability to **"Add a Key"** to allow specific customers view the product. You'll also need to specify if you want to remove any links to the page and if you want this hidden from your store's native search function.  When you add a **Key** you'll see a drop down list of rules you are able to use to allow customers to view the page you are hiding. When using SparkLayer, we advise using **'if the customer is tagged with...'** as you are already using tags for your B2B customers (e.g. `b2b`). [Learn more](docId:5_lWMNohhjBJJppg9E6Vh)  **Step Three: Customise your Key ** When creating a key, you're able to add numerous conditions your customer has to meet before gaining access to the page. For this example, the customer must be tagged with `b2b` to access the page. You're also able to redirect your customers who are **not** tagged B2B to a different page or display a message to them.  **Step Four: Save Lock and Test** Once you have finished setting up your customisations, simply click **Save**. Next, go to your store and check if you can view the page as logged out customer. And vice versa, try accessing it as a logged in B2B customer. If you search for the page directly when **logged out** you should see something like the below.  If you are already logged in **without** a B2B tagged account, you'll see a notification message similar to the below.  *** ## Frequently Asked Questions :::ExpandableHeading **How do I change the default messages for locked content** When a customer tries to access content that is locked (e.g. a product, a collection, or a page), you can customise the messages that shows for them. Within Locksmith, you'll see a Messages section that allows you to customise the content.  ::: :::ExpandableHeading **How do I create multiple locks** You're able to create **multiple locks** that can apply to one customer group. All you need to do is select "Force open other locks" when setting up your customisations.  ::: :::ExpandableHeading **How do I lock my entire store to B2B customers** If you have a collection for a specific B2B customer group, it's possible to lock down your website so they **cannot access** anything other than the collection you have created for them. First, create a lock to your **Enter store**.  When creating the key, use **"if customer is tagged with..."** then enter the appropriate b2b tag (e.g. `b2b`). You'll also need to **"Invert" **the key, meaning that no customers can view this page **unless **they are tagged B2B.  Once you have created this lock, you'll then need to go in and create a second lock giving your B2B customers access to the B2B collection. You would need follow the normal steps mentioned above however when creating the key on this one you need to ensure you tick **"Force open other locks"** otherwise they would not have access to the collection due to the first lock on the entire store.  ::: ::::ExpandableHeading **Locks aren't taking affect on my backup theme, should they?** :::hint{type="warning"} **Please note** When working on a back up theme any lock you create will automatically take effect on your live theme. ::: If you are conducting testing on a back up (duplicate) theme, Locksmith will only take affect on your live theme. To resolve this, once you've created the lock, go to **Help > Unpublished themes**  Find the theme that you are currently testing on, and select install. This would the install the latest version of Locksmith along with all of the adjustments that you have carried out.  :::: [title] Installing SparkLayer on BigCommerce [path] Integrations/BigCommerce/ ## Introduction SparkLayer enables B2B functionality on your existing BigCommerce store, allowing your B2B customers to login, place orders, manage their account, and much more.  To familiarise yourself with SparkLayer, we also recommend reviewing the following guides: ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [How SparkLayer Works](docId:_2g8HwCXnN7OFy4o199y1) The fundamentals of what SparkLayer does ::: :::LinkArrayItem [Frontend](docId\:OgKfvQX13dHW2582D57kJ) The special "interfaces" SparkLayer enables ::: :::LinkArrayItem [Features](docId\:SSzdKXuNMlEIDOOITHQcU) The available features and functions. ::: :::: *** ## Requirements Before installing SparkLayer on your BigCommerce store, please ensure the following: | Item | Details | | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customer Storefront Accounts` | You’ll need to make sure that customer accounts are enabled on your storefront so that customers can sign in. This is turned on by default on BigCommerce, and you can [learn more here](https://support.bigcommerce.com/s/article/Customer-Account-Creation?language=en_US). | | `Product SKUs` | In order for SparkLayer to save B2B prices for your products, all products must have **SKUs**. Please see [this guide](https://support.bigcommerce.com/s/article/Product-Options-v2?language=en_US#skus) to learn more. | | `Customers` | For your B2B customers to see the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa), they must belong to a [customer group ](https://support.bigcommerce.com/s/article/Customer-Groups?language=en_US)within BigCommerce. You can learn more below on how to configure this. | | `Payment Processor` | If you’re installing SparkLayer on a test store, please ensure you have an example [payment method](https://support.bigcommerce.com/s/article/Available-Payment-Gateways?language=en_US) enabled. | | `Shipping` | In order to place an order via the [My Cart Interface](docId\:efevur-A3yCJXUHvrR7t-), please ensure you have shipping rules set up. You can manage this within BigCommerce under *Settings, Setup*. | :::hint{type="success"} Want to see BigCommerce and SparkLayer in action? Try out our [demo store](docId:6zLPH9x8-qEUITCHs2obE) ::: *** ## The Onboarding process When you create an account on SparkLayer, you'll get access to the [SparkLayer Dashboard](https://app.sparklayer.io/). The Dashboard has a customised onboarding process that gently guides you through all the necessary steps before you're ready to start inviting your B2B customers and taking orders on your website.  ::::WorkflowBlock :::WorkflowBlockItem **🔗 Connecting your BigCommerce store** This enables SparkLayer to connect to your BigCommerce store and begin synchronising the information it requires. ➡️ [View in dashboard](https://app.sparklayer.io/configuration/integrations/platform) ::: :::WorkflowBlockItem **📓 Setting up your B2B price lists** You'll then set up the B2B price lists that you want your customers to see when they login. These can be automated or you can manually upload specific pricing. ➡️ [View in dashboard](https://app.sparklayer.io/pricing) ::: :::WorkflowBlockItem **👪 Setting up your B2B customer groups** You'll then set the ordering rules for your customers such as minimum order values, available payment methods and price lists they are assigned to. ➡️ [View in dashboard](https://app.sparklayer.io/customers/groups) ::: :::WorkflowBlockItem **🛠️ Installing the frontend widgets** You'll need to install special code snippets ("widgets") into your BigCommerce theme in order to show the special SparkLayer B2B interfaces. ➡️ [View in dashboard](https://app.sparklayer.io/configuration/frontend/core) ::: :::WorkflowBlockItem **✅ Testing & launching** You'll then need to run through some final checks (such as placing a test order). Once you're happy, you can then launch SparkLayer and start taking orders! ➡️ [View in dashboard](https://app.sparklayer.io/configuration/onboarding) ::: :::: Let's now dive into each of them! *** ## 🔗 Connecting your BigCommerce store Once you've installed the [SparkLayer BigCommerce App ](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/)this step of the onboarding process happens automatically. Once SparkLayer is connected to your BigCommerce store, it will automatically synchronise product and customer data and then allow you to upload price lists and proceed to install the frontend widgets. :::hint{type="info"} **Installing for the first time?** When installing on BigCommerce for the first time, the process works as follows: 1. You'll need to install the [SparkLayer app](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/) (much like you would any other app). You can do this within your BigCommerce admin by going to **Apps** and clicking **Marketplace **and then searching for SparkLayer. 2. You'll then be asked to **create an account on SparkLayer**, or sign in if you already have one. 3. Finally, you need to confirm acceptance of our billing plan within BigCommerce to begin your free trial ::: Once the above is complete, you can then return back to the [SparkLayer Dashboard](https://app.sparklayer.io/) to continue with the onboarding process. You can also access the SparkLayer app within your BigCommerce store by going to the **Apps** and clicking **My Apps** within your BigCommerce admin and you'll find a summary of your onboarding process.  *** ## 📓 Setting up your B2B price lists Within the [Price Lists](https://app.sparklayer.io/pricing) area of the SparkLayer Dashboard, you can create and manage your B2B pricing rules.  SparkLayer allows you to set the following pricing types: | Type | Details | | ----------- | ------------------------------------------------------------------------------------------------ | | `Manual` | You can manually upload a CSV file with specific prices and even enable quantity pricing | | `Automatic` | You can use your BigCommerce prices and apply a discount, e.g. 50% off BigCommerce retail prices | :::hint{type="warning"} **Please note the following on price lists** SparkLayer will **only** use the price lists set up directly within the [SparkLayer Dashboard](https://app.sparklayer.io/pricing) and will not synchronise any price lists you may already have set up in BigCommerce. ::: ### Discounts We also offer discounts on top of the wholesale pricing you’ve already set up. You have the ability to offer a blanket discount, free products or you can get technincal with our "Advanced Discounts and Rewards" where you have the ability to apply discount depending on Brand, Category, Condition UPC or Search Keywords as you are able to see below.  :::hint{type="success"} **Ready to set your pricing?** To learn more about pricing, please see our [full guide here](docId\:s8XcbZGxQpgdeIGWtXseT). ::: *** ## 👪 Setting up your B2B customer groups [Customer Groups](https://app.sparklayer.io/customers/groups) let you configure specific rules for your customers, from defining their minimum order values and which price lists they see, through to what payment methods they're allowed to use when checking out.  Much like with Price Lists, you can fully manage this via the [SparkLayer Dashboard](https://app.sparklayer.io/customers/groups). SparkLayer will **automatically** synchronise customer groups from your BigCommerce store rather than you having to manually set these up in the SparkLayer Dashboard. To get started, please following the below steps: :::::WorkflowBlock :::WorkflowBlockItem Within BigCommerce, go to **Customers** and click **Customer Groups** ::: :::WorkflowBlockItem You can either create a new customer group, or edit an existing one ::: ::::WorkflowBlockItem To synchronise to SparkLayer, the customer **Group Name** must start with `B2B`. In our example below, we've set up `B2B Default`  For any customer groups you want to synchronise, please ensure `B2B` is added in the Group Name. :::hint{type="warning"} **Please note the following on customer groups** - Once you've set up your customer groups in BigCommerce, these must be assigned** to at least one customer record** before SparkLayer will synchronise and show them in the [Customer Groups area](https://app.sparklayer.io/customers/groups) - SparkLayer will only synchronise customer groups that start with **B2B** in the customer group name ::: :::: :::WorkflowBlockItem Once the customer groups have been set up in BigCommerce (i.e. those starting with `B2B`), and you've assigned the customer group to **at least** one customer, you'll then see these appear within the SparkLayer Dashboard, within the [Customer area.](https://app.sparklayer.io/customers/groups)  When the customer groups are imported into Sparklayer, they will always use this format: | Item | Details | | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Name | The exact name set up in BigCommerce, e.g.
`B2B - Default` | | Handle | This will use a sequential format, e.g.
`bigcommerce-group-1`
`bigcommerce-group-2`
Note: you will only need to use the handle for more advanced integrations. | ::: ::::: :::hint{type="success"} **Ready to configure your customer groups?** To learn more about customer groups, please see our [full guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: *** ## 🛠️ Installing the frontend widgets SparkLayer comes with ready-made B2B-optimised "widgets" that we collectively call the SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ). The widgets simply overlay sections of your existing BigCommerce store and enable our powerful B2B features We offer two ways to get started with SparkLayer on your BigCommerce theme: ::::WorkflowBlock :::WorkflowBlockItem **Installing our frontend widgets yourself** If you're experienced in working with BigCommerce and the [stencil templating language](https://developer.bigcommerce.com/stencil-docs/overview), you should find our onboarding process a breeze (see below). ::: :::WorkflowBlockItem **Request us to install for you** Our expert team can help set up the special SparkLayer frontend widgets on your BigCommerce store and some example B2B pricing. Once we're done, we can then arrange an onboarding call to walk you through it. [Contact our team](docId\:NNUw1G9z7eaJ4M78vk7t9) ::: :::: **Installing SparkLayer yourself** :::hint{type="info"} **Backing up your BigCommerce theme** If you'd prefer not to make these changes on your live BigCommerce theme, you can create a "Duplicate" and make the changes there before publishing. To make a duplicate, go to **Channels** and click **Themes** from within your BigCommerce admin.  ::: If you’re looking to install yourself, there are five steps to follow. ::::::WorkflowBlock :::::WorkflowBlockItem **Install the **[SparkLayer Core Script ](https://app.sparklayer.io/configuration/frontend/core)Within `/templates/layout/base.html` you'll need to add the SparkLayer Core Script that activates the SparkLayer functionality. ::::ExpandableHeading **🛠️ View instructions** :::hint{type="info"} To get started, head over to the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/frontend/core) and you'll see your customised SparkLayer Core Script within the Frontend Configurations.  The script simply needs to be included within the main header of your website's source code within the` ...` tags in your `/templates/base.html` file. If you are making edits to your website via the BigCommerce admin, you can access the template files via this URL: `yourstore.mybigcommerce.com/manage/channel/1/my-themes` ::: :::: ::::: :::::WorkflowBlockItem **Install the **[Product Detail Interface](https://app.sparklayer.io/configuration/frontend/pdp) You'll need to update your storefront's product detail page with the SparkLayer Product Purchasing Interface. When a customer logs in and SparkLayer recognises them as being a B2B customer, this will load a special interface with their specific prices and a way to purchase. ::::ExpandableHeading **🛠️ View instructions** ```javascript
This will send the customer an email order confirmation | | `Payment on Account` | The order will be created with the `Awaiting Payment` status in BigCommerce.
This will send the customer an email order confirmation | | `Request for Quote` | The order will be created with the `Incomplete` status in BigCommerce.
This will **not** send the customer an email order confirmation | | `Upfront Payment` | The order will be create with the `Awaiting Fulfiment` status in BigCommerce
This will send the customer an email order confirmation | :::Iframe{iframeHeight="0" code=""} ::: :::: :::WorkflowBlockItem **Invite your customers** Please refer to [our guide here](docId:5_lWMNohhjBJJppg9E6Vh) on our recommended way to do this  ::: ::::: *** ## Troubleshooting To troubleshoot the most common issues (such as issues with pricing), please see [our guide here](docId\:BlCEkkx3I30nkUcglsfw7). You can also [contact our support team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to assist. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for BigCommerce?** All SparkLayer plans are compatible with BigCommerce, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, our team will contact you to discuss the most appropriate plan for your needs. Billing is managed via a monthly billing cycle with the option to pay annually. ::: :::ExpandableHeading **How do I select and change plan (upgrade or downgrade)** You can sign up to SparkLayer on BigCommerce without initially selecting a plan. Once you've installed SparkLayer, our team will contact you to discuss the next steps. Once you've activated a plan, we are happy to work with you to upgrade or downgrade based on your changing requirements. ::: ### BigCommerce setup :::ExpandableHeading **Where do I find the SparkLayer BigCommerce app?** You can find the official SparkLayer for BigCommerce app in the [BigCommerce App Store](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/). ::: :::ExpandableHeading **What BigCommerce plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of BigCommerce, from BigCommerce Essentials right through to BigCommerce Enterprise. All you need is an active BigCommerce store and you're good to go. ::: :::ExpandableHeading **Can I use SparkLayer with my development website?** Yes! If you're setting up SparkLayer on a development store (e.g. a test account), we can enable a special developer-mode that lets you use SparkLayer until you're ready to activate a billing plan. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) for more details. ::: :::ExpandableHeading **Can I have DTC and B2B on the same BigCommerce website?** Yes, it's possible to install SparkLayer onto your existing BigCommerce DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://b2b-demo-store-usd.myshopify.com/) ::: ### Theme setup :::ExpandableHeading **Can you help me install SparkLayer on my BigCommerce website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any BigCommerce theme?** Yes! SparkLayer is compatible with all BigCommerce themes, even fully customised. If you need help in the setup, our team can add all the code snippets for you. ::: :::ExpandableHeading **How does SparkLayer affect my current BigCommerce theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a b2b customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your BigCommerce store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** In terms of payment methods supported by SparkLayer and BigCommerce. If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the BigCommerce checkout. From there, any payment methods you have set up in BigCommerce (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. We've attached a screenshot to illustrate this. In short, if BigCommerce support this payment method, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** BigCommerce does have the ability to hide collections from Customer Groups which could be one way to achieve this.  There are a few things we recommend to make the experience better: - You could **create a B2B-only collection** and redirect customers to this once they login. If you wanted to show special B2B-only products, you would need to create these as separate products within BigCommerce (i.e. with unique SKUs, etc) - With SparkLayer pricing, if you don't upload a price against a SKU, the B2B customer** won't be able to purchase it.** So this is a way to prevent them from adding items you don't want them to purchase - It is possible to adapt the BigCommerce themes to hide/show products using custom coding ::: :::ExpandableHeading **Can I use my BigCommerce prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your BigCommerce prices (e.g. your main BigCommerce retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your BigCommerce prices and we can even make provisions for your tax set up in BigCommerce (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within BigCommerce, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within BigCommerce so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in BigCommerce, it's relatively quick to do. You can either edit individual products and add them manually, or you can use BigCommerce's 'Import' or 'Edit products' feature to do this in bulk. ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. SparkLayer has a way to "reserve" stock for your DTC customers, essentially blocking B2B customers from ordering too much inventory for a specific product. [Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in BigCommerce to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: :::ExpandableHeading **Can I sell products on both store fronts?** Yes, it is possible to have product purchaseable on both store fronts if you are using both for wholesale. When you are in the product within your admin, please ensure that you have both store fronts selected as sales channles that you want to offer the products on. ::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some custom coding - You could use a [recommended form builder app](https://support.bigcommerce.com/s/article/Creating-a-Contact-Form?language=en_US#form-builders) to achieve this It's also worth noting that you can manually add customers via the **BigCommerce Customers** admin and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** Please refer to [our guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: :::ExpandableHeading **Will SparkLayer slow down my BigCommerce website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my BigCommerce website?** We recommend consulting with a BigCommerce expert developer before making changes to your website. For their reference, you may find the following Stencil code can be used as a mechanism to hide and show content based on a B2B customer being logged in. ```html {{#contains (toLowerCase customer_group_name) "b2b"}} {{/contains}} ``` ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in BigCommerce?** **Manual payments** For manual (non-card) payment orders (e.g. Payment by Invoice), the order is saved as a "Draft order". - You can view these in your BigCommerce admin within **Orders** and then click **Draft Orders** - You can then convert these into approved orders by marking them as paid or marking them with payment terms It's important to note that once an order has been approved, it will **only** then show in the customers My Account section and the [SparkLayer Dashboard](https://app.sparklayer.io/orders). **Card payments** You can view these in your BigCommerce admin within **Orders** ::: :::ExpandableHeading **How do I see the 'shipped' order status when viewing an order on SparkLayer?** SparkLayer will automatically show a B2B order as "Shipped" providing it meets the following conditions: 1. The order is marked as 'Shipped' within BigCommerce 2. The order has a shipment assigned to it within BigCommerce Without the both being applied to an order, the B2B order will remain in a "Processing" state until actioned. ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within BigCommerce when an order is placed via SparkLayer. If you have it configured to create orders as 'Draft orders' you can go into the order and make changes. If you subsequently then manually complete the order (i.e. Mark as paid), you can still edit the order up until the point of fulfilment. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly but there are some good ways to do this within BigCommerce using a recommended invoicing app or by sending invoices manually to your customers via your existing back-office financial system. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we do have support for minimum (and maximum) quantities, but you're only able to set these at a product or product-variant level. It's not currently possible to set minimum order-level quantities but it's something we are considering as part of a future update! ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** You can manage notifications from BigCommerce by going to **Settings** and clicking **Order Notifications** ::: :::hint{type="info"} **Need assistance?** We'd be happy to help guide you through this process. Please refer to [our guide here](docId\:NNUw1G9z7eaJ4M78vk7t9). ::: [title] QuickBooks Online [path] Integrations/Accountancy/  :::hint{type="info"} **Requirements** **QuickBooks: **Available to **QuickBooks Online** users only **Plan:** Merchants must be signed up to the Professional or Enterprise plan **Platform:** Merchants must be using Shopify ::: ## Introduction [QuickBooks Online](https://quickbooks.intuit.com/) provides online accounting tools for managing finances, invoices, inventory and customer records. With the SparkLayer integration, your B2B orders automatically sync to QuickBooks to create invoices and contacts - reducing manual data entry and removing the need for additional apps or systems to keep your platforms in sync. *** ## ⚠️ Pre-Requisites - important! The following areas need to be configured prior to enabling the integration. | Item | Details | | ---------- | ------------------------------------------------------------------------------------------------ | | `Products` | All B2B products need to be created in QuickBooks with the applicable tax rates applied | | `Shipping` | In order for shipping to be applied at invoice-level, shipping needs to be enabled in QuickBooks | *** ## Getting started To get started, login to your SparkLayer dashboard and navigate to **Integrations -> Partner Integrations -> Accountancy -> QuickBooks** and enable the integration. You will then be redirected to QuickBooks to complete authentication. You will also be notified about which data we require access to at this stage. :::hint{type="info"} **Please note** If your QuickBooks account is associated to multiple companies then you will be requested to select which company you want to connect with SparkLayer. Only one company can be connected per SparkLayer team. ::: Once you are connected, you can navigate back to the **Partner Integrations **page and modify the integrations configuration. You'll need to follow the steps below ("Configuration") to complete the setup. *** ## Configuration The following configuration options exists for the QuickBooks integration; | Setting | Description | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Automatic Contact Creation` | **This is not set on install, and must be configured before using the integration**
Controls whether SparkLayer should create customers in QuickBooks during the invoice synchronisation process.
When creating invoices, each invoice must be associated with a customer in QuickBooks. We first attempt to match an existing contact (as outlined in the Contact Matching section). If no match is found, this setting determines what happens next:
* **Enabled - **SparkLayer will automatically create a new contact in QuickBooks using the customer data held in SparkLayer. You can read more about contact creation [here](https://docs.sparklayer.io/xero#ZR11G). * **Disabled -** SparkLayer will not create new contacts in QuickBooks. This assumes that contacts are either: - Being created by another system, or - Being managed manually within QuickBooks. * In this case, if no matching contact is found, no invoice will be created. | | `Payment on account - Invoice creation trigger` | **Default: On order**
Controls when an invoice should be created for orders using the payment on account payment method.
* **On order **will create an invoice for the whole order once it reaches the `processing` status. * **On shipment **will create an invoice per shipment, once any fulfilments on the order have been created.
You can read more about payment on account orders below. | | `Enable Sales Receipts` | Enable this to generate sales receipts in QuickBooks for upfront payment orders | | `Shipping Tax Code` | Name of the tax code that should be applied to invoice lines for tax exempt users. This must be set in order for invoice synchronisation to succeed. | | `Tax Exemption Tax Code` | Name of the tax code that should be applied to tax exempt invoice lines. | | `Income Account` | Name of the account that should be used as the income account on new products - this will be used when creating the SparkLayer custom product | ### Custom Items On installation, a "SparkLayer Custom Product" product is created within QuickBooks that will be used when a custom item is added to an order within SparkLayer. To ensure an invoice can be successfully created, the applicable tax rate on this product needs to be set before use. You can set this in the same way as other products within QuickBooks. *** ## Invoice Creation SparkLayer automatically creates invoices in QuickBooks for eligible orders as soon as the order is received from your platform. :::hint{type="info"} **Please note** This process runs in the background to keep the checkout experience fast and uninterrupted, which means there may occasionally be a short delay before the invoice appears in QuickBooks. ::: ### Orders eligible for invoicing Whether an invoice is created depends on several conditions, including your integration settings and the specific details of the order. | Item | Details | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Fulfilment status` | We only create invoices for orders that are in either the *processing* or *shipped* fulfilment status. | | `Payment method` | Invoices are generated only for orders using either the **Payment by Invoice** or **Payment on Account** payment methods.
* **Payment by Invoice** For Payment by Invoice orders, the invoice is created as soon as the order reaches the `processing` status. * **Payment on Account** For Payment on Account orders, invoices are created depending on the integrations configuration. You can read more about payment on account orders below.
You can learn more about configuring these methods [our guide here](docId\:ibIKczvHM085BkeJIfFYv) | ### Payment on account orders & split shipments The integration configuration allows you to decide when invoices are created for orders that use the payment on account payment method. Invoices can be created either **on order ** or **on shipment.** If you have configured your integration for **on order **then an invoice will be created when the SparkLayer order reaches the `processing` state. If the integration is configured for **on shipment **then an invoice will be created at the time an fulfillment has been fulfilled on the order. This handling caters for **split fulfillments **as will we will create an invoice per fulfillment, containing only the line items fulfilled. Customers will be able to download all invoices associated with an order from their my account section. Note: If the integration is configured to create orders **on shipment **and changed to **on order** and partially fulfilled orders will not have invoices created for the remaining shipments. Please ensure any partially fulfilled orders are completed before changing this configuration. :::hint{type="info"} **Shipping** In the case of split shipments, the shipping method associated with the order will always be attached to the invoice created for the **first **shipment on the order. ::: ### How invoices are created Invoices are generated using the QuickBooks API. Each invoice is created using a combination of: - Data from the SparkLayer order - Your integration configuration - Relevant settings within QuickBooks The specific fields and logic used are outlined below. | Item | Details | | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Contact` | We attempt to match the invoice to an existing QuickBooks contact using the customer details from the SparkLayer order. If a match is found, the invoice is associated with that contact. You can read more about how contact matching and syncing works in detail here. | | `Billing Address` | The billing address shown on the invoice is taken from the order billing address. | | `Due Date` | The due date calculated for an invoice is dependant on three factors:
* The order date * The payment type * The customers payment terms | | `Due Date for Payment by Invoice orders` | For orders using the **payment by invoice **payment method, the due date is set to the order date. | | `Due Date for Payment on Account orders` | For orders using the **payment on account** type, the due date is calculated in the following hierarchical order:
1) If the customer has **net terms** configured in SparkLayer, these are applied to the order date. You can read more about configuring net terms [here](docId\:yWm70oQUosyKOoIqb4Z4G). 2) If not, any **payment terms** configured for the contact in QuickBooks are applied. 3) If neither of the above are set, any **global payment terms** configured in QuickBooks are applied. 4) If none of these are set, the due date defaults to the order date. | | `Line Item` |
* **Description** The line item’s SKU is used as its description. * **Quantity** The quantity matches the value recorded on the order in SparkLayer. * **Unit Amount & Line Amount** The unit and line amount are calculated by SparkLayer and passed directly to QuickBooks. * **Tax Amount** Tax values are calculated by QuickBooks using the tax rates specified in QuickBooks | | `Shipping` | If shipping enabled in QuickBooks, the shipping amount will be set on the invoice, with the shipping method reflecting the name of the service chosen and the price visile in the totals.
If shipping is disabled in QuickBooks it will be added as a line item to the invoice.
The shipping line will use the Shipping Tax Code specified in the configuration | *** ## Viewing Invoices Once an invoice has been created in QuickBooks, customers can access it directly from the **My Account** section of your store. When the invoice is ready, a **View & Download Invoice** button will appear on the relevant order.  Selecting this button will take the customer to the publicly accessible invoice URL generated by QuickBooks. If this button is not visible, please review our troubleshooting steps below. *** ## Contact matching & creation When creating an invoice, we first attempt to associate it with the correct QuickBooks customer using the customer details from the SparkLayer order. ### How contact matching works Contacts are matched in the following order: 1. **Account number match (Recommended) **- we check for an existing QuickBooks contact with an ID that matches the accounting ID [metafield](https://docs.sparklayer.io/account-and-addresses#advanced-account-settings) configured against the customer in SparkLayer 2. **Email match **- If no account number match is found, we attempt to match using the customer’s email address. If a match is found for either of these conditions, the invoice is associated with the matching contact. ### Multiple contacts for a single email :::hint{type="danger"} **Please note** If your organisation uses multiple contacts with the same email address, we recommend configuring unique account numbers for each contact to ensure reliable matching. ::: In SparkLayer, email addresses are unique - only one customer account can exist per email address. In QuickBooks, email addresses are not unique, meaning multiple contacts can share the same email. If multiple active QuickBooks contacts exist for the customer’s email address, and the currency of the invoice matches the customer, the invoice will be created against the oldest found customer. ### Automatic contact creation If no existing contact can be matched using the methods above, SparkLayer will automatically create a new contact in QuickBooks using the customer data from the order. This behaviour is controlled by the **Automatic Contact Creation** setting in your integration configuration. ### Data synced on contact creation When a contact is created in QuickBooks, the following information is synced once and is not automatically updated if changes occur later in SparkLayer: - First name & last name - Email address - Billing & shipping address (based on the order being invoiced at the time of matching) - Currency will be set to the currency of the invoice being created *** ## Disabling the integration To disable the integration, log in to your SparkLayer Dashboard and navigate to **Integrations → Partner Integrations → Accountancy → QuickBooks**, then toggle the integration off. :::hint{type="warning"} **Please note** If the integration is disabled, all related features will stop working. - No invoices will be created for orders placed while the integration is disabled. - Customers will no longer be able to access their QuickBooks invoices previously generated via SparkLayer using the link in their **My Account** section. ::: *** ## FAQ's :::ExpandableHeading **How do I disconnect from QuickBooks?** To disconnect from your QuickBooks organisation from SparkLayer you will need to login to your SparkLayer Dashboard and navigate to **Integrations -> Partner Integrations -> Accountancy -> QuickBooks **then disable the integration. This will remove the connection from your QuickBooks organisation. Please read further information here on what happens when the integration is disabled [here](https://docs.sparklayer.io/xero#OjTtC). ::: :::ExpandableHeading **Does the integration work for D2C orders?** No. The integration only supports B2B orders that are created through your platforms connection with SparkLayer. Direct-to-consumer (D2C) orders are not included in the sync and will not be pushed to QuickBooks as invoices. ::: :::ExpandableHeading **What level of access does the integration require in QuickBooks?** When connecting SparkLayer to your QuickBooks organisation, you’ll see a list of the exact permissions requested. We follow QuickBooks best-practice and only ask for the minimum access needed for the integration to function. Currently, this includes: - **View & manage contacts** - To match invoices to existing contacts and create new contacts for SparkLayer customers if your integration configuration allows. - **View & manage business transactions** - To create invoices in QuickBooks for SparkLayer B2B orders and in the future, view payments made on invoices. - **View organisation settings** - To read configuration details such as global payment terms when calculating invoice due dates. ::: *** ## Troubleshooting Below are some common issues and steps to help resolve them. If your issue isn’t listed, or the problem persists after following these steps, please contact our support team. :::ExpandableHeading **Customers cannot access their invoice from the My Account section** If links to invoices are not showing in a particular customers My Account section, it could be due to a number of reasons. - Ensure the integration is enabled in the SparkLayer Dashboard by navigating to **Integrations -> Partner Integrations -> Accountancy -> QuickBooks**. - Ensure the order is in a `processing` or `shipped` fulfilment status. We **do not **create invoices for orders which are in the `awaiting merchant` status. - Ensure an invoice exists in QuickBooks for the given order. In some cases it may take a little time for orders to sync across. If there appears to be a large delay, or an invoice has not been created, please contact support, providing the customer and order id. If you are still experiencing issues after checking the above, or invoice urls are not showing for **all **of your customers, please contact support. ::: *** ## Known limitations Please note the following: - Products must be setup in QuickBooks, with a SKU that matches Shopify and the correct tax rate applied. - Invoice creation in QuickBooks is one-way. Any changes made to invoices in QuickBooks, such as modifications to line items or customer details will **not **be reflected back in SparkLayer or your platform. - Apportioned tax rate for shipping line is not currently supported - Multi-currency is not currently supported where a customer has an existing invoice for another currency. [title] Accountancy [path] Integrations/ ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/SgPkgyz2M87ioKZl5xGrS-20251202-152201.jpg"} [Xero](docId\:WGhH4d8L-ys8zjOQmEoVx) ⚙️ Integrates Directly Create invoices and import payments ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/wBbAtWJv_p1-if-cpch7e-20260203-050948.png"} [QuickBooks Online](docId\:fDAlz0ggia651N47ICR2z) ⚙️ Integrates Directly Create invoices and import payments ::: :::: [title] BigCommerce Limitations [path] Integrations/BigCommerce/ ## Introduction Currently, there are a small number of limitations to be aware of with the SparkLayer and BigCommerce Integration. | Limitation | Notes | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Product SKUs` | Within BigCommerce, the product must have a SKU and this must be unique per product. | | `Product Inventory/Stock` | SparkLayer works on variant level stock. Product level stock support is limited and should be avoided where possible.
If the inventory is set to be tracked on product level where a product has multiple variants, SparkLayer would display that each of the variants has the set level rather than the product in its entirety across all variants.
In this situation, if a customer tried to add multiple variants to the cart with total quantity that exceeded the product stock level, a "Something went wrong" error would be shown to the customer and they would not be able to proceed. | | `Negative stock and pre-ordering` | BigCommerce does not support stock levels going below zero. As a result, SparkLayer cannot support pre-ordering functionality when stock is not yet available.
This limitation also applies to Quotes. A quote cannot be placed if there is currently insufficient stock available to fulfill the request. | | `Product Modifier Options` | If you are using BigCommerce Modifier Options (under the Customizations section of the BigCommerce edit product page), these will not show within the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). SparkLayer will only show the variants set up within BigCommerce variations section (e.g. options such as size, colour). | | `Custom Line Items` | SparkLayer custom line items feature is not supported on BigCommerce. | | `Multi-storefront` | Currently SparkLayer does not officially support BigCommerce's [multi-storefront functionality.](https://support.bigcommerce.com/s/article/Multi-Storefront?language=en_US)
However, in most cases multi-storefront setup will work out of the box with the following limitations:
1. Only one customer with the same email address can exist across all storefronts/channels used with SparkLayer.
2. All storefront/channel products, customers, and orders will share the same SparkLayer site.
3. A customer will share a single SparkLayer site across all channels/store-fronts, meaning that either the customers should only be assigned to a single channel at a time, or they will need to complete their checkout on one channel before adding any products on another to not end up creating invalid BigCommerce carts.
4. An extra SparkLayer Core Script Options field must be set with a unique `igniteCheckoutContext.channel_id` numeric value for each channel's storefront. | | `Price lists` | Currently price lists can only be managed though SparkLayer. Any price list modifications actioned via the BigCommerce admin will not apply to SparkLayer. | | `Promotions` | SparkLayer does not currently support the use of BigCommerce discounts (e.g. order-level discounts or promotional codes). This is an area that is being actively reviewed as part of a future update. | | `Multi-zone tax` | SparkLayer does support multi-zone tax configured in BigCommerce, however *at least one* of the following must be true for multi-zone tax to work:
1) The Tax "Prices entered with tax" setting is set to "No, I will enter prices exclusive of tax" 2) The Tax "When calculating the taxes on sales made outside this storefronts default tax zone" setting must be set to "Update product prices to reflect applicable tax rates". | | `Sales Agents` | [Sales Agent Ordering](docId\:Uw8mDbMEfwWKqZrVB5CqX) lets your sales team place orders on behalf of customers. During the checkout process, sales agents won't be able to select "Pay Online by Card" for a customer, payments must be "offline" methods (e.g. net terms, pay by invoice) | | `Company Users` | If you're using [Company Users](docId:_WwfeWVJY9xrSuNCQlFoZ) and a customer is inviting a team member, the team member will not receive a 'confirmation email' asking them to approve access. They will need to be manually informed of their login email address and to use the "Forgot password" feature on the BigCommerce store to create a password for their account. | | `Tax price display setting updates` | The setting called "How are prices displayed on your storefront" influences how shipping costs appear in your shopping cart. When you install the SparkLayer app or modify the overarching "Prices entered with tax" setting, this setting is automatically updated. But if you adjust this particular setting on its own, SparkLayer won't automatically update, causing the shipping cost to display incorrectly.
If you need to change this setting, reach out to SparkLayer for proper synchronisation. | | `Shipping and checkout` | At this time, it's not possible to use the [SparkLayer Shipping](docId\:CfZ_ZpGw2umOVAo73Lc5m) feature in parallel with B2B orders that require going through the BigCommerce checkout to pay online by card ("Upfront payment").
Due to BigCommerce shipping configurations, any SparkLayer shipping methods are overwritten by BigCommerce, reverting to the default shipping rules you've set up on your store.
SparkLayer shipping can be only used with BigCommerce if the Upfront Payment method is **disabled**. | | `Shipping method cost display` | When the tax zone price display setting is set to "Tax Inclusive", the shipping method option cost shown in the SparkLayer cart will be calculated using the overall cart tax rate rather than any shipping specific tax bands.
Please note that this is just the cost display amount shown in the shipping method options select UI rather than the actual shipping cost shown in the cart summary which is provided by BigCommerce and is not affected by this limitation. | [title] Magento [path] Integrations/ ## Introduction SparkLayer is the powerful platform that transforms your existing Magento website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed SparkLayer on your Magento store SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your Magento store. The best part is you can retain your *existing* Magento store design and layout and enable B2B alongside your retail operation (DTC). ## Supported Magento Plans  SparkLayer works with Magento Open Source versions 2.4.2 or later (formerly "Community Edition") and Adobe Commerce (Cloud) versions 2.4.2 or later. *** ## Magento Demo Store Want to see SparkLayer & Magento in action? Try it out on our Magento demo store using the details below: | Item | Details | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Login URL | [demo.magento.sparklayer.io/ ](https://demo.magento.sparklayer.io/)This is an example DTC + B2B store. To login as a B2B customer, [go to this link](https://demo.woocommerce.sparklayer.io/my-account/) and use the credentials below. | | Login details | **Sales Agent / Regular B2B Customer**
`contact@sparklayer.io`
`Testtest!` | *** ## Get started ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem [Installing SparkLayer on Magento](docId\:tlR1CAK6UzBa7R4JItqXq) Learn about the steps to install SparkLayer on your WooCommerce store ::: :::LinkArrayItem [Magento Metafields & Data Mapping](docId\:eBCDHtikvf78kB7v6axEh) Learn how to use the powerful WooCommerce metafields feature ::: :::LinkArrayItem [Magento FAQs](docId\:iN3pgYKCvUVn9R76lza2h) See some of our most commonly asked questions! ::: :::: [title] Linnworks [path] Integrations/ERPs & Operations/Untitled/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to the Professional or Enterprise plan - Platform: works with all eCommerce platforms ::: ## Introduction Linnworks is a multi-channel platform that lets you connect, manage, and automate your eCommerce operations. From inventory and stock, order management, right through to fulfilment. You can learn more about Linnworks [here](https://www.linnworks.com/). *** ## How it works The Linnworks integration for SparkLayer is available for all [Shopify merchants](https://docs.sparklayer.io/integrations/shopify-introduction#introduction) that already use Linnworks and allows you to bring B2B pricing and B2B ordering to your Shopify store.The integration works in two ways: | **Item** | **Details** | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Product Pricing** | Flow: Linnworks into SparkLayer
Product pricing is synchronised from Linnworks into SparkLayer using the 'Extended properties' feature available for all inventory items. | | **Orders** | Flow: SparkLayer to Shopify to Linnworks
Orders placed via SparkLayer are synchronised from Shopify into Linnworks using your **existing** Linnworks integration. Prices that show on orders will be the special B2B pricing | Please note, all customer data is managed via Shopify via the normal methods. *** ## Configuring on SparkLayer **Before you start - **to configure Linnworks on SparkLayer, you'll need to have an approved account with Linnworks. Please visit the [Linnworks website](https://www.linnworks.com/) to learn more. To get started, you'll sign into your Linnworks account and install the SparkLayer app. Once signed in, [click here](https://apps.linnworks.net/Authorization/Authorize/d4d9f57c-ea0e-4ecf-8c6d-eaa5632d4581) to start the process and you'll then be given an **authorisation token.** Within the SparkLayer Dashboard, go to the **Integrations** section and click **Partner Integrations.** Under **Multi-channel management**, click the toggle on the right to activate the Linnworks integration.  You'll then be prompted to enter the **authorisation token** and save your changes.  *** ## Configuring pricing **Creating price lists in SparkLayer** Price Lists determine what prices specific customers see when they log into your website and are central to how SparkLayer works. SparkLayer retrieves pricing from a backend system and ensures the backend system, such as Linnworks, remains as the 'source of truth' for pricing data. The Linnworks integration for SparkLayer works by first creating price lists within SparkLayer directly, and then using the '**extended properties**' feature in Linnworks to map pricing.To get started, go to **Data Feeds **within the SparkLayer Dashboard, and click **Price Lists**  Click **Create Price List **and enter in a unique **Handle** and a **Name** for the price list. You can repeat this process for as many price lists as you need. **Creating B2B pricing in Linnwork** To create B2B product pricing in Linnworks to synchronise with SparkLayer (and subsequently then show on your Shopify store), you need to use the **extended properties **feature in Linnworks. You can learn more about how this works in Linnworks [here](https://assets.linnworks.com/support/inventory/my-inventory/edit-inventory-item/extended-properties/).To get started, navigate to a product in Linnworks and click the **Extended properties** tab  Click 'Add New' and then follow the below steps: - **Name**: this must match the Handle used for the price list in SparkLayer and also start with b2b- For example, if the price list Handle in SparkLayer was was base-list the name in Linnworks would be b2b-base-list. - **Value**: this is is a list of prices in comma separated format and there is also support for tiered pricing. It works as follows: the first price entered is the price for 1 item. If you want to add tiered pricing, prefix the price with the quantity and a plus symbol. For example, let's say you have a product that costs £7.00 for 1 item ordered, but £5.00 for 10+ items ordered. This would be entered as 7.00,10+5.00. - **Unit of Measure: **You may also configure Unit of Measure by formatting the each pricing tier with a Unit of Measure key. For example, if a quantity of 10 items equates to 1 box priced at 5.00 per unit and a quantity of 100 items equates to 1 crate priced at 4.00 per unit. This would be entered as 7.00,10+5.00+box,100+4.00+crate. You can read more about our unit of measure pricing [here](https://docs.sparklayer.io/quantity-pricing#H9IT8). - **Type**: this must be entered as Other  **Bulk updating pricing** We recommend using bulk importing tools in Linnworks to more easily update B2B pricing. You can learn how this works [here](https://assets.linnworks.com/support/settings/import-and-export-data/). Once you've add the B2B product pricing in Linnworks, this will then be synchronised **every hour **into SparkLayer. You can check the pricing that's being received in SparkLayer at any point by using the [Product Data Look up tool](https://docs.sparklayer.io/partners/linnworks). *** ## Configuring customers The final step is to ensure that customers who sign into your Shopify store see the correct pricing. To do this, you'll need to configure Customer Groups. Please read our [full guide here](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard/settings#customer-groups) to complete this step. Once this is completed, you can login as a customer on your Shopify store, navigate to a product, and you'll see the pricing as set up in Linnworks. [title] Magento FAQs [path] Integrations/Magento/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for Magento?** Our "Enterprise" plan is required to use the SparkLayer Magento integration. [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via the SparkLayer Dashboard under Acccount > Plan ::: ### Magento setup :::ExpandableHeading **Where do I find the SparkLayer Magento module?** Please get in touch with our support team to get access to the SparkLayer Magento module. ::: :::ExpandableHeading **What Magento plan do I need to be on to use SparkLayer?** SparkLayer supports the following Magento Plans - Magento Open Source (version 2.4.2+) - Adobe Commerce (Cloud, version 2.4.2+) ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing Magento DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.woocommerce.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **How does SparkLayer affect my current Magento theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Magento store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will be taken to our Magento payment methods checkout. From there, any payment methods you have set up in Magento (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if Magento support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. You could also configure your Magento theme to hide and show products based on tag via custom coding. ::: :::ExpandableHeading **Can I use my Magento prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Magento prices (e.g. your main Magento retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Magento prices and we can even make provisions for your tax set up in Magento (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Magento so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Magento, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Magento 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Magento to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. It's also worth noting that you can manually add customers via the admin by going to **Magento > Customers** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. You could think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my Magento website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my Magento website?** This is possible but would require custom coding. We recommend consulting with a Magento expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within Magento when an order is placed via SparkLayer providing payment hasn't already been processed. From Magento > Sales, navigate to an order. You'll then see the option to **Edit order** allowing you to make changes. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: [title] Wix FAQs [path] Integrations/Wix/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for Wix?** All SparkLayer plans are compatible with Wix, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, billing is managed via your Wix admin and processed monthly or annually if you've selected this option. ::: ### Wix setup :::ExpandableHeading **Where do I find the SparkLayer Wix app?** You can find the official SparkLayer for Wix app in the [Wix App Market](https://www.wix.com/app-market/search-result?query=sparklayer). ::: :::ExpandableHeading **What Wix plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of Wix. All you need is an active Wix store and you're good to go. ::: :::ExpandableHeading **Can I have DTC and B2B on the same store?** Yes, it's possible to install SparkLayer onto your existing Wix DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://demo.wix.sparklayer.io/) ::: ### Store setup :::ExpandableHeading **Can you help me install SparkLayer on my Wix website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any Wix theme?** Yes! SparkLayer is compatible with all Wix themes. Once you install the SparkLayer app, our special B2B widgets are automatically added to your Wix store and you're good to go. ::: :::ExpandableHeading **How does SparkLayer affect my current Wix theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a B2B customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your Wix store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the Wix checkout. From there, any payment methods you have set up in Wix (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. In short, if Wix support specific payment methods, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: :::ExpandableHeading **Can I use multiple currencies for my B2B customers?** Currently, Wix [doesn't allow](https://support.wix.com/en/article/wix-stores-request-selling-in-multiple-currencies) a Wix store to accept multiple currencies (e.g. USD, EUR, GBP etc). If you do set up multiple currencies within SparkLayer in the [Price List section](https://app.sparklayer.io/pricing/lists), it's important to note the following: - Customers will see the correct currency when browser your store as a logged in B2B customer. The price they see will be the currency exchange rate at that time - If they proceed to place an order in a different currency to your Wix store's default currency, this will create an order however the pricing will show in your default currency. We've illustrated this below  How the order shows in Wix. Note how the totals are the same but the currency (EUR) has defaulted to the Wix store currency (£ GBP)  ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** There are a few things we recommend to make the experience better: You could **create a B2B-only collection** and redirect customers to this once they login. Within Wix, you can set pages to have **Permissions** for **Site members**. You create a **Member Role** of `B2B Customers` and then assign this to specific pages on your Wix website. You can see [their full guide here](https://support.wix.com/en/article/wix-stores-creating-restricted-store-pages).  If you wanted to show special B2B-only products, you would need to create these as separate products within Wix (i.e. with unique SKUs, etc) With SparkLayer pricing, if you don't upload a price against a SKU, the B2B customer** won't be able to purchase it.** So this is a way to prevent them from adding items you don't want them to purchase ::: :::ExpandableHeading **How do I hide prices on my regular (B2C) Wix store? ** Within your Wix store, you can easily hide the regular (B2C) retail price from showing. This is a great way to make your Wix store "B2B only" and only show prices once a customer signs in. To view more details on how to do this, please see the [official Wix guide here](https://support.wix.com/en/article/wix-stores-hiding-product-prices). ::: :::ExpandableHeading **Can I use my Wix prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your Wix prices (e.g. your main Wix retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your Wix prices and we can even make provisions for your tax set up in Wix (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within Wix, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within Wix so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in Wix, it's relatively quick to do. You can either edit individual products and add them manually, or you can use Wix 'Import' or 'Edit products' feature to do this in bulk. ::: :::ExpandableHeading **How do I show inventory (stock) levels?** It's possible to show inventory levels and a stock status when your B2B customers log in. You can learn more about how to enable this in [our guide here.](docId:5_lWMNohhjBJJppg9E6Vh) ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in Wix to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some additional fields - You could create a brand new registration page and direct prospective B2B customers to this. Wix [have a guide here](https://support.wix.com/en/article/wix-forms-an-overview) on ways to do this. It's also worth noting that you can manually add customers via the admin by going to **Customers & Leads > Contacts** and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** When you're ready to invite your B2B customers to begin using your store, there are a variety of ways you can do this. One of the easiest ways is to use the built-in Wix messaging system to simply notify your customer to sign in and begin placing orders. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You'll see a tab called **Inbox** that allows you to send direct messages.  You could also think about sending a marketing newsletter to your customers to notify them of your new B2B store and to sign in. You can access this by going to your Wix Dashboard, clicking **Customers & Leads** and then **Contacts**. You can then search and filter your customers and click **Send Email Campaign** to send an email.  We also have some example messaging you can use when inviting your customers and you can explore more in [our guide here](docId\:YUfghEGoxe_h7uJfcshna). ::: :::ExpandableHeading **Will SparkLayer slow down my Wix website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my Wix website?** We recommend consulting with a Wix expert developer before making changes to your website. ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in Wix?** | Payment Method | Notes | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Payment by Invoice` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Payment on Account` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Request for Quote` | The order will be created within **Sales > Orders** with a payment status of "UNPAID". You can then manually mark the order as paid once you have received payment (e.g. via offline means) | | `Upfront Payment (Card payments)` | The order will be created within **Sales > Orders** with a payment status of "PAID". You can then proceed to fulfil the order. | ::: :::ExpandableHeading **Why do orders show up as "Awaiting Merchant"?** When a B2B customer first places an order, it will show as **Awaiting Merchant** when they view it in their [My Account Interface](docId\:lQXaNI7IVDqna09D9soAP). This status means that the order requires the merchant (the Wix store owner) to view the order and then confirm payment (e.g. such as sending the customer an invoice or arranging payment via other means). Once you then mark the order as paid within Wix, this will then update the order status from **Awaiting Merchan**t to **Processing** and you can then fulfil the order as normal.   ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within Wix when an order is placed via SparkLayer providing payment hasn't already been processed. From your Wix Dashboard, navigate to an order and click the **More Actions** button. You'll then see the option to **Edit order** allowing you to make changes.  ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly but there are some good ways to do this within Wix. When viewing an order within your Wix Dashboard, you'll see the option to **Create Invoice** under **More Actions**. When sending an invoice, this is managed outside of SparkLayer and it will require you to collect payment by your preferred means. Once you've received payment, you can then mark the order as paid within Wix and then fulfil it as normal.  ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we support the ability to set minimum/maximum order level spends for your B2B customers. You can configure these by going to the [Customer Groups](https://app.sparklayer.io/customers/groups) area of the SparkLayer Dashboard. ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** You can manage notifications and emails that are sent by going to your Wix Dashboard, clicking **Settings** and then **Outgoing Notifications**. ::: [title] Uninstalling & Transferring accounts [path] Integrations/Wix/ ## Uninstalling SparkLayer SparkLayer works just like any other app in Wix and you can uninstall it very easily.  Please follow the below steps: ::::WorkflowBlock :::WorkflowBlockItem From your Wix admin, click **Apps**, and then click **Manage Apps.** ::: :::WorkflowBlockItem For the SparkLayer, click the three dots on the right and then click **Delete**. This will then remove SparkLayer from your store. ::: :::: Once you've removed the app, this will then **cancel** the SparkLayer recurring billing charges with immediate effect. :::hint{type="info"} **More information** You can learn more about removing apps in this [Wix guide](https://support.wix.com/en/article/deleting-apps). ::: :::hint{type="warning"} **Please note** - When you follow the uninstall process, this will disable customers, product and order updates to SparkLayer but will **not** delete the data until you [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to remove your account. - Please note, depending on when your billing cycle to SparkLayer began, you may see charges you're not expecting. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) if you would like us to investigate. ::: *** ## Transferring to another Wix store At this time, it's not possible to transfer your SparkLayer account to a new Wix store. We recommend creating a brand new SparkLayer account on the new store and following our setup guide. [title] Wix [path] Integrations/ ## Introduction SparkLayer is the powerful platform that transforms your existing Wix website into a fully featured B2B solution. Say goodbye to complicated and costly installation processes and hello to a hassle-free setup that gets you up and running in no time! ::embed[]{url="https://www.youtube.com/watch?v=23uqVqW59d0"} Once you've installed the [official SparkLayer for Wix app](https://www.wix.com/app-market/web-solution/sparklayer-b2b-wholesale), SparkLayer enables a B2B-ready frontend interface that simply "overlays" sections of your Wix store. The best part is you can retain your *existing* Wix store design and layout and enable B2B alongside your retail operation (DTC). ## Supported Wix Plans  SparkLayer works with all versions of Wix including Wix Editor and Wix Studio. *** ## Wix Demo Store ::embed[]{url="https://www.youtube.com/embed/Bww33sF7sLk"} Want to see SparkLayer & Wix in action? Try it out on our Wix demo store using the details below: | Item | Details | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Login URL | [[[https://demo.wix.sparklayer.io/](https://demo.wix.sparklayer.io/) ](https://demo.bigcommerce.sparklayer.io/)](https://demo.bigcommerce.sparklayer.io/login.php)To login as a B2B click the "Try Demo" link in the main navigation. | *** ## Get started ::::LinkArray :::LinkArrayItem [Installing SparkLayer on Wix](docId\:JcMpSOZdCrFjgWO6M49rS) Learn about the steps to install SparkLayer on your Wix store ::: :::LinkArrayItem [Wix FAQs](docId\:FTSB7UVso1qIpgXNPwYcI) See some of our most commonly asked questions! ::: :::: [title] Shopify Limitations [path] Integrations/Shopify/ ## Introduction Currently, there are a small number of limitations to be aware of with the SparkLayer and Shopify Integration. | Limitation | Notes | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Discounts` | Currently, it's not possible to use Shopify discounts in parallel to SparkLayer. Instead, SparkLayer has its' own discount system that allows powerful discounts and promotions to be set up. [Learn more](docId\:WrejPw9URyjQwiQeKs_Cg) | | `Product SKUs` | Within Shopify, the product **must** have a SKU and this must be unique per product. | | `Product Customisations` | If you're using an app that adds customisations to a product (e.g. a text-entry field), these will not show within the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa). SparkLayer will only show the variants set up within Shopify's own catalogue (e.g. size, colour). It is possible to add customisations using the [JavaScript SDK](docId:315uNbM85_FWnh6FU9KkK) however please be aware that this will require custom development. | | `Cart Line Items` | A set a restriction of a **350 line items**. By request to support, this can be increased to 500, please note this is not by default due to the performance of the Shopify APIs. | | `Product Tax rates` | If you're using line-item tax exemption rules within your product catalogue, SparkLayer will not have appropriate tax handling if a customer's order combines both tax-included and tax-exempt products.
For stores which "Include taxes in pricing", we'll be unable to calculate the gross pricing correctly, and we recommend setting up another store specifically for B2B with this setting off where we can provide net pricing. | | `Duties` | Due to Shopify's API not including Duties, we'll be unable to calculate duties as a 'separate' addition to the cart when completing an order. It's recommended that, if you're using duties in your store, to [disable this option](https://admin.shopify.com/settings/taxes/duties/management) in your Shopify admin settings or create a separate B2B store if required. We will add support for this as soon as is available with Shopify. | | `Companies` | Currently, SparkLayer is not compatible with Shopify B2B companies. Please refer to our [Shopify FAQs](docId\:P-7titr2d20hXBeixvKBZ) for recommended options on how to migrate from Shopify Companies to Shopify (regular) Customers. | [title] Shopify B2B Landing Page [path] Integrations/Shopify/Shopify Customisations/ ## Introduction  When your B2B customers sign in, you may want to take them to a dedicated page that provides a more tailored experience - whether it's to highlight specific products, show important information, or act as a central hub for your B2B store. SparkLayer gives you the ability to control *where* B2B customers land when they log in, and you can customise this to suit your needs. In this guide, we’ll cover a few ideas and approaches you can take. :::hint{type="info"} I**mportant to note** Customising the landing experience for B2B customers is a Shopify-specific change and will require making updates to your theme or using a page builder app. While SparkLayer enables the redirect behaviour, we’re unable to assist with Shopify design or layout customisation. If you’re unsure how to make the changes in Shopify, we recommend working with a Shopify expert ::: *** ## Redirect to a B2B product collection One simple approach is to create a B2B-specific **collection** in Shopify that contains the products you want your B2B customers to see first. For example: :::BlockQuote /collections/b2b-products ::: You can manage collections in Shopify by going to **Products** > **Collections** in your [Shopify admin](https://admin.shopify.com/collections?selectedView=all). Once created, you can configure SparkLayer to redirect logged-in customers to this URL instead of the standard homepage (see "*How to redirect B2B customers to a custom URL*" below) This is ideal if you want your customers to immediately browse and order from your wholesale catalogue. *** ## Create a custom landing page in Shopify Another option is to create a standard **page** in Shopify (e.g. named "*B2B Landing Page"*) and build it out with relevant content. For example, the URL could be: :::BlockQuote /pages/b2b-landing-page ::: This page could include: - Rich text or welcome messaging - Featured product links or categories - Helpful content or banners - Links to customer account tools (e.g. invoices, quick order) You can manage and edit pages directly from the Shopify admin, under **Online Store > Pages** and also within **Online Store** > **Customize** on your live theme. Once created, you can configure SparkLayer to redirect logged-in customers to this URL instead of the standard homepage (see *"How to redirect B2B customers to a custom UR*L" below) :::hint{type="info"} **Please note** The level of functionality may depend on which theme you are using and you may need to consult your theme developer on how best to approach this. ::: *** ## Use a third-party page builder app If you want more control over the design, you can use a **Shopify page builder app** and redirect your B2B customers to a specially designed page. There are many options within the Shopify app store such as: - [PageFly](https://apps.shopify.com/pagefly?st_source=autocomplete\&surface_detail=autocomplete_apps) - [Shogun](https://apps.shopify.com/shogun?st_source=autocomplete\&surface_detail=autocomplete_apps) - [Instant](https://apps.shopify.com/instant-builder?st_source=autocomplete\&surface_detail=autocomplete_apps) - [and many others](https://apps.shopify.com/categories/store-design-storefronts-page-builder/) These apps give you drag-and-drop interfaces to create visually rich landing pages, without needing to write code. This can be a great solution if you want a highly polished, branded B2B dashboard or homepage. As with other pages in your Shopify store, page builder apps will also generate a unique URL that you can direct your B2B customers to. For example, the URL could be: :::BlockQuote /pages/b2b-customer-landing-page ::: Once created, you can configure SparkLayer to redirect logged-in customers to this URL instead of the standard homepage (see *"How to redirect B2B customers to a custom UR*L" below) *** ## Other ideas Every B2B setup is different, and your landing page might be shaped by what matters most to your customers. You could also consider including: - A quick links section to access quotes, past orders, or special promotions - Displaying B2B-only content using Shopify Liquid (read our guide to showing B2B-only content) - Embedding a video or help resources to guide new customers *** ## How to redirect B2B customers to a custom URL When a logged in customer accesses your website's existing my account area (e.g. `/account`), it will redirect them to the SparkLayer My Account interface instead. If you'd prefer, you can change the default handling and set a custom URL to redirect B2B customers to once they log in. You can do this by updating the SparkLayer Core Script on your website. ```javascript /* Add the below code into the SparkLayer Core Script */ /* Please refer to our help guide on how to do this */ accountRedirect: { urlRegex: /\/account/g, goTo: "/index", // page to redirect logged in users to }, /* End of code */ ``` ::::Tabs :::Tab{title="🛍️ Using Shopify"} **Using Shopify Customer Accounts (New Accounts)** If you're using Shopify Customer Accounts, you can configure which URL to send a customer to directly via your Shopify admin. In your Shopify admin, go to Settings, Checkout, and within [Configurations](https://admin.shopify.com/settings/checkout#checkoutprofiles), click "Customize".  From the top, navigate to the "Orders" page, click "Apps" on the left, and then enable the "B2B Account Redirect" extension. You can include: - Some optional placeholder text that shows before the customer is redirected should you wish to inform them that they are being redirected. - A specific destination URL to take the customer to once they are redirected. For example, you may want to take them to a specific collection page or a landing page. **Setting up redirect URLs based on a customer tag** If you're using *Legacy* Shopify accounts (Classic Accounts), you can also add handling to vary the destination redirect URL based on a customer group. E.g. customer group ABC goes to` /collections/wholesale-page` whereas customer group XYZ goes to `/collections/wholesale-vip` Within your SparkLayer Core Script, you can replace the above code sample with the following Liquid code logic (and adapt accordingly): ```javascript accountRedirect: { urlRegex: /\/account/g, {% assign goTo = "/index" %} {% for tag in customer.tags %} {% if tag == "b2b-group-1" %} {% assign goTo = "/collections/wholesale-page" %} {% elsif tag == "b2b-group-2" %} {% assign goTo = "/collections/another-wholesale-page" %} {% endif %} {% endfor %} goTo: {{ goTo | json}}, }, ``` ::: :::Tab{title="🌐 Other platforms"} No configurations available. ::: :::: *** ## Show custom content on your B2B landing page You can also use Shopify’s Liquid templating to tailor the content on your landing page depending on whether a customer is a B2B user. Here’s a simple example: ```html {% if customer.tags contains 'b2b' %}
Welcome back, valued wholesale customer!
Browse B2B Products {% else %}This page is for B2B customers only.
{% endif %} ``` For more advanced examples, see our full guide [Shopify B2B-only Content](docId:30hMTg4Cqqv69EhqNvpnf) [title] Brightpearl [path] Integrations/ERPs & Operations/  :::hint{type="info"} **Requirements** - Plan: Merchants must be signed up to the Professional or Enterprise plan - Platform: Merchants must be using Shopify ::: ## Introduction Brightpearl is a multi-channel platform that lets you connect, manage, and automate your eCommerce operations. From inventory and stock, order management, right through to fulfilment. You can learn more about Brightpearl [here. ](http://brightpearl.com/) *** ## How it works The Brightpearl integration for SparkLayer is available for all [Shopify merchants](https://docs.sparklayer.io/integrations/shopify-introduction#introduction) that already use Brightpearl and allows you to bring **B2B pricing and B2B ordering** to your Shopify store. The integration works in the following ways: | **Item** | **Details** | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Customers** | Brightpearl becomes the 'master' of your B2B customer data, and any changes to tagged customer records will automatically be synchronised to Shopify and SparkLayer. | | **Orders** | Orders placed via SparkLayer are synchronised from Shopify into Brightpearl using your **existing** Brightpearl integration. Prices that show on orders will be the special B2B pricing as set up in Brightpearl | | **Product Pricing** | Price lists and product prices are imported into SparkLayer via pricing rules you set up in Brightpearl | *** ## Configuring on SparkLayer To configure Brightpearl on SparkLayer, you'll need to have an approved account with Brightpearl. Please visit the [Brightpearl website](http://brightpearl.com/) to learn more. To get started using Brightpearl on SparkLayer, you'll first need to enable the integration. Within the [SparkLayer Dashboard](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard), go to the **Integrations** section and click **Partner Integrations**. Under **Multi-channel management**, click the toggle on the right to activate the Brightpearl integration.  You'll then be prompted to enter your **Brightpearl account ID** (which can be found within your Brightpearl admin) and then authorise SparkLayer to access your Brightpearl account. Once the authorisation process is completed, the final step is to configure how you want customers to be mapped between the two systems. *** ## Configuring Customers Broadly speaking, Brightpearl is your **central location **for managing B2B customer data. When customers are configured in Brightpearl as B2B customers, SparkLayer can automatically retrieve this data and then enable the B2B ordering experience on your Shopify site.Within Brightpearl, **Contact tags** are used as the primary mechanism to map data between systems. Within Brightpearl, go to **Settings**, **Contacts** and click **Tags**.  To enable the data mapping between the two systems, it's necessary to create new tags and then to map the names accordingly. For example, if you wanted just a single B2B customer group for your UK store, you could name this **SparkLayer UK. **Within SparkLayer, to complete the mapping process, this tag simply needs to be matched as shown below.  You can then create specific rules for this customer group, e.g. minimum orders, price lists, via the [Customer Group](https://docs.sparklayer.io/sparklayer-dashboard/the-sparklayer-dashboard/settings#customer-groups) section within SparkLayer. **Customer sub-groups** It's also possible to create more sophisticated rules for your customers and create **sub-groups** as shown below.  For example, you may have a **VIP** group within your B2B customers where they get special pricing. To map sub-groups between Brightpearl and SparkLayer: 1. First create your sub-group in Brightpearl. For example **SparkLayer UK - VIP** 2. Within the Customer Group section within SparkLayer, create a new group ensuring you match the naming convention after the dash symbol in Brightpearl, e.g. VIP  This will then allow you to create additional B2B sub-groups within your customer base. **Customer mapping** Customers are mapped between the systems based on the **primary email** set within Brightpearl. Once this is mapped, SparkLayer will then synchronise the following data into Shopify. | **Brightpearl** | **Shopify / Spark Layer** | | --------------------------------- | --------------------------------------------------------------------------------------------------- | | Address | Shows against customer record in Shopify | | Receive email newsletters | Shows against customer record in Shopify | | Primary Telephone | Shows against customer record in Shopify | | First / Last Name | Shows against customer record in Shopify | | Title | Shown via metafields in Shopify | | Company Name | Shown via metafields in Shopify | | Customer tag (see above) | Shown via metafields in Shopify - matches to customer group | | Credit Limit / Balance on Account | Shown via metafields in Shopify | | Price List | Shown via metafields in Shopify | | Customer Custom Field: SL\_SAGTS | Shown via metafields in Shopify - matches to SparkLayer Sales Agent groups, must be comma-delimited |  Please note, all customer data is managed via Brightpearl and any amends made directly in Shopify will not synchronise back to Brightpearl. **Adding new B2B customers** Since Brightpearl is the central source for customer data, any new customers created in Brightpearl will **automatically** be added to Shopify. When new customer records are added to Shopify, they will by default be added as **Pending** customer accounts and receive an **automatic email** to enable their account by setting a password.  This uses the **Customer account invite **notification email which can be edited in the Notifications section within Shopify. *** ## Configuring Product Pricing Once customers are mapped between Brightpearl and SparkLayer, the next step is to configure your B2B pricing. As with customers, Brightpearl is your centralised source for managing your B2B pricing. **Setting up B2B pricing in Brightpearl** Within Brightpearl, go to **Settings**, **Products/Inventory,** and click **Price Lists**. To add a new price list, click the Add new price list button and complete as necessary.  In the example above, we've created two price lists; B2B and UKVIP. Once you've created your price list(s) in Brightpearl, you'll then see a new tab show against all product records where pricing rules (including price breaks) can be specified. In the example below, you can see pricing for the UKVIP price list.  In order for SparkLayer to map this data, price list records are **automatically** imported each time you add a price list in Brightpearl. The mapping works as follows: | **Field name in SparkLayer** | **Field name in Brightpearl** | | ---------------------------- | ----------------------------- | | Handle / ID | Price list code | | Name | Price list | | Currency | Currency |  Please note: Only price lists set to **non-cost **are synchronised between Brightpearl and SparkLayer. During the prices synchronisation, they will be match based on **gross / net** setup within the Brightpearl price list. *** ## Known limitations Please note the following: - Default addresses in Brightpearl will be mapped to Shipping and Billing address in Shopify as Shopify doesn't support independent addresses. - A customer that is removed from the customer group will also need their allocated 'b2b' tag removed from their customer account in Shopfiy. - Addresses are a 1-way sync currently, from Brightpearl into Shopify. Its recommended to not allow address editing in SparkLayer otherwise new addresses added won't appear in Brightpearl. - Issues syncing customers across are provided via email currently. A viewer will be added in the dashboard shortly. [title] Uninstalling, Transferring accounts, & Trials [path] Integrations/Shopify/ ## Uninstalling SparkLayer We understand SparkLayer may not be right just now, but we'd love to be able to help before you uninstall and cancel your subscription. **What's the main reason you're considering canceling?** 💸 [It's too expensive →](https://www.sparklayer.io/feedback/?reason=pricing) 🕒 [I'm not using it enough →](https://www.sparklayer.io/feedback/?reason=usage) 🧩 [Missing features I need →](https://www.sparklayer.io/feedback/?reason=features) 🛠️ [Technical issues →](https://www.sparklayer.io/feedback/?reason=technical) 🔄 [Switching to a competitor →](https://www.sparklayer.io/feedback/?reason=competitor) ❓ [It's something else → ](https://www.sparklayer.io/feedback/?reason=other) You can also see our guide below on how to uninstall SparkLayer from your Shopify store. :::::ExpandableHeading **Uninstalling SparkLayer in Shopify (click to expand)** SparkLayer works as a **Sales channel** within Shopify and uninstalling it works in the same way as any other sales channel.  Please follow the below steps: ::::WorkflowBlock :::WorkflowBlockItem From your Shopify admin, click **Settings**, and then click **Apps and sales channels**. ::: :::WorkflowBlockItem Click **Uninstall** beside the **SparkLayer B2B & Wholesale ** sales channel that you want to remove. ::: :::WorkflowBlockItem If you want to give a reason for removing the channel, then enter it in the field. ::: :::WorkflowBlockItem Click to confirm ::: :::: Once you've removed the sales channel, this will then **cancel** the SparkLayer recurring billing changes with immediate effect. :::hint{type="info"} **More information** You can learn more about removing Sales channel in this [Shopify help guide](https://help.shopify.com/en/manual/online-sales-channels#remove-an-online-sales-channel-from-your-shopify-admin). ::: :::hint{type="warning"} **Please note** - If you've also added the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) to your Shopify store, these will need to be removed manually. - When you follow the uninstall process, our system will automatically delete the account associated with that team after 30 days. If an account is scheduled for automatic deletion, you'll see a warning message at the top of the dashboard notifying you. - Please note, depending on when your billing cycle to SparkLayer began, you may see charges you're not expecting. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) if you would like us to investigate. ::: ::::: *** ## Transferring to another Shopify store When you first sign up to SparkLayer, you'll be asked to associate your account with a Shopify URL (i.e. `storename.myshopify.com`). Once that's done, SparkLayer will be locked to that URL and will begin synchronising products, customers, and enable you to install the Frontend code snippets to test it out. There may be some scenarios where you need to "transfer" your SparkLayer account to a different Shopify store: - You want to trial SparkLayer on a **test or development Shopify store** just to see how it works before you fully commit to using it. - You want to transfer SparkLayer from a "hybrid" Shopify store to a "standalone" Shopify store (or vice versa) The good news is, it's possible to transfer accounts by following the below steps! - First, sign into your Shopify store and uninstall SparkLayer **via the steps above**. This will disconnect SparkLayer from the Shopify store - Next, you'll need to create a new team by following [these steps](docId\:r9NG74uJdtyWlvGbpnB5u) - Next, [sign into SparkLayer](https://app.sparklayer.io/Login) with the new account you created and go to Configuration and click [Integrations](https://app.sparklayer.io/configuration/integrations/platform) - Once you've created the new team, go to Configuration > Connect your Shopify Store - Select **Shopify** and re-enter the new Shopify URL you wish to connect (i.e. `new-storename.myshopify.com`) - You'll then be taken to the Shopify admin and asked to reinstall SparkLayer and select a plan. - Once that's completed, you'll then be returned to the SparkLayer Dashboard. SparkLayer will then begin synchronising your products and customers and you can then re-install the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) on the new store :::hint{type="info" attributes="[object Object]"} **Please note** Shopify data: The transfer process above will **not** transfer any of your Shopify data (e.g. products, customers, orders). This must be managed externally to SparkLayer and apps such as [Matrixify](https://apps.shopify.com/excel-export-import?) can help with this process. If you require any assistance in transferring your Shopify store, please feel free to [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. ::: *** ## Trial period When you first setup SparkLayer, you'll be given a free-trial to allow you to test how it works and ensure it's a good fit for your needs. If you'd like to extend your trial, please [contact our team](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to discuss. [title] Customer Experience [path] Integrations/ ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/F5usKmg_-6xRtRJXj0TU__sufio.png"} [Sufio Invoicing](docId\:qlBasATpzOCOF5eXC99O3) ⚙️ Integrates Directly Professional invoices ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-Sv5L43Yj_sdqbBSwRWZw--20241121-141344.png"} [Locksmith](https://docs.sparklayer.io/locksmith) ✅ Trusted Partner Restrict content ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/JqdLbaSP2Tn4fw6WpY669-tqfB4hdlhBIZadLAKFqRu-20250214-094403.png"} [Intuitive Shipping](docId\:ZkesmMUAWX2SQQ7j6as07) ⚙️ Integrates Directly Advanced shipping ::: :::: [title] Payments [path] Integrations/ ::::LinkArray{contentSource="CUSTOM"} :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/XK7wbxwqgb_6TSQUcXmna_balance.png"} [Balance ](https://www.sparklayer.io/partners-balance/)↗ ✅ Trusted Partner Buy Now, Pay Later for B2B ::: :::LinkArrayItem{headerType="IMAGE" headerImage="https://archbee-image-uploads.s3.amazonaws.com/kxppJrvFK15E9wXbMKaTP/DrzxLSJwqPwu_ZvrAGrM4_billiet.png"} [Billie ](https://www.sparklayer.io/partners-billie/)↗ ✅ Trusted Partner Buy Now, Pay Later for B2B ::: :::: [title] Magento Metafields & Data Mapping [path] Integrations/Magento/ ## Introduction :::hint{type="warning"} **Please note** The SparkLayer Help Docs refer to attributes as "Metafields" elsewhere. ::: Attributes help you to customise the functionality and appearance of your Magento store by letting you save specialised information that isn't usually captured in the Magento admin. You can use attributes for internal tracking, or to display specialised information on your online store in a variety of ways. In the context of SparkLayer, attributes are used to capture additional B2B data that you can then use in a variety of ways: | Type | Details | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Product attributes` | Updating the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) by adding configurations such as [pack sizing](docId\:CmxfrPgjQxfz9vJzTVv0D), [RRP prices](docId\:S_VTlJBorGmnwjjfSMom9), and more | | `Customer attributes` | Updating a customer's information by adding information such as [credit limits](docId\:yWm70oQUosyKOoIqb4Z4G) | | `Order attributes` | Updating an order with [invoicing information](docId\:yWm70oQUosyKOoIqb4Z4G) | *** ## How to add attributes to Magento The easiest way to add attributes is to action this via the SparkLayer Dashboard. Simply go to **Integrations > Platform Connection** and click "Configure" under "Configure metafields". You can then select which of the SparkLayer [attributes](docId\:OTLHhi8sQ6oS4PAt23-8H) you'd like to enable. *** ## Important considerations In order for SparkLayer to work with Magento attributes, please note the following: :::hint{type="warning"} **Product attributes** Attributes are always added at the product variant level, even if the product only comes in a single variant. **JSON data** Some SparkLayer settings require attributes to be set up as JSON strings. These will need to be carefully added, making sure the formatting is set correctly. ::: *** ## Advanced settings To learn about more advanced settings, including customer-level product attributes settings, please see [Product Settings](docId\:Cm9B1I6Cz0vOlc67g-fJI) [title] Wix Error Codes [path] Integrations/Wix/ ## Introduction If SparkLayer detects an error on your Wix store, you may notice one of the following error codes display within the [My Cart Interface](#). We've detailed the most common errors along with the associated way to resolve them. ## Error codes :::hint{type="danger"} - **wix-checkout-out-of-stock**: This occurs when a product in your cart is out of stock in Wix but SparkLayer believes that it is in stock. When a product is not syncing properly from Wix to SparkLayer (for example because a different product already has the same SKU) stock information cannot be synced either. To resolve this go to your [Data Sync](docId:8XClbafeyxHtt5begKM58) page and make sure that all your products are syncing properly. ::: [title] Uninstalling SparkLayer on WooCommerce [path] Integrations/WooCommerce/ ## Uninstalling SparkLayer SparkLayer works just like any other plugin in WooCommerce and you can uninstall it very easily. Please follow the below steps: ::::WorkflowBlock :::WorkflowBlockItem From your WooCommerce admin, click **Plugins**, and then click **Installed Plugins.** ::: :::WorkflowBlockItem Under plugin "SparkLayer B2B", click **Deactivate** ::: :::: Once you've removed the sales channel, this will then **cancel** the SparkLayer recurring billing charges with immediate effect. :::hint{type="info"} **More information** You can learn more about removing apps in this [WooCommerce guide](https://wordpress.com/support/plugins/deactivate-or-delete-a-plugin/). ::: :::hint{type="warning"} **Please note** - If you've also added the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) to your WooCommerce store, these will need to be removed manually. - When you follow the uninstall process, this will disable customers, product and order updates to SparkLayer but will **not** delete the data until you [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to remove your account. - Please note, depending on when your billing cycle to SparkLayer began, you may see charges you're not expecting. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) if you would like us to investigate. ::: *** ## Transferring to another WooCommerce store When you first sign up to SparkLayer, you'll be asked to associate your account with your WooCommerce store. Once that's done, SparkLayer will be locked to that URL and will begin synchronising products, customers, and enable you to install the Frontend code snippets to test it out. You may be wanting to trial SparkLayer on a **test or development WooCommerce store** just to see how it works before you fully commit to using it. The good news is, it's possible to transfer accounts by following the below steps! - First, sign into your WooCommerce store and uninstall SparkLayer via the steps above. This will disconnect SparkLayer from the WooCommerce store - Next, [sign into SparkLayer](https://app.sparklayer.io/Login) with the original account you created and go to Configuration and click [Integrations](https://app.sparklayer.io/configuration/integrations/platform) - Select **WooCommerce** and re-enter the new WooCommerce URL you wish to connect - You'll then be taken to the WooCommerce admin and asked to reinstall SparkLayer and select a plan. - Once that's completed, you'll then be returned to the SparkLayer Dashboard. SparkLayer will then begin synchronising your products and customers and you can then re-install the [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) on the new store :::hint{type="info" attributes="[object Object]"} **Need assistance?** If you require any assistance in transferring your WooCommerce store, please feel free to [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. ::: [title] Shopify Markets & Currencies [path] Integrations/Shopify/ ## Introduction SparkLayer lets you offer B2B pricing in multiple currencies - so each customer sees prices in the currency you assign to them, all from within a single Shopify store. This is ideal for merchants selling to wholesale buyers across different regions. :::hint{type="info"} **Please note:** To enable multiple currencies for your B2B customers, you must have [Shopify Markets](https://help.shopify.com/en/manual/markets) set up. Each currency you want to offer requires a corresponding market within Shopify. Multi-currency also requires [Shopify Payments](https://help.shopify.com/en/manual/payments/shopify-payments) to be active in a supported region. ::: By default, SparkLayer shows B2B pricing in your store's default currency. For example, if your store currency is GBP, all B2B pricing will display in GBP when customers log in. With Shopify Markets enabled, you can configure additional currencies (e.g. USD, EUR) so that each customer group sees pricing in their assigned currency automatically. :::hint{type="success"} **Want to try it out?** Head over to [our demo store](https://demo.sparklayer.io/pages/b2b-login-register) and see multi-currency B2B pricing in action! ::: *** ## How it works When a B2B customer logs in, SparkLayer checks which price list is assigned to their customer group. If that price list is set to a different currency (e.g. EUR instead of your default GBP), the customer automatically sees all B2B pricing, cart totals, and checkout amounts in that currency - no manual switching required. This means you can serve customers in multiple regions from one store, each seeing accurate B2B pricing in the currency you control. *** ## Setting up Shopify Markets Before creating multi-currency price lists in SparkLayer, you need to have the correct markets configured in Shopify. Each currency you plan to use must have a corresponding market. 1. In your Shopify admin, go to **Settings → Markets** (or **Markets** in the main navigation if you are using the new Markets experience). 2. Create a market for each region or country where you want to offer a specific currency. For example, create a "Europe" market with EUR as the currency. 3. Make sure the market is set to **Active** so that the currency is available for use. 4. Ensure [Shopify Payments](https://help.shopify.com/en/manual/payments/shopify-payments/supported-countries) is enabled - multi-currency is only supported in regions where Shopify Payments is available. :::hint{type="info"} **Please note:** You do not need to configure catalogs or product availability within Shopify Markets for SparkLayer to work. SparkLayer manages B2B product visibility and pricing independently. The market simply needs to exist so that Shopify recognises the currency. :::  *** ## Creating your price lists Creating a price list in an additional currency follows the same process as creating any SparkLayer price list. 1. Go to the [Price Lists](https://app.sparklayer.io/price-lists) section of the SparkLayer dashboard. 2. Create a new price list (or edit an existing one). 3. Under **Price List Currency**, select the currency you want this price list to use (e.g. EUR, USD, AUD). 4. Add your product pricing as normal - all values should be entered in the selected currency.  *** ## Assigning price lists to customers Once your multi-currency price list is ready, assign it to the relevant customer group. 1. Go to [Customers](https://app.sparklayer.io/customers) in the SparkLayer dashboard. 2. Select the customer group you want to assign the price list to. 3. Under the pricing section, choose the price list with the correct currency. 4. Configure any additional ordering rules (e.g. minimum order value) - these will apply in the price list's currency.  When those customers log in, they will automatically see B2B pricing in the assigned currency across product pages, the cart, and checkout. *** ## The customer experience ### Product pages When a customer with a non-default currency logs in, product pages display B2B pricing in their assigned currency. For example, a customer assigned a EUR price list will see all prices in euros, while a customer on the default GBP price list sees pounds. ### Cart and checkout The cart and review step display all line items, subtotals, and order totals in the customer's assigned currency. The payment methods available are those you have configured against their [customer group](https://docs.sparklayer.io/customers). ### Shipping If you have multiple shipping methods set up for a customer group (e.g. standard and express), the shipping costs are converted from your store's default currency to the customer's assigned currency. *** ## How orders appear in Shopify When a B2B customer places an order in a non-default currency, the order enters your Shopify admin with the correct currency assigned. How it arrives depends on the payment method: | Payment method | How the order arrives in Shopify | | -------------------- | ------------------------------------------------------------------ | | `Payment by invoice` | Submitted as a draft order | | `Payment on account` | Submitted as a draft order | | `Upfront payment` | Customer completes Shopify checkout - arrives as a completed order | For draft orders, you can [ these into completed orders](https://app.sparklayer.io/integrations/platform) if required.  :::hint{type="info"} **Please note:** Due to how Shopify handles currency conversion and applies discounts internally, you may notice minor rounding differences between the B2B price you set and the price that appears on the order in Shopify. For example, a price set at €7.99 may display as €8.00 in the Shopify admin. This is a known Shopify limitation and not something controlled by SparkLayer. ::: *** ## Using Shopify Companies with Shopify Markets If you are using Shopify's native B2B Companies feature alongside SparkLayer, multi-currency works in a similar way. For full details on how SparkLayer integrates with Shopify Companies, see our [Shopify Companies](https://docs.sparklayer.io/shopify-companies) guide. *** ## Limitations - **"Show prices in local currency" setting** - In a multi-country market, Shopify offers a setting to show prices in each customer's local currency. SparkLayer does not support this setting. You will need to disable it for B2B customers in the relevant market to ensure orders are placed correctly.  - **Price rounding** - Minor discrepancies may occur between the B2B price you set in SparkLayer and the price that arrives in Shopify, due to Shopify's internal currency conversion and rounding logic. - **One market per currency** - Each currency you offer to B2B customers requires a separate market set up in Shopify Markets. - **Shopify Payments required** - Multi-currency is only supported in regions[ where Shopify Payments is available](https://help.shopify.com/en/manual/payments/shopify-payments/supported-countries). - **Managed Markets and zero-value orders** - If you use Shopify Managed Markets, you cannot create a zero-value (e.g. £0.00 / €0.00) B2B order in any currency other than your store's default currency. Customers will see an error at checkout if they attempt this. [Learn more](https://help.shopify.com/en/manual/international/managed-markets/requirements-and-considerations#considerations). - **Duties and import tax** - If you have duties enabled in your Shopify Markets settings, SparkLayer will not charge these in the SparkLayer cart. Duties are not currently supported. - **Market catalogs** - If you assign a specific product collection to a market in Shopify, SparkLayer will not detect or enforce this. SparkLayer manages B2B product visibility independently through its own rules and customer group settings. *** ## FAQ :::ExpandableHeading **Do I need Shopify Plus to use multi-currency with SparkLayer?** No. Multi-currency works on any Shopify plan that supports Shopify Markets and Shopify Payments. However, some advanced Markets features (such as the new Markets experience with submarkets and catalogs) are currently available only on Shopify Plus. ::: :::ExpandableHeading **Can I set different B2B prices per currency, or does SparkLayer just convert from my default currency?** SparkLayer does not convert prices automatically. You create a separate price list for each currency and enter the exact prices you want customers to see. This gives you full control over your B2B pricing in every currency. ::: :::ExpandableHeading **What happens if I haven't set up a Shopify Market for the currency I've used in a SparkLayer price list?** The currency will not be recognised by Shopify at checkout, which may cause errors when orders are placed. Always ensure a corresponding Shopify Market exists and is active for each currency you use in SparkLayer. ::: :::ExpandableHeading **Will my B2C customers be affected by the Shopify Markets I set up for B2B?** Shopify Markets apply to your entire store, so B2C customers in the relevant regions will also see the market's currency. SparkLayer's B2B pricing is separate and only visible to logged-in B2B customers - but the underlying Shopify Market currency applies to all visitors from that region. ::: :::ExpandableHeading **Can I offer the same customer group pricing in multiple currencies?** Not within a single price list. Each price list has one currency. If you need the same customer group to see pricing in different currencies depending on their region, create separate price lists (one per currency) and assign the correct one to each customer or customer group. ::: :::ExpandableHeading **Why do I see small rounding differences on orders in Shopify?** This is caused by Shopify's internal currency conversion logic. When SparkLayer submits a B2B order, Shopify applies its own conversion and discount calculations, which can result in minor rounding differences (e.g. €7.99 becoming €8.00). This is a Shopify-side limitation. ::: :::ExpandableHeading **Does SparkLayer support Shopify's automatic exchange rates?** No. SparkLayer uses fixed prices that you define in each price list. Shopify's automatic exchange rate conversion does not apply to SparkLayer B2B pricing. You control the exact price your customers see. ::: [title] Wix Metafields & Data Mapping [path] Integrations/Wix/ ## Introduction :::hint{type="danger"} **Please note** At this time, it is not possible to use metafields with Wix therefore all [configurations detailed here](docId\:OTLHhi8sQ6oS4PAt23-8H) are not currently available. In the near future, Wix will be adding support for metafields and we will update this guide accordingly. ::: [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) help you to customise the functionality and appearance of your store by letting you save specialised information that isn't usually captured in the Wix Dashboard admin. You can use metafields for internal tracking, or to display specialised information on your online store in a variety of ways. [title] Uninstalling SparkLayer on Magento [path] Integrations/Magento/ ## Uninstalling SparkLayer SparkLayer works just like any other integration in Magento and you can uninstall it very easily. Please follow the below steps: ::::WorkflowBlock :::WorkflowBlockItem From your Magento admin, click **System**, and then click **Integrations.** ::: :::WorkflowBlockItem Under plugin "SparkLayer B2B", click **Delete** ::: :::: Once you've removed the sales channel, this will then **cancel** the SparkLayer recurring billing charges with immediate effect. :::hint{type="warning"} **Please note** - If you've also added the SparkLayer [Frontend Interfaces](docId\:ccZ1vnH0O6D_722w35Xpa) to your Magento store, these will need to be removed manually. - When you follow the uninstall process, this will disable customers, product and order updates to SparkLayer but will **not** delete the data until you [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) to remove your account. - Please note, depending on when your billing cycle to SparkLayer began, you may see charges you're not expecting. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) if you would like us to investigate. ::: [title] Unleashed [path] Integrations/ERPs & Operations/  :::hint{type="info"} **Requirements** - **Plan**: Merchants must be signed up to the Pro or Enterprise plan - **Ecommerce Platform**: Merchants must be using Shopify - **Unleashed**: Merhcants must have an approved Unleashed account ::: ## Introduction Unleashed is a leading inventory management system that’s designed for manufacturers, wholesalers and distributors. From inventory and stock, order management, right through to fulfilment, Unleashed lets you automate your eCommerce operations. You can learn more about Unleashed [here](https://www.unleashedsoftware.com/). *** ## How it works The Unleashed integration for SparkLayer is available for all [Shopify merchants](https://docs.sparklayer.io/integrations/shopify-introduction#introduction) that already use Unleashed and allows you to bring **B2B pricing and B2B ordering** into SparkLayer and your Shopify store. The integration works in the following ways: | **Item** | **Details** | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Customers` | Unleashed becomes the 'master' of your B2B customer data, and any changes to customer records that have the assigned Customer Type will automatically be synchronised to Shopify and SparkLayer. | | `Orders` | Orders placed via SparkLayer are synchronised from Shopify into Unleashed using your **existing** [Unleashed integration](https://support.unleashedsoftware.com/hc/en-us/articles/4402425783577-Shopify-Integration-Introduction). Prices that show on orders will be the special B2B pricing as set up in Unleashed | | `Pricing` | Price lists and product prices are imported into SparkLayer via pricing rules you set up in Unleashed | | `Sync` | The automatic sync is carried out every 4 hours | :::hint{type="info"} **Please note** We recommend also familiarising yourself with the "Known limitations" below ::: *** ## Configuring the integration :::hint{type="info"} **Before you begin** You'll need to have an approved account with Unleashed - Please visit the [Unleashed website](https://www.unleashedsoftware.com/) to learn more. ::: To get started, the integration needs to be enable within the [SparkLayer Dashboard.](https://app.sparklayer.io/configuration/integrations/partners)Go to the **Integrations** section and click **Partner Integrations.** Under **Multi-channel management**, click the toggle on the right to activate the Unleashed integration.  You'll then be prompted to enter the following details:  | **Item** | **Details** | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `API ID` | You can find this within your Unleashed admin under **Integration, Unleashed API Access** | | `API Key` | You can find this within your Unleashed admin under **Integration, Unleashed API Access** | | `Customer Types` | The customer type should match a customer type that exists in Unleashed. This is the group of customers within Unleashed that SparkLayer will **synchronise to Shopify**.**Please note:** this must match exactly what is in Unleashed and be seperated by a **comma** with **no** space (e.g. `GROUP1,GROUP2)`. For the purposes of testing, we recommend creating a new group and testing with a dummy customer first before using an existing group. | | `Price Lists` | This is the Unleashed price list you want to set as highest priority for all customer groups. For example if you assign a price list here this would take priority over all other price lists assigned to the customer account.
**Please note: **if you are adding multiple price lists, these must be seperated by a **comma** with **no** spaces. | *** ## Configuring Customers Broadly speaking, Unleashed is your **central location **for managing B2B customer data. When customers are configured in Unleashed as B2B customers, SparkLayer can **automatically** retrieve this data and then enable the B2B ordering experience on your Shopify site. ::::ExpandableHeading **Step 1 - setting up Customer Types** When you have set up the [integration with SparkLayer](https://app.sparklayer.io/configuration/integrations/partners) within your Unleashed Dashbaord, go to **Settings** and then **System**. Within the options you will see **Customer Type**. Within this field, you'll then need to create the different customer groups that you are going to be offering different prices to.  Next, navigate to your **SparkLayer Dashboard** and [Customer Groups](https://app.sparklayer.io/customers/groups). Here you'll need to create the customer groups with the names **matching** the title of the **Customer Types** you have created in Unleashed. In our example below, we have `Base` and `Gold`.  Next, go to the [Partner Integrations](https://app.sparklayer.io/configuration/integrations/partners) section of SparkLayer and click **Modify** within the Unleashed integration. Finally, add the **Customer Types** you have created in Unleashed that you want to sync across to SparkLayer. In our example, we've added them for `Base` and `Gold`. :::hint{type="warning"} **Please note** Customer Types**must** be seperated by a comma with **no** spacing to sync correctly e.g. `Base,Gold` :::  :::: ::::ExpandableHeading **Step 2 - syncing your customers** To sync your customers, you'll need to create your customers in your Unleashed Dashboard if you haven't already. When doing this you are able to allocate them a **Customer Type. **This will assign them into the specific [customer group](https://app.sparklayer.io/customers/groups) within SparkLayer when they are synced across. **Please note: **The customer will be tagged with this customer group as the normal SparkLayer process.  When setting up your customers in Unleashed, please ensure you set up: - A full address - Assign any specific tax settings - Assign a valid email address. This must be set up in order to sync to SparkLayer and Shopify. **Syncing across to SparkLayer and Shopify** First, you'll need to update the customer type to match that entered in the **Customer Type** field (as noted above). SparkLayer is then configured to synchronise **once per night**, and any new and updated records will automatically be synchronised with Shopify. Customers are mapped between the systems based on the **primary contact email** set within Unleashed. Once this is mapped, SparkLayer will then synchronise the following data into Shopify and you'll be able to see within the customer record within Shopify. | **Unleashed** | **Shopify / Spark Layer** | | ------------------- | ------------------------------------------------------------------ | | `Address` | Shows against customer record in Shopify | | `Phone` | Shows against customer record in Shopify | | `First / Last Name` | Shows against customer record in Shopify | | `Company Name` | Shown via metafields in Shopify | | `Stop Credit` | Shown via metafields in Shopify (used to allow payment on account) | | `Taxable` | Shows against customer record in Shopify | :::hint{type="warning"} **Please note** All customer data is managed via Unleashed and any amends made directly in Shopify will **not** synchronise back to Unleashed. ::: :::: :::ExpandableHeading **Step 3 - giving access & notifying new customers** Since Unleashed is the central source for customer data, any new customers created in Unleashed will **automatically** be added to Shopify. When new customer records are added to Shopify, they will by default be added as **Pending** customer accounts and receive an **automatic email** to enable their account by setting a password.  This uses the **Customer account invite** notification email which can be edited in the [Notifications section within Shopify](https://admin.shopify.com/settings/notifications/customer). If you prefer **not** to send the customer account invite automatically, you can easily check if this option has been activated. Simply go to your SparkLayer Dashboard, navigate to [Partner Integrations](https://app.sparklayer.io/sparklayerunleashedtest/live/configuration/integrations/partners). When modifying your Unleashed integration, you can enable or disable this via the setting at the bottom.  ::: *** ## Configuring Pricing In Unleashed, you can utilise **up to 10 price lists**, allowing you to create multiple pricing tiers tailored to your various customer levels. On top of this limit, you have the flexibility to set customer-specific and product-specific discounts, providing even more granular control over your pricing strategy. ::::ExpandableHeading **Step 1 - price list setup** In Unleashed, navigate to **Settings **> **System **> **Sell Price Tiers**. Here, you can customise the names of your price tiers, which are initially labelled as "Sell Price Tier 1" through to "Sell Price Tier 10". :::hint{type="warning"} **Please note** SparkLayer **does not** support the custom names meaning they will show in SparkLayer as "Sell Price Tier X" ::: **Promotion price list** If you want to offer a promotion to customers you are able to do this by creating a promotional price list. You are able to do this by adjusting the product prices within a specific price list mentioned above. You are then able to sync this to all of your customers and make it a "priority price list". You'll need to add this to the [Partner Integration](https://app.sparklayer.io/configuration/integrations/partners) within the SparkLayer Dashboard by clicking **Modify** on the Unleashed option. Within the Price Lists section, enter the price lists you want add. As with Customer Types, if you're adding multple price lists, they must be separated with a **comma** with **no spacing**. E.g. `PriceList1,PriceList1`  :::: ::::ExpandableHeading **Step 2 - viewing price lists** When you view a product within your Unleashed Dashboard, under the **Sale** tab you’ll see the available price tiers listed. For products offered to your wholesale customers, you can specify the exact price for each tier, depending on which pricing list is assigned to the customer.  If you are offering multiple currencies then you are able to use the Sell Price Tiers wihtin Unelashed to achieve this. For instance, if you offer pricing in USD, GBP and EUR then you can assign each currency to a Sell Price Tier in Unleashed (e.g "Sell Price Tier 1" is your GBP price. "Sell Price Tier 2" is EUR). You are able to set this up SparkLayer by going to Settings > Integrations > Partner Integrations, when modifying the Unleashed Integration and you will see the below :::hint{type="warning"} **Please note** If you only sell in the base currency of the store then you will not need to specify the currency as above. :::  :::: ::::ExpandableHeading **Step 3 - assigning a price list** Within your Unleashed Dashboard, navigate back to the customer account that you are working on. You are then able to assign them a price list directly to the customer account within **Sell Price Tier**. This means when they login they will see the product pricing you've assigned to them.  :::hint{type="warning"} **Please note** These price lists will be asigned directly to the customer account through the SparkLayer price list metafield which is set up differently to standard price lists. You can learn more in [Metafields](docId\:OTLHhi8sQ6oS4PAt23-8H) ::: :::: ::::ExpandableHeading **Setting up product specific discounts** Within the Unleashed Dashboard, navigate to a customer record and click Customer Pricing. Here you are able to set product specific pricing for this customer account. You are able to search for a product, specify a fixed price or discount on the product. When doing this, it will create a new price list within the [SparkLayer Price Lists](https://app.sparklayer.io/pricing/lists) section.  :::hint{type="warning"} **Please note** If you choose to offer a discount this will be from the **Default Sell Price** under **Discount From**. You can see more below under our Known Limitations. ::: :::: :::ExpandableHeading **Setting up additional customer discounts** Within the Unleashed Dashboard, navigate to a customer account and under the **Details** tab, you can provide customers with an additional discount on top of their assigned price list. You’ll see a **Discount (%)** box, where you can enter the desired discount percentage. When doing this, it will create a new price list within the [SparkLayer Price Lists](https://app.sparklayer.io/pricing/lists) section.  ::: :::ExpandableHeading **Assiging prices to the Shopify Customer account** Once you have finished configuring your customers pricing and a sync has taken place, you can then check the customer account in Shopify to ensure they have been assigned the correct pricing. The price list will be assigned directly to the customer account in a **Price List metafield** (this gets added automatically when you first set up the SparkLayer integration). It will also create the price list within your SparkLayer Dashboard > Price lists as an "Integration" Price List. With this metafield it will **always** work in a hierarchy order, which means when a customer searches a SKU it will check the first price list and will cascade through the price lists untill it finds a price. In the example below you are able to see a number of price lists. 1. Any** customer product specific discounts** you have created within the customer in Unleashed. 2. Any** customer specific percentage discounts **that you have given on top of the price list assigned to the customer. 3. The **normal price list **that you have assigned to the customer 4. You will alway see a fallback of the **Default Sell Price**.  ::: *** ## Data mapping We've detailed how data is mapped between SparkLayer and Unleashed. | Item | Details | | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Creating Price Lists` | SparkLayer generates several types of price lists based on the product prices available in Unleashed. | | `Default Price List` | All product prices set in Unleashed under the **Product/Sale** tab go into a standard Default Price List. This acts as the baseline price for all products. | | `Sell Price Tiers` | If Unleashed has specific Sell Price Tiers set up (e.g., "Sell Price Tier 1", "Sell Price Tier 2", etc.), SparkLayer creates separate price lists for these tiers. Unleashed supports up to 10 Sell Price Tiers that you can assign to different groups of customers. | | `Customer-Specific Prices` | If any customer has unique prices specified under the Customer/Product Pricing tab in Unleashed, SparkLayer creates a Customer-Specific Price List for that customer. This ensures that individual customer agreements or special pricing arrangements are captured. | | `Handling Different Currencies` | If a customer uses a currency other than the base currency, SparkLayer will automatically create Alternative Currency Price Lists based on the existing price lists. | | `Applying Discounts` | If a customer has a specific discount percentage assigned (e.g., 10% off all products), SparkLayer will generate a Discounted Price List to reflect the adjusted prices. | | `Assigning Price Lists to Customers` | When assigning prices to customers, SparkLayer follows this order of priority:
* First, the Customer-Specific Price List (if available). * Then, a Sell Price Tier (if assigned in Unleashed). * Finally, the Default Price List.
If a customer has multiple currencies or discounts, they will get additional price lists accordingly. | | `Why Prefixed Price Lists?` | SparkLayer may apply generic "prefixed" price lists to every customer. This is to ensure that a basic Sell Price Tier is always in place, even if the customer’s Unleashed configuration doesn’t explicitly assign one. | *** ## Known limitations **Setting a Discount % as a Price Type** In Unleashed, you can assign the customer’s ‘Sell Price Tier’ from the ‘Details’ tab of the customer record.  Additionally, you can set up specific discounts from the ‘Customer Pricing’ tab. However, there is a specific configuration of this that we do not support due to a limitation with the Unleashed API. If you choose ‘Discount %’ as the Price Type, it will only affect their ‘Sell Price Tier’ (as referred to above), and not the ‘Default Sell Price’ or the ‘Customer Price Tier’.  The following limitations also apply: - Internally SparkLayer will use the internal SellPriceTier naming for simplicity between mapping, not the custom naming that can be setup via the Unleashed Settings - Customers set as obsolete will not be synced. When converting an account to obsolete in Unleashed, the customer will be needed to be disabled manually in Shopify. - Changing the customers email address, will create an additional customer in Shopify. The old account will need to be disabled manually. - Primary Customer Contacts will only be synced. If a new primary contact is selected, the existing Shopify customer on the store should be manually disabled. - Order Import Options in Unleashed Order Configuration must not use import orders to a single customer. To get around this, using a second store for B2B can be the solution. - Customer Synchronization must be disabled in the Unleashed Shopify integration. *** ## Troubleshooting :::ExpandableHeading **Why are some of my customers not syncing correctly from Unleashed to Shopify?** Ensure that the Customer Type field in Unleashed matches exactly what you have set up in SparkLayer. Remember, the Customer Type names should be separated by a comma with no spaces (e.g., Base,Gold). Also, check that the email address is correctly set in Unleashed, as this is used to map the customer records. ::: :::ExpandableHeading **Why am I not seeing the B2B pricing updates in my Shopify store?** This could be due to the pricing rules in Unleashed not being set up correctly. Make sure that the Price Lists in Unleashed are correctly assigned to the customers. Check that these lists match the Price Lists configured in SparkLayer and that they are separated by commas without spaces. ::: :::ExpandableHeading **Why do changes I make in Shopify not reflect in Unleashed?** Shopify is not the master data source for customers in this integration. Unleashed is the single source of truth, meaning any updates made directly in Shopify will not synchronise back to Unleashed. Make changes in Unleashed, and the integration will push these updates to Shopify. ::: :::ExpandableHeading **What should I do if orders placed in Shopify are not appearing in Unleashed?** Verify that the integration settings are configured correctly in the Unleashed Dashboard. Check that the correct API Key and Customer Type fields are being used. If these are set correctly, review the order logs in SparkLayer for any errors during the sync process. ::: :::ExpandableHeading **Why are my custom price lists not displaying properly in SparkLayer?** SparkLayer currently supports Unleashed’s default Sell Price Tiers (e.g., "Sell Price Tier 1"). If you’ve created custom-named tiers, they will not appear in SparkLayer. You need to use the default naming convention for Sell Price Tiers to ensure they display correctly. ::: :::ExpandableHeading **Why am I getting duplicate customers in Shopify after updating emails in Unleashed?** When you change a customer’s email address in Unleashed, it is treated as a new customer by Shopify. To avoid duplication, manually disable the old account in Shopify after making the change in Unleashed. ::: :::ExpandableHeading **Why are my customer-specific discounts not being applied correctly?** Check that the Discount % has been set correctly in Unleashed. Keep in mind that using the "Discount %" option affects only the Sell Price Tier and not the Default Sell Price. For accurate discounts, make sure to apply them to the relevant Price Tiers or use Customer Pricing options within Unleashed. ::: [title] BigCommerce FAQs [path] Integrations/BigCommerce/ ## Introduction We've included some of our most commonly asked questions below. If you can't find the answer you're after, please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) and we'll be happy to help. *** ## Frequently Asked Questions ### Plans and pricing :::ExpandableHeading **Which SparkLayer plans do you offer for BigCommerce?** All SparkLayer plans are compatible with BigCommerce, from "Starter" right through to "Enterprise". [Learn more](https://www.sparklayer.io/pricing/) about our plans and pricing. ::: :::ExpandableHeading **How does billing work?** When you sign up to SparkLayer, our team will contact you to discuss the most appropriate plan for your needs. Billing is managed via a monthly billing cycle with the option to pay annually. ::: :::ExpandableHeading **How do I select and change plan (upgrade or downgrade)** You can sign up to SparkLayer on BigCommerce without initially selecting a plan. Once you've installed SparkLayer, our team will contact you to discuss the next steps. Once you've activated a plan, we are happy to work with you to upgrade or downgrade based on your changing requirements. ::: ### BigCommerce setup :::ExpandableHeading **Where do I find the SparkLayer BigCommerce app?** You can find the official SparkLayer for BigCommerce app in the [BigCommerce App Store](https://www.bigcommerce.com/apps/sparklayer-b2b-wholesale/). ::: :::ExpandableHeading **What BigCommerce plan do I need to be on to use SparkLayer?** SparkLayer works on all versions of BigCommerce, from BigCommerce Essentials right through to BigCommerce Enterprise. All you need is an active BigCommerce store and you're good to go. ::: :::ExpandableHeading **Can I use SparkLayer with my development website?** Yes! If you're setting up SparkLayer on a development store (e.g. a test account), we can enable a special developer-mode that lets you use SparkLayer until you're ready to activate a billing plan. Please [contact us](docId\:NNUw1G9z7eaJ4M78vk7t9) for more details. ::: :::ExpandableHeading **Can I have DTC and B2B on the same BigCommerce website?** Yes, it's possible to install SparkLayer onto your existing BigCommerce DTC store (i.e. retail), meaning you can run both DTC and B2B on the same store. We call this a 'hybrid setup'; when your B2B customers sign in, they simply see the special SparkLayer [Frontend](docId\:OgKfvQX13dHW2582D57kJ) interface that allow them to see their prices and place orders. If you want to see this in action, you can try our [B2B/B2C demo store here](https://b2b-demo-store-usd.myshopify.com/) ::: ### Theme setup :::ExpandableHeading **Can you help me install SparkLayer on my BigCommerce website?** Yes! Within the [SparkLayer Dashboard](https://app.sparklayer.io/help), you'll see an option to request our team to install SparkLayer for you. Typically we can do this within 1-2 working days and you're then good to go. We then offer an onboarding session to walk you through how everything works. ::: :::ExpandableHeading **Does SparkLayer work on any BigCommerce theme?** Yes! SparkLayer is compatible with all BigCommerce themes, even fully customised. If you need help in the setup, our team can add all the code snippets for you. ::: :::ExpandableHeading **How does SparkLayer affect my current BigCommerce theme?** The SparkLayer B2B widgets, including B2B pricing, cart and my account area, are only loaded once a customer who has been added to a b2b customer group successfully signs in to your store. For all other users, your store will remain completely unaffected. This allows you to have full control over which customers are able to see your B2B pricing and place B2B orders. ::: :::ExpandableHeading **What if I'm already using a wholesale B2B app on my website?** If you already have a B2B / Wholesale app installed on your store, SparkLayer can work alongside this. It's a great way to test out SparkLayer and, once you're happy, you can simply uninstall any previous B2B apps you were using. If your previous B2B app has made code changes to your BigCommerce store, you may want to ask the app developer to remove these although this is optional. ::: ### Payments :::ExpandableHeading **Can I use my existing payment methods on the checkout?** In terms of payment methods supported by SparkLayer and BigCommerce. If your customers choose "Pay Online by Card" during the SparkLayer checkout process, they will simply be taken to the BigCommerce checkout. From there, any payment methods you have set up in BigCommerce (e.g. Paypal, Affirm Pay) will show up, allowing the customers to pay by this method. We've attached a screenshot to illustrate this. In short, if BigCommerce support this payment method, your B2B customers could select it during the checkout providing they choose "Pay Online by Card". ::: ### Products :::ExpandableHeading **How do I hide products or set up B2B-only products?** BigCommerce does have the ability to hide collections from Customer Groups which could be one way to achieve this.  There are a few things we recommend to make the experience better: - You could **create a B2B-only collection** and redirect customers to this once they login. If you wanted to show special B2B-only products, you would need to create these as separate products within BigCommerce (i.e. with unique SKUs, etc) - With SparkLayer pricing, if you don't upload a price against a SKU, the B2B customer** won't be able to purchase it.** So this is a way to prevent them from adding items you don't want them to purchase - It is possible to adapt the BigCommerce themes to hide/show products using custom coding ::: :::ExpandableHeading **Can I use my BigCommerce prices for my B2B pricing?** Yes! SparkLayer allows you to automatically synchronise your BigCommerce prices (e.g. your main BigCommerce retail price), making it really easy to set up B2B pricing for your customers. For example, you could set your B2B prices to be 20% off your BigCommerce prices and we can even make provisions for your tax set up in BigCommerce (e.g. exclusive or inclusive of tax). ::: :::ExpandableHeading **How do I set up pre-order and backorder products?** In terms of pre-ordering, SparkLayer has full support for different stock status messages and it's possible to set up products as pre-order/back-order easily - it does rely on some configuration within BigCommerce, but it's relatively easy to do! We've [full information here](docId\:Gj_Ao_gQ6oA-jx0D27Hys) on how it works and you can even set up "due in" dates to give your customers visibility. ::: :::ExpandableHeading **Do I need to use product SKUs?** In terms of product SKUs, SparkLayer relies on these being added to your products within BigCommerce so that we can display the correct B2B pricing when your customers log in. Without a unique SKU, there's no way for SparkLayer to do this. If you don't already have SKUs in BigCommerce, it's relatively quick to do. You can either edit individual products and add them manually, or you can use BigCommerce's 'Import' or 'Edit products' feature to do this in bulk. ::: ::::ExpandableHeading **How do I restrict B2B customers from DTC inventory (and vice versa)** If you're installing SparkLayer on a single website and you are looking to run both DTC and B2B at the same time, it will be necessary to **use the same stock pool **behind the scenes. From an inventory point of view, this essentially means that both DTC and B2B customers will be ordering from the same stock source which can pose challenges. SparkLayer has a way to "reserve" stock for your DTC customers, essentially blocking B2B customers from ordering too much inventory for a specific product. [Learn more](docId\:Gj_Ao_gQ6oA-jx0D27Hys) :::hint{type="info"} **Important** It is not possible to block DTC customers from ordering from your inventory and there is no mechanism in BigCommerce to do this. If you are wanting to implement this, you will need to consider: - Creating B2B-specific products on your store - Creating a separate store just for your B2B customers, effectively separating out your inventory completely. ::: :::: :::ExpandableHeading **Can I sell products on both store fronts?** Yes, it is possible to have product purchaseable on both store fronts if you are using both for wholesale. When you are in the product within your admin, please ensure that you have both store fronts selected as sales channles that you want to offer the products on. ::: ### User Experience :::ExpandableHeading **How do I set up a B2B registration form?** If you're looking to enable a wholesale/B2B registration form there are a few good options for this and In summary, these are the options we recommend: - You could use your current login/registration page and enhance the registration page with some custom coding - You could use a [recommended form builder app](https://support.bigcommerce.com/s/article/Creating-a-Contact-Form?language=en_US#form-builders) to achieve this It's also worth noting that you can manually add customers via the **BigCommerce Customers** admin and from there you could moderate your wholesale applications. ::: :::ExpandableHeading **How do I invite a B2B customer to my website?** Please refer to [our guide here](docId:5_lWMNohhjBJJppg9E6Vh). ::: :::ExpandableHeading **Will SparkLayer slow down my BigCommerce website?** No. For performance, the SparkLayer Frontend only loads when a valid B2B customer successfully logs into a website; for your standard (DTC) customers, no code is loaded at all. When a B2B customer logs in, all loading of the interfaces is asynchronous which means a negligible impact on page load times and performance even though SparkLayer is a hosted third-party solution. The result is the end customer will have a rapid experience browsing products and placing orders. ::: :::ExpandableHeading **How do I setup B2B-specific content on my BigCommerce website?** We recommend consulting with a BigCommerce expert developer before making changes to your website. For their reference, you may find the following Stencil code can be used as a mechanism to hide and show content based on a B2B customer being logged in. ```html {{#contains (toLowerCase customer_group_name) "b2b"}} {{/contains}} ``` ::: ### Orders :::ExpandableHeading **Where do I find my B2B orders in BigCommerce?** **Manual payments** For manual (non-card) payment orders (e.g. Payment by Invoice), the order is saved as a "Draft order". - You can view these in your BigCommerce admin within **Orders** and then click **Draft Orders** - You can then convert these into approved orders by marking them as paid or marking them with payment terms It's important to note that once an order has been approved, it will **only** then show in the customers My Account section and the [SparkLayer Dashboard](https://app.sparklayer.io/orders). **Card payments** You can view these in your BigCommerce admin within **Orders** ::: :::ExpandableHeading **How do I see the 'shipped' order status when viewing an order on SparkLayer?** SparkLayer will automatically show a B2B order as "Shipped" providing it meets the following conditions: 1. The order is marked as 'Shipped' within BigCommerce 2. The order has a shipment assigned to it within BigCommerce Without the both being applied to an order, the B2B order will remain in a "Processing" state until actioned. ::: :::ExpandableHeading **How do I edit orders?** It is possible to edit orders within BigCommerce when an order is placed via SparkLayer. If you have it configured to create orders as 'Draft orders' you can go into the order and make changes. If you subsequently then manually complete the order (i.e. Mark as paid), you can still edit the order up until the point of fulfilment. ::: :::ExpandableHeading **How do I send an invoice?** In terms of invoicing, SparkLayer doesn't send invoices directly but there are some good ways to do this within BigCommerce using a recommended invoicing app or by sending invoices manually to your customers via your existing back-office financial system. ::: :::ExpandableHeading **How do I set a minimum order quantity?** Within SparkLayer, we do have support for minimum (and maximum) quantities, but you're only able to set these at a product or product-variant level. It's not currently possible to set minimum order-level quantities but it's something we are considering as part of a future update! ::: :::ExpandableHeading **How do I send order notifications to customers and my team?** You can manage notifications from BigCommerce by going to **Settings** and clicking **Order Notifications** ::: [space] SparkLayer B2B Catalogs (/b2b-catalogs) [title] Configuring Access Denied View [path] Setup/ When a product has been hidden for a customer, if the customer attempts to access the the product's PDP page - they will be shown an "access denied" view. If you would like to customize the content of this page, you can do so by modify the liquid `snippets/sparklayer-b2b-catalogs-access-denied.liquid` file that is automatically added when you installed the B2B Catalogs app. :::hint{type="warning"} **Please note** If you disable B2B Catalogs on a theme where you have modified this file, your modifications will be removed. ::: [title] Enabling Catalogs [path] Setup/ :::hint{type="success"} Enabling B2B catalogs is as simple as selecting a theme you would like to display your catalogs, and clicking the `enable` button. :::  Once you've enabled B2B Catalogs on a theme, you will see a list of all other themes which you can / have already enabled B2B Catalogs on. There is no limit to the amount of themes you can have Catalogs enabled on.  [title] Limitations [path] / ### Advanced Catalogs Variant Count Due to the way Shopify provides access to product variants within a theme - we can only guarantee the desired hide/show behaviour on products with `<= 250` variants. ### Hidden product Add to cart caveats If a customer already has a product in their cart before said product is configured such that it should be hidden - the product will remain in the customers cart and they will be able to check out. Similarly customers will still be able to add a product to their cart via add to cart permalinks even if the product is hidden from them. ### Third party app compatibility The Shopify app eco-system is vast, as such we cannot guarantee compatibility with all other third party apps ### Invalid liquid syntax We're unable to modify theme files that contain invalid liquid syntax. If you encounter an error stating `invalid liquid syntax in file
Whether the storefront should show the gross amount and label it tax inclusive. Not derivable from tax_rate, since a zero-rated SKU on a tax-inclusive price list has a rate of 0 but must still be labelled. Display only - it says nothing about what is charged.
", "default": false } ] }, { "name": "price_v2_pre_discount", "kind": "optional", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "PriceDeprecated", "description": "", "modelRef": "#/components/schemas/PriceDeprecated", "schema": [ { "name": "net", "kind": "optional", "type": "numberWhether the storefront should show the gross amount and label it tax inclusive. Not derivable from tax_rate, since a zero-rated SKU on a tax-inclusive price list has a rate of 0 but must still be labelled. Display only - it says nothing about what is charged.
", "default": false } ] } ], "schema": [] }, { "name": "handle", "kind": "optional", "type": "string", "description": "" }, { "name": "cost_type", "kind": "optional", "type": "string", "description": "" }, { "name": "cost_language_string", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "allowed_payment_methods", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "payment_by_invoice", "kind": "optional", "type": "stringReplaces all existing cart line items. The provided quantities are absolute values (not deltas). Passing an empty array clears the cart.
", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "optional", "type": "integer", "description": "" } ] }, { "name": "shipping_address_id", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "temporary_shipping_address", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "first_name", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "last_name", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "address_line1", "kind": "optional", "type": "string", "description": "" }, { "name": "address_line2", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "city", "kind": "optional", "type": "string", "description": "" }, { "name": "region_code", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "postal_code", "kind": "optional", "type": "string", "description": "" }, { "name": "country_code", "kind": "optional", "type": "string", "description": "" }, { "name": "phone", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] }, { "name": "customer_reference", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "po_number", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "shipping_requested_date", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "custom_fields", "kind": "optional", "type": "array", "description": "Replaces all existing custom fields on the cart. Any existing field not included is removed. Passing an empty array clears all custom fields.\n", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "A null value has the same effect as omitting this field from the array: it is not included in the replaced set of custom fields.
" } ] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful response", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "cart", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Cart", "customType": "Cart", "schema": [ { "name": "id", "kind": "optional", "type": "stringWhether the storefront should show the gross amount and label it tax inclusive. Not derivable from tax_rate, since a zero-rated SKU on a tax-inclusive price list has a rate of 0 but must still be labelled. Display only - it says nothing about what is charged.
", "default": false } ] }, { "name": "unit_total", "kind": "optional", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "Price", "description": "", "modelRef": "#/components/schemas/Price", "schema": [ { "name": "net", "kind": "optional", "type": "string", "description": "" }, { "name": "gross", "kind": "optional", "type": "string", "description": "" }, { "name": "tax_rate", "kind": "optional", "type": "numberWhether the storefront should show the gross amount and label it tax inclusive. Not derivable from tax_rate, since a zero-rated SKU on a tax-inclusive price list has a rate of 0 but must still be labelled. Display only - it says nothing about what is charged.
", "default": false } ] } ], "schema": [] } ] }, { "name": "totals", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CartTotals", "customType": "CartTotals", "schema": [ { "name": "total", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Totals", "customType": "Totals", "schema": [ { "name": "pre_discount", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "net", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Amount", "customType": "Amount", "schema": [ { "name": "amount", "kind": "optional", "type": "string", "description": "" }, { "name": "currency_code", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "gross", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Amount", "customType": "Amount", "schema": [ { "name": "amount", "kind": "optional", "type": "string", "description": "" }, { "name": "currency_code", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "tax", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Amount", "customType": "Amount", "schema": [ { "name": "amount", "kind": "optional", "type": "string", "description": "" }, { "name": "currency_code", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "apportioned_tax_rate", "kind": "optional", "type": "numberShipping Method ID (always prefixed with sm_)
", "example": "sm_123", "maxLength": 15 }, { "name": "created_at", "kind": "optional", "type": "stringShown by order (lower first)
", "default": 0, "minimum": 0, "maximum": 127 }, { "name": "countries", "kind": "optional", "type": "array", "description": "Countries covered by this shipping method (ISO 3166-1 alpha-2)
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "GB", "itemDefault": "" }, { "name": "regions", "kind": "optional", "type": "map", "description": "Regions covered by this shipping method (per country) Keys are country codes (ISO 3166-1 alpha-2) Values are lists of region codes. If the list is empty, all regions are allowed
", "example": "", "customType": "mapCustomer groups covered by this shipping method (use default to cover all groups)
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "default", "itemDefault": "" }, { "name": "bands", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "Internal Band Name", "example": "Band 1", "maxLength": 50 }, { "name": "priority", "kind": "optional", "type": "number", "description": "Filtered by first found by percentage_charge order (lower first)
", "default": 0, "minimum": 0, "maximum": 127 }, { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "Shipping SKU (Leave null to use the Shipping Method SKU)
", "example": "ship_123", "maxLength": 15 }, { "name": "requirement", "kind": "optional", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "weight": "#/components/schemas/ShippingMethod.Requirement.Weight", "none": "#/components/schemas/ShippingMethod.Requirement.None", "net_total": "#/components/schemas/ShippingMethod.Requirement.NetTotal", "gross_total": "#/components/schemas/ShippingMethod.Requirement.GrossTotal" } }, "description": "", "complexType": "oneOf", "complexItems": [ { "name": "ShippingMethod.Requirement.Weight", "description": "", "modelRef": "#/components/schemas/ShippingMethod.Requirement.Weight", "schema": [ { "name": "type", "kind": "optional", "type": "stringShipping Method ID (always prefixed with sm_)
", "example": "sm_123", "maxLength": 15 }, { "name": "created_at", "kind": "optional", "type": "stringShown by order (lower first)
", "default": 0, "minimum": 0, "maximum": 127 }, { "name": "countries", "kind": "optional", "type": "array", "description": "Countries covered by this shipping method (ISO 3166-1 alpha-2)
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "GB", "itemDefault": "" }, { "name": "regions", "kind": "optional", "type": "map", "description": "Regions covered by this shipping method (per country) Keys are country codes (ISO 3166-1 alpha-2) Values are lists of region codes. If the list is empty, all regions are allowed
", "example": "", "customType": "mapCustomer groups covered by this shipping method (use default to cover all groups)
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "default", "itemDefault": "" }, { "name": "bands", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "Internal Band Name", "example": "Band 1", "maxLength": 50 }, { "name": "priority", "kind": "optional", "type": "number", "description": "Filtered by first found by percentage_charge order (lower first)
", "default": 0, "minimum": 0, "maximum": 127 }, { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "Shipping SKU (Leave null to use the Shipping Method SKU)
", "example": "ship_123", "maxLength": 15 }, { "name": "requirement", "kind": "optional", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "weight": "#/components/schemas/ShippingMethod.Requirement.Weight", "none": "#/components/schemas/ShippingMethod.Requirement.None", "net_total": "#/components/schemas/ShippingMethod.Requirement.NetTotal", "gross_total": "#/components/schemas/ShippingMethod.Requirement.GrossTotal" } }, "description": "", "complexType": "oneOf", "complexItems": [ { "name": "ShippingMethod.Requirement.Weight", "description": "", "modelRef": "#/components/schemas/ShippingMethod.Requirement.Weight", "schema": [ { "name": "type", "kind": "optional", "type": "stringList of sku, quantity and price to update. Partial updates are supported, meaning only the SKUs present will be affected. For the given SKUs, existing prices are deleted then the supplied prices are inserted. If SKU is provided but quantity and price are blank, all prices for that SKU are removed from the price list.
", "schema": [ { "name": "sku", "kind": "required", "type": "string", "description": "", "example": "SKU-1", "maxLength": 128 }, { "name": "display_tax_rate", "kind": "optional", "type": "number", "nullable": true, "description": "Tax rate used only to display a tax-inclusive price, expressed as a whole percentage (10 means 10%). Stored prices remain net and the eCommerce platform remains authoritative for the tax actually charged at checkout.\nOn an update the field has three states: omit it to leave any stored rate unchanged (so a price-only sync never disturbs it), send null to clear it, or send a value to set it.
", "example": 10, "modelRef": "#/components/schemas/DisplayTaxRate", "customType": "DisplayTaxRate", "schema": [] }, { "name": "pricing", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "quantity", "kind": "required", "type": "integer", "description": "The quantity at which the specified price is applicable. This allows for quantity discount pricing to be set up.", "example": 1, "default": 1, "minimum": 1 }, { "name": "price", "kind": "required", "type": "numberThe unit of measure associated with this quantity. When specifying a unit of measure, it must match the pattern. To remove any value set, either omit the property or set the value as null.
", "example": "pallet", "pattern": "^[a-zA-Z0-9-]+$" } ] } ], "itemType": "object", "customType": "object[]", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "204", "description": "Successful response", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Validation errors", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "PriceUpdateError[]", "schema": [ { "name": "line", "kind": "optional", "type": "integer", "description": "line of input which the error relates to" }, { "name": "field", "kind": "optional", "type": "string", "description": "field which the error relates to" }, { "name": "message", "kind": "optional", "type": "string", "description": "human readable description of error" } ], "modelRef": "#/components/schemas/PriceUpdateError", "isExpanded": true } ] }, { "statusCode": "404", "description": "Price list not found", "jsonExample": "", "isExpanded": true }, { "statusCode": "default", "description": "Error Response", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] API Authentication [path] /  Authentication with SparkLayer works by creating an OAuth client credential for the environment within the SparkLayer Dashboard and authenticating with an OAuth2 flow. This ensures that every user that uses the application gets assigned an individualised token. ### Environment Domain Depending on the environment you're accessing, the domain denotes the environment you are using: | Area | Domain | | ---- | -------------------------------- | | Live | `https://app.sparklayer.io` | | Test | `https://test.app.sparklayer.io` | ### Retrieving an access token :::hint{type="info"} **Please note:** You can retreive the Client ID and Secret from the [SparkLayer Dashboard](https://app.sparklayer.io/configuration/api) ::: You can create a `POST` request to the `/api/auth/token` using the domain above. It must have a header of `Content-type=application/json` and the `Site-Id` provided from the dashboard when creating an API key. :::hint{type="info"} **Please note:** It's recommended to set the `User-Agent` to help us debug any issues you may encounter. ::: ```json { "grant_type": "client_credentials", "client_id": "c466d1fb-1af1-4437-a25c-03e8f94814bf", "client_secret": "7zA5ltJNkiI2WzhU90fTmYJANRcXYJPXsB8SnIEM3x37B2genuwqyv5tVdfLkUWV" } ``` If the details are correct you will recieve the below: ```json { "token_type": "Bearer", "expires_in": 3600, "access_token": "7zA5ltJNkiI2WzhU90fTmYJANRcXYJPXsB8SnIEM3x37B2genuwqyv5tVdfLkUWV" } ``` To use the `access_token` that you retrieved, you will need to send it as a header with all of your requests. The header should look like this: | Item | Details | | ------------- | ----------------------------------------------------------------------- | | Authorization | Bearer 7zA5ltJNkiI2WzhU90fTmYJANRcXYJPXsB8SnIEM3x37B2genuwqyv5tVdfLkUWV | :::hint{type="info"} **Please note:** Make sure to replace `7zA5ltJNkiI2WzhU90fTmYJANRcXYJPXsB8SnIEM3x37B2genuwqyv5tVdfLkUWV` with your actual `access_token`. Once the token expires it is no longer valid. ::: ### Example Auth Request: ```javascript POST /api/auth/token HTTP/1.1 Site-Id: exampleclient Content-Type: application/json Host: app.sparklayer.io User-Agent: exampleclient { "grant_type": "client_credentials", "client_id": "c466d1fb-1af1-4437-a25c-03e8f94814bf", "client_secret": "7zA5ltJNkiI2WzhU90fTmYJANRcXYJPXsB8SnIEM3x37B2genuwqyv5tVdfLkUWV" } ``` ### Example Auth Response: ```javascript HTTP/1.1 200 OK Content-Type: application/json Access-Control-Allow-Origin: * Access-Control-Allow-Headers: authorization, content-type, site-id Access-Control-Max-Age: 7200 Access-Control-Allow-Methods: GET, POST, PUT, DELETE {"token_type":"Bearer","expires_in":3600,"access_token":"7zA5ltJNkiI2WzhU90fTmYJANRcXYJPXsB8SnIEM3x37B2genuwqyv5tVdfLkUWV"} ``` ### Example API Request: ```javascript GET /api/v1/price-lists HTTP/1.1 Site-Id: exampleclient Content-Type: application/json Host: app.sparklayer.io User-Agent: exampleclient Authorization: Bearer 7zA5ltJNkiI2WzhU90fTmYJANRcXYJPXsB8SnIEM3x37B2genuwqyv5tVdfLkUWV ``` ### Example API Response: ```javascript HTTP/1.1 200 OK Content-Type: application/json Access-Control-Allow-Origin: * Access-Control-Allow-Headers: authorization, content-type, site-id Access-Control-Max-Age: 7200 Access-Control-Allow-Methods: GET, POST, PUT, DELETE [] ``` [title] Files API [path] / Our files API is designed to store and retrieve any files in our system. For example, we use this for order file attachments. You can use this API to retrieve the files attached to your orders. More details later ## Technical details Important note: the URLs returned by the API to download/upload files have a expiry time of 15 minutes. ### Uploading a File To create a file, use the `POST` endpoint `/api/v1/files`. This takes a file path in the body, and will return a URL, some headers and some other information. You can then upload a file to this URL, using the headers provided. You ***must*** include these headers, or the file upload will fail. For example, to upload the file using cURL: ```bash curl --upload-file 'Integration should be used by external parties, custom is provided to any price lists setup in the dashboard and platform is reserved for the eCommerce platform.
", "example": "custom", "default": "custom", "enum": [ "custom", "platform", "integration" ] }, { "name": "tax_inclusive_display", "kind": "optional", "type": "boolean", "description": "When true, storefronts display prices on this price list inclusive of the per-SKU display_tax_rate, labelled as tax inclusive. This changes presentation only - prices are still stored and transacted net. SKUs on the list with no rate, or a rate of 0, display their net price and are still labelled tax inclusive.
", "example": false, "default": false }, { "name": "rules", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/PriceListRulesParam", "customType": "PriceListRulesParam", "schema": [ { "name": "source_price_list_slug", "kind": "optional", "type": "string", "description": "Source PriceList slug", "example": "base-list", "minLength": 1, "maxLength": 64 }, { "name": "adjustment_percentage", "kind": "optional", "type": "number", "description": "Adjustment percent expressed as a decimal fraction between 0 and 1 - E.g. 15% should be set as 0.15
", "example": 0.103333, "minimum": 0, "maximum": 1 }, { "name": "adjustment_direction", "kind": "optional", "type": "stringAdjustment direction (plus, minus)
", "example": "plus", "enum": [ "plus", "minus" ] }, { "name": "currency_exchange_rate", "kind": "optional", "type": "number", "nullable": true, "description": "Exchange rate between the currency of the source price list and the price list to which this rule belongs. If null, the rate will be determined automatically based on current market rates.
", "example": 1.254324, "minimum": 0.000001 } ] } ] }, { "name": "pagination", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Pagination", "customType": "Pagination", "schema": [ { "name": "total", "kind": "optional", "type": "integer", "description": "The total number of available records" }, { "name": "per_page", "kind": "optional", "type": "integer", "description": "The number of records returned per page" }, { "name": "current_page", "kind": "optional", "type": "integer", "description": "The current page of results returned" }, { "name": "total_pages", "kind": "optional", "type": "integer", "description": "the total number of available pages" } ] } ], "isExpanded": true } ] }, { "statusCode": "default", "description": "Error Response", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Query files by metadata [path] Untitled/Files API Docs/Files/ { "id": "IC_N75zEdu2QwtrW9w_Sa", "type": "api-oas-v2", "data": { "method": "POST", "url": "/api/v1/search-files", "servers": [], "name": "Query files by metadata", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "Site-Id", "type": "string", "example": "jones-climbing", "description": "Spark Layer Site ID" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "metadata", "kind": "required", "type": "", "nullable": true, "description": "Returns all files who's metadata contains this JSON. See: https://www.postgresql.org/docs/current/datatype-json.html#JSON-CONTAINMENT
", "example": "{\"sparklayer\":{\"forms\":{\"context\":\"email_template\"}}}" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "schema": [ { "name": "file_handle", "kind": "optional", "type": "object", "readOnly": true, "description": "", "modelRef": "#/components/schemas/FileHandle", "customType": "FileHandle", "schema": [ { "name": "file_path", "kind": "optional", "type": "string", "readOnly": true, "description": "The path to the file, including the file name
", "example": "folder/file.png" }, { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The ID of this type", "example": "86027e2c-e853-11ee-b1d4-7c214a6ed8c7" }, { "name": "url", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "URL to download/upload the file. For GET, this will be a readable link. If the file is not ready, this will be null. For POST/PATCH this will be a writeable link
An array of headers you must include in the file upload/download request
", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "readOnly": true, "description": "Name of the header", "example": "Content-Type" }, { "name": "value", "kind": "optional", "type": "string", "readOnly": true, "description": "Value of the header", "example": "application/pdf" } ] } ] }, { "name": "ready", "kind": "optional", "type": "boolean", "readOnly": true, "description": "Whether the file has been fully uploaded and verified", "example": true }, { "name": "mime_type", "kind": "optional", "type": "string", "readOnly": true, "description": "The mime type of this file", "example": "image/png" }, { "name": "file_size", "kind": "optional", "type": "integer", "readOnly": true, "description": "The size of this file in bytes", "example": 255 }, { "name": "created_at", "kind": "optional", "type": "stringThe date at which the file was created (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "updated_at", "kind": "optional", "type": "stringThe date at which the file was updated (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "metadata", "kind": "optional", "type": "object", "readOnly": true, "description": "", "example": "{\"sparklayer\":{\"forms\":{\"context\":\"email_template\",\"step_id\":\"erkjs\"},\"emails\":{\"attachments\":[\"86027e2c-e853-11ee-b1d4-7c214a6ed8c7\"]}}}", "schema": [] }, { "name": "rejected", "kind": "optional", "type": "boolean", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "default", "description": "Error Response", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Customer Specific Pricing [path] Untitled/Core API Docs/Customers/ { "id": "pmVrKvAoOEtg1fOTjDicq", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.sparklayer.io/api/v1/fetch-customer-pricing", "servers": [ { "url": "https://app.sparklayer.io/api/v1/fetch-customer-pricing", "description": "Live" }, { "url": "https://test.app.sparklayer.io/api/v1/fetch-customer-pricing", "description": "Test" } ], "name": "Get Customer Specific Pricing", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "application/problem+json" ], "default": "application/json" }, { "kind": "required", "name": "Site-Id", "type": "string", "example": "jones-climbing", "description": "Spark Layer Site ID" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "example": "{\"customer_id\":\"123e4567-e89b-12d3-a456-426614174000\",\"customer_lookup_by\":\"sparklayer\",\"line_items\":[{\"sku\":\"WIDGET-RED-M\",\"quantity\":10},{\"sku\":\"WIDGET-BLUE-L\",\"quantity\":25}]}", "description": "", "schema": [ { "name": "customer_id", "kind": "required", "type": "string", "description": "", "example": "123e4567-e89b-12d3-a456-426614174000" }, { "name": "customer_lookup_by", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/CustomerLookupBy", "customType": "CustomerLookupBy", "schema": [] }, { "name": "line_items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "sku", "kind": "required", "type": "string", "description": "SKU", "example": "WIDGET-RED-M", "minLength": 1, "maxLength": 128 }, { "name": "quantity", "kind": "required", "type": "integer", "description": "", "example": 10, "minimum": 1 } ] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful response — all line items resolved pricing
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"line_items\":[{\"sku\":\"WIDGET-RED-M\",\"quantity\":10,\"error\":null,\"currency_code\":\"USD\",\"unit_price\":{\"net\":\"8.500000\"},\"line_total\":{\"net\":\"85.000000\"},\"quantity_price_breaks\":[{\"min_quantity\":1,\"price\":{\"net\":\"10.000000\"},\"unit_of_measure\":\"box\"},{\"min_quantity\":10,\"price\":{\"net\":\"8.500000\"},\"unit_of_measure\":\"box\"}]}]}", "description": "", "schema": [ { "name": "line_items", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/LineItem", "customType": "LineItem[]", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "optional", "type": "integer", "description": "" }, { "name": "error", "kind": "optional", "type": "string", "nullable": true, "description": "Populated when pricing could not be determined for this SKU; null on success
" }, { "name": "currency_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "USD" }, { "name": "unit_price", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "net", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "line_total", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "net", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "quantity_price_breaks", "kind": "optional", "type": "array", "nullable": true, "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "min_quantity", "kind": "optional", "type": "integer", "description": "" }, { "name": "price", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "net", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "unit_of_measure", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "box" } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "207", "description": "Partial success — one or more line items could not be priced
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"line_items\":[{\"sku\":\"WIDGET-RED-M\",\"quantity\":10,\"error\":null,\"currency_code\":\"USD\",\"unit_price\":{\"net\":\"8.500000\"},\"line_total\":{\"net\":\"85.000000\"},\"quantity_price_breaks\":[{\"min_quantity\":1,\"price\":{\"net\":\"10.000000\"},\"unit_of_measure\":\"box\"}]},{\"sku\":\"WIDGET-BLUE-L\",\"quantity\":25,\"error\":\"Pricing not found for SKU 'WIDGET-BLUE-L'\",\"currency_code\":null,\"unit_price\":null,\"line_total\":null,\"quantity_price_breaks\":null}]}", "description": "", "schema": [ { "name": "line_items", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/LineItem", "customType": "LineItem[]", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "optional", "type": "integer", "description": "" }, { "name": "error", "kind": "optional", "type": "string", "nullable": true, "description": "Populated when pricing could not be determined for this SKU; null on success
" }, { "name": "currency_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "USD" }, { "name": "unit_price", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "net", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "line_total", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "net", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "quantity_price_breaks", "kind": "optional", "type": "array", "nullable": true, "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "min_quantity", "kind": "optional", "type": "integer", "description": "" }, { "name": "price", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "net", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "unit_of_measure", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "box" } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Validation error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Core-api-stock.yaml [path] Untitled/ [title] Get Pricing by Price List [path] Untitled/Pricing API Docs/Pricing/ { "id": "DR-2Wt-zTJqx2RLixPKC7", "type": "api-oas-v2", "data": { "method": "GET", "url": "/api/v1/price-lists/{slug}/pricing", "servers": [], "name": "Get Pricing by Price List", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "slug", "type": "string", "description": "Price List Slug" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "text/csv" ], "default": "application/json" }, { "kind": "required", "name": "Site-Id", "type": "string", "example": "jones-climbing", "description": "Spark Layer Site ID" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful response", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "Content-Disposition", "type": "string", "example": "attachment; filename=\"pricelist.csv\"", "description": "Used only with text/csv responses
The unit of measure associated with this quantity. When specifying a unit of measure, it must match the pattern. To remove any value set, either omit the property or set the value as null.
", "example": "pallet", "pattern": "^[a-zA-Z0-9-]+$" }, { "name": "display_tax_rate", "kind": "optional", "type": "number", "nullable": true, "description": "Tax rate used only to display a tax-inclusive price, expressed as a whole percentage (10 means 10%). Stored prices remain net and the eCommerce platform remains authoritative for the tax actually charged at checkout.\nOn an update the field has three states: omit it to leave any stored rate unchanged (so a price-only sync never disturbs it), send null to clear it, or send a value to set it.
", "example": 10, "modelRef": "#/components/schemas/DisplayTaxRate", "customType": "DisplayTaxRate", "schema": [] }, { "name": "sku", "kind": "optional", "type": "string", "description": "", "example": "SKU-1", "maxLength": 128 } ], "itemType": "object", "customType": "object[]", "isExpanded": true } ] }, { "statusCode": "204", "description": "Empty Response", "jsonExample": "", "isExpanded": true }, { "statusCode": "default", "description": "Error Response", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Update a Shipping Method [path] Untitled/Core API Docs/Shipping/ { "id": "xB3dOS72ir3_uFxla91jH", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "https://app.sparklayer.io/api/v1/shipping-methods/{id}", "servers": [ { "url": "https://app.sparklayer.io/api/v1/shipping-methods/{id}", "description": "Live" }, { "url": "https://test.app.sparklayer.io/api/v1/shipping-methods/{id}", "description": "Test" } ], "name": "Update a Shipping Method", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "Either the Internal or External ID" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "Site-Id", "type": "string", "example": "jones-climbing", "description": "Spark Layer Site ID" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "ShippingMethod", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "description": "Shipping SKU", "example": "SKU001", "maxLength": 50 }, { "name": "title", "kind": "optional", "type": "string", "description": "Shiping Method Name shown at checkout", "example": "Standard Shipping", "maxLength": 50 }, { "name": "priority", "kind": "optional", "type": "number", "description": "Shown by order (lower first)
", "default": 0, "minimum": 0, "maximum": 127 }, { "name": "countries", "kind": "optional", "type": "array", "description": "Countries covered by this shipping method (ISO 3166-1 alpha-2)
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "GB", "itemDefault": "" }, { "name": "regions", "kind": "optional", "type": "map", "description": "Regions covered by this shipping method (per country) Keys are country codes (ISO 3166-1 alpha-2) Values are lists of region codes. If the list is empty, all regions are allowed
", "example": "", "customType": "mapCustomer groups covered by this shipping method (use default to cover all groups)
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "default", "itemDefault": "" }, { "name": "bands", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "Internal Band Name", "example": "Band 1", "maxLength": 50 }, { "name": "priority", "kind": "optional", "type": "number", "description": "Filtered by first found by percentage_charge order (lower first)
", "default": 0, "minimum": 0, "maximum": 127 }, { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "Shipping SKU (Leave null to use the Shipping Method SKU)
", "example": "ship_123", "maxLength": 15 }, { "name": "requirement", "kind": "optional", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "weight": "#/components/schemas/ShippingMethod.Requirement.Weight", "none": "#/components/schemas/ShippingMethod.Requirement.None", "net_total": "#/components/schemas/ShippingMethod.Requirement.NetTotal", "gross_total": "#/components/schemas/ShippingMethod.Requirement.GrossTotal" } }, "description": "", "complexType": "oneOf", "complexItems": [ { "name": "ShippingMethod.Requirement.Weight", "description": "", "modelRef": "#/components/schemas/ShippingMethod.Requirement.Weight", "schema": [ { "name": "type", "kind": "optional", "type": "stringShipping Method ID (always prefixed with sm_)
", "example": "sm_123", "maxLength": 15 }, { "name": "created_at", "kind": "optional", "type": "stringShown by order (lower first)
", "default": 0, "minimum": 0, "maximum": 127 }, { "name": "countries", "kind": "optional", "type": "array", "description": "Countries covered by this shipping method (ISO 3166-1 alpha-2)
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "GB", "itemDefault": "" }, { "name": "regions", "kind": "optional", "type": "map", "description": "Regions covered by this shipping method (per country) Keys are country codes (ISO 3166-1 alpha-2) Values are lists of region codes. If the list is empty, all regions are allowed
", "example": "", "customType": "mapCustomer groups covered by this shipping method (use default to cover all groups)
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "default", "itemDefault": "" }, { "name": "bands", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "Internal Band Name", "example": "Band 1", "maxLength": 50 }, { "name": "priority", "kind": "optional", "type": "number", "description": "Filtered by first found by percentage_charge order (lower first)
", "default": 0, "minimum": 0, "maximum": 127 }, { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "Shipping SKU (Leave null to use the Shipping Method SKU)
", "example": "ship_123", "maxLength": 15 }, { "name": "requirement", "kind": "optional", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "weight": "#/components/schemas/ShippingMethod.Requirement.Weight", "none": "#/components/schemas/ShippingMethod.Requirement.None", "net_total": "#/components/schemas/ShippingMethod.Requirement.NetTotal", "gross_total": "#/components/schemas/ShippingMethod.Requirement.GrossTotal" } }, "description": "", "complexType": "oneOf", "complexItems": [ { "name": "ShippingMethod.Requirement.Weight", "description": "", "modelRef": "#/components/schemas/ShippingMethod.Requirement.Weight", "schema": [ { "name": "type", "kind": "optional", "type": "stringDiscount ID (uuid)
", "example": "942651af-f950-4716-9916-16170fe0645f", "format": "uuid" }, { "name": "created_at", "kind": "optional", "type": "stringDiscount template type. If not null allowed values are - 'order_level_get_amount_off', 'order_level_get_free_product', 'product_level_get_amount_off', 'order_level_get_shipping_reward', 'advanced_order_level_get_amount_off', 'order_level_requirement_amount_off', 'advanced_discount', 'advanced_free_products'
" }, { "name": "calculation_group", "kind": "required", "type": "number", "description": "Dependency level = Calculation Group. All discounts with the same dependency level will share the same base, pre-discount totals. E.g. discount A (50% off) and discount B (50% off) will reward 100% off - not 75% off.
", "minimum": 0, "maximum": 127 }, { "name": "priority", "kind": "required", "type": "number", "description": "The sequence to apply the discounts (within each discount 'dependency level')
", "minimum": 0, "maximum": 10000 }, { "name": "times_applicable_per_order", "kind": "required", "type": "number", "description": "Per order application limits. If -1 allow unlimited applications, otherwise limited
", "minimum": -1, "maximum": 127 }, { "name": "max_rewards", "kind": "optional", "type": "number", "nullable": true, "description": "Used when rewardSelectionType is cheapest or expensive to determine the number of rewards available", "default": 1, "minimum": 1, "maximum": 127 }, { "name": "groups", "kind": "required", "type": "array", "description": "Customer groups covered by this discount (use default to cover all groups)
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "default", "itemDefault": "" }, { "name": "excluded_customers", "kind": "optional", "type": "array", "description": "Array of email address or accounting ids of customers to exclude from the discount", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "customer@b2b.com", "itemDefault": "" }, { "name": "simultaneity", "kind": "optional", "type": "array", "nullable": true, "description": "Other discounts which can be applied simultaneous, if null no limitation
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "default", "itemDefault": "" }, { "name": "requirement_selection_type", "kind": "required", "type": "stringAdd X point(s) for each matching product OR Add X point(s) for once only
", "enum": [ "line", "item" ] }, { "name": "points", "kind": "required", "type": "integer", "description": "", "default": 1 }, { "name": "quantity", "kind": "required", "type": "integer", "description": "" }, { "name": "selection_type", "kind": "required", "type": "stringAt least X quantity of product(s) must match OR Exactly X quantity of product(s)
", "enum": [ "minimum", "exact" ] } ] }, { "name": "max_rewards", "kind": "required", "type": "integer", "nullable": true, "description": "Limit the number of rewards when this requirement applies" }, { "name": "min_spend", "kind": "required", "type": "number", "nullable": true, "description": "The cart must contain between min_spend and max_spend based on spend_tax_type of the requirement.
" }, { "name": "max_spend", "kind": "required", "type": "number", "nullable": true, "description": "" }, { "name": "spend_tax_type", "kind": "required", "type": "stringApply only if 'all' items matched in the cart OR if cart worth minimum of min_points requirement items(s) using requirements
", "enum": [ "minimum", "all" ] }, { "name": "min_points", "kind": "required", "type": "integer", "nullable": true, "description": "Only applies when selection_type is minimum
" } ] }, { "name": "rewards", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/Discount.Reward", "customType": "Discount.Reward[]", "schema": [ { "name": "type", "kind": "required", "type": "stringFilter by customer_identifiers[sparklayer]. Accepts comma-separated values. Maximum total length of all values is 2000 characters.
", "minLength": 1, "maxLength": 2000 }, { "kind": "optional", "name": "customer_identifiers[sparklayer_impersonator]", "type": "string", "description": "Filter by customer_identifiers[sparklayer_impersonator]. Accepts comma-separated values. Maximum total length of all values is 2000 characters.
", "minLength": 1, "maxLength": 2000 }, { "kind": "optional", "name": "customer_identifiers[sparklayer_sales_rep]", "type": "string", "description": "Filter by customer_identifiers[sparklayer_sales_rep]. Accepts comma-separated values. Maximum total length of all values is 2000 characters.
", "minLength": 1, "maxLength": 2000 }, { "kind": "optional", "name": "customer_identifiers[sparklayer_impersonator_assignee]", "type": "string", "description": "Filter by customer_identifiers[sparklayer_impersonator_assignee]. Accepts comma-separated values. Maximum total length of all values is 2000 characters. To get purchases that have no assignee, include a string value of 'NULL'.
", "minLength": 1, "maxLength": 2000 }, { "kind": "optional", "name": "company[id]", "type": "string", "description": "Filter by company[id]. Accepts comma-separated values. Maximum total length of all values is 2000 characters. Use this rather than listing every section id to report on a whole company.
", "minLength": 1, "maxLength": 2000 }, { "kind": "optional", "name": "company[section_id]", "type": "string", "description": "Filter by company[section_id]. Accepts comma-separated values. Maximum total length of all values is 2000 characters.
", "minLength": 1, "maxLength": 2000 }, { "kind": "optional", "name": "status", "type": "string", "example": "shipped", "description": "Filter by status", "enum": [ "incoming", "processing", "shipped", "part_shipped", "cancelled", "returned", "part_returned", "varied" ] }, { "kind": "optional", "name": "type", "type": "string", "example": "order", "description": "Filter by type", "enum": [ "order", "quote", "cart", "awaiting_approval", "awaiting_merchant", "archived", "platform_archived", "pending_recurring_order" ] }, { "kind": "optional", "name": "search", "type": "string", "example": "PO-12345", "description": "Search Term" }, { "kind": "optional", "name": "dates[last_updated][lte]", "type": "string", "description": "Filter by dates[last_updated][lte]
", "minLength": 1 }, { "kind": "optional", "name": "dates[last_updated][gte]", "type": "string", "description": "Filter by dates[last_updated][gte]
", "minLength": 1 }, { "kind": "optional", "name": "dates[placed][lte]", "type": "string", "description": "Filter by dates[placed][lte]
", "minLength": 1 }, { "kind": "optional", "name": "dates[placed][gte]", "type": "string", "description": "Filter by dates[placed][gte]
", "minLength": 1 }, { "kind": "optional", "name": "dates[submitted][lte]", "type": "string", "description": "Filter by dates[submitted][lte]
", "minLength": 1 }, { "kind": "optional", "name": "dates[submitted][gte]", "type": "string", "description": "Filter by dates[submitted][gte]
", "minLength": 1 }, { "kind": "optional", "name": "dates[shipping_requested][lte]", "type": "string", "description": "Filter by dates[shipping_requested][lte]
", "minLength": 1 }, { "kind": "optional", "name": "dates[shipping_requested][gte]", "type": "string", "description": "Filter by dates[shipping_requested][gte]
", "minLength": 1 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "PurchaseBase[]", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "", "example": "order", "modelRef": "#/components/schemas/PurchaseType", "customType": "PurchaseType", "schema": [] }, { "name": "purchase_identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer", "kind": "optional", "type": "stringThe identifier for the purchase on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the purchase on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier that will be shown to the customer in their recent orders", "example": "B2B01123" } ] }, { "name": "customer_identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer", "kind": "required", "type": "string", "nullable": false, "description": "The ID of the customer that that order is for.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" }, { "name": "sparklayer_impersonator", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the sales agent placing the order.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" }, { "name": "sparklayer_impersonator_assignee", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the sales agent assigned to be responsible for the order.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" }, { "name": "sparklayer_child", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the company user that placed the order.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" } ] }, { "name": "company", "kind": "optional", "type": "object", "nullable": true, "description": "Company sections are opt-in; omit this entirely for merchants that do not use them.
", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "stringThe section name at the time of purchase, kept so historical purchases stay readable after a section is renamed or deleted. Not filterable.
", "example": "Bristol", "maxLength": 128 } ] }, { "name": "payment_method", "kind": "optional", "type": "string", "nullable": true, "description": "How the purchase was/will be paid for
", "enum": [ "quote", "upfrontPayment", "paymentOnAccount", "paymentByInvoice" ] }, { "name": "dates", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "created_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date the purchase was created in SparkLayer (RFC-3339). This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "updated_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date the purchase was last updated in SparkLayer (RFC-3339). This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "placed_at", "kind": "optional", "type": "string", "nullable": true, "description": " The date at which the purchase was placed - include user timezone or Z for UTC (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "to_be_placed_at", "kind": "optional", "type": "string", "nullable": true, "description": " The date at which the purchase is due to be placed, for a purchase that is scheduled rather than placed immediately (RFC-3339). It can be changed while the purchase is still pending
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "calculated_submitted_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date the purchase was submitted (RFC-3339). This is when the cart is converted into another purchase type. This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "expires_at", "kind": "optional", "type": "string", "readOnly": true, "description": " the date at which the purchase will expire and become archived (RFC-3339). This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "payment_due_at", "kind": "optional", "type": "string", "description": "The date at which payment for the purchase is expected", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] }, { "name": "customer_reference", "kind": "optional", "type": "string", "nullable": true, "description": "Additional information that a customer adds to the order", "example": "Please deliver to the back of the store" }, { "name": "po_number", "kind": "optional", "type": "string", "nullable": true, "description": "PO number for the purchase", "example": "PO-001" }, { "name": "shipping_requested_date", "kind": "optional", "type": "string ", "nullable": true, "description": "The date requested for the delivery to arrive", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "recurring_purchase", "kind": "optional", "type": "object", "nullable": true, "description": "Present only for a purchase created from a recurring purchase template. Both properties are stored when the purchase is created and ignored on any later update", "example": "", "schema": [ { "name": "template_id", "kind": "optional", "type": "string ", "nullable": true, "description": "The recurring purchase template this purchase was created from. Set on creation and ignored on update", "example": "0f8fad5b-d9cb-469f-a165-70867728950e", "format": "uuid" }, { "name": "cancelled_at", "kind": "optional", "type": "string ", "nullable": true, "description": " The date the customer cancelled the purchase, after which it will not be placed (RFC-3339). Cancelling does not free the date - the template has already had its turn for it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "to_be_placed_at_initial", "kind": "optional", "type": "string", "nullable": true, "description": " The date to_be_placed_at was first set to (RFC-3339). Set on creation and ignored on update, so that rescheduling cannot let the same template produce a second purchase for the same date
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] }, { "name": "currency_code", "kind": "optional", "type": "string", "nullable": true, "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 }, { "name": "calculated_shipping_address", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "A single string containing all the details of the shipping address. This is read only - it should not be sent to the API, but will be returned form it
", "example": "John Spark, SparkLayer, SparkLayer HQ, Example City, 12345" }, { "name": "calculated_total", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "calculated_total_usd", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "calculated_total_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "calculated_fulfilment_status", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": " The status of the order, calculated from the statuses of the individual packages. This is read only - it should not be sent to the API, but will be returned form it
", "example": "processing", "enum": [ "incoming", "processing", "shipped", "part_shipped", "cancelled", "returned", "part_returned", "varied" ] }, { "name": "quote", "kind": "optional", "type": "object", "nullable": true, "description": "Quote data", "example": "", "schema": [ { "name": "status_slug", "kind": "optional", "type": "string", "description": "The slug of the quote status applied to this quote" }, { "name": "status", "kind": "optional", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "QuoteStatus", "description": "", "modelRef": "#/components/schemas/QuoteStatus", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "", "maxLength": 45 }, { "name": "slug", "kind": "optional", "type": "string", "description": "", "maxLength": 45, "pattern": "^[a-z0-9-]+$" }, { "name": "default", "kind": "optional", "type": "boolean", "description": "" }, { "name": "next", "kind": "optional", "type": "string", "nullable": true, "description": "", "maxLength": 45, "pattern": "^[a-z0-9-]+$" }, { "name": "actions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "created_at", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "updated_at", "kind": "optional", "type": "string ", "description": "", "format": "date-time" }, { "name": "deleted_at", "kind": "optional", "type": "string ", "nullable": true, "description": "", "format": "date-time" } ] } ], "schema": [] }, { "name": "expiry", "kind": "optional", "type": "string ", "nullable": true, "description": " The date at which the quote is considered expired and no longer valid (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] }, { "name": "payment_status", "kind": "optional", "type": "string", "description": "That payment status of the order", "enum": [ "unpaid", "part_paid", "paid" ] }, { "name": "total_paid", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": " The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] } ], "modelRef": "#/components/schemas/PurchaseBase", "isExpanded": true } ] }, { "statusCode": "500", "description": "Error Response", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get bulk files [path] Untitled/Files API Docs/Files/ { "id": "D-cXPUwNrGvwcdLiDfCM2", "type": "api-oas-v2", "data": { "method": "GET", "url": "/api/v1/files", "servers": [], "name": "Get bulk files", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "required", "name": "ids", "type": "array", "description": "IDs of the files to get", "format": "uuid", "schema": [], "itemType": "string", "customType": "string[]" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "File", "schema": [ { "name": "file_handle", "kind": "optional", "type": "object", "readOnly": true, "description": "", "modelRef": "#/components/schemas/FileHandle", "customType": "FileHandle", "schema": [ { "name": "file_path", "kind": "optional", "type": "string", "readOnly": true, "description": "The path to the file, including the file name
", "example": "folder/file.png" }, { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The ID of this type", "example": "86027e2c-e853-11ee-b1d4-7c214a6ed8c7" }, { "name": "url", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "URL to download/upload the file. For GET, this will be a readable link. If the file is not ready, this will be
", "example": "https://files.sparklayer.io/siteId/siteEnv/path/to/file.png." }, { "name": "required_headers", "kind": "optional", "type": "array", "readOnly": true, "description": "null. For POST/PATCH this will be a writeable linkAn array of headers you must include in the file upload/download request
", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "readOnly": true, "description": "Name of the header", "example": "Content-Type" }, { "name": "value", "kind": "optional", "type": "string", "readOnly": true, "description": "Value of the header", "example": "application/pdf" } ] } ] }, { "name": "ready", "kind": "optional", "type": "boolean", "readOnly": true, "description": "Whether the file has been fully uploaded and verified", "example": true }, { "name": "mime_type", "kind": "optional", "type": "string", "readOnly": true, "description": "The mime type of this file", "example": "image/png" }, { "name": "file_size", "kind": "optional", "type": "integer", "readOnly": true, "description": "The size of this file in bytes", "example": 255 }, { "name": "created_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date at which the file was created (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "updated_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date at which the file was updated (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "metadata", "kind": "optional", "type": "object", "readOnly": true, "description": "", "example": "{\"sparklayer\":{\"forms\":{\"context\":\"email_template\",\"step_id\":\"erkjs\"},\"emails\":{\"attachments\":[\"86027e2c-e853-11ee-b1d4-7c214a6ed8c7\"]}}}", "schema": [] } ], "modelRef": "#/components/schemas/File", "isExpanded": true } ] }, { "statusCode": "default", "description": "Error Response", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get Pricing by SKU [path] Untitled/Pricing API Docs/Pricing/ { "id": "ultT552Vr-wzHJyhV4ICc", "type": "api-oas-v2", "data": { "method": "GET", "url": "/api/v1/pricing/{sku}", "servers": [], "name": "Get Pricing by SKU", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "sku", "type": "string", "description": "Variant SKU (URL encoding to be used)
" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "Site-Id", "type": "string", "example": "jones-climbing", "description": "Spark Layer Site ID" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful response", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "VariantPricing[]", "schema": [ { "name": "price_list_slug", "kind": "required", "type": "string", "description": "Price List Slug", "example": "base-list" }, { "name": "display_tax_rate", "kind": "optional", "type": "number", "nullable": true, "description": "Tax rate used only to display a tax-inclusive price, expressed as a whole percentage (10 means 10%). Stored prices remain net and the eCommerce platform remains authoritative for the tax actually charged at checkout.\nOn an update the field has three states: omit it to leave any stored rate unchanged (so a price-only sync never disturbs it), send null to clear it, or send a value to set it.
", "example": 10, "modelRef": "#/components/schemas/DisplayTaxRate", "customType": "DisplayTaxRate", "schema": [] }, { "name": "pricing", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "quantity", "kind": "optional", "type": "integer", "description": "The quantity at which the specified price is applicable. This allows for quantity discount pricing to be set up.", "example": 1, "default": 1, "minimum": 1 }, { "name": "price", "kind": "required", "type": "number", "description": "", "example": 10.49, "format": "float" }, { "name": "tax_type", "kind": "optional", "type": "string ", "deprecated": true, "description": "Warning: Deprecated\nNet is the only supported value here", "default": "net", "enum": [ "net" ] }, { "name": "unit_of_measure", "kind": "optional", "type": "string", "nullable": true, "description": " The unit of measure associated with this quantity. When specifying a unit of measure, it must match the pattern. To remove any value set, either omit the property or set the value as null.
", "example": "pallet", "pattern": "^[a-zA-Z0-9-]+$" } ] } ], "modelRef": "#/components/schemas/VariantPricing", "isExpanded": true } ] }, { "statusCode": "default", "description": "Error Response", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Get stock levels at all connected locations for the provided SKUs [path] Untitled/Stock API Docs/Stock Levels - Bulk operations/ { "id": "lNBJM2EI7-IAYt4Wyjj2-", "type": "api-oas-v2", "data": { "method": "POST", "url": "/api/v1/batch-fetch-stock", "servers": [], "name": "Get stock levels at all connected locations for the provided SKUs", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "Site-Id", "type": "string", "example": "jones-climbing", "description": "Spark Layer Site ID" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "BatchFetchStock", "schema": [ { "name": "skus", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "SKU-1", "itemDefault": "" }, { "name": "filter", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "stock_location_ids", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "123e4567-e89b-12d3-a456-426614174000", "itemDefault": "" }, { "name": "all_stock_locations", "kind": "optional", "type": "boolean", "description": "" } ] } ], "modelRef": "#/components/schemas/BatchFetchStock", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful response", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "description": "Product Variant SKU", "example": "SKU-1" }, { "name": "stock_levels", "kind": "optional", "type": "object", "description": "Stock levels for the SKU at each location", "modelRef": "#/components/schemas/StockLevel", "customType": "StockLevel[]", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "BaseStockLevel", "description": "", "modelRef": "#/components/schemas/BaseStockLevel", "schema": [ { "name": "stock_level", "kind": "optional", "type": "integer", "description": "Quantity of stock held at the location", "example": 9, "default": 0, "format": "int32" }, { "name": "restock_date", "kind": "optional", "type": "string ", "nullable": true, "description": "Restock Date", "example": "2020-01-01", "format": "date" }, { "name": "min_stock_level", "kind": "optional", "type": "integer ", "description": " Allow pre-ordering / overselling up to this qty. For example, if set to -9 and stock level was 0, 9 units could be sold.
", "example": -9, "default": 0, "format": "int32" }, { "name": "created_at", "kind": "optional", "type": "string", "readOnly": true, "description": "", "format": "date-time" }, { "name": "updated_at", "kind": "optional", "type": "string ", "readOnly": true, "description": "", "format": "date-time" } ] }, { "name": "StockLocationId", "description": "", "modelRef": "#/components/schemas/StockLocationId", "schema": [ { "name": "stock_location_id", "kind": "optional", "type": "string ", "description": " Stock Location ID (internal UUID)
", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid" } ] }, { "name": "StockLocationName", "description": "", "modelRef": "#/components/schemas/StockLocationName", "schema": [ { "name": "stock_location_name", "kind": "optional", "type": "string", "description": "Stock Location Name", "example": "Main Warehouse" } ] } ] } ], "itemType": "object", "customType": "object[]", "isExpanded": true } ] }, { "statusCode": "default", "description": "Error Response", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Core-api-purchasing.yaml [path] Untitled/ [title] Update a Price List [path] Untitled/Pricing API Docs/Price Lists/ { "id": "_vH66_i9YCyA9VLo9sP3f", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "/api/v1/price-lists/{slug}", "servers": [], "name": "Update a Price List", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "slug", "type": "string", "description": "Price List Slug" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "Site-Id", "type": "string", "example": "jones-climbing", "description": "Spark Layer Site ID" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "rules", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/PriceListRulesParam", "customType": "PriceListRulesParam", "schema": [ { "name": "source_price_list_slug", "kind": "optional", "type": "string", "description": "Source PriceList slug", "example": "base-list", "minLength": 1, "maxLength": 64 }, { "name": "adjustment_percentage", "kind": "optional", "type": "number", "description": "Adjustment percent expressed as a decimal fraction between 0 and 1 - E.g. 15% should be set as 0.15
", "example": 0.103333, "minimum": 0, "maximum": 1 }, { "name": "adjustment_direction", "kind": "optional", "type": "string", "description": " Adjustment direction (plus, minus)
", "example": "plus", "enum": [ "plus", "minus" ] }, { "name": "currency_exchange_rate", "kind": "optional", "type": "number", "nullable": true, "description": "Exchange rate between the currency of the source price list and the price list to which this rule belongs. If null, the rate will be determined automatically based on current market rates.
", "example": 1.254324, "minimum": 0.000001 } ] }, { "name": "name", "kind": "optional", "type": "string", "description": "Name", "example": "Base Price List", "modelRef": "#/components/schemas/PriceListNameParam", "customType": "PriceListNameParam", "schema": [] }, { "name": "currency_code", "kind": "optional", "type": "string", "description": "ISO 4217 currency code", "example": "GBP", "modelRef": "#/components/schemas/PriceListCurrency", "customType": "PriceListCurrency", "schema": [] }, { "name": "tax_inclusive_display", "kind": "optional", "type": "boolean", "description": "Toggle tax-inclusive display for this price list.
", "example": true } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful response", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "PriceList", "schema": [ { "name": "slug", "kind": "optional", "type": "string", "description": "Slug", "example": "base-list", "minLength": 1, "maxLength": 64 }, { "name": "name", "kind": "optional", "type": "string", "description": "Name", "example": "Base Price List", "modelRef": "#/components/schemas/PriceListNameParam", "customType": "PriceListNameParam", "schema": [] }, { "name": "currency_code", "kind": "optional", "type": "string", "description": "ISO 4217 currency code", "example": "GBP", "modelRef": "#/components/schemas/PriceListCurrency", "customType": "PriceListCurrency", "schema": [] }, { "name": "source", "kind": "optional", "type": "string", "description": " Integration should be used by external parties, custom is provided to any price lists setup in the dashboard and platform is reserved for the eCommerce platform.
", "example": "custom", "default": "custom", "enum": [ "custom", "platform", "integration" ] }, { "name": "tax_inclusive_display", "kind": "optional", "type": "boolean", "description": "When true, storefronts display prices on this price list inclusive of the per-SKU display_tax_rate, labelled as tax inclusive. This changes presentation only - prices are still stored and transacted net. SKUs on the list with no rate, or a rate of 0, display their net price and are still labelled tax inclusive.
", "example": false, "default": false }, { "name": "rules", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/PriceListRulesParam", "customType": "PriceListRulesParam", "schema": [ { "name": "source_price_list_slug", "kind": "optional", "type": "string", "description": "Source PriceList slug", "example": "base-list", "minLength": 1, "maxLength": 64 }, { "name": "adjustment_percentage", "kind": "optional", "type": "number", "description": "Adjustment percent expressed as a decimal fraction between 0 and 1 - E.g. 15% should be set as 0.15
", "example": 0.103333, "minimum": 0, "maximum": 1 }, { "name": "adjustment_direction", "kind": "optional", "type": "string", "description": " Adjustment direction (plus, minus)
", "example": "plus", "enum": [ "plus", "minus" ] }, { "name": "currency_exchange_rate", "kind": "optional", "type": "number", "nullable": true, "description": "Exchange rate between the currency of the source price list and the price list to which this rule belongs. If null, the rate will be determined automatically based on current market rates.
", "example": 1.254324, "minimum": 0.000001 } ] } ], "modelRef": "#/components/schemas/PriceList", "isExpanded": true } ] }, { "statusCode": "default", "description": "Error Response", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false }, "children": [ { "text": "" } ] } [title] Pricing-api.yaml [path] Untitled/ [title] Create/Update Purchase [path] Untitled/Purchasing API Docs/Purchasing/ { "id": "Zt66bWwy086gLn6nXE6Te", "type": "api-oas-v2", "data": { "method": "PUT", "url": "/api/v1/purchases/{lookupBy}/{identifier}", "servers": [], "name": "Create/Update Purchase", "description": "Create/Update a purchase
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "lookupBy", "type": "string", "example": "platform", "description": "Lookup by an identifier set within the purchase_identifiers object
", "enum": [ "sparklayer", "platform", "internal", "visible" ] }, { "kind": "required", "name": "identifier", "type": "object", "description": "Lookup by an identifier. Note: lookupBy=sparklayer requires UUID
", "schema": [], "complexItems": [ { "name": "object", "schema": [] }, { "name": "object", "schema": [] } ], "complexType": "anyOf" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "application/problem+json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "SparkLayer purchase object", "customType": "Purchase", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "", "example": "order", "modelRef": "#/components/schemas/PurchaseType", "customType": "PurchaseType", "schema": [] }, { "name": "purchase_identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier SparkLayer uses for the purchase. You will need to generate this if the purchase does not exist", "example": "63428136-658f-48a6-beb7-7f333dfd9686", "format": "uuid", "minLength": 1 }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": " The identifier for the purchase on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the purchase on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier that will be shown to the customer in their recent orders", "example": "B2B01123" } ] }, { "name": "customer_identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer", "kind": "required", "type": "string", "nullable": false, "description": "The ID of the customer that that order is for.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" }, { "name": "sparklayer_impersonator", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the sales agent placing the order.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" }, { "name": "sparklayer_impersonator_assignee", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the sales agent assigned to be responsible for the order.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" }, { "name": "sparklayer_child", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the company user that placed the order.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" } ] }, { "name": "company", "kind": "optional", "type": "object", "nullable": true, "description": "Company sections are opt-in; omit this entirely for merchants that do not use them.
", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the company the purchase was placed for.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1", "format": "uuid" }, { "name": "section_id", "kind": "optional", "type": "string ", "nullable": true, "description": "The ID of the company section the purchase was placed for.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1", "format": "uuid" }, { "name": "section_name", "kind": "optional", "type": "string", "nullable": true, "description": " The section name at the time of purchase, kept so historical purchases stay readable after a section is renamed or deleted. Not filterable.
", "example": "Bristol", "maxLength": 128 } ] }, { "name": "payment_method", "kind": "optional", "type": "string", "nullable": true, "description": "How the purchase was/will be paid for
", "enum": [ "quote", "upfrontPayment", "paymentOnAccount", "paymentByInvoice" ] }, { "name": "dates", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "created_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date the purchase was created in SparkLayer (RFC-3339). This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "updated_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date the purchase was last updated in SparkLayer (RFC-3339). This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "placed_at", "kind": "optional", "type": "string", "nullable": true, "description": " The date at which the purchase was placed - include user timezone or Z for UTC (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "to_be_placed_at", "kind": "optional", "type": "string", "nullable": true, "description": " The date at which the purchase is due to be placed, for a purchase that is scheduled rather than placed immediately (RFC-3339). It can be changed while the purchase is still pending
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "calculated_submitted_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date the purchase was submitted (RFC-3339). This is when the cart is converted into another purchase type. This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "expires_at", "kind": "optional", "type": "string", "readOnly": true, "description": " the date at which the purchase will expire and become archived (RFC-3339). This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "payment_due_at", "kind": "optional", "type": "string", "description": "The date at which payment for the purchase is expected", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] }, { "name": "customer_reference", "kind": "optional", "type": "string", "nullable": true, "description": "Additional information that a customer adds to the order", "example": "Please deliver to the back of the store" }, { "name": "po_number", "kind": "optional", "type": "string", "nullable": true, "description": "PO number for the purchase", "example": "PO-001" }, { "name": "shipping_requested_date", "kind": "optional", "type": "string ", "nullable": true, "description": "The date requested for the delivery to arrive", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "recurring_purchase", "kind": "optional", "type": "object", "nullable": true, "description": "Present only for a purchase created from a recurring purchase template. Both properties are stored when the purchase is created and ignored on any later update", "example": "", "schema": [ { "name": "template_id", "kind": "optional", "type": "string ", "nullable": true, "description": "The recurring purchase template this purchase was created from. Set on creation and ignored on update", "example": "0f8fad5b-d9cb-469f-a165-70867728950e", "format": "uuid" }, { "name": "cancelled_at", "kind": "optional", "type": "string ", "nullable": true, "description": " The date the customer cancelled the purchase, after which it will not be placed (RFC-3339). Cancelling does not free the date - the template has already had its turn for it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "to_be_placed_at_initial", "kind": "optional", "type": "string", "nullable": true, "description": " The date to_be_placed_at was first set to (RFC-3339). Set on creation and ignored on update, so that rescheduling cannot let the same template produce a second purchase for the same date
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] }, { "name": "currency_code", "kind": "optional", "type": "string", "nullable": true, "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 }, { "name": "currency_code_base", "kind": "optional", "type": "string", "writeOnly": true, "nullable": true, "description": "The 3 letter currency code of the store's base currency", "example": "GBP", "minLength": 3, "maxLength": 3 }, { "name": "calculated_shipping_address", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "A single string containing all the details of the shipping address. This is read only - it should not be sent to the API, but will be returned form it
", "example": "John Spark, SparkLayer, SparkLayer HQ, Example City, 12345" }, { "name": "calculated_total", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "calculated_total_usd", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "calculated_total_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "calculated_fulfilment_status", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": " The status of the order, calculated from the statuses of the individual packages. This is read only - it should not be sent to the API, but will be returned form it
", "example": "processing", "enum": [ "incoming", "processing", "shipped", "part_shipped", "cancelled", "returned", "part_returned", "varied" ] }, { "name": "quote", "kind": "optional", "type": "object", "nullable": true, "description": "Quote data", "example": "", "schema": [ { "name": "status_slug", "kind": "optional", "type": "string", "description": "The slug of the quote status applied to this quote" }, { "name": "status", "kind": "optional", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "QuoteStatus", "description": "", "modelRef": "#/components/schemas/QuoteStatus", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "", "maxLength": 45 }, { "name": "slug", "kind": "optional", "type": "string", "description": "", "maxLength": 45, "pattern": "^[a-z0-9-]+$" }, { "name": "default", "kind": "optional", "type": "boolean", "description": "" }, { "name": "next", "kind": "optional", "type": "string", "nullable": true, "description": "", "maxLength": 45, "pattern": "^[a-z0-9-]+$" }, { "name": "actions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "created_at", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "updated_at", "kind": "optional", "type": "string ", "description": "", "format": "date-time" }, { "name": "deleted_at", "kind": "optional", "type": "string ", "nullable": true, "description": "", "format": "date-time" } ] } ], "schema": [] }, { "name": "expiry", "kind": "optional", "type": "string ", "nullable": true, "description": " The date at which the quote is considered expired and no longer valid (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] }, { "name": "payment_status", "kind": "optional", "type": "string", "description": "That payment status of the order", "enum": [ "unpaid", "part_paid", "paid" ] }, { "name": "total_paid", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": " The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "revision_date", "kind": "optional", "type": "string", "nullable": true, "description": " The date at which the purchase was last modified - include user timezone or Z for UTC (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Tax lines for the purchase.", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] }, { "name": "billing_address", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/components/schemas/PurchaseAddress", "customType": "PurchaseAddress", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones" }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones Hardware Ltd" }, { "name": "address_line1", "kind": "required", "type": "string", "description": "", "example": "7 Philosophy way" }, { "name": "address_line2", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "city", "kind": "required", "type": "string", "description": "", "example": "Willerby" }, { "name": "region_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "minLength": 1 }, { "name": "postal_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "BJ6 9MK" }, { "name": "country_code", "kind": "required", "type": "string", "description": "", "example": "GB" }, { "name": "phone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "0123456789" }, { "name": "sparklayer_id", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "63428136-658f-48a6-beb7-7f333dfd9686" }, { "name": "first_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom" }, { "name": "last_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Jones" } ] }, { "name": "packages", "kind": "required", "type": "object", "description": "Packages contained within this purchase", "modelRef": "#/components/schemas/Package", "customType": "Package[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "Incoming", "description": "", "modelRef": "#/components/schemas/Incoming", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_package_id", "kind": "required", "type": "string", "description": "A UUID for the package that must be unique within the purchase. You must generate this yourself", "example": "63428136-658f-48a6-beb7-7f333dfd9686", "format": "uuid" }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": " The identifier for the package on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the package on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier that will be shown to the customer in their recent orders" } ] }, { "name": "accounting_files", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/PurchaseFiles", "customType": "PurchaseFiles[]", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that is used by your system", "example": "INV011", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that should be shown to the customer", "default": "INV011" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "complexType": "anyOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "uri", "kind": "optional", "type": "string", "nullable": true, "description": "", "format": "uri" }, { "name": "type", "kind": "required", "type": "string ", "description": "", "example": "uri", "default": "uri", "enum": [ "uri" ] } ] } ], "schema": [] }, { "name": "file_type", "kind": "required", "type": "string ", "description": "", "example": "invoice", "enum": [ "credit", "invoice", "payment" ] } ] }, { "name": "line_items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "type", "kind": "optional", "type": "string ", "description": "", "enum": [ "custom", "product" ] }, { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_item_key", "kind": "optional", "type": "string", "nullable": true, "description": " Internally used for tracking line items. For orders, can be set to null
", "minLength": 1 }, { "name": "sparklayer_variant_id", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the variant on your e-commerce platform
", "example": "45552423353839", "minLength": 1 }, { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "CAT-MUG", "maxLength": 128 }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "A human-readable identifier for the product
" } ] }, { "name": "name_parent", "kind": "required", "type": "string", "description": "Name of the product", "example": "T-Shirt" }, { "name": "name_child", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the product variant/type
", "example": "Red" }, { "name": "quantity", "kind": "required", "type": "number", "description": "", "example": 4 }, { "name": "custom_attributes", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "key", "kind": "required", "type": "string", "nullable": false, "description": "Key or name of the attribute.", "example": "mug text" }, { "name": "value", "kind": "required", "type": "string", "nullable": false, "description": "Value of the attribute.", "example": "best company ever" } ] }, { "name": "line_total", "kind": "required", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_method", "kind": "optional", "type": "object", "nullable": true, "description": "Details of how the package was/will be shipped
", "example": "", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "SKU that identifies the shipping method used", "example": "SHIP-ECO", "minLength": 1 }, { "name": "name", "kind": "required", "type": "string", "description": "The friendly/human-readable name for the shipping method
", "example": "Standard Shipping" }, { "name": "line_total", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_address", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/components/schemas/PurchaseAddress", "customType": "PurchaseAddress", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones" }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones Hardware Ltd" }, { "name": "address_line1", "kind": "required", "type": "string", "description": "", "example": "7 Philosophy way" }, { "name": "address_line2", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "city", "kind": "required", "type": "string", "description": "", "example": "Willerby" }, { "name": "region_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "minLength": 1 }, { "name": "postal_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "BJ6 9MK" }, { "name": "country_code", "kind": "required", "type": "string", "description": "", "example": "GB" }, { "name": "phone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "0123456789" }, { "name": "sparklayer_id", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "63428136-658f-48a6-beb7-7f333dfd9686" }, { "name": "first_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom" }, { "name": "last_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Jones" } ] }, { "name": "shipments", "kind": "required", "type": "array", "description": "Carrier and tracking details for the shipment", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "carrier", "kind": "required", "type": "string", "description": "", "example": "Carrier Company Ltd" }, { "name": "carrier_id", "kind": "required", "type": "string", "description": "The tracking number/ID used by the carrier
" }, { "name": "tracking_url", "kind": "optional", "type": "string", "nullable": true, "description": "The URL the customer can use to track their shipment", "format": "uri" } ] }, { "name": "type", "kind": "required", "type": "string ", "description": "", "enum": [ "incoming" ] } ] }, { "name": "Processing", "description": "", "modelRef": "#/components/schemas/Processing", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_package_id", "kind": "required", "type": "string ", "description": "A UUID for the package that must be unique within the purchase. You must generate this yourself", "example": "63428136-658f-48a6-beb7-7f333dfd9686", "format": "uuid" }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": " The identifier for the package on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the package on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier that will be shown to the customer in their recent orders" } ] }, { "name": "accounting_files", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/PurchaseFiles", "customType": "PurchaseFiles[]", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that is used by your system", "example": "INV011", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that should be shown to the customer", "default": "INV011" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "complexType": "anyOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "uri", "kind": "optional", "type": "string", "nullable": true, "description": "", "format": "uri" }, { "name": "type", "kind": "required", "type": "string ", "description": "", "example": "uri", "default": "uri", "enum": [ "uri" ] } ] } ], "schema": [] }, { "name": "file_type", "kind": "required", "type": "string ", "description": "", "example": "invoice", "enum": [ "credit", "invoice", "payment" ] } ] }, { "name": "line_items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "type", "kind": "optional", "type": "string ", "description": "", "enum": [ "custom", "product" ] }, { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_item_key", "kind": "optional", "type": "string", "nullable": true, "description": " Internally used for tracking line items. For orders, can be set to null
", "minLength": 1 }, { "name": "sparklayer_variant_id", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the variant on your e-commerce platform
", "example": "45552423353839", "minLength": 1 }, { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "CAT-MUG", "maxLength": 128 }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "A human-readable identifier for the product
" } ] }, { "name": "name_parent", "kind": "required", "type": "string", "description": "Name of the product", "example": "T-Shirt" }, { "name": "name_child", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the product variant/type
", "example": "Red" }, { "name": "quantity", "kind": "required", "type": "number", "description": "", "example": 4 }, { "name": "custom_attributes", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "key", "kind": "required", "type": "string", "nullable": false, "description": "Key or name of the attribute.", "example": "mug text" }, { "name": "value", "kind": "required", "type": "string", "nullable": false, "description": "Value of the attribute.", "example": "best company ever" } ] }, { "name": "line_total", "kind": "required", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_method", "kind": "optional", "type": "object", "nullable": true, "description": "Details of how the package was/will be shipped
", "example": "", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "SKU that identifies the shipping method used", "example": "SHIP-ECO", "minLength": 1 }, { "name": "name", "kind": "required", "type": "string", "description": "The friendly/human-readable name for the shipping method
", "example": "Standard Shipping" }, { "name": "line_total", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_address", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/components/schemas/PurchaseAddress", "customType": "PurchaseAddress", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones" }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones Hardware Ltd" }, { "name": "address_line1", "kind": "required", "type": "string", "description": "", "example": "7 Philosophy way" }, { "name": "address_line2", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "city", "kind": "required", "type": "string", "description": "", "example": "Willerby" }, { "name": "region_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "minLength": 1 }, { "name": "postal_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "BJ6 9MK" }, { "name": "country_code", "kind": "required", "type": "string", "description": "", "example": "GB" }, { "name": "phone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "0123456789" }, { "name": "sparklayer_id", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "63428136-658f-48a6-beb7-7f333dfd9686" }, { "name": "first_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom" }, { "name": "last_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Jones" } ] }, { "name": "shipments", "kind": "required", "type": "array", "description": "Carrier and tracking details for the shipment", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "carrier", "kind": "required", "type": "string", "description": "", "example": "Carrier Company Ltd" }, { "name": "carrier_id", "kind": "required", "type": "string", "description": "The tracking number/ID used by the carrier
" }, { "name": "tracking_url", "kind": "optional", "type": "string", "nullable": true, "description": "The URL the customer can use to track their shipment", "format": "uri" } ] }, { "name": "type", "kind": "required", "type": "string ", "description": "", "enum": [ "processing" ] } ] }, { "name": "Shipment", "description": "", "modelRef": "#/components/schemas/Shipment", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_package_id", "kind": "required", "type": "string ", "description": "A UUID for the package that must be unique within the purchase. You must generate this yourself", "example": "63428136-658f-48a6-beb7-7f333dfd9686", "format": "uuid" }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": " The identifier for the package on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the package on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier that will be shown to the customer in their recent orders" } ] }, { "name": "accounting_files", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/PurchaseFiles", "customType": "PurchaseFiles[]", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that is used by your system", "example": "INV011", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that should be shown to the customer", "default": "INV011" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "complexType": "anyOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "uri", "kind": "optional", "type": "string", "nullable": true, "description": "", "format": "uri" }, { "name": "type", "kind": "required", "type": "string ", "description": "", "example": "uri", "default": "uri", "enum": [ "uri" ] } ] } ], "schema": [] }, { "name": "file_type", "kind": "required", "type": "string ", "description": "", "example": "invoice", "enum": [ "credit", "invoice", "payment" ] } ] }, { "name": "line_items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "type", "kind": "optional", "type": "string ", "description": "", "enum": [ "custom", "product" ] }, { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_item_key", "kind": "optional", "type": "string", "nullable": true, "description": " Internally used for tracking line items. For orders, can be set to null
", "minLength": 1 }, { "name": "sparklayer_variant_id", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the variant on your e-commerce platform
", "example": "45552423353839", "minLength": 1 }, { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "CAT-MUG", "maxLength": 128 }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "A human-readable identifier for the product
" } ] }, { "name": "name_parent", "kind": "required", "type": "string", "description": "Name of the product", "example": "T-Shirt" }, { "name": "name_child", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the product variant/type
", "example": "Red" }, { "name": "quantity", "kind": "required", "type": "number", "description": "", "example": 4 }, { "name": "custom_attributes", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "key", "kind": "required", "type": "string", "nullable": false, "description": "Key or name of the attribute.", "example": "mug text" }, { "name": "value", "kind": "required", "type": "string", "nullable": false, "description": "Value of the attribute.", "example": "best company ever" } ] }, { "name": "line_total", "kind": "required", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_method", "kind": "optional", "type": "object", "nullable": true, "description": "Details of how the package was/will be shipped
", "example": "", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "SKU that identifies the shipping method used", "example": "SHIP-ECO", "minLength": 1 }, { "name": "name", "kind": "required", "type": "string", "description": "The friendly/human-readable name for the shipping method
", "example": "Standard Shipping" }, { "name": "line_total", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_address", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/components/schemas/PurchaseAddress", "customType": "PurchaseAddress", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones" }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones Hardware Ltd" }, { "name": "address_line1", "kind": "required", "type": "string", "description": "", "example": "7 Philosophy way" }, { "name": "address_line2", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "city", "kind": "required", "type": "string", "description": "", "example": "Willerby" }, { "name": "region_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "minLength": 1 }, { "name": "postal_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "BJ6 9MK" }, { "name": "country_code", "kind": "required", "type": "string", "description": "", "example": "GB" }, { "name": "phone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "0123456789" }, { "name": "sparklayer_id", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "63428136-658f-48a6-beb7-7f333dfd9686" }, { "name": "first_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom" }, { "name": "last_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Jones" } ] }, { "name": "shipments", "kind": "required", "type": "array", "description": "Carrier and tracking details for the shipment", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "carrier", "kind": "required", "type": "string", "description": "", "example": "Carrier Company Ltd" }, { "name": "carrier_id", "kind": "required", "type": "string", "description": "The tracking number/ID used by the carrier
" }, { "name": "tracking_url", "kind": "optional", "type": "string", "nullable": true, "description": "The URL the customer can use to track their shipment", "format": "uri" } ] }, { "name": "type", "kind": "required", "type": "string ", "description": "", "enum": [ "shipment" ] }, { "name": "dates", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "shipped_at", "kind": "required", "type": "string ", "description": " The date at which the package was shipped - include user timezone or Z for UTC (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] } ] }, { "name": "Cancelled", "description": "", "modelRef": "#/components/schemas/Cancelled", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_package_id", "kind": "required", "type": "string", "description": "A UUID for the package that must be unique within the purchase. You must generate this yourself", "example": "63428136-658f-48a6-beb7-7f333dfd9686", "format": "uuid" }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": " The identifier for the package on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the package on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier that will be shown to the customer in their recent orders" } ] }, { "name": "accounting_files", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/PurchaseFiles", "customType": "PurchaseFiles[]", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that is used by your system", "example": "INV011", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that should be shown to the customer", "default": "INV011" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "complexType": "anyOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "uri", "kind": "optional", "type": "string", "nullable": true, "description": "", "format": "uri" }, { "name": "type", "kind": "required", "type": "string ", "description": "", "example": "uri", "default": "uri", "enum": [ "uri" ] } ] } ], "schema": [] }, { "name": "file_type", "kind": "required", "type": "string ", "description": "", "example": "invoice", "enum": [ "credit", "invoice", "payment" ] } ] }, { "name": "line_items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "type", "kind": "optional", "type": "string ", "description": "", "enum": [ "custom", "product" ] }, { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_item_key", "kind": "optional", "type": "string", "nullable": true, "description": " Internally used for tracking line items. For orders, can be set to null
", "minLength": 1 }, { "name": "sparklayer_variant_id", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the variant on your e-commerce platform
", "example": "45552423353839", "minLength": 1 }, { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "CAT-MUG", "maxLength": 128 }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "A human-readable identifier for the product
" } ] }, { "name": "name_parent", "kind": "required", "type": "string", "description": "Name of the product", "example": "T-Shirt" }, { "name": "name_child", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the product variant/type
", "example": "Red" }, { "name": "quantity", "kind": "required", "type": "number", "description": "", "example": 4 }, { "name": "custom_attributes", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "key", "kind": "required", "type": "string", "nullable": false, "description": "Key or name of the attribute.", "example": "mug text" }, { "name": "value", "kind": "required", "type": "string", "nullable": false, "description": "Value of the attribute.", "example": "best company ever" } ] }, { "name": "line_total", "kind": "required", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_method", "kind": "optional", "type": "object", "nullable": true, "description": "Details of how the package was/will be shipped
", "example": "", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "SKU that identifies the shipping method used", "example": "SHIP-ECO", "minLength": 1 }, { "name": "name", "kind": "required", "type": "string", "description": "The friendly/human-readable name for the shipping method
", "example": "Standard Shipping" }, { "name": "line_total", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_address", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/components/schemas/PurchaseAddress", "customType": "PurchaseAddress", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones" }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones Hardware Ltd" }, { "name": "address_line1", "kind": "required", "type": "string", "description": "", "example": "7 Philosophy way" }, { "name": "address_line2", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "city", "kind": "required", "type": "string", "description": "", "example": "Willerby" }, { "name": "region_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "minLength": 1 }, { "name": "postal_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "BJ6 9MK" }, { "name": "country_code", "kind": "required", "type": "string", "description": "", "example": "GB" }, { "name": "phone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "0123456789" }, { "name": "sparklayer_id", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "63428136-658f-48a6-beb7-7f333dfd9686" }, { "name": "first_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom" }, { "name": "last_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Jones" } ] }, { "name": "shipments", "kind": "required", "type": "array", "description": "Carrier and tracking details for the shipment", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "carrier", "kind": "required", "type": "string", "description": "", "example": "Carrier Company Ltd" }, { "name": "carrier_id", "kind": "required", "type": "string", "description": "The tracking number/ID used by the carrier
" }, { "name": "tracking_url", "kind": "optional", "type": "string", "nullable": true, "description": "The URL the customer can use to track their shipment", "format": "uri" } ] }, { "name": "type", "kind": "required", "type": "string ", "description": "", "enum": [ "cancelled" ] }, { "name": "dates", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "cancelled_at", "kind": "optional", "type": "string ", "nullable": true, "description": " The date at which the package was cancelled - include user timezone or Z for UTC (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] } ] }, { "name": "Return", "description": "", "modelRef": "#/components/schemas/Return", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "accounting_files", "kind": "required", "type": "array", "description": "Any accounting files associated with this package e.g. invoices", "modelRef": "#/components/schemas/PurchaseFiles", "customType": "PurchaseFiles[]", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that is used by your system", "example": "INV011", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that should be shown to the customer", "default": "INV011" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "complexType": "anyOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "uri", "kind": "optional", "type": "string", "nullable": true, "description": "", "format": "uri" }, { "name": "type", "kind": "required", "type": "string ", "description": "", "example": "uri", "default": "uri", "enum": [ "uri" ] } ] } ], "schema": [] }, { "name": "file_type", "kind": "required", "type": "string ", "description": "", "example": "invoice", "enum": [ "credit", "invoice", "payment" ] } ] }, { "name": "custom_fields", "kind": "required", "type": "array", "description": "Extra information for the purchase. This will be shown to the customer in their recent orders", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": " Name/identifier for the custom field
", "example": "delivery-date", "minLength": 1 }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Data for the custom field", "example": "2023-10-28" } ] }, { "name": "metadata", "kind": "optional", "type": "array", "description": "Extra information for the purchase. This not will be shown to the customer", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "Name/identifier for the metadata
", "example": "example-key", "minLength": 1 }, { "name": "value", "kind": "required", "type": "string", "description": "Data for the metadata", "example": "1234" } ] } ], "modelRef": "#/components/schemas/Purchase", "complexItems": [ { "name": "object", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "", "example": "order", "modelRef": "#/components/schemas/PurchaseType", "customType": "PurchaseType", "schema": [] }, { "name": "purchase_identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier SparkLayer uses for the purchase. You will need to generate this if the purchase does not exist", "example": "63428136-658f-48a6-beb7-7f333dfd9686", "format": "uuid", "minLength": 1 }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": " The identifier for the purchase on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the purchase on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier that will be shown to the customer in their recent orders", "example": "B2B01123" } ] }, { "name": "customer_identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer", "kind": "required", "type": "string", "nullable": false, "description": "The ID of the customer that that order is for.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" }, { "name": "sparklayer_impersonator", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the sales agent placing the order.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" }, { "name": "sparklayer_impersonator_assignee", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the sales agent assigned to be responsible for the order.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" }, { "name": "sparklayer_child", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the company user that placed the order.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1" } ] }, { "name": "company", "kind": "optional", "type": "object", "nullable": true, "description": "Company sections are opt-in; omit this entirely for merchants that do not use them.
", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the company the purchase was placed for.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1", "format": "uuid" }, { "name": "section_id", "kind": "optional", "type": "string ", "nullable": true, "description": "The ID of the company section the purchase was placed for.", "example": "4217ba4f-7618-4e3b-b1af-9055639b18d1", "format": "uuid" }, { "name": "section_name", "kind": "optional", "type": "string", "nullable": true, "description": " The section name at the time of purchase, kept so historical purchases stay readable after a section is renamed or deleted. Not filterable.
", "example": "Bristol", "maxLength": 128 } ] }, { "name": "payment_method", "kind": "optional", "type": "string", "nullable": true, "description": "How the purchase was/will be paid for
", "enum": [ "quote", "upfrontPayment", "paymentOnAccount", "paymentByInvoice" ] }, { "name": "dates", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "created_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date the purchase was created in SparkLayer (RFC-3339). This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "updated_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date the purchase was last updated in SparkLayer (RFC-3339). This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "placed_at", "kind": "optional", "type": "string", "nullable": true, "description": " The date at which the purchase was placed - include user timezone or Z for UTC (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "to_be_placed_at", "kind": "optional", "type": "string", "nullable": true, "description": " The date at which the purchase is due to be placed, for a purchase that is scheduled rather than placed immediately (RFC-3339). It can be changed while the purchase is still pending
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "calculated_submitted_at", "kind": "optional", "type": "string", "readOnly": true, "description": " The date the purchase was submitted (RFC-3339). This is when the cart is converted into another purchase type. This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "expires_at", "kind": "optional", "type": "string", "readOnly": true, "description": " the date at which the purchase will expire and become archived (RFC-3339). This is read only - it should not be sent to the API, but will be returned form it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "payment_due_at", "kind": "optional", "type": "string", "description": "The date at which payment for the purchase is expected", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] }, { "name": "customer_reference", "kind": "optional", "type": "string", "nullable": true, "description": "Additional information that a customer adds to the order", "example": "Please deliver to the back of the store" }, { "name": "po_number", "kind": "optional", "type": "string", "nullable": true, "description": "PO number for the purchase", "example": "PO-001" }, { "name": "shipping_requested_date", "kind": "optional", "type": "string ", "nullable": true, "description": "The date requested for the delivery to arrive", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "recurring_purchase", "kind": "optional", "type": "object", "nullable": true, "description": "Present only for a purchase created from a recurring purchase template. Both properties are stored when the purchase is created and ignored on any later update", "example": "", "schema": [ { "name": "template_id", "kind": "optional", "type": "string ", "nullable": true, "description": "The recurring purchase template this purchase was created from. Set on creation and ignored on update", "example": "0f8fad5b-d9cb-469f-a165-70867728950e", "format": "uuid" }, { "name": "cancelled_at", "kind": "optional", "type": "string ", "nullable": true, "description": " The date the customer cancelled the purchase, after which it will not be placed (RFC-3339). Cancelling does not free the date - the template has already had its turn for it
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "to_be_placed_at_initial", "kind": "optional", "type": "string", "nullable": true, "description": " The date to_be_placed_at was first set to (RFC-3339). Set on creation and ignored on update, so that rescheduling cannot let the same template produce a second purchase for the same date
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] }, { "name": "currency_code", "kind": "optional", "type": "string", "nullable": true, "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 }, { "name": "currency_code_base", "kind": "optional", "type": "string", "writeOnly": true, "nullable": true, "description": "The 3 letter currency code of the store's base currency", "example": "GBP", "minLength": 3, "maxLength": 3 }, { "name": "calculated_shipping_address", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "A single string containing all the details of the shipping address. This is read only - it should not be sent to the API, but will be returned form it
", "example": "John Spark, SparkLayer, SparkLayer HQ, Example City, 12345" }, { "name": "calculated_total", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "calculated_total_usd", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "calculated_total_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "calculated_fulfilment_status", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": " The status of the order, calculated from the statuses of the individual packages. This is read only - it should not be sent to the API, but will be returned form it
", "example": "processing", "enum": [ "incoming", "processing", "shipped", "part_shipped", "cancelled", "returned", "part_returned", "varied" ] }, { "name": "quote", "kind": "optional", "type": "object", "nullable": true, "description": "Quote data", "example": "", "schema": [ { "name": "status_slug", "kind": "optional", "type": "string", "description": "The slug of the quote status applied to this quote" }, { "name": "status", "kind": "optional", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "QuoteStatus", "description": "", "modelRef": "#/components/schemas/QuoteStatus", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "", "maxLength": 45 }, { "name": "slug", "kind": "optional", "type": "string", "description": "", "maxLength": 45, "pattern": "^[a-z0-9-]+$" }, { "name": "default", "kind": "optional", "type": "boolean", "description": "" }, { "name": "next", "kind": "optional", "type": "string", "nullable": true, "description": "", "maxLength": 45, "pattern": "^[a-z0-9-]+$" }, { "name": "actions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "created_at", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "updated_at", "kind": "optional", "type": "string ", "description": "", "format": "date-time" }, { "name": "deleted_at", "kind": "optional", "type": "string ", "nullable": true, "description": "", "format": "date-time" } ] } ], "schema": [] }, { "name": "expiry", "kind": "optional", "type": "string ", "nullable": true, "description": " The date at which the quote is considered expired and no longer valid (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" } ] }, { "name": "payment_status", "kind": "optional", "type": "string", "description": "That payment status of the order", "enum": [ "unpaid", "part_paid", "paid" ] }, { "name": "total_paid", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": " The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] } ], "modelRef": "#/components/schemas/PurchaseBase", "customType": "PurchaseBase" }, { "name": "object", "schema": [ { "name": "revision_date", "kind": "optional", "type": "string", "nullable": true, "description": " The date at which the purchase was last modified - include user timezone or Z for UTC (RFC-3339)
", "example": "2020-01-01T00:00:00+02:00", "format": "date-time" }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Tax lines for the purchase.", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] }, { "name": "billing_address", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/components/schemas/PurchaseAddress", "customType": "PurchaseAddress", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones" }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones Hardware Ltd" }, { "name": "address_line1", "kind": "required", "type": "string", "description": "", "example": "7 Philosophy way" }, { "name": "address_line2", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "city", "kind": "required", "type": "string", "description": "", "example": "Willerby" }, { "name": "region_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "minLength": 1 }, { "name": "postal_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "BJ6 9MK" }, { "name": "country_code", "kind": "required", "type": "string", "description": "", "example": "GB" }, { "name": "phone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "0123456789" }, { "name": "sparklayer_id", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "63428136-658f-48a6-beb7-7f333dfd9686" }, { "name": "first_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom" }, { "name": "last_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Jones" } ] }, { "name": "packages", "kind": "required", "type": "object", "description": "Packages contained within this purchase", "modelRef": "#/components/schemas/Package", "customType": "Package[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "Incoming", "description": "", "modelRef": "#/components/schemas/Incoming", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_package_id", "kind": "required", "type": "string", "description": "A UUID for the package that must be unique within the purchase. You must generate this yourself", "example": "63428136-658f-48a6-beb7-7f333dfd9686", "format": "uuid" }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": " The identifier for the package on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the package on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier that will be shown to the customer in their recent orders" } ] }, { "name": "accounting_files", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/PurchaseFiles", "customType": "PurchaseFiles[]", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that is used by your system", "example": "INV011", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier of the purchase file that should be shown to the customer", "default": "INV011" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "complexType": "anyOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "uri", "kind": "optional", "type": "string", "nullable": true, "description": "", "format": "uri" }, { "name": "type", "kind": "required", "type": "string ", "description": "", "example": "uri", "default": "uri", "enum": [ "uri" ] } ] } ], "schema": [] }, { "name": "file_type", "kind": "required", "type": "string ", "description": "", "example": "invoice", "enum": [ "credit", "invoice", "payment" ] } ] }, { "name": "line_items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "type", "kind": "optional", "type": "string ", "description": "", "enum": [ "custom", "product" ] }, { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_item_key", "kind": "optional", "type": "string", "nullable": true, "description": " Internally used for tracking line items. For orders, can be set to null
", "minLength": 1 }, { "name": "sparklayer_variant_id", "kind": "optional", "type": "string", "nullable": true, "description": "The ID of the variant on your e-commerce platform
", "example": "45552423353839", "minLength": 1 }, { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "CAT-MUG", "maxLength": 128 }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on the e-commerce platform
", "example": "123456789", "minLength": 1 }, { "name": "internal", "kind": "optional", "type": "string", "nullable": true, "description": "The identifier for the product on your system", "minLength": 1 }, { "name": "visible", "kind": "optional", "type": "string", "nullable": true, "description": "A human-readable identifier for the product
" } ] }, { "name": "name_parent", "kind": "required", "type": "string", "description": "Name of the product", "example": "T-Shirt" }, { "name": "name_child", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the product variant/type
", "example": "Red" }, { "name": "quantity", "kind": "required", "type": "number", "description": "", "example": 4 }, { "name": "custom_attributes", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "key", "kind": "required", "type": "string", "nullable": false, "description": "Key or name of the attribute.", "example": "mug text" }, { "name": "value", "kind": "required", "type": "string", "nullable": false, "description": "Value of the attribute.", "example": "best company ever" } ] }, { "name": "line_total", "kind": "required", "type": "object", "nullable": true, "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_method", "kind": "optional", "type": "object", "nullable": true, "description": "Details of how the package was/will be shipped
", "example": "", "schema": [ { "name": "sku", "kind": "optional", "type": "string", "nullable": true, "description": "SKU that identifies the shipping method used", "example": "SHIP-ECO", "minLength": 1 }, { "name": "name", "kind": "required", "type": "string", "description": "The friendly/human-readable name for the shipping method
", "example": "Standard Shipping" }, { "name": "line_total", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "LineTotal", "description": "", "modelRef": "#/components/schemas/LineTotal", "schema": [ { "name": "total_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_tax_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "total_gross_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net", "kind": "required", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "discount_net_base", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MonetaryObject", "description": "", "modelRef": "#/components/schemas/MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] } ], "schema": [] }, { "name": "tax_rate", "kind": "optional", "type": "number", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n The tax rate to apply to the net total. The value represents a percentage e.g. 20 means 20%
", "example": 20, "default": 0, "format": "double", "minimum": 0 } ] } ], "schema": [] }, { "name": "tax_lines", "kind": "optional", "type": "array", "description": "Information about a tax line on a purchase", "modelRef": "#/components/schemas/TaxLine", "customType": "TaxLine[]", "schema": [ { "name": "title", "kind": "required", "type": "string", "description": "The title of the tax line", "example": "HST" }, { "name": "amount", "kind": "required", "type": "object", "description": "The amount of tax of the tax line", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "amount_base", "kind": "optional", "type": "object", "description": "The amount of tax of the tax line in the store's base currency", "modelRef": "#/components/schemas/MonetaryObject", "customType": "MonetaryObject", "schema": [ { "name": "number", "kind": "required", "type": "string", "description": "The amount of currency in this currency, represented as a string
", "example": "15.99", "minLength": 1 }, { "name": "currency", "kind": "required", "type": "string", "description": "The 3 letter currency code used for the prices in the purchase", "example": "GBP", "minLength": 3, "maxLength": 3 } ] }, { "name": "rate", "kind": "required", "type": "number", "nullable": true, "description": " The rate of the tax. The value represents a percentage e.g. 20 means 20%.
", "example": 20, "format": "double", "minimum": 0 } ] } ] }, { "name": "shipping_address", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/components/schemas/PurchaseAddress", "customType": "PurchaseAddress", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones" }, { "name": "company", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom Jones Hardware Ltd" }, { "name": "address_line1", "kind": "required", "type": "string", "description": "", "example": "7 Philosophy way" }, { "name": "address_line2", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "city", "kind": "required", "type": "string", "description": "", "example": "Willerby" }, { "name": "region_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "minLength": 1 }, { "name": "postal_code", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "BJ6 9MK" }, { "name": "country_code", "kind": "required", "type": "string", "description": "", "example": "GB" }, { "name": "phone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "0123456789" }, { "name": "sparklayer_id", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "63428136-658f-48a6-beb7-7f333dfd9686" }, { "name": "first_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tom" }, { "name": "last_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Jones" } ] }, { "name": "shipments", "kind": "required", "type": "array", "description": "Carrier and tracking details for the shipment", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "carrier", "kind": "required", "type": "string", "description": "", "example": "Carrier Company Ltd" }, { "name": "carrier_id", "kind": "required", "type": "string", "description": "The tracking number/ID used by the carrier
" }, { "name": "tracking_url", "kind": "optional", "type": "string", "nullable": true, "description": "The URL the customer can use to track their shipment", "format": "uri" } ] }, { "name": "type", "kind": "required", "type": "string ", "description": "", "enum": [ "incoming" ] } ] }, { "name": "Processing", "description": "", "modelRef": "#/components/schemas/Processing", "schema": [ { "name": "identifiers", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "sparklayer_package_id", "kind": "required", "type": "string