Skip to content

Voucher and Reward Widgets

This page covers the widgets for voucher lists and details, the customer’s own vouchers and rewards, and external voucher redemption. 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 › Vouchers & RewardsConfiguration
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 Vouchers & Rewards group in the Elements tab holds 6 widgets: external-redeem-voucher-widget, my-vouchers, reward-listing, rewards, voucher-details, voucher-list. Vouchers themselves are set up in the Voucher Management tile; these widgets show them and, on the widgets that offer it, let a customer claim or redeem one — which is recorded like any other claim or redemption. 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 Vouchers & Rewards, 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.

external-redeem-voucher-widget

Redeem an external voucher.

  1. In Elements, open Vouchers & Rewards (or search external-redeem-voucher-widget) and drag external-redeem-voucher-widget 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 — Voucher details page (pick a page); Hide face value
    • External redeem voucher uistyle — Tabs height; Color; Button background color
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

my-vouchers

Customer’s own vouchers.

  1. In Elements, open Vouchers & Rewards (or search my-vouchers) and drag my-vouchers 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 — Voucher details page (pick a page); Theme color; Theme background; Title and icon color; Title name; Hide title on mobile; Hide icon on no voucher; No voucher title; No voucher sub title
    • Style — Color; Font; Background
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

reward-listing

Rewards catalogue.

  1. In Elements, open Vouchers & Rewards (or search reward-listing) and drag reward-listing onto the page.
  2. Selected Node shows This widget has no settings to configure. The widget reads nothing from its settings; give the node a recognisable Name if you like.
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

rewards

Customer’s rewards.

  1. In Elements, open Vouchers & Rewards (or search rewards) and drag rewards 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 — Enable claim coupon using code; Theme color; Theme background; Title and icon color
    • Claim coupon uistyle — Color; Font; Background; Text; Border radius; Border
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

voucher-details

Details of one voucher.

  1. In Elements, open Vouchers & Rewards (or search voucher-details) and drag voucher-details 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 — Text color; Hide claim button; Hide terms condition; Hide face value; Confirmation dialog text; Timer dialog title
    • Bar code config — Color; Button background color
    • Redeem button config — Color; Button background color
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

voucher-list

Voucher list.

  1. In Elements, open Vouchers & Rewards (or search voucher-list) and drag voucher-list 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 — Voucher details page (pick a page)
  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.

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

Related documentation

Last updated on