Vouchers - WEBSALE Dokumentation

Vouchers are created and managed in the Admin Interface under the service . This page describes how a voucher is created, which settings are available and how purchase vouchers differ from promotional vouchers. The page Practical examples - Vouchers describes, among other things, how vouchers can be integrated into the template. How a product becomes a sellable voucher is described under Creating a purchase voucher product.

Accessing the service

You reach the service via the following URL:

https://www.<ihr-shop>.de/admin/vouchers

Voucher and voucher charge

A voucher is the code that a customer can redeem in the shop. A voucher charge governs everything around the voucher, for example value, currency, validity period and redemption conditions. Each voucher belongs to exactly one charge and inherits its settings.

When you create a voucher, a charge is therefore always created and, depending on the procedure, the vouchers within it.

The charge is addressed via its ID. This ID is the only value with which other places in the system refer to a charge, for example a purchase voucher product.

The charge ID is not the name of the charge. If no ID is entered when creating the charge, the system assigns a sequential number such as “122”.

The areas of the voucher administration

The service is divided into three tabs with the following contents:

Tab	Content	Purpose
Vouchers	All voucher charges with name, charge ID, quantity, voucher value and label	Overview of the existing voucher charges
Purchase voucher template	Templates from which vouchers are created when a purchase voucher product is bought	Sellable vouchers, see Creating a purchase voucher template.
Voucher templates	Reusable presets for the input form	Set up recurring campaigns faster

Vouchers Three Ways — Screenshot as of 01.09.2026

In the list of charges, the “Quantity” column is the quickest distinguishing feature. If it shows a number greater than zero, the charge contains ready-made voucher codes. If it shows 0, the charge belongs to a purchase voucher template whose codes are only created with an order.

Voucher types

When creating a voucher, “Voucher type” distinguishes between two types. The selection you make determines which items the voucher applies to.

Type	Effect
Promotional voucher	Only applies to products for which the field “Eligible for value vouchers” is set. This lets you exclude product groups from discount campaigns.
Purchase voucher	Acts as a means of payment on all items and overrides this restriction. This setting applies to sold vouchers and gift vouchers.

Creating a voucher charge

”+ New voucher” opens a form with several sections. It is filled in from top to bottom; the sections are also accessible as tabs.

Template

First, a voucher template is selected or the option “Without template” is chosen. The remaining sections are only displayed after this selection. A selected template prefills the corresponding fields and locks the others.

General settings

Voucher Create New Voucher — Screenshot as of 01.09.2026

Field	Meaning
Active	Controls whether the vouchers of the charge can be redeemed.
Name	Mandatory field. Name of the charge. Spaces are not allowed, otherwise the field is marked as invalid.
Charge ID	Freely assignable ID of the charge. If the field is left empty, the system assigns a sequential number. An ID that is already in use is rejected.
Set voucher code manually	Allows you to enter your own code. Only useful if exactly one voucher is generated.
Voucher code	The manually assigned code. Without the switch above it, the system generates the codes itself.
Quantity	Number of voucher codes to generate. Irrelevant for purchase voucher templates, see Creating a purchase voucher template.
Set maximum number of redemptions	Limits how often a voucher can be redeemed in total.
Voucher redeemable by different customers	Allows redemption by multiple customers.
Set maximum number of redemptions per customer	Limits the redemptions per customer.
Voucher type	Mandatory field. Promotional voucher or purchase voucher, see Voucher types.
Labels	Keywords for the charge. Labels control which vouchers can be combined with one another in an order. Without input, the shop sets the label itself.

Voucher value

The calculation type determines whether the voucher deducts an absolute amount, grants a percentage discount or grants a percentage discount up to a maximum amount. Below that, there is one row per currency with currency, VAT ID, voucher value and minimum order value. Further rows can be added via “Add another currency”. A voucher only applies in currencies for which a row exists. This section contains two further settings:

Remaining amount: With “Remaining amount reusable”, an unused amount is retained and can be redeemed again later. With “Remaining amount expires”, the voucher is used up after the first redemption.
Free shipping: Sets the shipping costs to zero upon redemption.

