Introduction
The Affiliate System for Shopware 6 provides a complete customers recruit customers system, allowing your customers to become partner and earn provision for refering other customers.
The Affiliate System allows complete flexibility with regards how many provision can be earned for each order and if it is relative or absolute.
Customer provision balances can be easily viewed and managed via the provided dashboard, accessible from your Shopware Administration area.
Pre-Requisites
The extension can only be installed on a self-managed Shopware environment running at least version 6.5.0.
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 Affiliate System:
- 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 > Affiliate System > Configuration.
First specify a Sales Channel to enable the extension for. The default is All Sales Channels.
General properties
The general properties provide basic controls, such as enabling/disabling the extension.
| Field | Type | Description |
| Activate plugin | Toggle | Enable this setting to activate the Affiliate System on your store. |
Partner registration
The settings in this area are related to configure how customers can register as a partner.
| Field | Type | Description | ||
| New partner needs approval | Toggle | Enable this setting to check a customer before the can start as a partner. | ||
| Partner must write an application | Toggle | Enable this settings to force your customers writing an application. | ||
| Partner can choose his affiliate code | Toggle | Enable this setting and your customer can choose his own affiliate code. Otherwise a random code will be generated. | ||
| Required days customer needed | Numerical input | Define number of days a customer needs to be registered before he can become a partner. | ||
| Required turnover in EUR | Numerical input | Define the number of turnover a customer must have before he can become a partner. | ||
| Allowed customer groups | Multi select | Choose all customer groups for which the partner registration should be possible. If no group is selected the partner system is not acessible. |
Provision collect
The settings in this area are related to how partner can collect provision.
| Field | Type | Description |
| Partner can poach customers from other partner | Toggle | Enable this setting when a customer can be transfered to another partner if they are already assigned to a partner and create a new order by clicking on another affiliate partner link. |
| Lifertime of a partner cookie in days | Numerical input | If a customer clicks on a partner affiliate link a cookie is created. Define the number of days of cookie lifetime. |
| Order provision activation event | Dropdown | Specify how provision is activated activated by selecting an option from the dropdown menu: • Always manual: via admin module • Order paid: provision is activated automatically after order is paid • Order completed: provision is credited as soon as the order status is set to completed • Immediately after ordering: provision is credited after submitting the order • Order shipped: provision is credited after order has shipped status |
| Order provision activation condition | Dropdown | Detemine if condition “Order provision activation event” OR “Credit provision n days after ordering” needs to be meet or if it is a AND combination |
| Credit provision n days after ordering | Numerical input | Enter the number of days that must elapse before bonus points are credited. |
| Deduct provision on order canceled | Toggle | Activate this option to automatically deduct any credited provision associated with a cancelled order. |
Admin Dashboard
After you have completed basic configuration of the Affiliate System, use the Admin Dashboard to monitor your partner, partner groups, orders and payouts.
Access the Admin Dashboard from your Shopware administration site, via Marketing > Affiliate System.
The main dashboard is divided into the following tabs:
- Dashboard (displayed by default when accessing the Admin Dashboard)
- Payout
- Order
- Partner
- Partner group
Please note: If you just have installed the extension then the section “Partner group” is most interesting for you. Because every partner needs to have a partner group (similar logic das for customer and customer group). After installation a default partner group is created but you need to configure it finally.
Dashboard overview
The dashboard overview is displayed by default when you access the Admin Dashboard and provides a useful summary of recent activity metrics, separated into two tables (statistics and top 5 amount credit). Additionally you can see partner applications and edit them directly.
Statistics
The Statistics table summarizes provision data with the following columns:
- Sales channel
- Amount earned
- Amount spent
- Amount not approved
- Credit (all time)
Use the time range dropdown to filter the metrics displayed in the tables by
- Overall (default view)
- Last 30 days
- Last 14 days
- Last 7 days
- Last 24 hours
- Since yesterday
The longer the selected time range, the more data is summarized in the table.
Top 5 amount credit
A partners’s amount is the number of remaining provision they have. Provision can be redeemed against future vouchers, bonus points or as money.
This table displays the five customers with the highest amount balances, via the following columns:
- Customer
- Amount credit
Payout
The Payout tab contains a single table which summarizes all your partner’s payout. The payouts are working automaticly except a money payout. If partner is requesting a money payout you need to approve it. By clicking the three dots you can open the approve dialog. At this dialog you can the the bank data of your partner. Then you can use your bank software, so send them the money manually. After it’s finished you can approve the payout request. Optionally you can upload a payout PDF and send it to your partner.
The table contains the following columns:
- Customer number
- Customer name
- Type
- Amount
- Approved
- Paid date
Click the refresh button on the right to retrieve the latest data.
Order
At the Order tab you can find all affiliate order from your partner.
The table contains the following columns:
- Order number
- Partner
- Order value
- Provision
- Order status
- Approved
| Click the stacked icon on the right-hand side of the table header to enable/disable columns and switch between compact and extended view. |
Manually activate provision
By default, when a customer makes a order, the provision of your partner must first be activated before they are available to them. Until activation, the partner cannot use the provision.
You can automate this activation process in the provision collect settings. If you enable automatic activation of points, they are available to the customer immediately upon a specific event, after which the customer can redeem them against purchases.
To manually activate provision associated with a order, click on the three dots at the order and select “Approved”.
Partner
The Partner tab contains a single table displaying a list of all of your shop partner, regardless of whether or not they have a provision balance. For partner that do have a provision balance, this is also shown within the table.
The displayed columns are:
- Customer number
- Name
- Number orders
- Turnover
- Provision
- Status
Edit partner
To edit any partner in the list, click the … icon and select View.
A summary of the partners’s details is displayed, including current provision, contact details, account status, customer group and partner group. Additionally you have a Order and Payout tab. There is the same functionality as described above but you will see only orders and payouts of the selected partner.
Partner group
The Partner group tab contains a single table displaying a list of all groups in your system.
The displayed columns are:
- Name
- Provision type
- Provision factor
- Number partner
- Is default
Create/ Edit partner group
To create a partner group click the button “Add group” in the head area of the administration. To edit a partner group click the three dots in partner group list and select “Edit”
| Field | Type | Description |
| Name | Free text | Enter a meaningful name for the partner group, e.g. “Premium partner”. |
| Campaign code | Free text | You can enter a campaign code to make all orders of this partner group filterable. |
| Provision type | Dropdown | Choose wheter a provision for a order is relative or absolute. |
| Provision factor | Numerical input | Define the provision factor. If you selected a relative “provision type”, then enter a percentual value like 5 to enable partner to get 5% provision of a order. If you configured a absolute “provision type” then configure a provision like “5.91” to enable partner to get 5,91 EUR for a order. |
| Need approval | Toggle | If disabled a provision for a new order is provisioned directly. |
| Provision only for number order | Numeric input | Enter a value different from 0 to give a partner provision only for the first n-orders. A value of 0 means no limitation. |
| Extended provision | List/ Overlay | Define in detail which products gain what kind of provision and if it is only for one order or for following orders too. |
| Show advisor info – On register page | Toggle | Enable this toggle to show you customers at register page an info box with partner information like: Name and contact data. In Admin you can change snippet text by navigating to “Settings -> Shop -> Snippets” and searching for snippet “prems-affiliate.partner-infos-for-customer.register-page”. |
| Show advisor info – On account page | Toggle | Enable this toggle to show you customers at account page an info box with partner information like: Name and contact data. In Admin you can change snippet text by navigating to “Settings -> Shop -> Snippets” and searching for snippet “prems-affiliate.partner-infos-for-customer.account-home-page”. |
| Show advisor info – On chckout confirm page | Toggle | Enable this toggle to show you customers at checkout confirm page an info box with partner information like: Name and contact data. In Admin you can change snippet text by navigating to “Settings -> Shop -> Snippets” and searching for snippet “prems-affiliate.partner-infos-for-customer.confirm-page”. |
| Partner voucher – Enable voucher | Toggle | Additionally to the affiliate link a partner can also get a voucher code to promote new customers. If a customer uses such a voucher code then he is automaticly assigned to the partner. Alternativ zum Affiliate Link können Ihre Partner auch einen Gutschein Code erhalten, mit dem sie neue Kunden werben. Nutzt ein Kunde diesen Gutschein Code, so wird er automatisch dem Partner zugewiesen. |
| Partner voucher – Voucher type | Dropdown | Choose whether the voucher should be relative or absolute. |
| Partner voucher – Voucher amount | Numerical input | Define the value of the voucher. |
| Partner voucher – Name | Free text | Define a name for the voucher. The placeholder ###partnerCode### is necessary. |
| Partner voucher – Code | Free text | Define a voucher code. The placeholder ###partnerCode### is necessary. |
| Partner voucher – Max. total uses | Numerical input | Define how many users this voucher could have. |
| Partner voucher – Max. uses per customer | Numerical input | Choose the number of uses of the voucher for a customer. |
| Partner voucher – Prevent combination with other promotions | Toggle | Configure if other promotions are allowed when this voucher is used. |
| Redeem as voucher allowed | Toggle | Enable this setting to allow partner to get a voucher for provision. |
| Redeem as money allowed | Toggle | Enable this setting to allow partner to get money for provision. |
| Redeem as bonus points allowed | Toggle | Enable this setting to allow partner to get bonus points for provision. |
| Vouchers | Table | This area is only visible if “Redeem as voucher allowed” is activated. You can assign voucher from the “Marketing -> Promotion” area here and add a provision amount for which the partner can buy that voucher. Please choose only promotions with “Promotion codes – Code options” configured as “Individual promotion codes”. Please create no promotion code in that campaign manually. The promotion has to be status “active”, assigned to a suitable “Sales channel” and need to have a discount assigned to it. |
| Payout Scale – Min amount | Numerical input | This field is only visible if “Redeem as money allowed” is activated. Define the min provision a partner must have before a payout is possible. |
| Bonus points – Points per EUR | Numerical input | This field is only visible if “Redeem as bonus points allowed” is activated. Define the number of points here a partner would get for 1 EUR Provision. |
| Bonus points – Rounding | Numerical input | This field is only visible if “Redeem as bonus points allowed” is activated. Define the type of rouding provision to bonus points. |
Extended provision
| Field | Type | Description |
| Name | Free text | Enter a meaningful name for the extended provision, e.g. “One time provision”. |
| Product Group | Dropdown | Choose which products of a product group are effected by this provision setting. |
| Provision type | Dropdown | Choose wheter a provision for a order is relative or absolute. |
| Provision factor | Numerical input | Define the provision factor. If you selected a relative “provision type”, then enter a percentual value like 5 to enable partner to get 5% provision of a order. If you configured a absolute “provision type” then configure a provision like “5.91” to enable partner to get 5,91 EUR for a order. |
| Provision only for number order | Numeric input | Enter a value different from 0 to give a partner provision only for the first n-orders. A value of 0 means no limitation. |
Delete a partner group
To delete a partner group click the three dots in partner group list and select “Delete”.
Please note: The extension needs one default partner group towork properly. It is not possible to delete the group with the “Is default” flag.
If any partner group is deleted and partner are assigned to this group they will automaticly get the default partner group.
Marketing page
Optionally you can create a page with marketing material for every partner group. This page is created as a shopping world page and shown in Shopware account area of the partner.
