Skip to content

Cart and Checkout Widgets

This page covers the widgets for the shopping cart and the step-by-step checkout. For each one it gives the steps to place it and the settings its form offers, in the words the form uses, so you can tell before you start which records and images you need to have ready. What a voucher (coupon) is, and what redeeming one records, is explained once in Voucher Management.

Your job, and the screen for it

The jobScreen or tabRead
Add one of these widgets to a pageDesign Panel › Elements › Cart & CheckoutConfiguration
Change a widget that is already on the pageClick it on the canvas, Design Panel › Selected NodeIts section under Configuration
Know which settings need an ID, JSON or rich textSelected NodeFields
Make a change reach the shopSAVE NODE, then PublishConfiguring Widgets
Find out why a widget shows nothingTroubleshooting

Overview

The Cart & Checkout group in the Elements tab holds 3 widgets. This page describes 2 of them: checkout-step-v2, shopping-cart. The other one is a layout built for one shop and is not described here. Checkout widgets decide which steps a shopper goes through — shipping, vouchers, membership points, payment — so walk through the checkout on Preview after changing them, signed in with a test account. The checkout widgets have no preview mode of their own: a voucher claimed or an order placed in Preview is real. Placing, saving and publishing work the same for every widget and are explained once in Configuring Widgets in the Website Builder; this page adds what is particular to each widget.

Where it fits

BeforeThese widgetsAfter
You can open the Website Builder and the page exists — User Permission Manager, Layout InstancePlaced on a page and configuredShoppers see them on the storefront after Publish

Screens and menus

Open a page from the Layout Manager tile. In the Design Panel, the Elements tab lists these widgets under Cart & Checkout, each with its one-line description; the search box matches the description too. Clicking a placed widget on the canvas opens its settings in Selected Node.

Configuration

Before you can use it

  • Everything in Configuring Widgets › Before you can use it: CP Commerce Admin for your login, and the records the widgets point at.
  • Check Platform before you drop a widget: it is added to that platform’s version of the page only.

checkout-step-v2

Step-by-step checkout.

  1. In Elements, open Cart & Checkout (or search checkout-step-v2) and drag checkout-step-v2 onto the page.
  2. In Selected Node, fill in the widget’s form: Enable Shipping (with Shipping Address Layout URL and Billing Address Layout URL), Product Listing Layout URL, Enable Cash Voucher, Enable Membership Points Conversion, Enable Payment Gateway and Allow Self Pick Up; then for each step — shopping cart, shipping, voucher, membership points, payment — its Title and the text, text colour, background and border of its Back and Next buttons. Under More settings at the bottom of the form:
    • General — Hide add shipping; Cart page (pick a page); Display popup; Hide billing address; Receipt label; Agreement label (rich text); Requires agreement confirmation; Display summary in payment; Settlement voucher limit; Enable auto select voucher; Enable claim coupon using code; Pickup branch radius limit; Is multi point; Enable claim discount voucher by code; Hide product image; All items grouped; Is no overseas delivery; Is no east malaysia delivery; Hide title on mobile; Edit address page (pick a page); Show remove all button; Payment history page (pick a page)
    • Shopping cart column config — Price; Qty; Discount; Amount
    • Shopping cart config › Pop up button — Background; Color
    • Shopping cart config › Address button — Color; Background; Border
    • Shopping cart config › Shipping method hover styles — Color; Background color
    • Shipping config › Pop up button — Background; Color
    • Shipping config › Address button — Color; Background; Border
    • Shipping config › Shipping method hover styles — Color; Background color
    • Voucher config › Pop up button — Background; Color
    • Voucher config › Address button — Color; Background; Border
    • Voucher config › Shipping method hover styles — Color; Background color
    • Membership point config › Pop up button — Background; Color
    • Membership point config › Address button — Color; Background; Border
    • Membership point config › Shipping method hover styles — Color; Background color
    • Payment config › Pop up button — Background; Color
    • Payment config › Address button — Color; Background; Border
    • Payment config › Shipping method hover styles — Color; Background color
    • Pop up button — Background; Color
    • Claim coupon uistyle — Color; Font; Background; Text; Border radius; Border
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

Agreement label, under More settings, is rich text. Allow Self Pick Up is saved, but nothing in the checkout reads it today — ticking it changes nothing.

shopping-cart

Shopping cart.

  1. In Elements, open Cart & Checkout (or search shopping-cart) and drag shopping-cart onto the page.
  2. In Selected Node, fill in the settings you need — leave the rest empty to keep the widget’s own behaviour:
    • General — Product category listing page (pick a page); Checkout page (pick a page); Hide product image
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

Fields

The settings are listed with each widget above, in the form’s own words. Colours, lists and JSON behave as described in Configuring Widgets › Step 3.

Settings marked (pick a page) — their labels end in page — open a list of your pages when you click them and fill in the page’s address, /page/ and its code. You can also type any link instead, such as a full https:// address. Left empty, the widget uses its own default page where it has one.

The settings that pick a record, take JSON or hold rich text:

KindWhereWhat to know
Rich textcheckout-step-v2 › Agreement labelFormatted text with links and images; Expand opens a large editor. Emptying the editor removes the setting

Lifecycle and effects

SAVE NODE keeps a change in your browser tab only; Publish sends the page to the shop, and a reload before publishing loses the change. A setting left empty is not saved and the widget uses its own behaviour for it; opening a widget and saving without changes leaves its stored settings as they were. The full sequence is in Configuring Widgets › Lifecycle and effects.

Related applets

  • CP Commerce Admin — decides who may publish, and holds the same pages under Layout Instance.
  • Media Library — where the images these widgets show are uploaded.

Troubleshooting

SymptomCauseFix
The widget is empty on the shopA record it shows is missing or inactiveCheck the records its pickers point at
A change is gone after reloadThe page was not publishedRedo it and Publish before leaving
It shows on desktop but not on phonesIt was added on a desktop platform onlySwitch Platform and add it there too
SAVE NODE does nothingWidget Config (JSON) holds invalid JSONFix or undo the JSON
A picker shows Not in the list — saved ID …The record it saved was deleted, belongs to another website, or is not in the list as loadedPublish what you have first (a reload loses unpublished changes), then reload; if it still shows, check the record before you pick a replacement
A picker shows The list is empty or could not be loadedNothing of that kind exists yet, or loading failedCreate the record first, or reload the page
Ticking Allow Self Pick Up changes nothingNothing in the checkout reads that setting todayExpected; self pick-up is not switched on by this tick box

Related documentation

Last updated on