Configuration

Every setting of the partner program, card by card.

The configuration has 30 cards in five groups: partners, marketing, commission, payout and system, plus eight cards of the multi-level marketing add-on plugin. Here you find every card with its notice and every field as named in the administration, with default and help text.

Marketing → Affiliate program → side menu System → Settings

Overview

Where are the settings, and which sales channel do they apply to?

The menu entry Settings opens the configuration of the affiliate program; you reach the same page through Extensions → My extensions → Configure. At the top you choose the sales channel: All sales channels applies everywhere, a single sales channel can override every value with one of its own. Two cards always apply to all sales channels: the automatic payout and the scheduled tasks with the console commands. The setup assistant asks for the most important values and saves them for all sales channels.

  1. 1In the side menu of the affiliate program, click System → Settings.

  2. 2Choose the sales channel at the top. A value of a single sales channel takes precedence over the value of “All sales channels”.

  3. 3Every field has a question mark on the right with its help; the text is listed below with every field.

  4. 4Click Save.

Partners

Affiliate program: Switch the affiliate program on per sales channel

The main switch for a sales channel. Switches the affiliate program on or off for the selected sales channel. When it is off, the shop shows no partner area there, sets no partner cookie, records no clicks and assigns no new customers.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Affiliate program card → Activate extensionEnables the extension for the current sales channel.

Partners · Registration: Who may take part in the affiliate program

Instant registration or application and its requirements. What requirements must an end customer in the shop fulfil in order to participate in the affiliate program? A customer can only register or apply for the affiliate program if all the conditions below are met. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Partners · Registration card → BehaviourHow may customers sign up to the affiliate program?

    Partners are activated directly:
    The customer will be automatically registered to the affiliate program and depending on the extension configuration will directly receive a partner code and a partner voucher.

    Partners must apply and be manually activated:
    The customer must apply for the affiliate program and can specify an individual partner code. The partner must be manually activated in the administration.

  • Partners · Registration card → Minimum turnover (in EUR)How much must a customer have net sales to date in order for the partner program to be offered ?
    The same rules apply for "valid" orders, as stated below.

  • Partners · Registration card → Valid customer groupsOnly these customer groups are activated for the affiliate program.

    Note:
    If NO customer groups are selected, then ALL customer groups are valid.

  • Partners · Registration card → Enable mandatory checkboxShould a customer be shown a mandatory checkbox when registering for the affiliate program? By default, the checkbox makes the partner accept the terms and conditions of the shop. The text of the checkbox can be changed in the snippets.

  • Partners · Registration card → Partners are automatically registeredShould customers be automatically registered in the affiliate program when they 1.) open the partner area in the customer account or 2.) place a new order? For an automated registration, all requirements of this card must be fulfilled in any case. In addition, the "Behaviour" must be set to "Partners are activated directly".

Partners · Defaults for new partners: Which commission new partners get

Starting values every new partner takes over on registration; they do not change existing partners. A customer is registered as a partner in the affiliate program with these default values. Each of these settings can be customised individually for each partner after registration. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Partners · Defaults for new partners card → Partner code patternHere 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.

    Example:
    code-%s%s%s%s%d%d%d%d

  • Partners · Defaults for new partners card → Type of commissionOn what basis should the partner receive a commission for a referred order? Can be customized per partner after registration in the administration.

    Percentage:
    The partner receives a percentage share (e.g. 5%) of the net goods value of a referred order as commission.

    Absolute (per order):
    The partner always receives a fixed amount (e.g. 5.- EUR) for a referred order, regardless of the order value.

    Absolute (per piece):
    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.

  • Partners · Defaults for new partners card → Commission (absolute or percentage)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.

  • Partners · Defaults for new partners card → Activate individual commission for subsequent ordersThe default whether partners receive a different commission for subsequent orders of referred customers than for the first order. Can be customized per partner after registration in the administration. Please make sure that the option "Commission subsequent orders" is activated.

  • Partners · Defaults for new partners card → Commission for subsequent orders (absolute or percentage)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.

  • Partners · Defaults for new partners card → Minimum order valueDefault for new partners in the default currency: if the amount the commission is calculated from is below this value, the order gets no commission. Empty: no limit. Existing partners are changed on the partner or through their partner group.

  • Partners · Defaults for new partners card → Maximum commission per orderDefault for new partners in the default currency: the commission of an order is limited to this amount, including the commission from commission rules and the subsequent rate. Empty: no limit. Existing partners are changed on the partner or through their partner group.

  • Partners · Defaults for new partners card → Partner group for new partnersNew partners get this partner group in addition to the rates above. Only an active partner group counts; empty means no partner group.

Partners · Starting credit: A starting credit for new partners

An amount as a welcome, as a manual booking. You can define a starting balance for each partner, which the partner receives directly as commission after registration. If, for example, you assign a starting credit of EUR 5 and the payment of a commission is only possible from EUR 10, then the new partner only has a short way to go for the first payment. With a starting credit, you can easily motivate the partner to acquire new customers directly. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Partners · Starting credit card → Activate starting creditShould 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.

  • Partners · Starting credit card → CreditThe starting credit in the standard currency (e.g. EUR 5.-) for each partner after registration.

Partners · Code changes: Whether partners may change their codes themselves

