# Installation
Install the app via **Extensions** > **My Extensions**. After installation, specify a **Sales Channel** to enable the app for. The default is All Sales Channels.
There are two aspects to the Bonus System app:
* Basic Configuration
* Admin Dashboard
Follow the steps in the section Basic Configuration first, then refer to the section Admin Dashboard for details on how to manage the app on an ongoing basis.
### Basic Configuration
Before you enable the app, check the settings in this section and ensure they meet your requirements. Make any changes to individual fields as described below by selecting **My extensions** > **Bonus System for Shopware 6** > **Configuration**.
First specify a **Sales Channel** to enable the app for. The default is All Sales Channels.
### General properties
The general properties provide basic controls, such as enabling/disabling the app and determining the visibility of customer points in key locations.
| **Field** | **Type** | **Description** |
| ---------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Activate Bonus System | Toggle | Enable this setting to activate the Bonus System app on your store. |
| Show points balance in header | Toggle | Enable this setting to show the customer’s point balance in the top right-hand area of the store header, alongside the account and cart balance controls. |
| Show points balance in invoice | Toggle | Enable this setting to show the customer’s point balance in any invoices they receive as a result of in-store purchases. |
| Show point credit for product on detail page | Toggle | Enable this setting to show the number of points customers will be credited for each product purchase, on the product detail page. |
| Show point credit for product on listing page | Toggle | Enable this setting to show the number of points customers will be credited for each product purchase, on the product listing page. |
| Show bonus point hint on guest register | Toggle | If activated a point hint is shown on register if customer activated guest checkbox. |
| Disallow customer group | Dropdown | If you have defined any customer groups, you can specify them as excluded from the points system by selecting them from the dropdown menu. |
| Display value of bonus points in EUR on detail page | Toggle | The bonus points are displayed in the shop currency. This allows the customer to see exactly how much money value the bonus points have. |
| Display value of bonus points in EUR on listing page | Toggle | The bonus points are displayed in the shop currency. This allows the customer to see exactly how much money value the bonus points have. |
| Show shop pages at bonus system menu | Dropdown | You can choose "shopping experience" pages which should be shown after customer login at bonus system menu in account area. All pages of type "shop pages" are usable. |
### Point crediting
The settings in this area are related to how customers are credited points.
| **Field** | **Type** | **Description** |
| --------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Points per euro | Numerical input | Add a value here for the number of points customers are credited per euro spent. *Example: enter 10 to award 10 points per euro spent.* |
| Credit points by conditions | Toggle | If this option is activated customers can only gain bonus products for products that are included by [condition](/en/plugins/bonus-system/admin-dashboard/conditions.md). |
| Exclude shipping costs | Toggle | Enable this setting to exclude shipping costs from earning the customer points. |
| Round points | Dropdown | Select the method of rounding up accumulated fractions of points from the dropdown list, either **round logically, round up** or **round down**. |
| Gain points for admin/ api orders | Toggle | If activated customers will also get points for orders created in admin or orders created over the API. |
| Points for every review | Numerical input | Define a number of points customers gain for creating a product review. This only works for the default Shopware rating system. |
### Newsletter Properties
If a customer registers for the newsletter he can gain points.\
Important: That only works, if the Shopware default newsletter registration is used.
| | | |
| -------------------------------------------- | --------------- | ---------------------------------------------------------------------------------- |
| **Field** | **Type** | **Description** |
| Credit points on a newsletter subscription | Toggle | Enable this property if customers should gain points for a newsletter registration |
| Amount of points for newsletter subscription | Numerical input | Define the number of points a customer should gain for a newsletter registration. |
| Points credit reason | Dropdown | Choose a snippet here that should be shown later for a booking. |
### Point redemption
The settings in this area are related to how customers can redeem points they have been credited.
| **Field** | **Type** | **Description** |
| ----------------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Disable point redemption | Toggle | Enable this setting to prevent customer from redeeming points they have been credited (customers can continue to be credited points while this setting is enabled). |
| Point redemption restriction | Dropdown | Optionally specify a min/max restriction for when customers redeem points, select either **At least X order value** or **Maximum of X EUR** from the dropdown menu. Define the value X in the next setting. |
| EUR value of restriction | Numerical input | Enter a value X for any restrictions set in the previous setting. |
| Conversion Factor (? Points = 1 EUR) | Numerical input |
Enter a numerical value for the number of redeemed points required to reach a value of 1 euro. Example: 20 = 20 points per 1 euro.
|
| Enable bonus products | Toggle | Enable this setting to allow customers to purchase specific bonus products by redeeming accumulated points. |
| Buy with points by default | Toggle | If the "Only buyable with points" option of a bonus product is not active, use the "Add for every X bonus points to the shopping cart" option by default. |
| Hide bonus products menu entry | Toggle | Activation disables a bonus product landingpage. This has only an effect if you've actviated bonus products. |
| Enable bonus product feature for every product | Toggle | If activated every product of shop can be purchased with bonus points. |
| Show available bonus products in cart | Toggle | Shows all available bonus products in cart. |
| Show available bonus products in checkout | Toggle | Shows all available bonus products in checkout. |
| Bonus products list header media | Image selector | Select a header image to show above defined bonus products. |
| Bonus products list header text | Free text | Enter the header text here to be shown above all bonus products. |
| Redeem points automatically on every order | Toggle | If customer has bonus points they were redeemed automatically during checkout. |
| Disable vouchers when point redeem is in basket | Toggle | If points were redeemed other vouchers are disabled automatically. |
| Bonus points item number | Free text |
If required, you can define an article number for bonus points. This will be used when bonus points are redeemed. Here you'll find more information.
|
| Show bonus points item number in cart | Toggle | If bonus points are to have an article number, you can specify whether the article number is to be displayed in the checkout. |
### Deduct points
With the settings of this area you can control how the extension should handle returns.
| | | |
| ----------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------- |
| **Field** | **Type** | **Description** |
| Deduct points on order state: Canceled | Toggle | Removes the previously credited points if the order state is set to cancelled. |
| Deduct points on delivery state: Returned | Toggle | Removes the previously credited points if the delivery state is set to returned. |
| Deduct points on delivery state: Returned (partially) | Toggle | Removes the previously credited points if the delivery state is set to returned (partially). |
### Point expiration
In this area you can define if points can expire and how an expiration should be handled.
| | | |
| -------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
| **Field** | **Type** | **Description** |
| Bonus point expires after days | Numerical input | If the value is greater than 0, the points that have expired (today - input days) will be removed from the customer account |
| Show expire warning after customer login | Toggle | If points expire soon the customer will get a one time warning after login. |
| Enable automatic E-Mail for point expiration | Toggle | If points will expire customer can get an notification e-mail. |
| Customer can unsubscribe from list | Toggle | With this option customer can unsubscribe from the notification e-mail |
| E-Mail number days before points expire | Numerical input | The number of days e-mail notification is send before points expire. |
### Point activation
The settings in this area control the activation and expiry of bonus points.
| **Field** | **Type** | **Description** |
| ------------------------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Order bonus point activation event | Dropdown |
Specify how bonus points are activated by selecting an option from the dropdown menu:
• Always manual: via admin module • Order paid: bonus points are activated automatically after order is paid • Order completed: bonus points are credited as soon as the order status is set to completed • Immediately after ordering: bonus points are credited after submitting the order
|
| Credit bonus points *n* days after ordering | Numerical input | Enter the number of days that must elapse before bonus points are credited. |
| Deduct points on order canceled | Toggle | Activate this option to automatically deduct any credited points associated with a cancelled order. |
| Bonus point expires after days | Numerical input | Set the number of valid days for bonus points, after which they will automatically expire and be deducted from the customer’s point balance. |
### Checkout properties
The settings in this area control how bonus points are credited to customers during the checkout process.
| **Field** | **Type** | **Description** |
| ------------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Show get bonus in basket | Dropdown | Select to show the bonus points the customer will be credited if they complete the checkout process, either **above basket**, **below basket** or **no** to disable this option. |
| Bonus point redeem in checkout | Dropdown | By default, bonus points can only be redeemed in the shopping cart. Optionally specify whether or not bonus points can also be redeemed **above checkout** or **below checkout** (the default is **no**). |
| Show get bonus in checkout | Dropdown | Specify whether or not, and where, to display to the user how many points will be credited with the current order. Choose from **no, above checkout**, or **below checkout.** |
### Layout properties
The settings in this area define the look and feel of the bonus points user interface elements in your shop.
| **Field** | **Type** | **Description** |
| ------------------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------------- |
| Icon color | Color picker | Select a primary color using the color picker or enter a hexadecimal value for the bonus points “P” icon. |
| Icon background color | Color picker | Select a background color using the color picker or enter a hexadecimal value for the bonus points “P” icon. |
| Badge color | Color picker | Select a background color using the color picker or enter a hexadecimal value for the badge icon. |
| Points color | Color picker | Select a background color using the color picker or enter a hexadecimal value for the numerical bonus points value. |
| Slider color | Color picker | Select a background color using the color picker or enter a hexadecimal value for the slider. |
| Icon for points label (50×50 pixels) | Image selector | Select an image (50 x 50 pixels) to use as the points label icon. |
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.premsoft.de/en/plugins/bonus-system/installation.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.