Widget Use
Displays a summary of the order for the user to review before proceeding to payment.
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 |
| Is B2C? | Determines whether the pricing and prompts should display in B2C format, i.e. inclusive of GST. | This would be ticked if the widget was being used on a B2C or Anonymous/Public layer, for example. Default is: unticked Tick to enable | All |
| Zero Dollar Freight Charge Display | The value to display when the selected freight option does not attract a charge. | Default is: No Charge | All |
| Requires Quote Freight Charge Display | The value to display when the selected freight option's charges can't be determined, therefore requiring a quote after order submission. | Default is: Requires Quote | 3.82 |
| Refresh Order on Load? | N/A - special use only. | This flag was applied in a special case where the order process did not contain freight or delivery address fields, which would ordinarily prompt an order update. Enable this flag if the order needs to be manually refreshed for the review summary. | All |
| Show Edit Button? | Determines whether the Edit button is displayed in the order summary during checkout. Clicking this would return the user to the cart. | Default is: ticked Untick to disable | 3.95 |
| Itemise Charges? | Determines whether various charges are broken down into their various components, instead of being grouped as 'Charges'. | Default is: unticked Tick to enable | 3.95 |
| Show Promotional Code Expiry Date? | Determines whether the expiry date is shown next to any promo codes applied to the cart. | Default is: unticked Tick to enable | 3.95 |
| Titles | |||
| Heading | The heading text displayed at the top of the widget. | Default is: Order Summary | All |
| Heading Icon | The icon displayed to the left of the heading text. | Default is: cv-ico-general-cart | All |
| Prompts | |||
| Subtotal Prompt | The label for the subtotal display. | This will be appended with either (inc GST) or (ex GST) as determined by the 'Is B2C?' flag. Default is: Subtotal | All |
| Charges Prompt | The label for the charges display (to show minimum order charges, for example). | Default is: Charges | All |
| Charge Line Discounts Prompt | The label for the discounts line in the order summary (where discounts are applied as a charge line with a negative value). | Default is: Discounts | 3.95 |
| Discounts Prompt | The label for the discount display (to show promotional discounts, for example). | Default is: Discounts | All |
| Freight Prompt | The label for the freight charges display. | Default is: Freight | All |
| GST Prompt | The text displayed to denote tax. | Default is: GST | All |
| Amount owing after gift cards | The label for the balance remaining display. | Default is: Net Owing | 3.78 |
| Giftcard total prompt | The label for the amount paid by gift card display. | Default is: Giftcard Total | 3.78 |
| Pomotional Code Expiry Date Prompt | Default is: This Promotional Code expires on: {0} | 3.95 | |
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.
