Widget Use
Presents the various shipping methods available to the user during checkout. Each option and its associated cost is displayed, so that the user can make their selection before proceeding to payment.The widget is also used to present pickup locations where Store Pickup functionality is enabled.
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. | 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 configuration is needed. The widget can be added to the zone more than once and the layer feature can determine which audience can see each widget. | All |
| Freight Options Heading | The heading text displayed at the top of the widget. | Default is: Freight Options | All |
| Freight Options Heading Icon | The icon displayed to the left of the heading text. | Default is: cv-ico-general-shipping Select via drop-down | All |
| Show GST Suffix? | Determines whether to include the (ex GST) or (inc GST) suffix against each charge option. | Default is: ticked Untick to disable | All |
| GST Prompt | The text displayed in the GST Suffix with either 'ex' or 'inc'. | Default is: GST | All |
| Zero Dollar Freight Charge Display | The text displayed when the freight option does not attract a charge. | Default is: No Charge | All |
| Pickup Locations Heading | The heading text displayed above the Pickup Locations section. | Default is: Pickup Location Note: An 's' is automatically appended when there are multiple pickup warehouses. | All |
| Pickup Locations Heading Icon | The icon displayed to the left of the Pickup Locations Heading text. | Default is: cv-ico-general-location Select via drop-down | All |
| Pickup Location List Label | The prompt text displayed when the user has not yet selected a pickup location. | Default is: Select Pickup Location | All |
| Map Link Text | The text displayed for the location map hyperlink. | Default is: map | All |
| Select Warehouse Label | The button text displayed against each possible pickup location. | Default is: Select Warehouse | All |
| No Own Carrier Name Message | The prompt text displayed when Own Carriers are enabled but the user has not yet selected. | Default is: Please select one of your own carriers | All |
| No Own Carrier Account Message | The prompt text displayed for the Own Carrier Account Number field. | Default is: Please enter your Freight Account Number | All |
| Freight Option Not Selected Message | The prompt text displayed when no Freight Option selection has been made. | Default is: Please select a freight option | All |
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.
