Every setting of the partner program plugin

The Affiliate & Partner Program plugin for Shopware 6 comes with 93 settings, grouped into 24 sections. This page describes each one with its purpose, its default value and the options available.

You find the settings in the administration under Extensions → My extensions → Affiliate & Partner Program → Configuration. Every setting applies per sales channel.

All settings at a glance

Setting Section Type Default value
Activate plugin Default settings Switch on
Allow manual entry of the partner code during the ordering process Default settings Switch off
Assigned customers may be poached from other partners Default settings Switch off
Partners receive commission for their own orders Default settings Switch on
Partners are allowed to change their partner code Default settings Choice Yes, new code must be checked manually
Partners are allowed to change their voucher code Default settings Choice Yes, new code must be checked manually
Behaviour Requirements Choice Partners are activated directly
Minimum turnover (in EUR) Requirements Text field 0
Enable mandatory checkbox Requirements Switch off
Partners are automatically registered Requirements Switch off
Affiliate Code Muster Affiliate settings Text field partner-{{ customer.firstName }}-{{ customer.lastName }}
Type of provision Affiliate settings Choice Percental
Commission (absolute or percental) Affiliate settings Text field 5
Activate individual commission for subsequent orders Affiliate settings Switch off
Commission for subsequent orders (absolute or percental) Affiliate settings Text field 2
Activate starting credit Starting credit Switch off
Credit Starting credit Text field 5
Activate partner links Partner link Switch on
Show partner link on product detail page Partner link Switch off
URL parameters for partner code Partner link Text field partner
Activate advertising voucher Partner voucher Switch on
Automatically add advertising voucher Partner voucher Switch off
Rebate of promotion Partner voucher Choice Percental
Discount (in percent or EUR) Partner voucher Text field 10
Name Partner voucher Text field 10% Partner Gutschein - {{ affiliate.code }}
Code Muster Partner voucher Text field {{ affiliate.code }}-%s%d%s%d%s%d%s%d
Usages total Partner voucher Text field 999
Usages per customer Partner voucher Text field 999
Not combinable with other promotions Partner voucher Switch on
Discount - Scope Partner voucher Choice Cart
Discount - Apply to selected products only Partner voucher Switch off
Age (in days) Commissionable orders Text field 14
Commission subsequent orders Commissionable orders Switch on
Automatically settle canceled orders Cancelled orders Switch on
Public notice of the booking Cancelled orders Text field Stornierte Bestellung #{{ order.orderNumber }} vom {{ order.createdAt|date('d.m.Y') }}
Activate individual commission for products Individual commission Switch off
Priority for category commissions Individual commission Choice Highest commission
Priority for product stream commissions Individual commission Choice Highest commission
Priority for multiple commission rates Commission priority Choice Highest priority
Type of remuneration Compensation Choice Promotion
Type of convertion Compensation - by promotion Choice Convert in staggered amounts
Minimum amount (in EUR) Compensation - by promotion Text field 0
Name Compensation - by promotion - individual amount Text field Provision Partner - {{ affiliate.code }} - %s%d%s%d%s%d%s%d
Code Muster Compensation - by promotion - individual amount Text field %s%s%d%d%s%s%d%d%s%s%d%d%s%s%d%d
Not combinable with other promotions Compensation - by promotion - individual amount Switch on
Discount - Scope Compensation - by promotion - individual amount Choice Cart
Discount - Apply to selected products only Compensation - by promotion - individual amount Switch off
Type of remuneration Compensation - by payout Choice Payment in staggered amounts
Minimum amount (in EUR) Compensation - by payout Text field 0
Payout (in EUR) I Compensation - by payout - staggered amounts Text field 10
Payout (in EUR) II Compensation - by payout - staggered amounts Text field 25
Payout (in EUR) III Compensation - by payout - staggered amounts Text field 50
Payout (in EUR) IV Compensation - by payout - staggered amounts Text field 100
Payout (in EUR) V Compensation - by payout - staggered amounts Text field 250
Selection last recruited orders Storefront - options Choice Last x orders
Number of last orders / days Storefront - options Text field 10
Display last recruited customers Storefront - options Switch on
Selection last recruited customers Storefront - options Choice Last x customers
Number of last customers / days Storefront - options Text field 10
Display last manual bookings Storefront - options Switch on
Advanced statistics for partners Storefront - options Switch off
Download document for payouts Storefront - options Switch off
Show turnover and commissions for non-commissionable orders Storefront - options Switch off
Show commission status Storefront - options Switch off
Email address Email notifications - administrator Text field admin@shop.de
Activate email when a partner wants a payout Email notifications - administrator Switch off
Activate email when a partner generates a promotion Email notifications - administrator Switch off
Activate email when registering a new partner Email notifications - administrator Switch off
Activate email on new partner application Email notifications - administrator Switch off
Activate email when changing the partner code Email notifications - administrator Switch off
Activate email upon request to change the partner code Email notifications - administrator Switch off
Activate email when changing the promotion code Email notifications - administrator Switch off
Activate email upon request to change the promotion code Email notifications - administrator Switch off
Activate email when commission is available for payment Email notifications - partner Switch off
Activate email when an assigned customer creates an order Email notifications - partner Switch off
Generate order when creating a voucher Orders for redeemed commissions Switch off
Product number Orders for redeemed commissions Text field empty
Name Orders for redeemed commissions Text field empty
Generate order when requesting a payout Orders for redeemed commissions Switch off
Product number Orders for redeemed commissions Text field empty
Name Orders for redeemed commissions Text field empty
Cookie group Cookie settings Choice Technically required
Expiration (in days) Cookie settings Text field 30
Live Calculation of the commission Switch on
Via scheduled-task Calculation of the commission Switch on
Via console command Calculation of the commission Switch on
Only partners with new orders Scheduled-task Switch off
Activate scheduled-task output Debug settings Switch off
Activate scheduled-task log Debug settings Switch off
Activate console command output Debug settings Switch on
Activate console command log Debug settings Switch off
Log the calculation of commission for each order Debug settings Switch on
Verfügbare Provision um Netto-Wert reduzieren bei Kunden aus Deutschland mit USt-ID Miscellaneous settings Switch off

