Features
Configurations
Account & Addresses
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 cart & checkout docid\ o3ndhzbcxiswh6m6satdt , 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 frontend integration guide docid\ qwxsym9x5 pviogutekcp frontend integration guide docid\ qwxsym9x5 pviogutekcp about how to update display settings on sparklayer / 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 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 my account interface 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 updating language and text you can update the default text by adding code to your frontend integration guide docid\ qwxsym9x5 pviogutekcp languages & international docid\ klrs7wtxn3wncdy8z5zvu about how to update text on sparklayer / 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 seturned" "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 complete" "complete", "account order status awaiting approval" "requires approval", "account order status awaiting merchant" "awaiting merchant", "account order status archived" "archived", } }, / end of code / 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 frontend integration guide docid\ qwxsym9x5 pviogutekcp frontend integration guide docid\ qwxsym9x5 pviogutekcp about how to update display settings on sparklayer / 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 settings docid\ gznstztqcrfflfzstaw0n 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 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 for more information, please refer to the sparklayer technical docs account credit and credit balances please refer to credit, net terms, & invoicing docid\ ywm70oquosykooiqb4z4g 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 updating the display you can update the default display by adding code to your frontend integration guide docid\ qwxsym9x5 pviogutekcp frontend integration guide docid\ qwxsym9x5 pviogutekcp about how to update display settings on sparklayer / 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 / in addition to this, 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) 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}}, }, 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 my account interface docid\ lqxani7ivdqna09d9soap order invoices it's possible to attach invoices (e g a pdf) to a b2b customer's order please refer to credit, net terms, & invoicing docid\ ywm70oquosykooiqb4z4g to learn more 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 ("targets") 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 setting up metafields on shopify to learn more about how to configure metafields on shopify for sparklayer, please refer to shopify metafields & data mapping docid\ bxwngb6b1n7qffhtnu7pk accounting id item details custom data type customers 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 title item details custom data type customers 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 company name item details custom data type customers 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 shipping address id item details custom data type customers 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 billing address id item details custom data type customers 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 available shipping addresses by id item details custom data type customers 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 available shipping addresses ids use case this can be used to specify the available shipping addresses for the for the customer (by id) 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