Partner code and voucher code, each on its own. Whether partners may change their partner code and the code of their partner voucher themselves: right away or only after your review under Affiliate program › Code requests. The extension checks every new code, for example for special characters and codes already in use. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Partners · Code changes card → Partners are allowed to change their partner codeIs the partner allowed to change their own partner code? The extension checks the validity of the new code in any case - e.g. no special characters and no existing code.

    Yes, new code is changed directly:
    The partner may change their own partner code at any time.

    Yes, new code must be checked manually:
    The partner may make a proposal for a new partner code. The new code must be manually activated in the administration.

    No:
    The partner cannot change their partner code.

  • Partners · Code changes card → Partners are allowed to change their voucher codeIs the partner allowed to change their own voucher code? The extension checks the validity of the new code in any case - e.g. no special characters and no existing code.

    Yes, new code is changed directly:
    The partner may change their own voucher code at any time.

    Yes, new code must be checked manually:
    The partner may make a proposal for a new voucher code. The new code must be manually activated in the administration.

    No:
    The partner cannot change their voucher code.

Partners · Partner area: What partners see in the partner area

Lists, statistics, documents and partner group in the customer account. What partners see in the partner area of their customer account: the latest referred orders and customers, manual bookings, statistics, payout documents, commission also for orders that are not commissionable yet, their partner group and the state of the commission. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Partners · Partner area card → Selection of the last referred ordersAccording to which criterion (number or days) should the last referred orders be displayed? Please note that you may have to adjust the text modules for describing the most recently referred orders.

  • Partners · Partner area card → Number of last orders / daysPlease indicate the number of orders or days.

  • Partners · Partner area card → Show the last referred customersShould the partner be shown the last customers referred? Only the first name, the first letter of the last name and the city are shown.

  • Partners · Partner area card → Selection of the last referred customersAccording to which criterion (number or days) should the last referred customers be displayed? Please note that you may have to adjust the text modules for describing the most recently referred customers.

  • Partners · Partner area card → Number of last customers / daysPlease indicate the number of customers or days.

  • Partners · Partner area card → Display last manual bookingsShould the partner be shown the last manual bookings? The partner is shown the public comment.

  • Partners · Partner area card → Advanced statistics for partnersShould the partner be able to view advanced statistics for referred orders? The statistics are similar to the detailed referred orders within the administration of a partner and contain e.g. the conditions for commissionable orders.

  • Partners · Partner area card → Offer the payout document as a downloadShould the payout document be made available to the partner as a download?

  • Partners · Partner area card → Show turnover and commissions for non-commissionable ordersShould 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.

  • Partners · Partner area card → Show the partner group in the partner areaShows the partner's active partner group and the progress to the next partner group with automatic promotion. Nothing is shown while no partner group is active.

  • Partners · Partner area card → Show commission statusShould the status of the commission be shown? Each commission is marked as "Eligible for commission", "Not eligible for commission" or "Canceled".

  • Partners · Partner area card → Status for canceled ordersPlease select the status that marks orders as canceled. The commission for these orders will then also be marked as canceled.

    Note:
    If NO status is selected, then NO commission is marked as canceled.

Marketing

Marketing · Click tracking: Record clicks on partner links

The data for clicks, click sources and the click statistics of the partners. Records clicks on partner links for the statistics in the administration and, if you like, in the partner area: time, shortened IP, browser, target page and origin. After the retention period the extension deletes them daily. The commission does not change; name the storage in your privacy policy. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Marketing · Click tracking card → Record clicks on partner linksStores time, shortened IP, user agent, landing path, referring domain and UTM data. Known customers and the first associated order can be linked. Repeated visits are usually recognised; occasional duplicate clicks are possible. Update your privacy information accordingly.

  • Marketing · Click tracking card → Retention in daysExpired click records are deleted daily. Statistics cover the retained data only; commissions remain unchanged.

  • Marketing · Click tracking card → Show click statistics in the partner areaShows aggregated clicks and conversions for the signed-in partner. No IP addresses, user agents or customer references are shown.

Marketing · Partner voucher: The voucher of every partner

Defaults for the promotion created for every partner. In addition to the partner code within a link, each partner can also recruit potential customers with an individual voucher. A Shopware voucher is created automatically for each partner and made available to the partner. You can define the default values for this voucher here. Each of these settings can be changed for each partner in their promotion after registration. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Marketing · Partner voucher card → Activate partner voucherShould a partner voucher be created automatically for each partner? A partner can use this voucher to attract more customers.

  • Marketing · Partner voucher card → Automatically add partner voucherShould 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.

  • Marketing · Partner voucher card → Type of discountThe type of discount of the partner voucher.

  • Marketing · Partner voucher card → Discount (in percent or EUR)The amount of the discount, in percent or EUR depending on the type.

  • Marketing · Partner voucher card → NameThe name of the voucher in the administration and in the shopping cart of the customer.

  • Marketing · Partner voucher card → Code patternHere you can define a pattern for the voucher code. Use the placeholders %s for a letter and %d for a number.

    Example:
    code-%s%s%s%s%d%d%d%d

  • Marketing · Partner voucher card → Total usesThe value for "total uses" within the voucher.

  • Marketing · Partner voucher card → Uses per customerThe value for "uses per customer" within the voucher.

  • Marketing · Partner voucher card → Condition - Not combinable with other promotionsIf enabled, then a new automatically created partner voucher will be created with the "Prevents combination with other promotions" option enabled. Thus, partner vouchers cannot be combined with other vouchers.

  • Marketing · Partner voucher card → Condition - Customer rulesOptional customer rules for the voucher for the "rule-based conditions".

  • Marketing · Partner voucher card → Condition - Cart rulesOptional cart rules for the voucher for the "rule-based conditions".

  • Marketing · Partner voucher card → Discount - ScopeThe value for "Scope" in the "Discounts" section within the voucher.

  • Marketing · Partner voucher card → Discount - Apply to selected products onlyThe value for "Apply to selected products only" in the "Discounts" section within the voucher.

  • Marketing · Partner voucher card → Discount - Product rulesThe value for "Product rules" in the "Discounts" section within the voucher.