Default settings

What does the setting "Activate plugin" do?

Switches the plugin on for this sales channel. Without it nothing runs in that channel: no partner account, no assignment, no commission.

Section
Default settings
Type
Switch
Default value
on
Technical name
status

Help text in the administration:

Enables the plugin for the current sales channel.

What does the setting "Allow manual entry of the partner code during the ordering process" do?

Shows a field in the cart and during checkout where the customer can type the partner code themselves, and names the assigned partner on the order confirmation. This is the route for referrals without a link, from a business card or a video.

Section
Default settings
Type
Switch
Default value
off
Technical name
manualPartnerCodeInput

Help text in the administration:

Should an input field for entering the partner code or an overview of the partner be displayed on the order confirmation page in the shopping basket and in the order process?

What does the setting "Assigned customers may be poached from other partners" do?

A referred customer is usually permanently assigned to an affiliate. The customer's commission is always attributed to the original partner, even if the customer is led into the shop for follow-up orders from another partner. Activate this configuration so that the original assignment is cancelled and the customer can thus be poached.

Section
Default settings
Type
Switch
Default value
off
Technical name
poachCustomerAssignment

Help text in the administration:

A referred customer is usually permanently assigned to an affiliate. The customer's commission is always attributed to the original partner, even if the customer is led into the shop for follow-up orders from another partner. Activate this configuration so that the original assignment is cancelled and the customer can thus be poached.

What does the setting "Partners receive commission for their own orders" do?

Do partners receive commission for their own orders if they have referred themselves - e.g. test the partner link or use the partner voucher? Please note that the partner can order with guest accounts and these orders could be commissioned in any case.

Section
Default settings
Type
Switch
Default value
on
Technical name
selfCommission

Help text in the administration:

Do partners receive commission for their own orders if they have referred themselves - e.g. test the partner link or use the partner voucher? Please note that the partner can order with guest accounts and these orders could be commissioned in any case.

What does the setting "Partners are allowed to change their partner code" do?

Is the partner allowed to change his own partner code? The plugin checks the validity of the new code in any case - e.g. no special characters and no existing code.<br /><br /><b>Yes, new code is changed directly:</b><br />The partner may change his own partner code at any time.<br /><br /><b>Yes, new code must be checked manually:</b><br />The partner may make a proposal for a new partner code. The new code must be manually activated in the administration.<br /><br /><b>No:</b><br />The partner cannot change his partner code.

Section
Default settings
Type
Choice
Default value
Yes, new code must be checked manually
Technical name
changeCodeType

The options are:

  • Yes, new code is changed directly
  • Yes, new code must be checked manually
  • No

Help text in the administration:

Is the partner allowed to change his own partner code? The plugin checks the validity of the new code in any case - e.g. no special characters and no existing code.<br /><br /><b>Yes, new code is changed directly:</b><br />The partner may change his own partner code at any time.<br /><br /><b>Yes, new code must be checked manually:</b><br />The partner may make a proposal for a new partner code. The new code must be manually activated in the administration.<br /><br /><b>No:</b><br />The partner cannot change his partner code.

What does the setting "Partners are allowed to change their voucher code" do?

Is the partner allowed to change his own voucher code? The plugin checks the validity of the new code in any case - e.g. no special characters and no existing code.<br /><br /><b>Yes, new code is changed directly:</b><br />The partner may change his own voucher code at any time.<br /><br /><b>Yes, new code must be checked manually:</b><br />The partner may make a proposal for a new voucher code. The new code must be manually activated in the administration.<br /><br /><b>No:</b><br />The partner cannot change his voucher code.

Section
Default settings
Type
Choice
Default value
Yes, new code must be checked manually
Technical name
changePromotionCodeType

The options are:

  • Yes, new code is changed directly
  • Yes, new code must be checked manually
  • No

Help text in the administration:

Is the partner allowed to change his own voucher code? The plugin checks the validity of the new code in any case - e.g. no special characters and no existing code.<br /><br /><b>Yes, new code is changed directly:</b><br />The partner may change his own voucher code at any time.<br /><br /><b>Yes, new code must be checked manually:</b><br />The partner may make a proposal for a new voucher code. The new code must be manually activated in the administration.<br /><br /><b>No:</b><br />The partner cannot change his voucher code.

Requirements

What does the setting "Behaviour" do?

How may customers sign up to the affiliate program?<br /><br /><b>Partners are activated directly:</b><br />The customer will be automatically registered to the affiliate program and depending on the plugin configurations will directly receive an affiliate code and an affiliate voucher.<br /><br /><b>Partners must apply and be manually activated:</b><br />The customer must apply for the partner program and can specify an individual partner code. The partner must be manually activated in the administration.

Section
Requirements
Type
Choice
Default value
Partners are activated directly
Technical name
registrationType

The options are:

  • Partners are activated directly
  • Partners must apply and be manually activated

Help text in the administration:

How may customers sign up to the affiliate program?<br /><br /><b>Partners are activated directly:</b><br />The customer will be automatically registered to the affiliate program and depending on the plugin configurations will directly receive an affiliate code and an affiliate voucher.<br /><br /><b>Partners must apply and be manually activated:</b><br />The customer must apply for the partner program and can specify an individual partner code. The partner must be manually activated in the administration.

What does the setting "Minimum turnover (in EUR)" do?

How much must a customer have net sales to date in order for the partner program to be offered ?<br />The same rules apply for "valid" orders, as stated below.

Section
Requirements
Type
Text field
Default value
0
Technical name
requirementsMinimumOrderAmount

Help text in the administration:

How much must a customer have net sales to date in order for the partner program to be offered ?<br />The same rules apply for "valid" orders, as stated below.

What does the setting "Enable mandatory checkbox" do?

Should a customer be shown a mandatory checkbox when registering for the affiliate program? The checkbox makes the partner accept the terms and conditions of the store in the plugin standard. The text at the checkbox can have changed in the text modules.

