Skip to end of metadata
Go to start of metadata

Widget Use

Displays the 'My Store' locator widget for sites where product availability or pickup location is enabled based on a user's selected store. The user enters a postcode or suburb and selects a store from the results returned.

Example of Widget Use

Following is an example of the widget in use:


Where can the Widget be placed?

The widget can be used in the following templates:

  • Theme Layout Template
  • Cart Template

Widget Options

OptionUseCommentsAvailable from Version
DescriptionA short description of the widget's use.We recommend this field be updated so the widget's purpose is clear at a glance from the template page.All
LayerThe layer the widget is valid for.

The layering technology allows for the content to be shown to specific audiences. This is handy if the content is only valid for a certain type of user or if the same widget is required for more than one audience but different configurations are needed.

The widget can be added to the zone more than once and the layer feature can determine which audience can see each widget. 

Select Display Location

Determines where in the layout the widget should render:

  • If the widget is being placed in Theme Layout Template for display on the Home Page, the display location should be 'Top Bar of All Pages'.
  • If the widget is being placed in the Cart Template, the display location should be 'Page Content of Cart Page'.
Default: Top Bar of All Pages3.81
Store Details Json Field GroupSpecifies the JSON field group used to determine which fields are shown for each store in the search results. Default: store-location-availability3.81
Max Number of Search ResultsThe maximum number of store locations returned based on the user's postcode/suburb input.Default: 33.81
Current Store PromptThe prompt text displayed for the user's currently selected store.Default: My Store3.81
When No Store Set TextThe text displayed when the user has not yet set a store.Default: Please select your store3.81
Change Store TextThe link text for expanding the Store Locator input field.Default: Change Store3.81
Change Store InstructionsThe instruction text displayed above the postcode/suburb input box.
Search Box Place HolderThe placeholder text displayed inside the postcode/suburb input box.Default: Enter suburb or postcode3.81
Search Button TextThe text displayed on the search button.Default: Find my nearest store3.81
Set Store Button TextThe text displayed on the button next to each store location in the result set (except for the user's currently selected store).Default: Set Location3.81
Current Store Button TextThe text displayed on the button next to the user's currently selected store in the result set.Default: My Store3.81

Other Widgets

  • Page:
    Items Meta Data Filter Widget — Configures the data source and filtering options when Server Side filtering mode is selected for the Article List Features filter.
  • Page:
    B2C Registration Verification Notification Widget Used in the B2C Registration Verification Notification email template to alert your online team or a staff member that a user has registered on your website.
  • Page:
    B2C Registration Verification Required Email Widget Creates the content of the email notifying a B2C user they have to authenticate their email address after they register on your site.
  • Page:
  • Page:
    Token Customer Credit Card Info Widget — Displays the message in credit card expiry reminder emails to Customers who have existing token payment set up.
  • Page:
    Email Credit Card Verification Link Widget Adds credit card verification instructions in order confirmation and verification reminder emails, and includes a link to the validation page.
  • Page:
    Report Subscription Widget Renders input field and button configurations for the Report Subscription screen. Field labels, headings and text can be edited.
  • Page:
    Report Generator Widget Provides input field and button configurations for the Report Generator feature. You can customise the widget to configure display field options and text to suit your website style.
  • Page:
    SignalR Group Message Selector Widget Define the text for the button users will click when selecting a SignalR client–in this example, a printer enabled to print orders/invoices in PDF format.
  • Page:
    Page Content Search Result Widget Customise the 'no results returned' message when the keyword search does not match any static content on your pages or products.
  • Page:
    Display Customer Currency Widget Displays the default currency set for a Customer based on login for websites operating in international markets. 
  • Page:
    Scripts & Styles Widget — The new Scripts & Styles widget allows you to bundle related scripts and styles into one widget to function as a unit, or add multiple Scripts & Styles widgets to a page so they operate independently. Due to its name, and because the widget functions to run scripts or apply styles only, you know at a glance if a page is using customised JavaScript or Style Sheets.
  • Page:
    Account Payment Detail Widget Renders the payment detail information in the body of the various Account Payment confirmation emails. Information includes (but is not limited to) the order number, account number, invoice, and amount paid.
  • Page:
    Dashboard Recent Invoices Widget — Displays the logged in user's 5 most recent invoices, with a link to each invoice in detail, as well as a 'View All' option.
  • Page:
    Dashboard Account Status Widget — Displays a list of the user's customer account status, including balance owing and payment terms, as well as links to statements and the account payment page.