Metafields

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 docid\ ccz1vnh0o6d 722w35xpa by adding configurations such as docid\ cmxfrpgjqxfz9vjztvv0d , docid\ s vtljborgmnwjjfsmom9 , and more customer metafields updating a customer's information by adding information such as docid\ ywm70oquosykooiqb4z4g order metafields updating an order with docid\ ywm70oquosykooiqb4z4g 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 docid\ bxwngb6b1n7qffhtnu7pk docid\ bkhor8d6qhgzx yxsdt56 automatically configure metafields within the https //app sparklayer io/configuration/integrations/platform , you can speed up the creation of metafields using our built in tool to automatically configure them 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 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 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 docid\ s vtljborgmnwjjfsmom9 rrp json pack size allows you to configure pack size rules for products, e g 6, 12, 18 docid\ cmxfrpgjqxfz9vjztvv0d pack size integer minimum purchasable quantity (variant level) allows you to specify the required minimum quantity of the variant customers can purchase docid\ cmxfrpgjqxfz9vjztvv0d min order quantity integer maximum purchasable quantity (variant level) allows you to specify the maximum quantity of the variant customers can purchase 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 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 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 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 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 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 docid\ cm9b1i6cz0volc67g fji this "supercedes" the above metafields this "supercedes" the above metafields settings json reserved dtc stock quantity allows you to specify a stock quantity to reserve for your dtc customers 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 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 docid\ gj ao gq6oa jx0d27hys stock location data json learn more it's also possible to set customer specific product metafields and you can learn more in 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 docid\ xxiwz30efvbkxnuf3j1g8 title single line text company name allows you to specify the name of the company associated to a customer docid\ xxiwz30efvbkxnuf3j1g8 company name single line text assigned groups allows you to specify the group assigned to a customer this "supercedes this "supercedes " any tags assigned to the customer 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 docid\ v8dvucj7ju0fh7bvinrew this "supercedes this "supercedes " any price lists assigned to the customer group 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 docid\ ywm70oquosykooiqb4z4g payment by invoice json credit limit and account balance contains the customers credit limit and account balance details docid\ ywm70oquosykooiqb4z4g payment on account json accounting id allows you to specify a unique accounting id for a customer 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 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 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 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 docid wwfewvjy9xrsuncqlfoz role single line text default shipping address id allows you to specify which shipping address to use as the default for orders 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 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 docid\ xxiwz30efvbkxnuf3j1g8 available shipping address ids json please note if you're looking to use our advanced metafields, please 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 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 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 docid\ bxwngb6b1n7qffhtnu7pk visible id single line text