Section
Requirements
Type
Switch
Default value
off
Technical name
registrationMandatoryCheckbox

Help text in the administration:

Should a customer be shown a mandatory checkbox when registering for the affiliate program? The checkbox makes the partner accept the terms and conditions of the store in the plugin standard. The text at the checkbox can have changed in the text modules.

What does the setting "Partners are automatically registered" do?

Should customers be automatically registered in the partner programme when they 1.) call up the partner programme in the customer account or 2.) place a new order? For an automated registration, all "Prerequisites for registration" must be fulfilled in any case. In addition, the "Behaviour" must be set to "Partners are activated directly".

Section
Requirements
Type
Switch
Default value
off
Technical name
automaticRegistration

Help text in the administration:

Should customers be automatically registered in the partner programme when they 1.) call up the partner programme in the customer account or 2.) place a new order? For an automated registration, all "Prerequisites for registration" must be fulfilled in any case. In addition, the "Behaviour" must be set to "Partners are activated directly".

Affiliate settings

What does the setting "Affiliate Code Muster" do?

Here you can define a pattern for the partner code. You can access the customer variable (the customer). Also use the placeholders %s for a letter and %d for a number. Please note that all characters except numbers, letters and hyphens are filtered.<br /><br /><b>Example:</b><br />code-%s%s%s%s%d%d%d%d

Section
Affiliate settings
Type
Text field
Default value
partner-{{ customer.firstName }}-{{ customer.lastName }}
Technical name
affiliateCodePattern

Help text in the administration:

Here you can define a pattern for the partner code. You can access the customer variable (the customer). Also use the placeholders %s for a letter and %d for a number. Please note that all characters except numbers, letters and hyphens are filtered.<br /><br /><b>Example:</b><br />code-%s%s%s%s%d%d%d%d

What does the setting "Type of provision" do?

On what basis shall the Partner receive a commission for a referred order? Can be customized per partner after registration in the administration.<br /><br /><b>Percental:</b><br />The Partner shall receive a percentage share (e.g. 5%) of the net goods value of a referred order as commission.<br /><br /><b>Absolute (per order):</b><br />The Partner shall always receive a fixed amount (e.g. 5.- EUR) for a referred order, regardless of the order value.<br /><br /><b>Absolute (per piece):</b><br />The partner always receives a fixed amount (e.g. 0.10 EUR) for each number of items within a referred order, regardless of the order value or value of goods of the product.

Section
Affiliate settings
Type
Choice
Default value
Percental
Technical name
affiliateCommissionType

The options are:

  • Percental
  • Absolut (per order)
  • Absolut (per piece)

Help text in the administration:

On what basis shall the Partner receive a commission for a referred order? Can be customized per partner after registration in the administration.<br /><br /><b>Percental:</b><br />The Partner shall receive a percentage share (e.g. 5%) of the net goods value of a referred order as commission.<br /><br /><b>Absolute (per order):</b><br />The Partner shall always receive a fixed amount (e.g. 5.- EUR) for a referred order, regardless of the order value.<br /><br /><b>Absolute (per piece):</b><br />The partner always receives a fixed amount (e.g. 0.10 EUR) for each number of items within a referred order, regardless of the order value or value of goods of the product.

What does the setting "Commission (absolute or percental)" do?

The initial commission of the Partner in percent (e.g. 5%) or in the default currency (e.g. 5,- EUR). Can be customized per partner after registration in the administration.

Section
Affiliate settings
Type
Text field
Default value
5
Technical name
affiliateCommissionFee

Help text in the administration:

The initial commission of the Partner in percent (e.g. 5%) or in the default currency (e.g. 5,- EUR). Can be customized per partner after registration in the administration.

What does the setting "Activate individual commission for subsequent orders" do?

Should affiliates receive a different commission for follow-up orders from referred customers than for the first order? Please make sure that the option "Commission subsequent orders" is activated.

Section
Affiliate settings
Type
Switch
Default value
off
Technical name
affiliateCommissionSubsequentStatus

Help text in the administration:

Should affiliates receive a different commission for follow-up orders from referred customers than for the first order? Please make sure that the option "Commission subsequent orders" is activated.

What does the setting "Commission for subsequent orders (absolute or percental)" do?

The initial commission for subsequent orders of the Partner in percent (e.g. 5%) or in the default currency (e.g. 5,- EUR). Can be customized per partner after registration in the administration.

Section
Affiliate settings
Type
Text field
Default value
2
Technical name
affiliateCommissionSubsequentFee

Help text in the administration:

The initial commission for subsequent orders of the Partner in percent (e.g. 5%) or in the default currency (e.g. 5,- EUR). Can be customized per partner after registration in the administration.

Starting credit

What does the setting "Activate starting credit" do?

Should a starting balance be created automatically for each partner? The starting credit is added as a manual booking. The public comment for this booking can be customized in the text modules.

Section
Starting credit
Type
Switch
Default value
off
Technical name
startingCreditStatus

Help text in the administration:

Should a starting balance be created automatically for each partner? The starting credit is added as a manual booking. The public comment for this booking can be customized in the text modules.

What does the setting "Credit" do?

The starting credit in the standard currency (e.g. EUR 5.-) for each partner after registration.

Section
Starting credit
Type
Text field
Default value
5
Technical name
startingCreditValue

Help text in the administration:

The starting credit in the standard currency (e.g. EUR 5.-) for each partner after registration.

Partner voucher

What does the setting "Activate advertising voucher" do?

Should a promotional voucher be created automatically for each partner? A partner can use this voucher to attract more customers.

Section
Partner voucher
Type
Switch
Default value
on
Technical name
adPromotionStatus

Help text in the administration:

Should a promotional voucher be created automatically for each partner? A partner can use this voucher to attract more customers.

What does the setting "Automatically add advertising voucher" do?

Should the partner voucher be automatically added to the shopping cart when a customer is directed to the shopping cart via a partner link? Alternatively, the customer would always have to activate the partner voucher manually in the shopping cart.

