# Installation
Install the extension 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 can change partner code | Dropdown |
Specify whether a partner is allowed to change his own partner code by selecting an option from the dropdown menu:
• No: the partner code can only be changed by an admin • Yes, code is changed immediately: the new code is applied without further checks
• Yes, code needs to be approved by admin: the requested code change has to be approved by an admin before it becomes active.
|
### 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 needs to confirm terms
Toggle
Enable this setting to require a new partner to accept the partner terms during registration. You need to edit the snippet partner-terms in Admin → Snippets and insert a link to your terms.
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. |
### Provision deduct
| Field | Type | Decriptio |
| -------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Deduct provision on delivery state: Returned | Toggle | Activate this option to automatically remove a previously credited provision as soon as the delivery state of the related order is set to Returned. |
| Deduct provision on delivery state: Returned (partially) | Toggle | Activate this option to automatically remove a previously credited provision as soon as the delivery state of the related order is set to *Returned (partially)*. |
### Provision redeem
| Field | Type | Description |
| ------------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Individual voucher code pattern | Text | Define the pattern that is used to generate individual voucher codes when a partner redeems his provision. Each %s is replaced by a random character. The default value %s%s%s%s%s produces a five-character code. |
### Technical properties
| Field | Type | Description |
| ------------------------------------------------------------ | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Affiliate link parameter | Text (required) | Specify the URL parameter used inside affiliate links. By default the parameter is partner, so a link looks like . Please do not change this value if you already have active partners — otherwise existing affiliate links will no longer be valid. |
| Set affiliate cookie as technical required on cookie consent | Toggle | Enable this setting to register the affiliate cookie as a technically required cookie at the cookie consent. If disabled, the affiliate cookie is treated as an optional cookie — visitors who do not accept it will not be assigned to a partner. |
---
# 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/affiliate-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.
