To the home page
Contact

Bonus System

Installation

Install the plugin via Extensions → My extensions and activate it. Two steps follow:

  1. the configuration — all settings on this page, stored per sales channel,
  2. the Admin Dashboard — day-to-day operation.

If you only want to get started quickly, the Quickstart covers the essential fields.

Open the configuration via My extensions → Bonus system for Shopware 6 → Configuration. Pick the sales channel the settings should apply to at the top. All sales channels defines the defaults; individual channels can differ.

Without Activate Bonus System for the respective sales channel the plugin renders nothing in the storefront.

General Properties

Field Type Description
Activate Bonus System Toggle Activates the bonus system for the selected sales channel.
Show points balance in header Toggle Shows the point balance next to the account icon after login. If it is off, balance and link appear in the account menu.
Show points balance in invoice Toggle Prints redeemed and earned bonus points on the invoice document. Default: off.
Show point credit for product on detail page Toggle Shows on the product detail page how many points the purchase earns. Default: on.
Show point credit for product on listing page Toggle Same for product listings and sliders. Default: on.
Show value of bonus points in EUR on detail page Toggle Additionally shows the monetary value of the points in shop currency. Default: off.
Show value of bonus points in EUR on listing page Toggle Same for product listings. Default: off.
Show bonus point hint on guest register Toggle Tells customers who pick “guest” that a customer account would earn points. Default: off.
Show shop pages at bonus system menu Multi select Shopping experience pages of type shop page to show in the bonus system menu of the customer account. See Create more nav items.
Disallow customer group Multi select Customer groups for which the bonus system is disabled.

Point crediting

Field Type Description
Points per euro Number Points per 1 EUR of order value, up to five decimal places. Example: 1 gives 10 points on a 10 EUR order, 0.5 gives 5 points.
Credit points by conditions Toggle Points are only credited for products released through a condition of type Include products for bonus points. Default: off.
Exclude shipping costs Toggle Shipping costs are not taken into account when calculating points.
Round points Select Round up (default), Round logically or Round down for fractional points.
Gain points for admin/api orders Toggle Orders created in the administration or through the API also earn points.
Points for every review Number Points for an approved product review. Default: 100. Works only with the Shopware review system.

Newsletter Properties

Customers can be credited points for a newsletter sign-up. This only works with the Shopware default newsletter registration.

Field Type Description
Credit points on a newsletter subscription Toggle Enables the credit on newsletter sign-up. Default: off.
Amount of points for newsletter subscription Number Number of points for the sign-up.
Points credit reason Snippet Snippet whose text is used as the booking reason (default: Newsletter subscription).

Point redemption

Field Type Description
Disable point redemption Toggle Customers keep collecting points but cannot redeem them as a voucher.
Point redemption restriction Select At least X EUR order value or Maximum of X EUR voucher value. Value X follows in the next field.
EUR value of restriction Number Value X for the restriction above.
EUR min. cart value for Bonus Product Number Minimum cart value required to order a bonus product.
Min. points required for redeem Number Below this balance no redemption is possible; the storefront shows a hint. Default: 0 (no limit).
Conversion Factor (? Points = 1 EUR) Number Points per 1 EUR of discount. Example: 20 means 20 points for 1 EUR. Default: 0 — redemption is then impossible.
Exclude redeem points for shipping Toggle Shipping costs cannot be paid with points.
Redeem points automatically on every order Toggle The available balance is redeemed without the customer doing anything. Default: off.
Disable vouchers when point redeem is in basket Toggle Other vouchers are removed as soon as points are redeemed. Default: off.
Hide voucher error messages in cart Toggle Suppresses the messages about vouchers removed by the option above. Default: off.
Bonus points item number Text Item number for the points line item in the cart, e.g. for your ERP. Details under Product number for bonus points.
Show bonus points item number in cart Toggle Displays that item number in cart and checkout. Default: off.
Points redemption type Select Storefront control: Slider (default), Number field + Button or Button — the button redeems the possible maximum right away.

Bonus products

