Skip to content

Voucher Management

The earlier build of the voucher applet — vouchers, the tickets under them and the scanned-event log — writing the same coupon records as Voucher Management Applet V2, which is the full reference; this page records only what differs. It is master data: nothing posts, and tickets are redeemed at the till in POS General. The earlier build has no recurring vouchers, no ticket import and no daily limit, and its Default Selection entry leads to a not-found page; install the V2 build if you need those.

Your job, and the screen for it

The jobScreen or tabRead
Create a voucher with its rules and treatmentsVoucher; rules, treatments, images and serials on their own screens rather than tabsScreens and menus
Check tickets and scans — tickets are redeemed at the till in POS General; the Ticket menu has no create routeTicket, Scanned EventScreens and menus; Lifecycle and effects
Link a voucher to a website — not in this buildthe website’s Voucher Management tab in the CP Commerce Admin applet, or the V2 build’s Website Link tabWhere it fits
Use recurring vouchers, ticket import, a daily limit or the Default Selection settings screen — not in this buildinstall the V2 build; set defaults per user under PersonalizationTroubleshooting

Overview

Voucher Management is the earlier build of the voucher applet: vouchers, the tickets (serial numbers) under them, and the scanned-event log — three menus, with the rules, treatments, images and serials each reached through their own route. It writes the same coupon tables and calls the same coupon endpoints as the Voucher Management Applet V2 build, which is where the fields, rules, treatments, ticket statuses, backend behaviour and troubleshooting are documented. This page records only what is different.

Two applets, two builds. Voucher Management (the original) and Voucher Management Applet V2 are both listed, both point their documentation at the V2 page, and each installs its own build. This page describes the original.

Where it fits

As Voucher Management Applet V2 → Where it fits: upstream Doc Item Maintenance (COUPON items) and Membership Admin (member classes and labels for rules); downstream POS General (voucher and coupon settlement) and CP Commerce Admin. This build has no screen that links a voucher to a website: link it from the website’s Voucher Management tab in CP Commerce Admin, or from the V2 build’s Website Link tab.

Screens and menus

Route root: applets/tnt/wavelet/voucher-management-applet/. Sidebar: Voucher (voucher-listing), Ticket (ticket-listing), Scanned Event (ticket-scanned-listing). The shell menu of this build also lists a Scheduler entry that points at the applet’s error-page route and a Job Processor page.

AreaRoutesWhat differs from V2
Vouchervoucher-listing, voucher-create, voucher-editSame voucher header; rules, images, serials and treatments are separate routes rather than tabs
Rulesrule-add / rule-edit, event-rule-add, redemption-rule-add, entity-type-rule-add, and listing / add / edit routes for entity, member, member-class, member-label, branch, delivery-region, company, item, category and regex rulesIndividual Entity and Member rules exist here; V2’s Doc Hdr list has neither
Images, serialsimage-add / image-edit, serial-create / serial-editSeparate screens
Treatmentstreatment-listing, treatment-add, treatment-invoice-level, treatment-item-level, treatment-item-add, treatment-editInvoice-level and item-level treatments as screens (V2: For All and Product sub-tabs)
Ticketticket-listing, ticket-editNo ticket create route
Scanned Eventticket-scanned-listing, ticket-scanned-edit, ticket-scanned-edit-attachmentSame content
Otherjob-processor, error-pageV2 has neither
Settingssettings/field-settings, feature-visibility, permission-set / user / team / role listingsMenu label “Application Settings”
Personalizationpersonal-default-selection, sidebarSame

Not in this build: Recurring Voucher, Import Tickets, Webhook settings, Print, Daily Limit, the PRODUCT voucher type, and the Default Selection settings screen — the settings menu lists a Default Selection entry, but no default-selection route is defined, so the entry leads to the applet’s 404 page.

No captures here: the images taken of this applet were taken on the V2 build and are quarantined (see Voucher Management Applet V2 → Screens and menus).

Configuration

Before you can use it

As Voucher Management Applet V2 → Before you can use it.

Applet settings

Application Settings (settings/field-settings) renders three toggles: ENABLE_MULTIPLE_TICKET and the two voucher-type hides (reward, discount) — the same keys, same effects, as documented on Voucher Management Applet V2 → Applet settings. ENABLE_EDIT_VOUCHER_CODE is not offered here. There is no Default Selection screen, so no DEFAULT_TIMEZONE or tab-order setting; Personalization → Default Selection is per user.

Document behaviour settings

Not applicable — master data.

Feature visibility / permissions

The same coupon API permissions (TNT_LOG_COUPON_*, TNT_API_COUPON_*) as Voucher Management Applet V2 → Feature visibility / permissions. The applet has no client-side permissions.

Fields

Voucher, treatment, rule and ticket fields are those on Voucher Management Applet V2 → Fields, minus Daily Limit and the PRODUCT type. The rule set is wider by two Doc Hdr kinds — Entity and Member — each with its own listing, add and edit route.

Lifecycle and effects

Identical to Voucher Management Applet V2 → Lifecycle and effects: master data, no document type, no journal posting; tickets are four independent status flags; redemption is recorded against the sales document line by the coupon redemption step; expiry is an endpoint, not a scheduled job.

Related applets

Troubleshooting

SymptomCauseFix
Settings → Default Selection opens a 404 pageThe menu entry exists; the route does notUse the V2 build, or set defaults per user under Personalization
Scheduler menu entry opens an error pageThe shell menu points at error-pageSchedule coupon processors from the Scheduler applet
No Recurring Voucher, Import Tickets or Daily LimitNot in this buildInstall the V2 build

Everything else: see Voucher Management Applet V2 → Troubleshooting.

Related documentation

Last updated on