Marketing · Customer assignment: Which customers belong to a partner and for how long

Code in the cart, new customers only, poaching and duration. A customer belongs to the partner whose link, partner voucher or code brings them into the shop. Here you decide which customers are assigned, whether another partner may take them over and how long the assignment earns commission. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Marketing · Customer assignment card → Allow manual entry of the partner code during the ordering processShould 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?

  • Marketing · Customer assignment card → Assign new customers onlyWhen switched on, only customers without any order in the shop are assigned to a partner, neither with this customer account nor with the same email address. Existing customers stay without a partner even if they come through a partner link, and their orders get no partner code.

  • Marketing · Customer assignment card → Assigned customers may be poached from other partnersA referred customer is usually permanently assigned to a partner. 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.

  • Marketing · Customer assignment card → Assignment lasts (months)How many months a referred customer counts for its partner, starting at the "referred at" date. 0 means without limit. Customers without a stored "referred at" date are never limited. Orders after the end get no commission.

  • Marketing · Customer assignment card → When the assignment endsOnly with a limited assignment. The customer either stays with its partner without any further commission, or loses its partner and can be referred by another partner again.

Marketing · Fraud check: Which orders are flagged as suspicious

Five checks, each switchable on its own. During the synchronisation the extension compares every referred order with the data of its partner. If a switched-on check matches, the order is only marked and shows up under Affiliate program › Fraud check; the commission continues as usual until you decide “Fraud attempt” there. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Marketing · Fraud check card → Suspicion: email address is the PayPal address of the partnerMarks an order whose email address is the PayPal address the partner receives their payouts at.

  • Marketing · Fraud check card → Suspicion: same address as the partnerMarks an order whose billing or shipping address (street, house number, postcode, country) is an address of the partner. Spellings like "Str." and "Straße" count as the same.

  • Marketing · Fraud check card → Suspicion: same last name and same postcodeMarks an order whose customer has the last name of the partner and lives at the same postcode, for example a family member or a second customer account.

  • Marketing · Fraud check card → Suspicion: same phone numberMarks an order with a phone number of the partner. The last nine digits are compared, "+49 251 123456" and "0251 123456" count as the same.

  • Marketing · Fraud check card → Suspicion: same first and last nameMarks an order whose customer has the first and last name of the partner. The address does not matter, a delivery to the office counts as well.

Commission

Commission · Commissionable orders: Which orders earn commission, and from when

Waiting period, customer groups, order status, subsequent orders and own orders. A referred order only becomes commissionable when all the requirements below have been met. Only commissionable orders are counted towards the partner's available commission. Although the partner sees all referred orders in their statistics, sales and commission are only visible as soon as an order is commissionable. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Commission · Commissionable orders card → Age (in days)What is the minimum age (in days) that an order must be in order to receive commission?

  • Commission · Commissionable orders card → Customer groupsOnly orders of customers in these customer groups get commission.

    Note:
    If NO customer groups are selected, then ALL customer groups are valid.

  • Commission · Commissionable orders card → Order statusThe status an order must have to get commission.

    Note:
    If NO status is selected, then ALL statuses except cancelled are valid. Cancelled orders never receive a new commission, even if selected here.

  • Commission · Commissionable orders card → Commission subsequent ordersShould all orders of a customer - including all subsequent orders - get commission? Otherwise, only one order per customer is eligible for commission.

  • Commission · Commissionable orders card → Guest orders with the same email address are subsequent ordersShopware creates a separate guest account for every guest order. When switched on, an order counts as a subsequent order if a guest order with the same email address already received a commission (and the other way round). When switched off, only orders of the same customer account count.

  • Commission · Commissionable orders card → Partners receive commission for their own ordersDo partners receive commission for their own orders if they have referred themselves - e.g. test the partner link or use the partner voucher? A guest order with the email address of the partner also counts as an own order. The fraud check can flag guest orders with other email addresses as suspicious.

Commission · Cancelled orders: What happens to the commission of cancelled orders

The automatic offset as a negative manual booking. As soon as an order has been commissioned (e.g. completed and after 14 days), the commission received always remains untouched - regardless of whether the order is adjusted, canceled or deleted. Here you can activate automatic compensation as soon as an order is canceled. This means that a negative manual entry is automatically made for a canceled order for which commission has already been calculated and, if applicable, paid out, in order to reduce the value of the available commission. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Commission · Cancelled orders card → Automatically settle canceled ordersShould a negative manual posting be created automatically for canceled orders to clear them?

  • Commission · Cancelled orders card → Public notice of the bookingThe public notice of the manual booking.

Commission · Commission rules: Switch on commission rules and choose the rate