Bonus products are rewards: existing products of your catalogue that can be ordered with points. You create them in the admin module under Bonus products.

Field Type Description
Enable bonus products Toggle Switches the reward feature on. Without it, bonus products stay invisible in the storefront.
Buy with points by default Toggle If “Only buyable with points” is off for a bonus product, the option “Add for every X bonus points to the cart” is preselected. Default: off.
Hide bonus products menu entry Toggle Disables the landing page /bonus-products and its menu entry.
Enable bonus product feature for every product Toggle Every product of the shop can be bought with points — no need to create individual bonus products.
Show available bonus products in cart Toggle Shows a slider with available rewards in the cart. Default: off.
Show available bonus products in checkout Toggle Same for the checkout. Default: off.
Number of bonus products in slider Number Maximum number of rewards in the slider. Default: 24.
Slider controls position Select None, Inside or Outside (default) for the slider arrows.
Bonus products list header media Image Header image on the rewards listing page.
Bonus products list header text Text Header text on the rewards listing page.

Point activation

This section defines when collected points become usable for the customer.

Field Type Description
Order bonus point activation event Select Always manual (release in the admin module), Order paid, Order completed, Immediately after ordering or Order shipped.
Order bonus point activation condition Select Relation between the event above and the release after n days: OR (default, one condition is enough) or AND (both must match).
Credit bonus points n days after ordering Number Scheduled release after n days — empty or 0 means no scheduled release. The release happens on the customer's next login or through the scheduled task. Points that are already activated stay untouched.

Deduct points

Field Type Description
Deduct points on order state: Canceled Toggle Removes credited points when the order is cancelled.
Deduct points on delivery state: Returned Toggle Removes credited points when the delivery state is set to returned.
Deduct points on delivery state: Returned (partially) Toggle Removes credited points when the delivery state is set to returned (partially).

Point expiration

Field Type Description
Bonus point expires after days Number If greater than 0, expired points (today minus n days) are removed from the account. Default: 0.
Show expire warning after customer login Toggle One-time hint after login. Default: on.
Enable automatic E-Mail for point expiration Toggle Sends the mail template Bonus points expiration notification. Default: off.
Customer can unsubscribe from list Toggle Customers manage the subscription themselves in their points account. Default: off.
E-Mail number days before points expire Number Lead time of the notification. Default: 7.

Checkout Properties

Field Type Description
Show get bonus in basket Select No, Above basket or Below basket — shows how many points the order will earn.
Bonus point redeem in checkout Select Points can normally only be redeemed in the cart; here you can additionally allow Above or Below checkout.
Show get bonus in checkout Select No, Above checkout or Below checkout.

Layout Properties

Field Type Description
Icon color Colorpicker Colour of the “P” icon. Default: #ffffff.
Icon background color Colorpicker Background of the “P” icon. Default: #f1c40f.
Badge color Colorpicker Background of the points badge. Default: #fbf5db.
Points color Colorpicker Text colour of the point value. Default: #ae8e0a.
Slider color Colorpicker Colour of the redemption slider. Default: #f1c40f.
Icon for points label (50x50 pixels) Image Replaces the letter “P” with your own icon.

Technical Properties

You only need these options in special cases.

Field Type Description
Calculate points for customLineItemType Toggle Only needed if third-party extensions such as configurators create their own line items and no points are calculated for them. Leave it off under normal circumstances.
Whitelist: Custom line item types Text Additional third-party line item types that should earn points — separate multiple types with a comma, e.g. line-item-type-1,line-item-type-2.
Enable logging Toggle Writes bonus system log files to the var/log folder. Only enable it for troubleshooting. Default: off.

Bonus points per product (custom field)

During installation the custom field set Bonus System is created with the product field Bonus points on order product. If you enter a value greater than 0 for a product, the customer receives those points per purchased quantity — in addition to the calculation via the conversion factor. You find the field in the product detail view under Custom fields.

If a factor should apply to product groups, categories, customer groups or periods instead, use the Conditions.

What next

Cookie settings