The vouchers/ endpoint provides you with an interface for managing vouchers in our shop system. With this interface, you can create vouchers, delete them, create templates, and view existing vouchers.
This section describes all endpoints for managing individual vouchers. Through the interface, vouchers can be created, updated, deleted, and retrieved. The management of voucher charges is handled separately in its own section.For all operations, corresponding read, write, create, or delete permissions are required.
This method returns a paginated list of all vouchers present in the system.Filter and sort parameters can be used to specifically restrict and order the results. The returned voucher data includes information on activity, validity, redemption conditions, and value specifications.Read permissions are required for access.
This method updates the properties of an existing voucher by its unique ID. Through the request body, various fields such as activation status, validity periods, values, or redemption conditions can be changed. On successful update, a confirmation is returned.Write permissions for voucher data are required.
This method is not yet implemented and is planned for a future version.
This method creates one or more new vouchers. The vouchers can either be assigned to a new charge or appended to an existing charge. For a new charge to be created, the chargeId field in the request body must be empty.A maximum of 10,000 vouchers can be created per request. On successful creation, the associated charge ID as well as the number of created vouchers are returned.Create permissions for voucher data are required.
Not authorized: you are not logged in or do not have the required permissions to create voucher data.
400 Bad Request
Request body could not be loaded.
400 Bad Request
”invalidFormat”
count is not a number. data is not an object.
400 Bad Request
”missing”
data is missing. appendToCharge is true, and chargeId is missing.
400 Bad Request
”invalidValue”
count ∉ [1;10000]
400 Bad Request
”invalidCombination”
count ≠ 1 and voucherId is not empty. When creating multiple vouchers, the ID is generated automatically and cannot be set manually. newCustomersOnly and existingCustomersOnly are set.
400 Bad Request
”duplicateEntry”
voucherId or chargeId already exist.
400 Bad Request
”unknownDataField”
An unknown field was provided in the request body.
This method deletes an existing voucher by its unique ID.On successful deletion, the ID of the removed voucher is returned as confirmation.Delete permissions for voucher data are required for execution.
This method allows you to create or update multiple vouchers in a single request (bulk import). The request body must contain a JSON array in which each element is an object with a data field that contains the voucher data.A maximum of 10,000 entries can be provided per request. Invalid entries are skipped and listed under skippedLines in the response.If a voucher with the same ID already exists, it is checked whether the data is compatible. With the query parameter ?force, an update can be forced.Create permissions for voucher data are required.
This method allows you to delete multiple vouchers in a single request. The request body must contain a JSON array in which each element is an object with the id of the voucher to be deleted.A maximum of 10,000 entries can be provided per request. Invalid entries are skipped and listed under skippedItems in the response.Delete permissions for voucher data are required.
This section describes all endpoints for managing voucher charges. A voucher charge is a group of vouchers that can be created and managed together.Through the interface, charges can be listed, filtered, created, updated, exported, and deleted. In addition, creator information and labels of existing charges can be retrieved.For all operations, corresponding read, write, create, or delete permissions are required.
This method returns a paginated list of all voucher charges present in the system.Filter and sort parameters can be used to restrict and order the list by various criteria. The returned data contains information about the charge itself as well as the associated voucher settings.Read permissions are required for access.
This method returns a list of user accounts with IDs and emails that have created voucher charges. For manually created charges, the name corresponds to the email address of the user account; for imported charges, “Import” is displayed instead.Read permissions are required for access.
This method returns a list of all labels assigned to voucher charges. Labels are used for categorizing charges and are considered in the full-text search.Access to this information requires read permissions for voucher data.
This method updates the properties of an existing voucher charge by its unique ID. Through the request body, fields such as name, description, or additional labels can be changed. On successful update, a confirmation is returned.Write permissions for voucher data are required.
This method is not yet implemented and is planned for a future version.
This method deletes an existing voucher charge together with all vouchers it contains by the specified charge ID. On successful deletion, the ID of the removed charge is returned as confirmation.Delete permissions for voucher data are required for execution.
This section describes all endpoints for managing voucher blueprints (templates). Voucher blueprints define predefined configurations such as discount types, validity periods, values, and other conditions for vouchers. Through the interface, blueprints can be created, updated, retrieved, deleted, and organized with labels.Note: The templateId field internally corresponds to the name column in the database. Despite this assignment, however, within the API you may not sort or filter by name, nor query or set the value explicitly. All operations are performed exclusively via templateId.For all operations, corresponding read, write, create, or delete permissions are required.
This method returns a paginated list of all existing voucher blueprints (templates). Filter and sort parameters can be used to restrict and order the list. The blueprints define default values for vouchers or voucher charges that can later be created based on these blueprints.Read permissions are required for access.
This method returns a list of all labels assigned to voucher blueprints (templates). Labels are used for categorizing blueprints and are considered in the full-text search.Read permissions are required for access.
This method updates the properties of an existing voucher blueprint (template) by its unique ID, where the ID corresponds to the name of the blueprint.Through the request body, fields such as name, status, values, types, or labels can be adjusted. On successful update, the templateId of the edited blueprint is returned.Write permissions for voucher data are required.
This method creates a new voucher blueprint (template) based on the submitted configuration data.The request body must contain a unique templateId and a data object with the relevant voucher settings. On successful creation, the ID of the new blueprint is returned.Create permissions for voucher data are required.
This method deletes an existing voucher blueprint (template) by its unique ID, where the ID corresponds to the name of the blueprint. On successful deletion, the templateId of the removed blueprint is returned as confirmation.Delete permissions for voucher data are required for execution.
This section describes all endpoints for managing voucher presets.In contrast to voucher blueprints, which can be flexibly created and adapted by users, voucher presets are standardized structures that define specific types or properties of vouchers. Presets serve as a basis for creating new vouchers according to fixed specifications and are often more tightly coupled to the system.Through the interface, these presets can be retrieved and adjusted as needed. For all operations, corresponding read and write permissions are required.Note: The presetId field internally corresponds to the name column in the database. Despite this assignment, however, within the API you may not sort or filter by name, nor query or set the value directly. All operations are performed exclusively via presetId.
This method returns a paginated list of all existing voucher presets.Filter and sort parameters can be used to restrict and order the list by properties such as system status or creation date.The presets contain predefined settings for creating new vouchers.Read permissions are required for access.
This method returns a list of all labels assigned to voucher presets. Labels are used for categorizing presets and are considered in the full-text search.Read permissions are required for access to this information.
This method updates the properties of an existing voucher preset by its unique ID, where the ID corresponds to the name of the preset.Through the request body, the new settings of the preset are provided, including discount types, values, terms of use, and further attributes. On successful update, the ID of the changed preset is returned.Write permissions for voucher data are required.
This method creates a new voucher preset based on the submitted configuration data.The request body must contain a unique presetId and a data object with the relevant voucher settings. On successful creation, the ID of the new preset is returned.Create permissions for voucher data are required.
This method deletes an existing voucher preset by its unique ID, where the ID corresponds to the name of the preset. On successful deletion, the ID of the removed preset is returned as confirmation.Delete permissions for voucher data are required for execution.
Bei technischen Fragen und Hilfestellungen ist unser Support-Team für Sie erreichbar: Zum KundenportalBitte senden Sie uns eine möglichst detaillierte Beschreibung sowie Screenshots, Requests/Antworten, damit wir Ihre Anfrage zeitnah und zielführend beantworten können.