Whether commission rules count and which rate wins. Manage customer, product, category and dynamic product group rates in commission rules with selections, priority and partner assignments. A customer or product match is sufficient. Existing bookings remain unchanged. Only active commission rules valid for the partner are eligible. Customers, products, categories and dynamic product groups within a rule are combined with OR: One match is sufficient. The type of match does not give a rule precedence: for example, a customer rule is not more important than a product rule. The following option only applies to Always highest rate and Always lowest rate. When checked, the individual partner rate is compared alongside matching rules. It can therefore win itself, for example as the lowest rate. When unchecked, only matching rules are compared. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Commission · Commission rules card → Enable commission rulesUses commission rules for customers, products, categories and dynamic product groups (Partner program › Commission rules). When disabled, only partner and subsequent-order rates apply.

  • Commission · Commission rules card → Commission selectionThe higher priority number wins. Equal priorities are resolved by the highest or lowest rate. Always highest/lowest ignores priority. A customer, product, category or dynamic product group match does not give a rule precedence.

  • Commission · Commission rules card → Include the individual partner rate in “Always highest/lowest rate”Only applies to Always highest/lowest: Include the individual partner rate in the comparison so it can win. When unchecked, only matching rules are compared. If no rule matches, the partner rate applies regardless of this option.

Payout

Payout · Compensation: Voucher, payout or both

How partners receive their commission; changeable per partner. A partner's commission can either be remunerated via vouchers or paid out directly. Here you can select which type of remuneration the partner can choose. In the case of remuneration by voucher, voucher codes are automatically created for the vouchers specified below. The partner can use these voucher codes directly in your shop. In the case of remuneration by payout, the partner requests a payout, or it is created by the automatic payout on the payout day. You check every payout and pay it out by SEPA file or through PayPal. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · Compensation card → Type of remunerationIn what form should your partners receive their commission?

    Voucher:
    The partner can convert their commission into vouchers independently and can redeem them directly in the shop.

    Payout:
    The partner can request payment of the commission, or it is created by the automatic payout. To do so, they enter their bank account or their PayPal account; you check and confirm the payouts and pay them out by SEPA file or through PayPal.

Payout · Compensation by voucher: Commission as a voucher: steps or a free amount

The vouchers partners can choose. How partners turn their commission into vouchers: in fixed steps with the promotions chosen here, or as a free amount from a minimum amount, then with the template of the card “Payout · Voucher with a free amount”. Only applies when the compensation allows vouchers. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · Compensation by voucher card → Type of conversionIn what amount or on what scale can the partner convert their credit into a voucher?

    Free amount:
    The partner chooses the value of the voucher, from the minimum amount up to their available commission. A new, individual voucher is generated for each conversion according to the specifications below.

    Convert in staggered amounts:
    The partner may only convert their credit into vouchers in predefined increments. The available vouchers can be selected below.

  • Payout · Compensation by voucher card → Minimum amount (in EUR)With “Free amount”, the least value (in EUR) of a voucher.

  • Payout · Compensation by voucher card → Voucher 1Please select a voucher that the partner can redeem.

    Note:
    Please note that the voucher uses individual promotion codes and that the discount is absolute.

  • Payout · Compensation by voucher card → Voucher 2Please select a voucher that the partner can redeem.

    Note:
    Please note that the voucher uses individual promotion codes and that the discount is absolute.

  • Payout · Compensation by voucher card → Voucher 3Please select a voucher that the partner can redeem.

    Note:
    Please note that the voucher uses individual promotion codes and that the discount is absolute.

  • Payout · Compensation by voucher card → Voucher 4Please select a voucher that the partner can redeem.

    Note:
    Please note that the voucher uses individual promotion codes and that the discount is absolute.

  • Payout · Compensation by voucher card → Voucher 5Please select a voucher that the partner can redeem.

    Note:
    Please note that the voucher uses individual promotion codes and that the discount is absolute.

Payout · Voucher with a free amount: The template for vouchers with a free amount

Name, code and conditions of every new voucher. Template for the promotion that is created anew for every voucher with “Free amount”: name, code, combination and conditions as under Marketing › Promotions. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · Voucher with a free amount card → NameThe name of the voucher in the administration and in the shopping cart of the customer.

  • Payout · Voucher with a free amount card → Code patternHere you can define a pattern for the voucher code. Use the placeholders %s for a letter and %d for a number.

    Example:
    code-%s%s%s%s%d%d%d%d

  • Payout · Voucher with a free amount card → Condition - Not combinable with other promotionsIf enabled, then a new voucher with a free amount will be created with the "Prevents combination with other promotions" option enabled. Thus, these vouchers cannot be combined with other vouchers.

  • Payout · Voucher with a free amount card → Condition - Customer rulesOptional customer rules for the voucher for the "rule-based conditions".

  • Payout · Voucher with a free amount card → Condition - Cart rulesOptional cart rules for the voucher for the "rule-based conditions".

  • Payout · Voucher with a free amount card → Discount - ScopeThe value for "Scope" in the "Discounts" section within the voucher.

  • Payout · Voucher with a free amount card → Discount - Apply to selected products onlyThe value for "Apply to selected products only" in the "Discounts" section within the voucher.

  • Payout · Voucher with a free amount card → Discount - Product rulesThe value for "Product rules" in the "Discounts" section within the voucher.

Payout · Compensation by payout: Commission as a payout: steps or a free amount