Section
Partner voucher
Type
Switch
Default value
off
Technical name
adPromotionAutomaticStatus

Help text in the administration:

Should the partner voucher be automatically added to the shopping cart when a customer is directed to the shopping cart via a partner link? Alternatively, the customer would always have to activate the partner voucher manually in the shopping cart.

What does the setting "Rebate of promotion" do?

The rebate type of the promotion.

Section
Partner voucher
Type
Choice
Default value
Percental
Technical name
adPromotionType

The options are:

  • Absolute
  • Percental

Help text in the administration:

The rebate type of the promotion.

What does the setting "Discount (in percent or EUR)" do?

The percentage discount of the voucher.

Section
Partner voucher
Type
Text field
Default value
10
Technical name
adPromotionValue

Help text in the administration:

The percentage discount of the voucher.

What does the setting "Name" do?

The name of the voucher in the administration and in the shopping cart of the customer.

Section
Partner voucher
Type
Text field
Default value
10% Partner Gutschein - {{ affiliate.code }}
Technical name
adPromotionName

Help text in the administration:

The name of the voucher in the administration and in the shopping cart of the customer.

What does the setting "Code Muster" do?

Here you can define a pattern for the voucher code. Use the placeholders %s for a letter and %d for a number.<br /><br /><b>Example:</b><br />code-%s%s%s%s%d%d%d%d

Section
Partner voucher
Type
Text field
Default value
{{ affiliate.code }}-%s%d%s%d%s%d%s%d
Technical name
adPromotionCodePattern

Help text in the administration:

Here you can define a pattern for the voucher code. Use the placeholders %s for a letter and %d for a number.<br /><br /><b>Example:</b><br />code-%s%s%s%s%d%d%d%d

What does the setting "Usages total" do?

The value for "total uses" within the voucher.

Section
Partner voucher
Type
Text field
Default value
999
Technical name
adPromotionMaxRedemptionsGlobal

Help text in the administration:

The value for "total uses" within the voucher.

What does the setting "Usages per customer" do?

The value for "uses per customer" within the voucher.

Section
Partner voucher
Type
Text field
Default value
999
Technical name
adPromotionMaxRedemptionsPerCustomer

Help text in the administration:

The value for "uses per customer" within the voucher.

What does the setting "Not combinable with other promotions" do?

If enabled, then a new automatically created promotional voucher will be created with the "Prevents combination with other promotions" option enabled. Thus, promotional voucher cannot be combined with other vouchers.

Section
Partner voucher
Type
Switch
Default value
on
Technical name
adPromotionPreventCombination

Help text in the administration:

If enabled, then a new automatically created promotional voucher will be created with the "Prevents combination with other promotions" option enabled. Thus, promotional voucher cannot be combined with other vouchers.

What does the setting "Discount - Scope" do?

The value for "Scope" in the "Discounts" section within the coupon.

Section
Partner voucher
Type
Choice
Default value
Cart
Technical name
adPromotionDiscountScope

The options are:

  • Cart
  • Shipping costs
  • Set

Help text in the administration:

The value for "Scope" in the "Discounts" section within the coupon.

What does the setting "Discount - Apply to selected products only" do?

The value for "Apply to selected products only" in the "Discounts" section within the coupon.

Section
Partner voucher
Type
Switch
Default value
off
Technical name
adPromotionDiscountConsiderAdvancedRules

Help text in the administration:

The value for "Apply to selected products only" in the "Discounts" section within the coupon.

Commissionable orders

What does the setting "Age (in days)" do?

Sets how many days old an order has to be before a commission arises at all. The higher the value, the more cancellations have passed beforehand. This is the most effective brake against reversals, because the plugin does not reclaim money already paid out.

Section
Commissionable orders
Type
Text field
Default value
14
Technical name
commissionableDays

Help text in the administration:

What is the minimum age (in days) that an order must be in order to receive commission?

What does the setting "Commission subsequent orders" do?

Should all orders of a customer - including all subsequent orders - be provisioned? Otherwise, only one order per customer is eligible for commission.

Section
Commissionable orders
Type
Switch
Default value
on
Technical name
commissionableSubsequentOrder

Help text in the administration:

Should all orders of a customer - including all subsequent orders - be provisioned? Otherwise, only one order per customer is eligible for commission.

Cancelled orders

What does the setting "Automatically settle canceled orders" do?

Automatically creates a negative entry for a cancelled order that offsets the commission. It is triggered by the order status, not by the payment or delivery status. Partial refunds and returns are left out; you correct those by hand.

Section
Cancelled orders
Type
Switch
Default value
on
Technical name
cancelledOrdersReduceCommissionStatus

Help text in the administration:

Should a negative manual posting be created automatically for canceled orders to clear them?

What does the setting "Public notice of the booking" do?

The public notice of the manual booking.

Section
Cancelled orders
Type
Text field
Default value
Stornierte Bestellung #{{ order.orderNumber }} vom {{ order.createdAt|date('d.m.Y') }}
Technical name
cancelledOrdersReduceCommissionPublicComment

Help text in the administration:

The public notice of the manual booking.

Individual commission

What does the setting "Activate individual commission for products" do?

