BigCommerce Metafields & Data Mapping
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 by adding configurations such as pack sizing, RRP prices, and more |
Customer metafields | Updating a customer's information by adding information such as credit limits |
Order metafields | Updating an order with invoicing information |
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.
Item | Details |
|---|---|
Approved apps | Metafields Manager 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 on accessing metafield data |
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.
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.
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.
In order for SparkLayer to work with BigCommerce 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.
To learn about more advanced settings, including customer-level product metafield settings, please see Product Settings