The amounts partners can request. How partners have their commission paid out: in fixed steps or as a free amount from a minimum amount. Only applies when the compensation allows payouts. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · Compensation by payout card → Type of payoutIn what amount or on what scale may the partner have their credit paid out?

    Free amount:
    The partner chooses the amount, from the minimum amount up to their available commission.

    Payment in staggered amounts:
    The partner may only have their credit paid out in predefined scales. The individual scales can be defined below.

  • Payout · Compensation by payout card → Minimum amount (in EUR)With “Free amount”, the least amount (in EUR) of a payout.

  • Payout · Compensation by payout card → Payout 1 (in EUR)Please enter the amount that the partner can withdraw.

  • Payout · Compensation by payout card → Payout 2 (in EUR)Please enter the amount that the partner can withdraw.

  • Payout · Compensation by payout card → Payout 3 (in EUR)Please enter the amount that the partner can withdraw.

  • Payout · Compensation by payout card → Payout 4 (in EUR)Please enter the amount that the partner can withdraw.

  • Payout · Compensation by payout card → Payout 5 (in EUR)Please enter the amount that the partner can withdraw.

Payout · Payout methods: SEPA bank transfer, PayPal and remittance information

Which methods partners can choose. Which methods partners can have their payouts sent by (SEPA bank transfer, PayPal) and which remittance information the transfer carries. The access data is in the cards “Payout · SEPA bank transfer” and “Payout · PayPal”. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · Payout methods card → Offer SEPA bank transferPartners can enter an account holder and an IBAN. Payouts are paid with a SEPA file for your online banking.

  • Payout · Payout methods card → Offer PayPalPartners can enter the email address of their PayPal account. Payouts are paid through the PayPal API.

  • Payout · Payout methods card → Remittance informationTwig as in the mail templates: {{ payout.number }} payout number, {{ payout.value }} amount, {{ partner.name }} partner. Empty or faulty, the default applies. At most 140 characters. Used in SEPA files and as the message of PayPal transfers.

Payout · SEPA bank transfer: The account of the shop for the SEPA file

Name, IBAN and BIC of the account the transfer comes from. The account of the shop the SEPA file under Affiliate program › SEPA payouts transfers from. Without a valid IBAN no file can be created; each sales channel can have its own account. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · SEPA bank transfer card → Name of the shop accountAccount holder of the account the SEPA file pays from.

  • Payout · SEPA bank transfer card → IBAN of the shop accountIBAN of the account the SEPA file pays the payouts from; spaces are allowed. Required for SEPA files: if it is missing or invalid, no file can be created. A sales channel can have a shop account of its own.

  • Payout · SEPA bank transfer card → BIC of the shop accountThe international bank code (BIC, 8 or 11 characters, e.g. COBADEFFXXX) of the bank that holds the shop account. Optional: within the SEPA area the bank finds the account by its IBAN and does not need the BIC. Only enter it if your bank asks for it in the SEPA file. An entered BIC must be valid, otherwise no SEPA file can be created.

Payout · PayPal: The access to the PayPal API

Client ID, secret and sandbox, with “Test connection”. Access to the PayPal API for payouts under Affiliate program › PayPal payouts. You need a REST app with payouts enabled; “Test connection” checks the data after saving. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · PayPal card → Client IDClient ID of a REST app in the PayPal developer dashboard with payouts enabled.

  • Payout · PayPal card → SecretSecret of the same REST app as the client ID above, from the matching environment (sandbox or live, see the “Sandbox” switch). After saving, check both with “Test connection”.

  • Payout · PayPal card → SandboxSends payouts to the PayPal sandbox with test accounts instead of real money.

Payout · Automatic payout: Create payouts automatically

Interval and payout day for all partners with payouts. Applies to all sales channels. Note: only for the type of remuneration “Payout”. Partners with the type of remuneration “Voucher” or “Voucher and payout” get no automatic payout, and the switch “With an automatic payout, partners may also request payouts themselves” does not apply to them: these partners always request their payouts themselves. The automatic payout only reads “All sales channels”: this card, the limit (smallest staggered amount or minimum amount of the payout), the default type of remuneration, the payout methods offered and the mail settings. It applies to all active partners with the type of remuneration “Payout”, also to partners without customer account; a single partner is left out in the card “Automatic payout” of the partner. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · Automatic payout card → Activate automatic payoutsOn the payout day the extension creates a payout of the whole balance, rounded down to whole euros, for every partner whose type of remuneration is "Payout". The same limit applies as for a request of the partner: the smallest staggered amount or the minimum amount of the card "Payout · Compensation by payout". The payouts are reviewed like every request.

  • Payout · Automatic payout card → IntervalHow often the automatic payout runs. The payout day is set by the weekday or the day of the month below.

  • Payout · Automatic payout card → Weekday (only for "Weekly" and "Every two weeks")Applies to "Weekly" and "Every two weeks". Every two weeks counts from the first payout day after switching the automatic payout on.

  • Payout · Automatic payout card → Day of the month (only for "Monthly")Applies to "Monthly": on the 1st, on the 15th or on the last day of the month.

  • Payout · Automatic payout card → With an automatic payout, partners may also request payouts themselvesApplies only when the automatic payout is activated above and only to partners with the type of remuneration "Payout"; otherwise partners always request their payouts themselves. On: besides the automatic payout partners may request a payout at any time. Off: money only comes by the automatic payout. Default for all partners, changeable for each partner in the card "Automatic payout".

Payout · Order for each redemption: An order for each redemption for the ERP