Should the individual commission be enabled for customers, products and categories? If the product or any category of the product have a commission stored, then the commission will be calculated on this basis (instead of the partner's default).

Section
Individual commission
Type
Switch
Default value
off
Technical name
individualProductCommissionStatus

Help text in the administration:

Should the individual commission be enabled for customers, products and categories? If the product or any category of the product have a commission stored, then the commission will be calculated on this basis (instead of the partner's default).

What does the setting "Priority for category commissions" do?

Which commission should be granted if a product is assigned to several categories with different commissions.

Section
Individual commission
Type
Choice
Default value
Highest commission
Technical name
individualProductCommissionCategoryPriority

The options are:

  • Lowest commission
  • Highest commission

Help text in the administration:

Which commission should be granted if a product is assigned to several categories with different commissions.

What does the setting "Priority for product stream commissions" do?

Which commission should be granted if a product is assigned to several product streams with different commissions.

Section
Individual commission
Type
Choice
Default value
Highest commission
Technical name
individualProductCommissionProductStreamPriority

The options are:

  • Lowest commission
  • Highest commission

Help text in the administration:

Which commission should be granted if a product is assigned to several product streams with different commissions.

Commission priority

What does the setting "Priority for multiple commission rates" do?

Which commission rate should be granted on a product if several commission rates are valid.

Section
Commission priority
Type
Choice
Default value
Highest priority
Technical name
commissionPriority

The options are:

  • Highest priority
  • Lowest commission rate
  • Highest commission rate

Help text in the administration:

Which commission rate should be granted on a product if several commission rates are valid.

Compensation

What does the setting "Type of remuneration" do?

In what form should your partners receive their commission?<br /><br /><b>Promotion:</b><br />The partner can convert his commission into vouchers independently and can redeem them directly in the shop.<br /><br /><b>Payout:</b><br />The partner can request payment of the commission. To do so, he enters his account details and you have to execute and confirm the payouts manually.

Section
Compensation
Type
Choice
Default value
Promotion
Technical name
commissionType

The options are:

  • Promotion
  • Payout
  • Promotion and Payout

Help text in the administration:

In what form should your partners receive their commission?<br /><br /><b>Promotion:</b><br />The partner can convert his commission into vouchers independently and can redeem them directly in the shop.<br /><br /><b>Payout:</b><br />The partner can request payment of the commission. To do so, he enters his account details and you have to execute and confirm the payouts manually.

Compensation - by promotion

What does the setting "Type of convertion" do?

In what amount or on what scale can the partner convert their credit into a voucher?<br /><br /><b>Convert complete at any time:</b><br />The partner can convert the full amount of their credit into a voucher at any time. A new, individual voucher is generated for each conversion according to the specifications below.<br /><br /><b>Convert in staggered amounts:</b><br />The partner may only convert their credit into vouchers in predefined increments. The available vouchers can be selected below.

Section
Compensation - by promotion
Type
Choice
Default value
Convert in staggered amounts
Technical name
commissionPromotionType

The options are:

  • Convert in staggered amounts
  • Convert complete at any time

Help text in the administration:

In what amount or on what scale can the partner convert their credit into a voucher?<br /><br /><b>Convert complete at any time:</b><br />The partner can convert the full amount of their credit into a voucher at any time. A new, individual voucher is generated for each conversion according to the specifications below.<br /><br /><b>Convert in staggered amounts:</b><br />The partner may only convert their credit into vouchers in predefined increments. The available vouchers can be selected below.

What does the setting "Minimum amount (in EUR)" do?

The minimum amount (in EUR) if the partner wishes to convert their credit balance in full into a voucher at any time.

Section
Compensation - by promotion
Type
Text field
Default value
0
Technical name
commissionPromotionMinimumAmount

Help text in the administration:

The minimum amount (in EUR) if the partner wishes to convert their credit balance in full into a voucher at any time.

Compensation - by promotion - individual amount

What does the setting "Name" do?

The name of the voucher in the administration and in the shopping cart of the customer.

Section
Compensation - by promotion - individual amount
Type
Text field
Default value
Provision Partner - {{ affiliate.code }} - %s%d%s%d%s%d%s%d
Technical name
commissionPromotionCustomName

Help text in the administration:

The name of the voucher in the administration and in the shopping cart of the customer.

What does the setting "Code Muster" do?

Here you can define a pattern for the voucher code. Use the placeholders %s for a letter and %d for a number.<br /><br /><b>Example:</b><br />code-%s%s%s%s%d%d%d%d

Section
Compensation - by promotion - individual amount
Type
Text field
Default value
%s%s%d%d%s%s%d%d%s%s%d%d%s%s%d%d
Technical name
commissionPromotionCustomCodePattern

Help text in the administration:

Here you can define a pattern for the voucher code. Use the placeholders %s for a letter and %d for a number.<br /><br /><b>Example:</b><br />code-%s%s%s%s%d%d%d%d

What does the setting "Not combinable with other promotions" do?

If enabled, then a new automatically created promotional voucher will be created with the "Prevents combination with other promotions" option enabled. Thus, promotional voucher cannot be combined with other vouchers.

Section
Compensation - by promotion - individual amount
Type
Switch
Default value
on
Technical name
commissionPromotionCustomPreventCombination

Help text in the administration:

If enabled, then a new automatically created promotional voucher will be created with the "Prevents combination with other promotions" option enabled. Thus, promotional voucher cannot be combined with other vouchers.

What does the setting "Discount - Scope" do?

The value for "Scope" in the "Discounts" section within the coupon.

Section
Compensation - by promotion - individual amount
Type
Choice
Default value
Cart
Technical name
commissionPromotionCustomDiscountScope

The options are:

  • Cart
  • Shipping costs
  • Set

Help text in the administration:

The value for "Scope" in the "Discounts" section within the coupon.

What does the setting "Discount - Apply to selected products only" do?

The value for "Apply to selected products only" in the "Discounts" section within the coupon.

Section
Compensation - by promotion - individual amount
Type
Switch
Default value
off
Technical name
commissionPromotionCustomDiscountConsiderAdvancedRules

Help text in the administration:

The value for "Apply to selected products only" in the "Discounts" section within the coupon.

Compensation - by payout

What does the setting "Type of remuneration" do?

In what amount or on what scale may the partner have his credit paid out?<br /><br /><b>Payout complete at any time:</b><br />The partner can withdraw his balance in full at any time.<br /><br /><b>Payment in staggered amounts:</b><br />The partner may only have his credit paid out in predefined scales. The individual scales can be defined below.

Section
Compensation - by payout
Type
Choice
Default value
Payment in staggered amounts
Technical name
commissionPayoutType

The options are:

  • Payment in staggered amounts
  • Payout complete at any time

Help text in the administration:

In what amount or on what scale may the partner have his credit paid out?<br /><br /><b>Payout complete at any time:</b><br />The partner can withdraw his balance in full at any time.<br /><br /><b>Payment in staggered amounts:</b><br />The partner may only have his credit paid out in predefined scales. The individual scales can be defined below.

What does the setting "Minimum amount (in EUR)" do?

The minimum amount in case the partner can withdraw his balance in full at any time.

Section
Compensation - by payout
Type
Text field
Default value
0
Technical name
commissionPayoutMinimumAmount

Help text in the administration:

The minimum amount in case the partner can withdraw his balance in full at any time.

Compensation - by payout - staggered amounts

What does the setting "Payout (in EUR) I" do?

Please enter the amount that the partner can withdraw.

Section
Compensation - by payout - staggered amounts
Type
Text field
Default value
10
Technical name
commissionPayout1

Help text in the administration:

Please enter the amount that the partner can withdraw.

What does the setting "Payout (in EUR) II" do?

Please enter the amount that the partner can withdraw.

Section
Compensation - by payout - staggered amounts
Type
Text field
Default value
25
Technical name
commissionPayout2

Help text in the administration:

Please enter the amount that the partner can withdraw.

What does the setting "Payout (in EUR) III" do?

Please enter the amount that the partner can withdraw.

Section
Compensation - by payout - staggered amounts
Type
Text field
Default value
50
Technical name
commissionPayout3

Help text in the administration:

Please enter the amount that the partner can withdraw.

What does the setting "Payout (in EUR) IV" do?

Please enter the amount that the partner can withdraw.

Section
Compensation - by payout - staggered amounts
Type
Text field
Default value
100
Technical name
commissionPayout4

Help text in the administration:

Please enter the amount that the partner can withdraw.

What does the setting "Payout (in EUR) V" do?

Please enter the amount that the partner can withdraw.

Section
Compensation - by payout - staggered amounts
Type
Text field
Default value
250
Technical name
commissionPayout5

Help text in the administration:

Please enter the amount that the partner can withdraw.

Storefront - options

What does the setting "Selection last recruited orders" do?

According to which criterion (number or days) should the last recruited orders be displayed? Please note that you may have to adjust the text modules for describing the most recently acquired orders.

Section
Storefront - options
Type
Choice
Default value
Last x orders
Technical name
storefrontLastOrderSelection

The options are:

  • Last x orders
  • Last x days

Help text in the administration:

According to which criterion (number or days) should the last recruited orders be displayed? Please note that you may have to adjust the text modules for describing the most recently acquired orders.

What does the setting "Number of last orders / days" do?

Please indicate the number of orders or days.

Section
Storefront - options
Type
Text field
Default value
10
Technical name
storefrontLastOrderValue

Help text in the administration:

Please indicate the number of orders or days.

What does the setting "Display last recruited customers" do?

Should the partner be shown the last customers referred? Only the first name and city are listed.

Section
Storefront - options
Type
Switch
Default value
on
Technical name
storefrontLastCustomerStatus

Help text in the administration:

Should the partner be shown the last customers referred? Only the first name and city are listed.

What does the setting "Selection last recruited customers" do?

According to which criterion (number or days) should the last recruited customers be displayed? Please note that you may have to adjust the text modules for describing the most recently acquired customers.

Section
Storefront - options
Type
Choice
Default value
Last x customers
Technical name
storefrontLastCustomerSelection

The options are:

  • Last x customers
  • Last x days

Help text in the administration:

According to which criterion (number or days) should the last recruited customers be displayed? Please note that you may have to adjust the text modules for describing the most recently acquired customers.

What does the setting "Number of last customers / days" do?

Please indicate the number of customers or days.

Section
Storefront - options
Type
Text field
Default value
10
Technical name
storefrontLastCustomerValue

Help text in the administration:

Please indicate the number of customers or days.

What does the setting "Display last manual bookings" do?

Should the partner be shown the last manual bookings? The partner is shown the public comment.

Section
Storefront - options
Type
Switch
Default value
on
Technical name
storefrontLastManualBookingsStatus

Help text in the administration:

Should the partner be shown the last manual bookings? The partner is shown the public comment.

What does the setting "Advanced statistics for partners" do?

Should the affiliate be able to view advanced statistics for recruited orders? The statistics are similar to the detailed recruited orders within the administration of a partner and contain e.g. the conditions for commissionable orders.

Section
Storefront - options
Type
Switch
Default value
off
Technical name
storefrontStatistics

Help text in the administration:

Should the affiliate be able to view advanced statistics for recruited orders? The statistics are similar to the detailed recruited orders within the administration of a partner and contain e.g. the conditions for commissionable orders.

What does the setting "Download document for payouts" do?

Releases the payout receipt as a PDF for the partner to download in their account. Without this switch the receipt stays in the administration and you send it yourself when it is needed.

Section
Storefront - options
Type
Switch
Default value
off
Technical name
storefrontPayoutDocumentDownload

Help text in the administration:

Should the document for payments be made available to the partner as a download?

What does the setting "Show turnover and commissions for non-commissionable orders" do?

Should the turnover and the commission also be displayed for non-commissionable orders? The provisional commission for the partner is already calculated and saved when the order is received. The provisional commission is never recalculated, so the actual commission may differ from the provisional commission.

Section
Storefront - options
Type
Switch
Default value
off
Technical name
storefrontShowCommissionForNonCommissionableOrders

Help text in the administration:

Should the turnover and the commission also be displayed for non-commissionable orders? The provisional commission for the partner is already calculated and saved when the order is received. The provisional commission is never recalculated, so the actual commission may differ from the provisional commission.

What does the setting "Show commission status" do?

Should the status of commissions be displayed? A commission is marked as not yet commissionable, commissionable or canceled.

Section
Storefront - options
Type
Switch
Default value
off
Technical name
storefrontShowCommissionStatus

Help text in the administration:

Should the status of commissions be displayed? A commission is marked as not yet commissionable, commissionable or canceled.

Email notifications - administrator

What does the setting "Email address" do?

The email address of the shop owner as a recipient.

Section
Email notifications - administrator
Type
Text field
Default value
admin@shop.de
Technical name
emailAdminEmailAddress

Help text in the administration:

The email address of the shop owner as a recipient.

What does the setting "Activate email when a partner wants a payout" do?

Sends you an email as soon as a partner has requested a payout. Useful, because a payout requires an action from you: check, confirm, transfer.

Section
Email notifications - administrator
Type
Switch
Default value
off
Technical name
emailAdminCommissionPayoutStatus

Help text in the administration:

Should the shop operator be informed by email as soon as a partner redeems a commission (payout)?

What does the setting "Activate email when a partner generates a promotion" do?

Sends you an email as soon as a partner has converted balance into a voucher. That runs without your involvement, so the message is purely informational.

Section
Email notifications - administrator
Type
Switch
Default value
off
Technical name
emailAdminCommissionPromotionStatus

Help text in the administration:

Should the shop operator be informed by email as soon as a partner redeems a commission (voucher)?

What does the setting "Activate email when registering a new partner" do?

Sends you an email as soon as a new partner has registered. With immediate activation that is information, not a task.

Section
Email notifications - administrator
Type
Switch
Default value
off
Technical name
emailAdminNewPartnerStatus

Help text in the administration:

Should the shop operator be informed by email as soon as a new partner has registered?

What does the setting "Activate email on new partner application" do?

Sends you an email as soon as somebody has applied and is waiting for your activation. If you work with applications, switch this message on, otherwise applications sit there unnoticed.

Section
Email notifications - administrator
Type
Switch
Default value
off
Technical name
emailAdminNewPartnerApplicationStatus

Help text in the administration:

Should the shop operator be informed by email as soon as a new application from a possible partner has been received for manual review?

What does the setting "Activate email when changing the partner code" do?

Sends you an email as soon as a partner has changed their partner code themselves. Only relevant if you allow the change without confirmation.

Section
Email notifications - administrator
Type
Switch
Default value
off
Technical name
emailAdminPartnerCodeChangeStatus

Help text in the administration:

Should the shop operator be informed by email as soon as a partner independently changes his partner code?

What does the setting "Activate email upon request to change the partner code" do?

Sends you an email as soon as a partner requests a change to their partner code. That request waits for a decision from you, so this message belongs switched on.

Section
Email notifications - administrator
Type
Switch
Default value
off
Technical name
emailAdminPartnerCodeChangeRequestStatus

Help text in the administration:

Should the shop operator be informed by email as soon as a partner makes a request to change his partner code

What does the setting "Activate email when changing the promotion code" do?

Sends you an email as soon as a partner has changed their voucher code themselves.

Section
Email notifications - administrator
Type
Switch
Default value
off
Technical name
emailAdminPromotionCodeChangeStatus

Help text in the administration:

Should the shop operator be informed by email as soon as a partner independently changes his promotion code?

What does the setting "Activate email upon request to change the promotion code" do?

Sends you an email as soon as a partner requests a change to their voucher code and is waiting for you to confirm it.

Section
Email notifications - administrator
Type
Switch
Default value
off
Technical name
emailAdminPromotionCodeChangeRequestStatus

Help text in the administration:

Should the shop operator be informed by email as soon as a partner makes a request to change his promotion code

Email notifications - partner

What does the setting "Activate email when commission is available for payment" do?

Should the partner be informed by email as soon as he has collected enough commission for a payout? He can activate or deactivate the notification in his customer account.

Section
Email notifications - partner
Type
Switch
Default value
off
Technical name
emailAffiliatePayoutAvailableStatus

Help text in the administration:

Should the partner be informed by email as soon as he has collected enough commission for a payout? He can activate or deactivate the notification in his customer account.

What does the setting "Activate email when an assigned customer creates an order" do?

Sends the partner an email as soon as one of their assigned customers has ordered. That keeps them engaged, but with active partners it can mean a lot of messages.

Section
Email notifications - partner
Type
Switch
Default value
off
Technical name
emailAffiliateOrderStatus

Help text in the administration:

Should the partner be informed by email as soon as an assigned customer places an order?

Orders for redeemed commissions

What does the setting "Generate order when creating a voucher" do?

Creates a real order by the partner for every redeemed voucher, so that a warehouse system can pick the process up. For the settlement alone the receipt is enough; this order is meant only for the integration.

Section
Orders for redeemed commissions
Type
Switch
Default value
off
Technical name
redeemOrderPromotionStatus

Help text in the administration:

When creating a voucher (for commission), should an order automatically be created for the customer?

What does the setting "Product number" do?

The product number of the product for the order when creating a voucher.

Section
Orders for redeemed commissions
Type
Text field
Default value
empty
Technical name
redeemOrderPromotionProductNumber

Help text in the administration:

The product number of the product for the order when creating a voucher.

What does the setting "Name" do?

The name of the product for the order when creating a voucher.

Section
Orders for redeemed commissions
Type
Text field
Default value
empty
Technical name
redeemOrderPromotionProductName

Help text in the administration:

The name of the product for the order when creating a voucher.

What does the setting "Generate order when requesting a payout" do?

Creates a real order by the partner for every requested payout, with a tag of its own and its own shipping and payment method, so that your integration can tell it apart from goods orders.

Section
Orders for redeemed commissions
Type
Switch
Default value
off
Technical name
redeemOrderPayoutStatus

Help text in the administration:

When requesting a payout (for commission), should an order automatically be created for the customer?

What does the setting "Product number" do?

The product number of the product for the order when requesting a payout.

Section
Orders for redeemed commissions
Type
Text field
Default value
empty
Technical name
redeemOrderPayoutProductNumber

Help text in the administration:

The product number of the product for the order when requesting a payout.

What does the setting "Name" do?

The name of the product for the order when requesting a payout.

Section
Orders for redeemed commissions
Type
Text field
Default value
empty
Technical name
redeemOrderPayoutProductName

Help text in the administration:

The name of the product for the order when requesting a payout.

Calculation of the commission

What does the setting "Live" do?

When the affiliate program is called up in the storefront, the current commission is calculated for the current partner live. This is the recommended procedure for smaller shops in order to always display the partner's most up-to-date data. However, the larger the shop, the longer the waiting time for the call, as the calculation of the commission for new orders can take a very long time in case of doubt.

Section
Calculation of the commission
Type
Switch
Default value
on
Technical name
calculationLive

Help text in the administration:

When the affiliate program is called up in the storefront, the current commission is calculated for the current partner live. This is the recommended procedure for smaller shops in order to always display the partner's most up-to-date data. However, the larger the shop, the longer the waiting time for the call, as the calculation of the commission for new orders can take a very long time in case of doubt.

What does the setting "Via scheduled-task" do?

The commission for new orders is calculated asynchronously for all partners within a scheduled task. Recommended for small to medium-sized shops to avoid a "traffic jam" of orders when a partner calls up the partner programme in the storefront.

Section
Calculation of the commission
Type
Switch
Default value
on
Technical name
calculationScheduledTask

Help text in the administration:

The commission for new orders is calculated asynchronously for all partners within a scheduled task. Recommended for small to medium-sized shops to avoid a "traffic jam" of orders when a partner calls up the partner programme in the storefront.

What does the setting "Via console command" do?

The commission for new orders is calculated via a console command for all or individual partners. You must plan and ensure the execution of the console command yourself. Recommended for medium to large shops in order to calculate all commissions from new orders as continuously and promptly as possible in order to minimise the load on the shop.

Section
Calculation of the commission
Type
Switch
Default value
on
Technical name
calculationConsoleCommand

Help text in the administration:

The commission for new orders is calculated via a console command for all or individual partners. You must plan and ensure the execution of the console command yourself. Recommended for medium to large shops in order to calculate all commissions from new orders as continuously and promptly as possible in order to minimise the load on the shop.

Scheduled-task

What does the setting "Only partners with new orders" do?

If enabled, each scheduled-task run processes only partners that actually have an order without a commission yet, instead of iterating every partner. Strongly recommended for shops with many partners. Only relevant when the scheduled-task calculation is active.

Section
Scheduled-task
Type
Switch
Default value
off
Technical name
scheduledTaskDeltaOnly

Help text in the administration:

If enabled, each scheduled-task run processes only partners that actually have an order without a commission yet, instead of iterating every partner. Strongly recommended for shops with many partners. Only relevant when the scheduled-task calculation is active.

Debug settings

What does the setting "Activate scheduled-task output" do?

Should the scheduled-task (for sending the emails) have the outputs enabled? You can enable this option if you want to control the output via messenger:consume -vvv.

Section
Debug settings
Type
Switch
Default value
off
Technical name
scheduledTaskOutputStatus

Help text in the administration:

Should the scheduled-task (for sending the emails) have the outputs enabled? You can enable this option if you want to control the output via messenger:consume -vvv.

What does the setting "Activate scheduled-task log" do?

Should the log be activated for the scheduled task (for updating the commissions)? The log is stored in the directory /var/log/.

Section
Debug settings
Type
Switch
Default value
off
Technical name
scheduledTaskLogStatus

Help text in the administration:

Should the log be activated for the scheduled task (for updating the commissions)? The log is stored in the directory /var/log/.

What does the setting "Activate console command output" do?

Lets the console command for updating commissions report what it is doing. Helpful while setting things up, usually unnecessary in normal operation through a cron job.

Section
Debug settings
Type
Switch
Default value
on
Technical name
consoleCommandOutputStatus

Help text in the administration:

Should the console command (for sending the emails) have the outputs enabled?

What does the setting "Activate console command log" do?

Should the log be activated for the console command (for updating the commissions)? The log is stored in the directory /var/log/.

Section
Debug settings
Type
Switch
Default value
off
Technical name
consoleCommandLogStatus

Help text in the administration:

Should the log be activated for the console command (for updating the commissions)? The log is stored in the directory /var/log/.

What does the setting "Log the calculation of commission for each order" do?

Stores the log of the commission calculation for every order. That lets you retrace later which rate applied and why an order did not count. Without the log, questions can only be answered by guessing.

Section
Debug settings
Type
Switch
Default value
on
Technical name
debugSaveCommissionCalculatorInfoStatus

Help text in the administration:

Should the basis for calculating the commission be saved for all orders?

Miscellaneous settings

What does the setting "Verfügbare Provision um Netto-Wert reduzieren bei Kunden aus Deutschland mit USt-ID" do?

Soll für Partner mit einer Rechnungsadresse innerhalb von Deutschland und einer hinterlegten USt-IdNr. in den Kunden Stammdaten die verfügbare Provision um den Netto-Betrag einer gewünschten Auszahlung / Einlösung in einen Gutschein reduziert werden? Beispiel: wenn der Partner eine Auszahlung in Höhe von 10,- EUR beantragt, dann wird ein Datensatz zur Auszahlung in Höhe von 10,- EUR angelegt, aber die verfügbare Provision wird lediglich um 8,40 EUR (10,- EUR abzgl. 19% MwSt.) reduziert.

Section
Miscellaneous settings
Type
Switch
Default value
off
Technical name
miscReduceCommissionNetForUstAffiliates

Help text in the administration:

Soll für Partner mit einer Rechnungsadresse innerhalb von Deutschland und einer hinterlegten USt-IdNr. in den Kunden Stammdaten die verfügbare Provision um den Netto-Betrag einer gewünschten Auszahlung / Einlösung in einen Gutschein reduziert werden? Beispiel: wenn der Partner eine Auszahlung in Höhe von 10,- EUR beantragt, dann wird ein Datensatz zur Auszahlung in Höhe von 10,- EUR angelegt, aber die verfügbare Provision wird lediglich um 8,40 EUR (10,- EUR abzgl. 19% MwSt.) reduziert.

Everything on this page is generated straight from the plugin configuration. When a setting changes in the plugin, this page changes with it.