Account & Addresses

Custom My Account fields 
Within the My Account Interface﻿, 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﻿, by adding special code to your website within the SparkLayer Core Script. You can use our sample below to get started.
Updating the display
You can update the default display by adding code to your Core Script﻿.
Learn more﻿ about how to update display settings on SparkLayer
﻿
JS
|
/* 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 */
/* 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:
<a href="mailto:value">displayText</a>
phone This will set a link in the following format:
<a href="tel:value">displayText</a>
website This will set a link in the following format:
<a href="value">displayText</a>
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"
Please note
If you are using our Sales Agent Ordering﻿ 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.
﻿
﻿
﻿
﻿
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.
﻿
Updating the display
You can update the default display by adding code to your Core Script﻿.
Learn more﻿ about how to update display settings on SparkLayer
﻿
JS
|
/* 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 */
/* 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﻿﻿
﻿
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. 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.
🛍️ Using Shopify
🌐 Other platforms
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﻿ for the customer when viewing an order detail page.
﻿
For more information, please refer to the SparkLayer Technical Docs﻿
﻿
﻿
﻿
Account credit and credit balances
Please refer to Credit & Invoicing﻿﻿
﻿
﻿
﻿
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. Learn more﻿﻿
﻿
﻿
﻿
Order invoices
It's possible to attach invoices (e.g. a PDF) to a B2B customer's order. Please refer to our guide here﻿ to learn more.

Updated 20 Sep 2023

Did this page help you?

TABLE OF CONTENTS

Custom My Account fields

Show shipping address summary

Allow address editing

Order tracking (shipping) details

Account credit and credit balances

Account redirect

Order invoices

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: <a href="mailto:value">displayText</a> phone This will set a link in the following format: <a href="tel:value">displayText</a> website This will set a link in the following format: <a href="value">displayText</a>
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"