Product, tax rates, shipping and payment method of the order. In order to (partially) automate the downstream processes for a payout via your ERP, you can trigger an order from the partner for each payout. Each order contains a pseudo-product with the product number defined here and a name. For example, you can use the product number within the ERP to recognise that this is a credit note that needs to be paid out. Please note that the extension simulates a normal checkout process and therefore the selected shipping and payment method must be valid for the shop! If, for example, you only want an individual payment method for payouts that should not otherwise be available in the shop, you can assign a tag to the pseudo-product and check for this tag within a rule for this payment method. Also select both tax rates of your shop below: without a valid tax rate no order is created; the redemption itself stays saved and the partner sees a notice. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · Order for each redemption card → Generate order when creating a voucherWhen creating a voucher (for commission), should an order automatically be created for the customer?

  • Payout · Order for each redemption card → Product numberThe product number of the product for the order when creating a voucher.

  • Payout · Order for each redemption card → NameThe name of the product for the order when creating a voucher.

  • Payout · Order for each redemption card → Generate order when requesting a payoutWhen requesting a payout (for commission), should an order automatically be created for the customer?

  • Payout · Order for each redemption card → Product numberThe product number of the product for the order when requesting a payout.

  • Payout · Order for each redemption card → NameThe name of the product for the order when requesting a payout.

  • Payout · Order for each redemption card → TagYou can assign a tag to the product so that you can check for it in the Shipping and Payment Rule Builder.

  • Payout · Order for each redemption card → Tax rate - consumers (gross)The tax rate of the product for end customers. Select the 0 % tax rate here, since end customers are paid gross equals net.

  • Payout · Order for each redemption card → Tax rate - businesses (net and/or tax-free)The tax rate of the product for businesses. Select the standard tax rate (19 % VAT) here.

  • Payout · Order for each redemption card → Shipping methodThe shipping method for automatically created orders.

  • Payout · Order for each redemption card → Payment methodThe payment method for automatically created orders.

Payout · Partners with a German VAT ID: Net deduction for partners with a German VAT ID

A special case for businesses as partners. A special case for partners who invoice as a business from Germany with a VAT ID: with the switch, a payout or a voucher reduces the available commission by the net amount only. Off by default. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • Payout · Partners with a German VAT ID card → Reduce available commission by the net amount for partners from Germany with a VAT IDFor partners with a German billing address and a VAT ID in their customer account, should available commission be reduced by the net amount of a payout or voucher redemption? For example, requesting a EUR 10 payout creates a EUR 10 payout record but reduces available commission by only EUR 8.40 (EUR 10 excluding 19% VAT).

System

System · Emails to the shop: Which emails the shop receives

Ten switches, all off by default. Flows send the emails (System › Flows). Every switch releases one message to the shop; when it is off, custom flows do not send this message either. The messages go to the email address of the basic information of Shopware; other recipients can be set in the flow. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • System · Emails to the shop card → Activate email when registering a new partnerShould the shop operator be informed by email as soon as a new partner has registered?

  • System · Emails to the shop card → Activate email on new partner applicationShould the shop operator be informed by email as soon as a new application from a possible partner has been received for manual review?

  • System · Emails to the shop card → Activate email when changing the partner codeShould the shop operator be informed by email as soon as a partner independently changes their partner code?

  • System · Emails to the shop card → Activate email upon request to change the partner codeShould the shop operator be informed by email as soon as a partner makes a request to change their partner code?

  • System · Emails to the shop card → Activate email when changing the voucher codeShould the shop operator be informed by email as soon as a partner independently changes their voucher code?

  • System · Emails to the shop card → Activate email upon request to change the voucher codeShould the shop operator be informed by email as soon as a partner makes a request to change their voucher code?

  • System · Emails to the shop card → Activate email when a partner moves up to a new partner groupShould the shop operator be informed by email as soon as a partner moves up to a new partner group?

  • System · Emails to the shop card → Activate email when a partner wants a payoutShould the shop operator be informed by email as soon as a partner redeems a commission (payout)?

  • System · Emails to the shop card → Activate email when a partner generates a promotionShould the shop operator be informed by email as soon as a partner redeems a commission (voucher)?

  • System · Emails to the shop card → Activate email with the summary of automatic payoutsShould the shop operator get an email with the summary of the automatic payouts after every payout day?

System · Emails to partners: Which emails partners receive

Eight switches, all off by default. Every switch releases one message to partners, sent through flows (Affiliate program › Flows). The partner can additionally unsubscribe from the message about available commission in their customer account. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • System · Emails to partners card → Activate email when an application is approvedShould the partner be informed by email as soon as their application has been approved?

  • System · Emails to partners card → Activate email when an application is rejectedShould the partner be informed by email as soon as their application has been rejected?

  • System · Emails to partners card → Activate email when an assigned customer creates an orderShould the partner be informed by email as soon as an assigned customer places an order?

  • System · Emails to partners card → Activate email when commission is available for paymentShould the partner be informed by email as soon as they have collected enough commission for a payout? They can switch the notification on or off in their customer account.

  • System · Emails to partners card → Activate email when a payout is confirmedShould the partner be informed by email as soon as their payout has been confirmed?

  • System · Emails to partners card → Activate email when a payout is rejectedShould the partner be informed by email as soon as their payout has been rejected?

  • System · Emails to partners card → Activate email when a payout was created automaticallyShould the partner be informed by email as soon as an automatic payout has been created for them?

  • System · Emails to partners card → Activate email when the partner moves up to a new partner groupShould the partner be informed by email as soon as they move up to a new partner group?

System · Calculation of the commission: When the commission of new orders is created

