Metafields
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 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 |
The following guide serves as an overview of all available metafields that can be configured within SparkLayer.
Platform-specific metafields You can learn more about metafields in the following guides:
Please note that all product metafields must be applied at the variant level.
Key | Type | Details |
|---|---|---|
pack_size | integer | Learn more |
min_order_quantity | integer | Learn more |
max_order_quantity | integer | Learn more |
min_order_parent_quantity | integer | Learn more |
max_order_parent_quantity | integer | Learn more |
reserve_stock_quantity | integer | Learn more |
display | boolean | Learn more |
sell | boolean | Learn more |
settings | json | Learn more This "supercedes" the above metafields |
min_stock_level | integer | Learn more |
restock_date | date | Learn more |
stock_location_data | json | Learn more |
Learn more It's also possible to set customer-specific product metafields and you can learn more in our guide here.
Key | Type | Details |
|---|---|---|
authentication | single_line_text | Learn more |
title | single line text | Learn more |
company_name | single line text | Learn more |
group | single line text | This "supercedes" any tags assigned to the customer |
price_lists | json single_line_text | Learn more This "supercedes" any price lists assigned to the customer group |
payment_by_invoice | json | Learn more |
payment_on_account | json | Learn more |
accounting_id | single line text | Learn more |
discount_percentage | single line text integer float | Learn more |
sales_agent_groups | list.single_line_text | Learn more |
parent_customer_id | single line text | Learn more |
role | single line text | Learn more |
shipping_address_id | single line text | Learn more |
billing_address_id | single line text | Learn more |
available_shipping_addresses_ids | json | Learn more |
Please note If you're looking to use our advanced metafields, please speak to our team to learn more about how it works.
Key | Type | Details |
|---|---|---|
invoice_url | url list.url file_reference list.file_reference | Learn more |
sparkOrderImport | boolean | Learn more |