Widget Use
Renders the relevant B2C billing and delivery address input fields during checkout.
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:
- Checkout Template
- Checkout Quote Template
- Guest Checkout Template
- PayPal Express Template
Widget Options
Option | Use | Comments | Available from Version |
---|---|---|---|
Description | A short description of the widget's use. | We recommended this field be updated so the widget's purpose is clear at a glance from the template page. | All |
Layer | The layer the widget is valid for. | For this widget, the layer would generally be B2C. The layering technology allows for the content to be shown to specific audiences. This is handy | All |
Use PostCode Validation? | Determines whether to validate the postcode against the suburb. | Default is: ticked Untick to disable | All |
Use Store Pickup? | Determines whether to offer the Pickup option to users during checkout (where there are pickup options available). | Default is: ticked Untick to disable | All |
Use Customer Reference? | Determines whether to display the Customer Reference field. | Default is: unticked Tick to enable | All |
Create User Default Checked? | Determines whether the 'Create Account' option is ticked by default during Guest Checkout. | Default is: unticked Tick to enable | 3.81 |
Show delivery address entry by default | Determines whether the Delivery Address section is displayed by default, or whether it stays hidden until the user ticks the box to indicate 'My Delivery Address is different from Billing Address'. | Default is: unticked Tick to enable | 3.85 |
Show Company Name In Address | Determines whether to include a Company Name field. | Default is: unticked Tick to enable | 3.81 |
Hide State Field In Address | Default is: unticked Tick to enable | ||
Show Country | Determines whether to include the Country address field. | Default is: unticked Tick to enable | 3.81 |
Country List | Colon and comma-separated list of Country values and labels, to be displayed in the rendered output. | The content before the colon is the Country value, the content after the colon is the Country label displayed to the user. For example: {'Argentina':'Argentina','Bermuda':'Bermuda','Bolivia':'Bolivia','Brazil':'Brazil','Belize':'Belize','Canada':'Canada','Chile':'Chile','Colombia':'Colombia'} | 3.81 |
State List | Colon and comma-separated list of State values and labels, relative to the selected Country. |
For example: {'United States' : {'AL' : 'Alabama','AK' : 'Alaska','AZ' : 'Arizona','AR' : 'Arkansas','CA' : 'California','WY' : 'Wyoming'}} | 3.81 |
Show Authority To Leave? | Determines whether the Authority To Leave tickbox and options are displayed during checkout. | Default is: Unticked Tick to enable | 3.81 |
Titles | |||
Address Validation Title | The heading text displayed on the Address Validation popup window. | Default is: Address Search | 3.81 |
Billing Details Heading | The heading text displayed above the Contact & Billing Address section. | Default is: Contact / Billing Address | All |
Billing Details Heading Icon | The icon displayed to the left of the Billing Details Heading text. | Default is: cv-ico-general-user Select via drop-down | All |
Delivery Details Heading | The heading text displayed above the Delivery Details section (when expanded). | Default is: Delivery Address | All |
Delivery Details Heading Icon | The icon displayed to the left of the Delivery Details Heading text. | Default is: cv-ico-general-truck Select via drop-down | All |
Delivery Options Heading | The heading text displayed above the Delivery / Pickup selection. | Default is: Delivery Options | All |
Delivery Options Heading Icon | The icon displayed to the left of the Delivery Options Heading text. | Default is: cv-ico-general-shipping Select via drop-down | All |
Delivery Option Delivery Prompt | The text displayed for the Delivery option. | Default is: Delivery | All |
Delivery Option Pickup Prompt | The text displayed for the Pickup option. | Default is: Pickup | All |
Customer Reference Prompt | The text displayed for the Customer Reference field. | Default is: Customer Reference | All |
Create User Prompt | The text displayed next to the 'Create Account' option during Guest Checkout. | Default is: Create Account & Remember my details | 3.81 |
Delivery Instructions Heading | The heading text displayed above the Delivery Instructions section. | Default is: Delivery Instructions | All |
Delivery Instructions Heading Icon | The icon displayed to the left of the Delivery Instructions Heading text. | Default is: cv-ico-general-truck Select via drop-down | All |
Delivery Instructions Prompt | The text displayed for the Delivery Instructions field. | Default is: Delivery Instructions | All |
Pickup Instructions Heading | The heading text displayed above the pickup details section. | Default is: Pickup Instructions | All |
Pickup Instructions Heading Icon | The icon displayed to the left of the Pickup Instructions Heading text. | Default is: cv-ico-general-truck Select via drop-down | All |
Pickup Instructions Prompt | The text displayed for the Pickup Instructions field. | Default is: Pickup Instructions | All |
Order Comments Prompt | The text displayed for the Order Comments field. | Default is: Order Comments | All |
Notifications | |||
Address Is Valid Message | The notification text displayed to advise the user that their address has been validated and accepted. | Default is: Your address is valid | 3.81 |
Authority To Leave Updated Success Message | The confirmation text displayed when the user changes/updates the selected Authority To Leave option. | Default is: Authority to leave updated successfully | 3.81 |
Delivery Instructions Updated Success Message | The notification text displayed after the user enters Delivery Instructions. | Default is: Delivery instructions updated successfully | 3.81 |
Pickup Instructions Updated Success Message | N/A - field to be removed. | ||
Order Comments Updated Success Message | The notification text displayed after the user enters Order Comments. | Default is: Order comments updated successfully | 3.81 |
Delivery Address Updated Success Message | N/A - field to be removed. | ||
Missing Delivery Address Fields Message | The message text displayed when one or more of the mandatory address fields are left blank. | Default is: Not all the mandatory address fields have been populated | All |
Buttons | |||
My Address Checked Button Label | The text displayed on the the 'Check Address' button once the user has successfully validated their address. | Default is: Address Checked | 3.81 |
Address Validation Button Label | The text displayed on the button to select an address from the list. | Default is: Select | 3.81 |
Address Validation Cancel Button Label | The text displayed on the button to cancel the address selection process. | Default is: Cancel | 3.81 |
Check My Address Button Label | The text displayed on the button to initiate Address Validation. | Default is: Check My Address | 3.81 |
Authority to Leave | |||
Leave At Alternative Location Prompt | The text displayed with the Authority To Leave tickbox. | Default is: Authority to leave at alternate location if you are unavailable | 3.81 |
Authority To Leave | Prompt text for the Authority To Leave option. | Default is: Authority To Leave | 3.81 |
Authority To Leave Options | Semicolon-separated list of authority to leave options, to be displayed in the rendered output. | Default is: Reception; Front Door; Front Porch; Front Verandah; In Carport; In Garage; In Letter Box; In Mail Box; Over Front Fence; Next To Wheelie Bins; Under Front Stairs | 3.81 |
Authority To Leave Format | The format in which to display the Authority To Leave options when rendering in the output. | Default is: Authority To Leave {0} (with {0} representing the list of options from 'Authority To Leave Options') | 3.81 |
Where To Show Authority To Leave? | Determines the placement of the Authority To Leave tickbox and dropdown selector. Can be displayed either above or below the Delivery Instructions section. | Default is: Below Delivery Instructions | |
Address Lookup | |||
Address Lookup Provider | The organisation supplying the table of valid addresses to be used in address lookup. Current options are:
| Default is: None | 3.88 |
Address Lookup Prompt | The label for the address input field. | Default is: Street Address | 3.88 |
Address Lookup Help | The help text for address input. | Default is: Start typing your address and select the right one from the list presented. If it does not appear on the list, please enter your address details manually | 3.88 |
Select Address Message | The prompt for the user to select their address from the suggestions list. | Default is: Please review the suggestions below and select the correct address to proceed | 3.88 |
No Address Found Message | The message returned when the user's manually entered address does not match any in the lookup table. | Default is: There are no valid matches for that address, would you like to proceed with the address supplied? | 3.88 |
Number Of Suggestions | The number of options returned once the user starts typing their address into the input field. | Default is: 10 | 3.88 |
Minimum Lookup Length | The number of characters the user must type before suggestions are returned. | Default is: 4 | 3.88 |
Show Additional Address Field? | Allows an additional field to be inlcuded in the address lookup section. | Default is: unticked Tick to enable | 3.88 |
Billing Address Lookup Mandatory Message | The message returned when the does not enter a Billing Address and attempts to checkout. | Default is: Billing Address is mandatory | 3.91 |
Delivery Address Lookup Mandatory Message | The message returned when the user does not enter a Delivery Address and attempts to checkout. | Default is: Delivery Address is mandatory | 3.91 |
Other Widgets
-
Order Payment Links Form Widget — Renders an order details stepper with an order form that can be automatically populated with query strings, and/or manually entered by the user. The form doesn't validate the order details are accurate in order to stay both secure and accessible to unauthenticated users.
-
Magic Link Authentication Message Widget — Renders the Magic Link authentication message.
-
CUSTOM_Side by Side Content Tiles Widget — Renders two side by side content tiles in a zone with widget options for selecting or adding background colour, image, text and link/button positioning.
-
Stock Dialog Widget — Displays the Stock to Receive Detail dialog window.
-
Stock to Receive Widget — Displays the Stock to Receive page.
-
Stock Levels Widget — Displays Stock Levels page.
-
Order Declined Pending 3rd Party Installment Msg Widget — Renders the message body for the email sent when the user selects to sign up and pay with a Buy Now Pay Later provider but approval is subject to further checks.
-
Order Field Static Widget — Renders an additional order field in email templates.
-
Online Quote Validation Widget — Renders the appropriate message to the user after the current status of an online quote accessed via an email link is validated.
-
Header Level Cost Centre Widget — Renders the cost centre input field on the order header in the shopping cart.
-
Openpay Summary Widget — Renders Openpay marketing information for a product on the product detail page. Use this widget instead of the Product Purchase Details widget if you want to customise tagline placement on the template.
-
Order Line Availability - Click and Collect Widget — Displays product availability and delivery methods at the order line level in dynamic scenarios such as the cart when Click & Collect is enabled.
-
Account Activation Email Content Widget — Renders the message content in the Invitation to Register an Account email.
-
Order Template Cost Centre Widget — Renders the cost centre input field on each product line in an order template.
-
BPAY Account Payment Detail Widget — Renders BPAY payment information in the body of the BPAY Account Payment email. This email is sent to users who pay invoices or pay down their account balance using BPAY.