Skip to content

Tracking and After-sales Widgets

This page covers the widgets for shipment and goods tracking, refunds, returns (RMA) and warranty registration and status. 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.

Your job, and the screen for it

The jobScreen or tabRead
Add one of these widgets to a pageDesign Panel › Elements › Tracking & After-salesConfiguration
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 Tracking & After-sales group in the Elements tab holds 9 widgets: goods-tracker, job-shipment-listing, request-refund, rma-application-widget, rma-status-widget, shipment-tracker, warranty-registration-widget, warranty-status-details-widget, warranty-status-widget. 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 Tracking & After-sales, 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.

goods-tracker

Goods tracking.

  1. In Elements, open Tracking & After-sales (or search goods-tracker) and drag goods-tracker 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 — Hide date
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

job-shipment-listing

Job shipment list.

  1. In Elements, open Tracking & After-sales (or search job-shipment-listing) and drag job-shipment-listing 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 — Tracking page (pick a page)
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

request-refund

Request a refund.

  1. In Elements, open Tracking & After-sales (or search request-refund) and drag request-refund 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 — Title; Email to; Reasons (comma-separated)
    • Style — Color; Background
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

rma-application-widget

Apply for a return (RMA).

  1. In Elements, open Tracking & After-sales (or search rma-application-widget) and drag rma-application-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 — Label Header guids; Attachment label
    • Form content style — Color; Background
    • Button style — Color; Background
    • Fields to hide — Address; Country; State; Post code; City; Proof of purchase; Proof of fault
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

rma-status-widget

Return (RMA) status.

  1. In Elements, open Tracking & After-sales (or search rma-status-widget) and drag rma-status-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 — Note (rich text)
    • Style — Color; Background
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

Note is rich text, shown as formatted text on the return status page.

shipment-tracker

Shipment / issue tracker.

  1. In Elements, open Tracking & After-sales (or search shipment-tracker) and drag shipment-tracker 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).

warranty-registration-widget

Register a warranty.

  1. In Elements, open Tracking & After-sales (or search warranty-registration-widget) and drag warranty-registration-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 — Category title
    • Default style — Color; Background
    • Button style — Color; Background
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

warranty-status-details-widget

Details of one warranty.

  1. In Elements, open Tracking & After-sales (or search warranty-status-details-widget) and drag warranty-status-details-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:
    • Default style — Color; Background
    • Button style — Color; Background
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

warranty-status-widget

Warranty status list.

  1. In Elements, open Tracking & After-sales (or search warranty-status-widget) and drag warranty-status-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 — Register warranty page (pick a page); Warranty details page (pick a page); Per row listing; Per row listing md
    • Button style — Color; Background
    • Listing style — Color; Background
    • Widget title style — Color; Background; Show widget title
    • Approval title color — Color
  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 textrma-status-widget › NoteFormatted 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

Related documentation

Last updated on