Live, by scheduled task or by console command. When the commission of new orders is calculated: right when the partner area is opened, in the scheduled task or by console command; for large shops the task or the command is recommended. The promotion into partner groups runs apart from it in a scheduled task of its own. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • System · Calculation of the commission card → Live when the partner area is openedWhen the partner opens the partner area, the current commission is calculated live for this partner. 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.

  • System · Calculation of the commission card → Via scheduled taskThe 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 opens the partner area.

  • System · Calculation of the commission card → Only partners with new ordersIf enabled, each run of the scheduled task of the calculation only processes partners that have an order without a commission yet, instead of every partner. Recommended for shops with many partners. Applies to the scheduled task only; the console command has the option --only-delta for this. The promotion into partner groups has a scheduled task of its own and always checks every partner.

  • System · Calculation of the commission card → Via console commandThe 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.

System · Scheduled tasks and console: Switch scheduled tasks and console commands

Two main switches for everything running in the background. Applies to all sales channels. Two switches for everything that runs without a person at the screen: the four scheduled tasks (synchronisation of the commissions, promotion into partner groups, automatic payouts, deletion of old clicks) and the five console commands (dvsn-affiliate:update-commission, dvsn-affiliate:tier:promote, dvsn-affiliate:payout:create, dvsn-affiliate:click:purge, dvsn-affiliate:reset-order). A switched-off task still runs on its schedule and returns at once; a switched-off command says so and stops. Both on is the normal state. The synchronisation of the commissions also follows the switches of the card “System · Calculation of the commission”. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • System · Scheduled tasks and console card → Run the scheduled tasksOff: the synchronisation of the commissions, the promotion into partner groups, the automatic payouts and the deletion of old clicks return at once at every run and do nothing. A due payout day waits until the tasks are on again and then continues. Clicks past their retention period stay until the command deletes them.

  • System · Scheduled tasks and console card → Allow the console commandsOff: every console command with the prefix "dvsn-affiliate:" stops with a message before it does anything. The administration, the partner area and the scheduled tasks are not affected.

System · Logs for troubleshooting: Output and logs for troubleshooting

Plus the calculation log at every order. Output and log files for troubleshooting, for example for support. The last switch stores for every order how its commission was calculated; without it the order has no calculation log. More in this chapter.

Where to find them in the settings (affiliate program menu on the left under System → Settings):

  • System · Logs for troubleshooting card → Activate the output of the scheduled taskShould the scheduled task (for the synchronisation of the commissions) have the outputs enabled? You can enable this option if you want to control the output via messenger:consume -vvv.

  • System · Logs for troubleshooting card → Activate the log of the scheduled taskShould the log be activated for the scheduled task (for the synchronisation of the commissions)? The log is stored in the directory /var/log/.

  • System · Logs for troubleshooting card → Activate the output of the console commandShould the console command (for the synchronisation of the commissions) have the outputs enabled?

  • System · Logs for troubleshooting card → Activate the log of the console commandShould the log be activated for the console command (for the synchronisation of the commissions)? The log is stored in the directory /var/log/.

  • System · Logs for troubleshooting card → Log the calculation of commission for each orderShould the basis for calculating the commission be saved for all orders?

Multi-level marketing

Default settings: Show multi-level marketing in the partner area

Statistics by level and the network as a tree in the customer account. More in this chapter.

Where to find them in the configuration of the multi-level marketing add-on plugin (Extensions → My extensions → Configure):

  • Default settings card → View multi-level marketing statistics in the affiliate programShould multi-level marketing statistics be displayed across all levels within the affiliate program in the customer account (storefront)? This option should be disabled if you already have a large number of partners and levels to increase performance.

  • Default settings card → Show the network as a tree in the affiliate programPartners see the partners they recruited directly and indirectly level by level, with shortened names, their figures and the last five orders of their customers. The overview by level stays.

Level settings: Over how many levels commission is created

The highest level for future orders. Here you can define the maximum level for a commission of an order. Depending on the level, up to five partners receive a commission per order. Level 1 are only orders from directly recruited customers and only the direct partner receives a commission. Level 5 are orders generated through four other partners and for which a total of five partners receive a commission. Please note that a change does not affect orders that are already eligible for commission. A change will only affect future orders and commissions. More in this chapter.

Where to find them in the configuration of the multi-level marketing add-on plugin (Extensions → My extensions → Configure):

  • Level settings card → LevelThe maximum level of commission for future orders.

Commission priority: Which rank the rates of levels 2 to 5 have

How the level rate competes with partner groups and commission rules. What the priority does. If several rates match an order, the priority decides which one applies: the higher number wins. On levels 2 to 5 the level rate, the partner group of the partner above (priority 50) and matching commission rules (usually 100 to 500) compete for that partner. The default 10 places the level rates below them. Partner groups and rules agreed on purpose come first, and the level rate applies wherever neither of them does. A higher value gives the level rates precedence, on equal priority the tie setting decides. The rate of the first level stays untouched, stored bookings are not recalculated. Note: only with "Priority first". The priority only counts if one of the two "Priority first" modes is selected under "Commission selection" in the partner program, as by default. With "Always highest rate" and "Always lowest rate" only the higher or lower calculated commission decides. Then even a very high priority gives the level rate no precedence. More in this chapter.

Where to find them in the configuration of the multi-level marketing add-on plugin (Extensions → My extensions → Configure):

  • Commission priority card → Priority of rates for levels 2 to 5The higher number wins. Default 10: partner groups (50) and commission rules (100 to 500) come first, the level rate applies wherever neither of them does. Only counts with "Priority first" under "Commission selection" in the partner program.