Further sections

Section	Content
Subshops	In which subshops the vouchers are valid.
Validity period	Start from generation or from a date, end open or on a date.
Target group	Restriction to new customers, existing customers or individual customers.
Automatically add products to the basket	Products that are added automatically upon redemption.
Redemption conditions - categories and products	Restriction of validity to specific categories or products.

Saving

The “Generate voucher” button is a split button. The arrow next to it opens three further options. The selection determines what is actually generated:

Action	Result
Generate voucher	Generates the configured number of ready-made voucher codes in a new charge.
Generate voucher and close	Same as above, then closes the form.
Generate voucher and save as template	Same as above, additionally saves the entries as a voucher template.
Save voucher as purchase voucher template	Does not generate any codes, but creates a purchase voucher template along with its charge.

Creating a purchase voucher template

A purchase voucher template is the basis for vouchers that are sold in the shop. It does not contain any codes itself. These are only created when a customer orders a purchase voucher product, one per ordered unit. The template is created in the same form as an ordinary charge:

Assign name and charge ID

The name becomes the purchase voucher template ID. The charge ID should be assigned manually and meaningfully, for example geschenkgutschein, because exactly this value is later entered at the product. If the field is left empty, the generated number has to be looked up in the list afterwards.

Set the voucher type to purchase voucher

Sold vouchers are a means of payment and should work regardless of whether individual products are approved for value vouchers.

Voucher value absolute, but without an amount

The calculation type is set to “absolute”, the voucher value remains at 0. The actual value is set by the price of the sold product. The charge should only carry one currency. For the remaining amount, “Remaining amount reusable” is the right choice, otherwise the rest of the purchased credit expires after a partial redemption.

Save via the arrow menu

In the menu next to “Generate voucher”, select the entry “Save voucher as purchase voucher template”. The main button would instead create ready-made voucher codes, which a purchase voucher product cannot use.

After saving, the entry is available in the Purchase voucher template tab with template ID and charge ID. The same charge additionally appears in the Vouchers tab with the quantity 0.

Purchase Voucher Template Created — Screenshot as of 01.09.2026

The next step in creating a purchase voucher is the product page → Creating a purchase voucher product.

Voucher templates

A voucher template saves the entries of the form so that recurring campaigns do not have to be filled in from scratch every time. It is created via the entry “Generate voucher and save as template” and is then available for selection in the “Template” section at the top. Templates only take effect when creating a voucher. A changed or deleted template has no influence on charges and vouchers that have already been generated.

Display in the shop

How vouchers appear in the shop is determined by the template. There are no settings for this in the Admin Interface.

The input field for the voucher code, the list of redeemed vouchers and the error texts are output in the template. Examples are given in the practical examples for vouchers.
Which data is available for this is described by the module $wsVoucher.
Sold vouchers do not appear via this module, but at the basket item, see Creating a purchase voucher product.

Concepts and technical names

Concept	Admin Interface	Interface
Group of vouchers	Voucher charge	`vouchers/charges`
Individual code	Voucher	`vouchers`
Template for sold vouchers	Purchase voucher template	`vouchers/templates`
Preset for the input form	Voucher template	`vouchers/presets`
Reference to a charge	Charge ID	`chargeId`

Guide

Creating a purchase voucher product describes the second part of the process.
API reference vouchers describes the same objects via the interface.
Practical examples - Vouchers shows how vouchers are redeemed in the shop template.
checkout - Order flow describes the settings for redemption during the order flow.

​Accessing the service

​Voucher and voucher charge

​The areas of the voucher administration

​Voucher types

​Creating a voucher charge

​Template

​General settings

​Voucher value

​Further sections

​Saving

​Creating a purchase voucher template

​Voucher templates

​Display in the shop

​Concepts and technical names

​Guide

Accessing the service

Voucher and voucher charge

The areas of the voucher administration

Voucher types

Creating a voucher charge

Template

General settings

Voucher value

Further sections

Saving

Creating a purchase voucher template

Voucher templates

Display in the shop

Concepts and technical names

Guide