Skip to content

Order and Invoice Widgets

This page covers the widgets for a signed-in customer’s order history, order details, invoices and e-Invoice requests. 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 › Orders & InvoicesConfiguration
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 Orders & Invoices group in the Elements tab holds 9 widgets: e-invoice, my-invoice, my-invoice-detail, my-invoice-item-detail, my-invoice-payment, orders-listing, sales-order-details, sales-order-item-details, seller-order-details. These widgets show the signed-in customer’s own documents, so a page holding them belongs behind sign-in. 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 Orders & Invoices, 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.

e-invoice

e-Invoice request and status.

  1. In Elements, open Orders & Invoices (or search e-invoice) and drag e-invoice 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 by pin; Rejection reasons (comma-separated); Einvoice no display config; Export PDF public access
    • Style — Color; Font; Background
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

my-invoice

Invoice history list.

  1. In Elements, open Orders & Invoices (or search my-invoice) and drag my-invoice onto the page.
  2. In Selected Node, fill in the widget’s form: Which document types the invoice list includes, as tick boxes. Under More settings at the bottom of the form:
    • General — Theme color; Theme background; Title and icon color; My invoice detail page (pick a page); Hide title on mobile
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

my-invoice-detail

Details of one invoice.

  1. In Elements, open Orders & Invoices (or search my-invoice-detail) and drag my-invoice-detail 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 — My invoice item detail page (pick a page); My invoice payment page (pick a page); My invoice request refund page (pick a page); Max no days; Enable refund
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

my-invoice-item-detail

Details of one invoice line.

  1. In Elements, open Orders & Invoices (or search my-invoice-item-detail) and drag my-invoice-item-detail 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).

my-invoice-payment

Pay an outstanding invoice.

  1. In Elements, open Orders & Invoices (or search my-invoice-payment) and drag my-invoice-payment 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 — My invoice page (pick a page); My invoice detail page (pick a page); My invoice item detail page (pick a page)
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

orders-listing

Order history list.

  1. In Elements, open Orders & Invoices (or search orders-listing) and drag orders-listing onto the page.
  2. In Selected Node, fill in the widget’s form: Under Doc Types to Show, which documents the list includes — Sales Order, Cash Bill, Sales Return, Receipt Voucher — and, under Dashboard Cards, Show Total Value. Under More settings at the bottom of the form:
    • General — My order details page (pick a page); Tracking website URL; Show available credit limit; Hide title on mobile; Theme color; Theme background; Title and icon color
    • Styles — Header color; Text color
    • Hidden fields — Total price
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

sales-order-details

Details of one sales order.

  1. In Elements, open Orders & Invoices (or search sales-order-details) and drag sales-order-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 — Icon driver GUID; Enable status icons; My order item details page (pick a page); Printable format GUID
    • Style — Header color; Color; Badge background; Badge color
    • Hidden fields — Order sumamry; Billing address
    • Order received styling options — Text; Color; Background; Border; Confirmation message; Border radius; Sales order status; Sales order cancel status; Hide sales order received button
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

sales-order-item-details

Details of one sales order line.

  1. In Elements, open Orders & Invoices (or search sales-order-item-details) and drag sales-order-item-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:
    • Style — Header color; Color
    • Hidden fields — Item code
  3. Click SAVE NODE, then Preview and Publish (Steps 4 and 5).

seller-order-details

Details of one seller (marketplace) order.

  1. In Elements, open Orders & Invoices (or search seller-order-details) and drag seller-order-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 — Icon driver GUID; Enable status icons; My order item details page (pick a page)
    • Style — Header color; Color; Badge background; Badge 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
Typed IDssales-order-details › Icon driver GUID; sales-order-details › Printable format GUID; seller-order-details › Icon driver GUIDNo picker yet: paste the ID of the record. The form accepts any text, so copy it rather than typing it

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