Commission - Level 1: Level 1 comes from the affiliate program

This card has no fields. The default values for level 1 commissions can be defined in the affiliate program plugin configuration. The commission of other, additional levels can be defined here. More in this chapter.

Commission - Level 2: Commission of the second level

Starting values for new partners, changeable per partner. More in this chapter.

Where to find them in the configuration of the multi-level marketing add-on plugin (Extensions → My extensions → Configure):

  • Commission - Level 2 card → Type of provisionOn what basis shall the Partner receive a commission for a referred order? Can be customized per partner after registration in the administration.

    Percental:
    The Partner shall receive a percentage share (e.g. 5%) of the net goods value of a referred order as commission.

    Absolute (per order):
    The Partner shall always receive a fixed amount (e.g. 5.- EUR) for a referred order, regardless of the order value.

    Absolute (per piece):
    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.

  • Commission - Level 2 card → Commission (absolute or percental)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.

  • Commission - Level 2 card → Activate individual commission for subsequent ordersShould 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.

  • Commission - Level 2 card → Commission for subsequent orders (absolute or percental)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.

Commission - Level 3: Commission of the third level

Starting values for new partners, changeable per partner. More in this chapter.

Where to find them in the configuration of the multi-level marketing add-on plugin (Extensions → My extensions → Configure):

  • Commission - Level 3 card → Type of provisionOn what basis shall the Partner receive a commission for a referred order? Can be customized per partner after registration in the administration.

    Percental:
    The Partner shall receive a percentage share (e.g. 5%) of the net goods value of a referred order as commission.

    Absolute (per order):
    The Partner shall always receive a fixed amount (e.g. 5.- EUR) for a referred order, regardless of the order value.

    Absolute (per piece):
    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.

  • Commission - Level 3 card → Commission (absolute or percental)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.

  • Commission - Level 3 card → Activate individual commission for subsequent ordersShould 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.

  • Commission - Level 3 card → Commission for subsequent orders (absolute or percental)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.

Commission - Level 4: Commission of the fourth level

Starting values for new partners, changeable per partner. More in this chapter.

Where to find them in the configuration of the multi-level marketing add-on plugin (Extensions → My extensions → Configure):

  • Commission - Level 4 card → Type of provisionOn what basis shall the Partner receive a commission for a referred order? Can be customized per partner after registration in the administration.

    Percental:
    The Partner shall receive a percentage share (e.g. 5%) of the net goods value of a referred order as commission.

    Absolute (per order):
    The Partner shall always receive a fixed amount (e.g. 5.- EUR) for a referred order, regardless of the order value.

    Absolute (per piece):
    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.

  • Commission - Level 4 card → Commission (absolute or percental)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.

  • Commission - Level 4 card → Activate individual commission for subsequent ordersShould 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.

  • Commission - Level 4 card → Commission for subsequent orders (absolute or percental)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.

Commission - Level 5: Commission of the fifth level

Starting values for new partners, changeable per partner. More in this chapter.

Where to find them in the configuration of the multi-level marketing add-on plugin (Extensions → My extensions → Configure):

  • Commission - Level 5 card → Type of provisionOn what basis shall the Partner receive a commission for a referred order? Can be customized per partner after registration in the administration.

    Percental:
    The Partner shall receive a percentage share (e.g. 5%) of the net goods value of a referred order as commission.

    Absolute (per order):
    The Partner shall always receive a fixed amount (e.g. 5.- EUR) for a referred order, regardless of the order value.

    Absolute (per piece):
    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.

  • Commission - Level 5 card → Commission (absolute or percental)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.

  • Commission - Level 5 card → Activate individual commission for subsequent ordersShould 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.

  • Commission - Level 5 card → Commission for subsequent orders (absolute or percental)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.

← Back to the manual

Common questions

Do the settings apply to all sales channels?

Yes, as long as you save them under All sales channels. Every sales channel can override single values. The automatic payout and the switches for scheduled tasks and console commands always apply to all sales channels.

Does a new default change the commission of existing partners?

No. The card Partners · Defaults for new partners provides starting values for new partners. You change existing partners at the partner itself, through a partner group or with commission rules.

Which settings are off by default?

Among others all 18 emails, the commission rules, the automatic payout, PayPal, the starting credit, the order for each redemption and the advanced statistics in the partner area. Switched on are for example the partner link, the partner voucher, click tracking, SEPA bank transfer, the five checks of the fraud check and the settlement of cancelled orders.

Where do I set the amount of commission?

For new partners in the card Partners · Defaults for new partners, for a single partner on the detail page in the tab Commission, for groups in the partner groups and for products, categories or customers in the commission rules.

How old must an order be before it earns commission?

14 days by default, adjustable in the card Commission · Commissionable orders under Age (in days). Customer groups and order status come on top.

Where are the settings of the multi-level marketing add-on plugin?

In the configuration of the add-on plugin under Extensions, My extensions, Configure: partner area, levels, priority and the rates of levels 2 to 5.

More chapters

Glossary The words of the partner program explained in two sentences each, with common synonyms and the place where you find them in the shop. Read on → Setup Install, grant the permission and get the partner program ready in ten steps with the setup assistant. Read on → Dashboard and statistics Figures, open tasks and the balance of all partners at a glance, plus statistics of the whole program in five tabs. Read on →